diff --git a/lib/model/message_list.dart b/lib/model/message_list.dart index 613b1a712e..947690c426 100644 --- a/lib/model/message_list.dart +++ b/lib/model/message_list.dart @@ -691,6 +691,9 @@ class MessageListView with ChangeNotifier, _MessageSequence { return true; case MentionsNarrow(): + // If changing this, consider whether [Unreads.countInMentionsNarrow] + // should be changed correspondingly, so the message-list view matches + // the unread-count badge. case StarredMessagesNarrow(): case KeywordSearchNarrow(): if (message.conversation case DmConversation(:final allRecipientIds)) { diff --git a/lib/model/unreads.dart b/lib/model/unreads.dart index 543cde28b6..6dcb59af66 100644 --- a/lib/model/unreads.dart +++ b/lib/model/unreads.dart @@ -160,9 +160,7 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier { // TODO(#370): maintain this count incrementally, rather than recomputing from scratch int countInCombinedFeedNarrow() { int c = 0; - for (final messageIds in dms.values) { - c = c + messageIds.length; - } + c += countInDms(); for (final MapEntry(key: streamId, value: topics) in streams.entries) { for (final MapEntry(key: topic, value: messageIds) in topics.entries) { if (channelStore.isTopicVisible(streamId, topic)) { @@ -222,7 +220,30 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier { int countInDmNarrow(DmNarrow narrow) => dms[narrow]?.length ?? 0; - int countInMentionsNarrow() => mentions.length; + /// The unread count for the mentions narrow. + /// + /// This excludes DM messages in conversations that are considered muted, + /// by [UserStore.shouldMuteDmConversation]. + // If changing which messages to exclude, consider whether the @-mentions + // view should change its "is-message-visible" code correspondingly, + // so the unread-count badge matches what you see in that view. + // TODO: deduplicate "is-message-visible" code + // between [Unreads] and [MessageListView]? + // TODO(#370): maintain this count incrementally, rather than recomputing from scratch + int countInMentionsNarrow() { + int c = 0; + for (final messageId in mentions) { + final narrow = locatorMap[messageId]; + if (narrow == null) continue; + switch (narrow) { + case DmNarrow(): + if (channelStore.shouldMuteDmConversation(narrow)) continue; + case TopicNarrow(): + } + c++; + } + return c; + } // TODO: Implement unreads handling. int countInStarredMessagesNarrow() => 0; @@ -230,6 +251,19 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier { // TODO: Implement unreads handling? int countInKeywordSearchNarrow() => 0; + /// The aggregated unread count for DM conversations. + /// + /// This excludes conversations that are considered muted, + /// by [UserStore.shouldMuteDmConversation]. + int countInDms() { + int c = 0; + for (final MapEntry(key: narrow, value: messageIds) in dms.entries) { + if (channelStore.shouldMuteDmConversation(narrow)) continue; + c += messageIds.length; + } + return c; + } + int countInNarrow(Narrow narrow) { switch (narrow) { case CombinedFeedNarrow(): diff --git a/lib/widgets/home.dart b/lib/widgets/home.dart index c74da27a86..1f74caa011 100644 --- a/lib/widgets/home.dart +++ b/lib/widgets/home.dart @@ -23,6 +23,7 @@ import 'store.dart'; import 'subscription_list.dart'; import 'text.dart'; import 'theme.dart'; +import 'unread_count_badge.dart'; import 'user.dart'; enum _HomePageTab { @@ -398,8 +399,13 @@ void _showMainMenu(BuildContext context, { }); } -abstract class _MenuButton extends StatelessWidget { - const _MenuButton(); +/// A button in the main menu. +/// +/// See Figma: +/// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=2037-243759&m=dev +@visibleForTesting +abstract class MenuButton extends StatelessWidget { + const MenuButton({super.key}); String label(ZulipLocalizations zulipLocalizations); @@ -419,6 +425,8 @@ abstract class _MenuButton extends StatelessWidget { color: selected ? designVariables.iconSelected : designVariables.icon); } + Widget? buildTrailing(BuildContext context) => null; + void onPressed(BuildContext context); void _handlePress(BuildContext context) { @@ -434,11 +442,20 @@ abstract class _MenuButton extends StatelessWidget { final designVariables = DesignVariables.of(context); final zulipLocalizations = ZulipLocalizations.of(context); + // Make [TextButton] set 44 instead of 48 for the height. + final visualDensity = VisualDensity(vertical: -1); + // A value that [TextButton] adds to some of its layout parameters; + // we can cancel out those adjustments by subtracting it. + final densityVerticalAdjustment = visualDensity.baseSizeAdjustment.dy; + final borderSideSelected = BorderSide(width: 1, strokeAlign: BorderSide.strokeAlignOutside, color: designVariables.borderMenuButtonSelected); final buttonStyle = TextButton.styleFrom( - padding: const EdgeInsets.symmetric(vertical: 9, horizontal: 8), + // Make the button 44px instead of 48px tall, to match the Figma. + visualDensity: visualDensity, + padding: EdgeInsets.symmetric( + vertical: 10 - densityVerticalAdjustment, horizontal: 8), foregroundColor: designVariables.labelMenuButton, // This has a default behavior of affecting the background color of the // button for states including "hovered", "focused" and "pressed". @@ -459,28 +476,29 @@ abstract class _MenuButton extends StatelessWidget { ~WidgetState.pressed: selected ? borderSideSelected : null, })); + final trailing = buildTrailing(context); + return AnimatedScaleOnTap( duration: const Duration(milliseconds: 100), scaleEnd: 0.95, - child: ConstrainedBox( - constraints: const BoxConstraints(minHeight: 44), - child: TextButton( - onPressed: () => _handlePress(context), - style: buttonStyle, - child: Row(spacing: 8, children: [ - SizedBox.square(dimension: _iconSize, - child: buildLeading(context)), - Expanded(child: Text(label(zulipLocalizations), - // TODO(design): determine if we prefer to wrap - overflow: TextOverflow.ellipsis, - style: const TextStyle(fontSize: 19, height: 26 / 19) - .merge(weightVariableTextStyle(context, wght: selected ? 600 : 400)))), - ])))); + child: TextButton( + onPressed: () => _handlePress(context), + style: buttonStyle, + child: Row(spacing: 8, children: [ + SizedBox.square(dimension: _iconSize, + child: buildLeading(context)), + Expanded(child: Text(label(zulipLocalizations), + // TODO(design): determine if we prefer to wrap + overflow: TextOverflow.ellipsis, + style: const TextStyle(fontSize: 19, height: 23 / 19) + .merge(weightVariableTextStyle(context, wght: selected ? 600 : 400)))), + ?trailing, + ]))); } } /// A menu button controlling the selected [_HomePageTab] on the bottom nav bar. -abstract class _NavigationBarMenuButton extends _MenuButton { +abstract class _NavigationBarMenuButton extends MenuButton { const _NavigationBarMenuButton({required this.tabNotifier}); final ValueNotifier<_HomePageTab> tabNotifier; @@ -496,7 +514,7 @@ abstract class _NavigationBarMenuButton extends _MenuButton { } } -class _SearchButton extends _MenuButton { +class _SearchButton extends MenuButton { const _SearchButton(); @override @@ -525,11 +543,23 @@ class _InboxButton extends _NavigationBarMenuButton { return zulipLocalizations.inboxPageTitle; } + @override + Widget? buildTrailing(BuildContext context) { + final store = PerAccountStoreWidget.of(context); + final unreadCount = store.unreads.countInCombinedFeedNarrow(); + if (unreadCount == 0) return null; + return UnreadCountBadge( + style: UnreadCountBadgeStyle.mainMenu, + count: unreadCount, + channelIdForBackground: null, + ); + } + @override _HomePageTab get navigationTarget => _HomePageTab.inbox; } -class _MentionsButton extends _MenuButton { +class _MentionsButton extends MenuButton { const _MentionsButton(); @override @@ -540,6 +570,18 @@ class _MentionsButton extends _MenuButton { return zulipLocalizations.mentionsPageTitle; } + @override + Widget? buildTrailing(BuildContext context) { + final store = PerAccountStoreWidget.of(context); + final unreadCount = store.unreads.countInMentionsNarrow(); + if (unreadCount == 0) return null; + return UnreadCountBadge( + style: UnreadCountBadgeStyle.mainMenu, + count: unreadCount, + channelIdForBackground: null, + ); + } + @override void onPressed(BuildContext context) { Navigator.of(context).push(MessageListPage.buildRoute( @@ -547,7 +589,7 @@ class _MentionsButton extends _MenuButton { } } -class _StarredMessagesButton extends _MenuButton { +class _StarredMessagesButton extends MenuButton { const _StarredMessagesButton(); @override @@ -565,7 +607,7 @@ class _StarredMessagesButton extends _MenuButton { } } -class _CombinedFeedButton extends _MenuButton { +class _CombinedFeedButton extends MenuButton { const _CombinedFeedButton(); @override @@ -609,11 +651,23 @@ class _DirectMessagesButton extends _NavigationBarMenuButton { return zulipLocalizations.recentDmConversationsPageTitle; } + @override + Widget? buildTrailing(BuildContext context) { + final store = PerAccountStoreWidget.of(context); + final unreadCount = store.unreads.countInDms(); + if (unreadCount == 0) return null; + return UnreadCountBadge( + style: UnreadCountBadgeStyle.mainMenu, + count: unreadCount, + channelIdForBackground: null, + ); + } + @override _HomePageTab get navigationTarget => _HomePageTab.directMessages; } -class _MyProfileButton extends _MenuButton { +class _MyProfileButton extends MenuButton { const _MyProfileButton(); @override @@ -624,7 +678,7 @@ class _MyProfileButton extends _MenuButton { final store = PerAccountStoreWidget.of(context); return Avatar( userId: store.selfUserId, - size: _MenuButton._iconSize, + size: MenuButton._iconSize, borderRadius: 4, showPresence: false, ); @@ -643,7 +697,7 @@ class _MyProfileButton extends _MenuButton { } } -class _SwitchAccountButton extends _MenuButton { +class _SwitchAccountButton extends MenuButton { const _SwitchAccountButton(); @override @@ -660,7 +714,7 @@ class _SwitchAccountButton extends _MenuButton { } } -class _SettingsButton extends _MenuButton { +class _SettingsButton extends MenuButton { const _SettingsButton(); @override @@ -677,7 +731,7 @@ class _SettingsButton extends _MenuButton { } } -class _AboutZulipButton extends _MenuButton { +class _AboutZulipButton extends MenuButton { const _AboutZulipButton(); @override diff --git a/lib/widgets/unread_count_badge.dart b/lib/widgets/unread_count_badge.dart index 828d724dc9..3208a28fb7 100644 --- a/lib/widgets/unread_count_badge.dart +++ b/lib/widgets/unread_count_badge.dart @@ -10,23 +10,20 @@ import 'theme.dart'; /// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=2037-186671&m=dev /// It looks like that component was created for the main menu, /// then adapted for various other contexts, like the Inbox page. +/// See [UnreadCountBadgeStyle]. /// -/// Currently this widget supports only those other contexts (not the main menu) -/// and only the component's "kind=unread" variant (not "kind=quantity"). -/// For example, the "Channels" page and the topic-list page: -/// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=6205-26001&m=dev -/// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=6823-37113&m=dev -/// (We use this for the topic-list page even though the Figma makes it a bit -/// more compact there…the inconsistency seems worse and might be accidental.) -// TODO support the main-menu context, update dartdoc +/// Currently this widget supports only the component's "kind=unread" variant, +/// not "kind=quantity". // TODO support the "kind=quantity" variant, update dartdoc class UnreadCountBadge extends StatelessWidget { const UnreadCountBadge({ super.key, + this.style = UnreadCountBadgeStyle.other, required this.count, required this.channelIdForBackground, }); + final UnreadCountBadgeStyle style; final int count; /// An optional [Subscription.streamId], for a channel-colorized background. @@ -55,23 +52,52 @@ class UnreadCountBadge extends StatelessWidget { backgroundColor = designVariables.bgCounterUnread; } + final padding = switch (style) { + UnreadCountBadgeStyle.mainMenu => + const EdgeInsets.symmetric(horizontal: 5, vertical: 4), + UnreadCountBadgeStyle.other => + const EdgeInsets.symmetric(horizontal: 5, vertical: 3), + }; + + final double wght = switch (style) { + UnreadCountBadgeStyle.mainMenu => 600, + UnreadCountBadgeStyle.other => 500, + }; + return DecoratedBox( decoration: BoxDecoration( borderRadius: BorderRadius.circular(5), color: backgroundColor, ), child: Padding( - padding: const EdgeInsets.symmetric(horizontal: 5, vertical: 3), + padding: padding, child: Text( style: TextStyle( fontSize: 16, height: (16 / 16), color: textColor, - ).merge(weightVariableTextStyle(context, wght: 500)), + ).merge(weightVariableTextStyle(context, wght: wght)), count.toString()))); } } +enum UnreadCountBadgeStyle { + /// The style to use in the main menu. + /// + /// Figma: + /// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=2037-185126&m=dev + mainMenu, + + /// The style to use in other contexts besides the main menu. + /// + /// Other contexts include the "Channels" page and the topic-list page: + /// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=6205-26001&m=dev + /// https://www.figma.com/design/1JTNtYo9memgW7vV6d0ygq/Zulip-Mobile?node-id=6823-37113&m=dev + /// (We use this for the topic-list page even though the Figma makes it a bit + /// more compact there…the inconsistency seems worse and might be accidental.) + other, +} + class MutedUnreadBadge extends StatelessWidget { const MutedUnreadBadge({super.key}); diff --git a/test/model/unreads_test.dart b/test/model/unreads_test.dart index 089ef315cb..ee89246285 100644 --- a/test/model/unreads_test.dart +++ b/test/model/unreads_test.dart @@ -191,6 +191,7 @@ void main() { await store.addSubscription(eg.subscription(stream2)); await store.addSubscription(eg.subscription(stream3, isMuted: true)); await store.setUserTopic(stream1, 'a', UserTopicVisibilityPolicy.muted); + await store.setMutedUsers([eg.thirdUser.userId]); fillWithMessages([ eg.streamMessage(stream: stream1, topic: 'a', flags: []), eg.streamMessage(stream: stream1, topic: 'b', flags: []), @@ -200,7 +201,7 @@ void main() { eg.dmMessage(from: eg.otherUser, to: [eg.selfUser], flags: []), eg.dmMessage(from: eg.thirdUser, to: [eg.selfUser], flags: []), ]); - check(model.countInCombinedFeedNarrow()).equals(5); + check(model.countInCombinedFeedNarrow()).equals(4); }); test('countInChannel/Narrow', () async { @@ -253,12 +254,17 @@ void main() { final stream = eg.stream(); prepare(); await store.addStream(stream); + await store.setUserTopic(stream, 'a', UserTopicVisibilityPolicy.muted); + await store.setMutedUsers([eg.thirdUser.userId]); fillWithMessages([ eg.streamMessage(stream: stream, flags: []), eg.streamMessage(stream: stream, flags: [MessageFlag.mentioned]), + eg.streamMessage(stream: stream, topic: 'a', flags: [MessageFlag.mentioned]), eg.streamMessage(stream: stream, flags: [MessageFlag.wildcardMentioned]), + eg.dmMessage(from: eg.otherUser, to: [eg.selfUser], flags: [MessageFlag.mentioned]), + eg.dmMessage(from: eg.thirdUser, to: [eg.selfUser], flags: [MessageFlag.mentioned]), ]); - check(model.countInMentionsNarrow()).equals(2); + check(model.countInMentionsNarrow()).equals(4); }); test('countInStarredMessagesNarrow', () async { @@ -271,6 +277,20 @@ void main() { ]); check(model.countInStarredMessagesNarrow()).equals(0); }); + + test('countInDms', () async { + prepare(); + await store.setMutedUsers([eg.thirdUser.userId]); + fillWithMessages([ + // No one is muted: don't exclude + eg.dmMessage(from: eg.otherUser, to: [eg.selfUser], flags: []), + // Everyone is muted: exclude + eg.dmMessage(from: eg.thirdUser, to: [eg.selfUser], flags: []), + // One is muted, one isn't: don't exclude + eg.dmMessage(from: eg.thirdUser, to: [eg.selfUser, eg.otherUser], flags: []), + ]); + check(model.countInDms()).equals(2); + }); }); group('isUnread', () { diff --git a/test/widgets/home_test.dart b/test/widgets/home_test.dart index 239449c990..6f4db863d7 100644 --- a/test/widgets/home_test.dart +++ b/test/widgets/home_test.dart @@ -255,6 +255,22 @@ void main () { .isSameColorAs(designVariables.icon); } + testWidgets('buttons are 44px tall', (tester) async { + await prepare(tester); + + await tapOpenMenuAndAwait(tester); + checkIconSelected(tester, inboxMenuIconFinder); + checkIconNotSelected(tester, channelsMenuIconFinder); + + final inboxElement = tester.element( + find.ancestor(of: inboxMenuIconFinder, matching: find.bySubtype())); + check((inboxElement.renderObject as RenderBox).size).height.equals(44); + + final channelsElement = tester.element( + find.ancestor(of: inboxMenuIconFinder, matching: find.bySubtype())); + check((channelsElement.renderObject as RenderBox).size).height.equals(44); + }); + testWidgets('navigation states reflect on navigation bar menu buttons', (tester) async { await prepare(tester);