feat(ui, core): deprecate pagination in favor of limit

Signed-off-by: xsahil03x <[email protected]>

packages/stream_chat_flutter/lib/src/channel_list_view.dart

@@ -59,7 +59,7 @@ typedef ViewInfoCallback = void Function(Channel);
 /// Modify it to change the widget appearance.
 class ChannelListView extends StatefulWidget {
   /// Instantiate a new ChannelListView
-  const ChannelListView({
+  ChannelListView({
     Key? key,
     this.filter,
     this.sort,
@@ -68,9 +68,12 @@ class ChannelListView extends StatefulWidget {
     this.presence = false,
     this.memberLimit,
     this.messageLimit,
-    this.pagination = const PaginationParams(
-      limit: 25,
-    ),
+    @Deprecated(
+      "'pagination' is deprecated and shouldn't be used. "
+      "This property is no longer used, Please use 'limit' instead",
+    )
+        this.pagination,
+    int? limit,
     this.onChannelTap,
     this.onChannelLongPress,
     this.channelWidget,
@@ -92,7 +95,8 @@ class ChannelListView extends StatefulWidget {
     this.onDeletePressed,
     this.swipeActions,
     this.channelListController,
-  }) : super(key: key);
+  })  : limit = limit ?? pagination?.limit ?? 25,
+        super(key: key);
 
   /// If true a default swipe to action behaviour will be added to this widget
   final bool swipeToAction;
@@ -129,7 +133,14 @@ class ChannelListView extends StatefulWidget {
   /// limit: the number of channels to return (max is 30)
   /// offset: the offset (max is 1000)
   /// message_limit: how many messages should be included to each channel
-  final PaginationParams pagination;
+  @Deprecated(
+    "'pagination' is deprecated and shouldn't be used. "
+    "This property is no longer used, Please use 'limit' instead",
+  )
+  final PaginationParams? pagination;
+
+  /// The amount of channels requested per API call.
+  final int limit;
 
   /// Function called when tapping on a channel
   /// By default it calls [Navigator.push] building a [MaterialPageRoute]
@@ -218,7 +229,7 @@ class _ChannelListViewState extends State<ChannelListView> {
       presence: widget.presence,
       memberLimit: widget.memberLimit,
       messageLimit: widget.messageLimit,
-      pagination: widget.pagination,
+      limit: widget.limit,
       channelListController: _channelListController,
       listBuilder: widget.listBuilder ?? _buildListView,
       emptyBuilder: widget.emptyBuilder ?? _buildEmptyWidget,

packages/stream_chat_flutter/lib/src/message_search_list_view.dart

@@ -53,12 +53,17 @@ typedef EmptyMessageSearchBuilder = Widget Function(
 /// Modify it to change the widget appearance.
 class MessageSearchListView extends StatefulWidget {
   /// Instantiate a new MessageSearchListView
-  const MessageSearchListView({
+  MessageSearchListView({
     Key? key,
     required this.filters,
     this.messageQuery,
     this.sortOptions,
-    this.paginationParams = const PaginationParams(limit: 30),
+    @Deprecated(
+      "'paginationParams' is deprecated and shouldn't be used. "
+      "This property is no longer used, Please use 'limit' instead",
+    )
+        this.paginationParams,
+    int? limit,
     this.messageFilters,
     this.separatorBuilder,
     this.itemBuilder,
@@ -71,7 +76,8 @@ class MessageSearchListView extends StatefulWidget {
     this.loadingBuilder,
     this.childBuilder,
     this.messageSearchListController,
-  }) : super(key: key);
+  })  : limit = limit ?? paginationParams?.limit ?? 30,
+        super(key: key);
 
   /// Message String to search on
   final String? messageQuery;
@@ -93,7 +99,14 @@ class MessageSearchListView extends StatefulWidget {
   /// limit: the number of users to return (max is 30)
   /// offset: the offset (max is 1000)
   /// message_limit: how many messages should be included to each channel
-  final PaginationParams paginationParams;
+  @Deprecated(
+    "'paginationParams' is deprecated and shouldn't be used. "
+    "This property is no longer used, Please use 'limit' instead",
+  )
+  final PaginationParams? paginationParams;
+
+  /// The amount of messages requested per API call.
+  final int limit;
 
   /// The message query filters to use.
   /// You can query on any of the custom fields you've defined on the [Channel].
@@ -152,7 +165,7 @@ class _MessageSearchListViewState extends State<MessageSearchListView> {
       filters: widget.filters,
       sortOptions: widget.sortOptions,
       messageQuery: widget.messageQuery,
-      paginationParams: widget.paginationParams,
+      limit: widget.limit,
       messageFilters: widget.messageFilters,
       messageSearchListController: _messageSearchListController,
       emptyBuilder: widget.emptyBuilder ??

packages/stream_chat_flutter/lib/src/user_list_view.dart

@@ -46,12 +46,17 @@ typedef UserItemBuilder = Widget Function(BuildContext, User, bool);
 /// Modify it to change the widget appearance.
 class UserListView extends StatefulWidget {
   /// Instantiate a new UserListView
-  const UserListView({
+  UserListView({
     Key? key,
     this.filter = const Filter.empty(),
     this.sort,
     this.presence,
-    this.pagination = const PaginationParams(limit: 30),
+    @Deprecated(
+      "'pagination' is deprecated and shouldn't be used. "
+      "This property is no longer used, Please use 'limit' instead",
+    )
+        this.pagination,
+    int? limit,
     this.onUserTap,
     this.onUserLongPress,
     this.userWidget,
@@ -71,6 +76,7 @@ class UserListView extends StatefulWidget {
           crossAxisCount == 1 || groupAlphabetically == false,
           'Cannot group alphabetically when crossAxisCount > 1',
         ),
+        limit = limit ?? pagination?.limit ?? 30,
         super(key: key);
 
   /// The query filters to use.
@@ -94,7 +100,14 @@ class UserListView extends StatefulWidget {
   /// limit: the number of users to return (max is 30)
   /// offset: the offset (max is 1000)
   /// message_limit: how many messages should be included to each channel
-  final PaginationParams pagination;
+  @Deprecated(
+    "'pagination' is deprecated and shouldn't be used. "
+    "This property is no longer used, Please use 'limit' instead",
+  )
+  final PaginationParams? pagination;
+
+  /// The amount of users requested per API call.
+  final int limit;
 
   /// Function called when tapping on a channel
   /// By default it calls [Navigator.push] building a [MaterialPageRoute]
@@ -185,7 +198,7 @@ class _UserListViewState extends State<UserListView>
               ),
       listBuilder:
           widget.listBuilder ?? (context, list) => _buildListView(list),
-      pagination: widget.pagination,
+      limit: widget.limit,
       sort: widget.sort,
       filter: widget.filter,
       presence: widget.presence,

packages/stream_chat_flutter/test/src/theme/channel_list_view_theme_test.dart

@@ -62,7 +62,7 @@ void main() {
             return Scaffold(
               body: StreamChannel(
                 channel: MockChannel(),
-                child: const ChannelListView(),
+                child: ChannelListView(),
               ),
             );
           },

packages/stream_chat_flutter/test/src/theme/user_list_view_theme_test.dart

@@ -56,7 +56,7 @@ void main() {
         home: Builder(
           builder: (BuildContext context) {
             _context = context;
-            return const Scaffold(
+            return Scaffold(
               body: UsersBloc(
                 child: UserListView(),
               ),
@@ -85,7 +85,7 @@ void main() {
         home: Builder(
           builder: (BuildContext context) {
             _context = context;
-            return const Scaffold(
+            return Scaffold(
               body: UsersBloc(
                 child: UserListView(),
               ),