subscription_list [nfc]: Allow onChannelSelect callback, notifying the selected channel

This will be used soon to provide specific behaviour when selecting
a channel, where if specified it will replace the default behaviour
of routing to the message list page of the selected channel narrow.

Author: rajveermalviya

lib/widgets/subscription_list.dart

@@ -13,17 +13,27 @@ import 'text.dart';
 import 'theme.dart';
 import 'unread_count_badge.dart';
 
+typedef OnChannelSelectCallback = void Function(ChannelNarrow narrow);
+
 /// Scrollable listing of subscribed streams.
 class SubscriptionListPageBody extends StatefulWidget {
   const SubscriptionListPageBody({
     super.key,
     this.showTopicListButtonInActionSheet = true,
     this.hideChannelsIfUserCantPost = false,
+    this.onChannelSelect,
   });
 
   final bool showTopicListButtonInActionSheet;
   final bool hideChannelsIfUserCantPost;
 
+  /// Callback to invoke when the user selects a channel from the list.
+  ///
+  /// If null, the default behavior is to navigate to the channel feed.
+  final OnChannelSelectCallback? onChannelSelect;
+
+  // TODO(#412) add onTopicSelect
+
   @override
   State<SubscriptionListPageBody> createState() => _SubscriptionListPageBodyState();
 }
@@ -72,6 +82,12 @@ class _SubscriptionListPageBodyState extends State<SubscriptionListPageBody> wit
     });
   }
 
+  void _handleChannelSelect(ChannelNarrow narrow) {
+    Navigator.push(context,
+      MessageListPage.buildRoute(context: context,
+        narrow: narrow));
+  }
+
   @override
   Widget build(BuildContext context) {
     // Design referenced from:
@@ -114,6 +130,8 @@ class _SubscriptionListPageBodyState extends State<SubscriptionListPageBody> wit
         message: zulipLocalizations.channelsEmptyPlaceholder);
     }
 
+    final onChannelSelect = widget.onChannelSelect ?? _handleChannelSelect;
+
     return SafeArea( // horizontal insets
       child: CustomScrollView(
         slivers: [
@@ -122,14 +140,16 @@ class _SubscriptionListPageBodyState extends State<SubscriptionListPageBody> wit
             _SubscriptionList(
               unreadsModel: unreadsModel,
               subscriptions: pinned,
-              showTopicListButtonInActionSheet: widget.showTopicListButtonInActionSheet),
+              showTopicListButtonInActionSheet: widget.showTopicListButtonInActionSheet,
+              onChannelSelect: onChannelSelect),
           ],
           if (unpinned.isNotEmpty) ...[
             _SubscriptionListHeader(label: zulipLocalizations.unpinnedSubscriptionsLabel),
             _SubscriptionList(
               unreadsModel: unreadsModel,
               subscriptions: unpinned,
-              showTopicListButtonInActionSheet: widget.showTopicListButtonInActionSheet),
+              showTopicListButtonInActionSheet: widget.showTopicListButtonInActionSheet,
+              onChannelSelect: onChannelSelect),
           ],
 
           // TODO(#188): add button leading to "All Streams" page with ability to subscribe
@@ -180,11 +200,13 @@ class _SubscriptionList extends StatelessWidget {
     required this.unreadsModel,
     required this.subscriptions,
     required this.showTopicListButtonInActionSheet,
+    required this.onChannelSelect,
   });
 
   final Unreads? unreadsModel;
   final List<Subscription> subscriptions;
   final bool showTopicListButtonInActionSheet;
+  final OnChannelSelectCallback onChannelSelect;
 
   @override
   Widget build(BuildContext context) {
@@ -198,7 +220,8 @@ class _SubscriptionList extends StatelessWidget {
         return SubscriptionItem(subscription: subscription,
           unreadCount: unreadCount,
           showMutedUnreadBadge: showMutedUnreadBadge,
-          showTopicListButtonInActionSheet: showTopicListButtonInActionSheet);
+          showTopicListButtonInActionSheet: showTopicListButtonInActionSheet,
+          onChannelSelect: onChannelSelect);
     });
   }
 }
@@ -211,12 +234,14 @@ class SubscriptionItem extends StatelessWidget {
     required this.unreadCount,
     required this.showMutedUnreadBadge,
     required this.showTopicListButtonInActionSheet,
+    required this.onChannelSelect,
   });
 
   final Subscription subscription;
   final int unreadCount;
   final bool showMutedUnreadBadge;
   final bool showTopicListButtonInActionSheet;
+  final OnChannelSelectCallback onChannelSelect;
 
   @override
   Widget build(BuildContext context) {
@@ -229,11 +254,7 @@ class SubscriptionItem extends StatelessWidget {
       // TODO(design) check if this is the right variable
       color: designVariables.background,
       child: InkWell(
-        onTap: () {
-          Navigator.push(context,
-            MessageListPage.buildRoute(context: context,
-              narrow: ChannelNarrow(subscription.streamId)));
-        },
+        onTap: () => onChannelSelect(ChannelNarrow(subscription.streamId)),
         onLongPress: () => showChannelActionSheet(context,
           channelId: subscription.streamId,
           showTopicListButton: showTopicListButtonInActionSheet),