This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Change 'type' prop on badges to 'forceDot' #12327
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Which, hopefully, better represents what it actually does. Tidies up some of the logic. Split out from #12254
dbkr
added
the
T-Task
dbkr
changed the title
richvdh
suggested changes
Mar 8, 2024
src/components/views/rooms/NotificationBadge/StatelessNotificationBadge.tsx
Outdated
Show resolved
Hide resolved
src/components/views/rooms/NotificationBadge/StatelessNotificationBadge.tsx
Outdated
Show resolved
Hide resolved
src/components/views/rooms/NotificationBadge/UnreadNotificationBadge.tsx
Outdated
Show resolved
Hide resolved
because it was also updating the logic for mark as unread badges and rewriting the ternary to the previous logic would be quite complex.
richvdh
reviewed
Mar 8, 2024
src/components/views/rooms/NotificationBadge/StatelessNotificationBadge.tsx
Outdated
Show resolved
Hide resolved
| @@ -28,7 +28,12 @@ interface Props { | |||
| count: number; | |||
| level: NotificationLevel; | |||
| knocked?: boolean; | |||
| type?: "badge" | "dot"; | |||
| /** | |||
| * If true, where we would normally show a badge, we instead show a dot. Count will | |||
There was a problem hiding this comment.
Do we mean count the property here, or "Notification count" as a concept? Given the text about it affecting whether the dot is displayed, I think we mean count? In which case, backticks and lower case.
There was a problem hiding this comment.
Mmm... I would say more the notification count concept: I'm not clear what exactly it would mean to display or not display a prop. I've referenced the count in the class doc and updated this to hopefully be clearer in 940e9d3.
Comment on lines
26
to
28
| /** | ||
| * If true, the badge will always be displayed as a dot. | ||
| */ |
There was a problem hiding this comment.
I think this needs updating in much the same way as StatelessNotificationBadge's version (though with differences to account for the fact that count comes from a different place)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
thoraj
added a commit
to verji/matrix-react-sdk
that referenced
this pull request
Mar 15, 2024
* Update `@vector-im/compound-design-tokens` in package.json (matrix-org#12339) * Change 'type' prop on badges to 'forceDot' (matrix-org#12327) * Change 'type' prop on badges tio 'forceDot' Which, hopefully, better represents what it actually does. Tidies up some of the logic. Split out from matrix-org#12254 * Missed a file * More comments * Oops, there is no count here. * Back out the logic refactor of StatelessNotificationBadge because it was also updating the logic for mark as unread badges and rewriting the ternary to the previous logic would be quite complex. * Fix doc comment Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clarify doc on displaying the count * Update doc for the forceDot param here too. --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * [Backport staging] Update `@vector-im/compound-design-tokens` in package.json (matrix-org#12340) (cherry picked from commit e3ba643) Co-authored-by: Florian Duros <florianduros@element.io> * Fix the image view (matrix-org#12341) * TAC: Fix hover state when expanded (matrix-org#12337) * Fix TAC hover state * Add playwright test * Update playwright snapshot after last compound style changes * v3.95.0-rc.0 * v3.95.0 * Reset matrix-js-sdk back to develop branch * TAC: Order rooms by most recent after notification level (matrix-org#12329) * Order room by thread timestamp * Fix key errors in test * Update jest snapshots * Update snapshots * Rename alpha/beta to numbers * Add playwright test * Replace forceCount prop with hideIfDot (matrix-org#12344) This replaces the `forceCount` prop on room badge components with `hideIfDot` which hopefully gives a better idea of what it does, since forceCount did not really force a count. Also remove the prop where it was just passing the default value anyway. --------- Co-authored-by: Florian Duros <florianduros@element.io> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: ElementRobot <releases@riot.im> Co-authored-by: Robin <robin@robin.town>
andybalaam
pushed a commit
that referenced
this pull request
Mar 18, 2024
* Change 'type' prop on badges tio 'forceDot' Which, hopefully, better represents what it actually does. Tidies up some of the logic. Split out from #12254 * Missed a file * More comments * Oops, there is no count here. * Back out the logic refactor of StatelessNotificationBadge because it was also updating the logic for mark as unread badges and rewriting the ternary to the previous logic would be quite complex. * Fix doc comment Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clarify doc on displaying the count * Update doc for the forceDot param here too. --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which, hopefully, better represents what it actually does. Tidies up some of the logic. Also adds some tests.
Split out from #12254
Checklist
public/exportedsymbols have accurate TSDoc documentation.