feat: Adds includeMetadataChanges and options

vedartm · Nov 17, 2021 · 69c1f3d · 69c1f3d
1 parent 3cfab82
commit 69c1f3d
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 12 deletions.
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -42,13 +42,13 @@ class HomePage extends StatelessWidget {
         // item builder type is compulsory.
         itemBuilderType:
             PaginateBuilderType.listView, //Change types accordingly
-        itemBuilder: (index, context, documentSnapshot) {
-          final data = documentSnapshot.data() as Map?;
+        itemBuilder: (context, documentSnapshots, index) {
+          final data = documentSnapshots[index].data() as Map?;
           return ListTile(
             leading: const CircleAvatar(child: Icon(Icons.person)),
             title:
                 data == null ? const Text('Error in data') : Text(data['name']),
-            subtitle: Text(documentSnapshot.id),
+            subtitle: Text(documentSnapshots[index].id),
           );
         },
         // orderBy is compulsory to enable pagination

diff --git a/lib/bloc/pagination_cubit.dart b/lib/bloc/pagination_cubit.dart
@@ -13,13 +13,17 @@ class PaginationCubit extends Cubit<PaginationState> {
     this._limit,
     this._startAfterDocument, {
     this.isLive = false,
+    this.includeMetadataChanges = false,
+    this.options,
   }) : super(PaginationInitial());
 
   DocumentSnapshot? _lastDocument;
   final int _limit;
   final Query _query;
   final DocumentSnapshot? _startAfterDocument;
   final bool isLive;
+  final bool includeMetadataChanges;
+  final GetOptions? options;
 
   final _streams = <StreamSubscription<QuerySnapshot>>[];
 
@@ -46,13 +50,15 @@ class PaginationCubit extends Cubit<PaginationState> {
     _lastDocument = null;
     final localQuery = _getQuery();
     if (isLive) {
-      final listener = localQuery.snapshots().listen((querySnapshot) {
+      final listener = localQuery
+          .snapshots(includeMetadataChanges: includeMetadataChanges)
+          .listen((querySnapshot) {
         _emitPaginatedState(querySnapshot.docs);
       });
 
       _streams.add(listener);
     } else {
-      final querySnapshot = await localQuery.get();
+      final querySnapshot = await localQuery.get(options);
       _emitPaginatedState(querySnapshot.docs);
     }
   }
@@ -69,7 +75,7 @@ class PaginationCubit extends Cubit<PaginationState> {
       } else if (state is PaginationLoaded) {
         final loadedState = state as PaginationLoaded;
         if (loadedState.hasReachedEnd) return;
-        final querySnapshot = await localQuery.get();
+        final querySnapshot = await localQuery.get(options);
         _emitPaginatedState(
           querySnapshot.docs,
           previousList:
@@ -90,7 +96,9 @@ class PaginationCubit extends Cubit<PaginationState> {
     } else if (state is PaginationLoaded) {
       final loadedState = state as PaginationLoaded;
       if (loadedState.hasReachedEnd) return;
-      final listener = localQuery.snapshots().listen((querySnapshot) {
+      final listener = localQuery
+          .snapshots(includeMetadataChanges: includeMetadataChanges)
+          .listen((querySnapshot) {
         _emitPaginatedState(
           querySnapshot.docs,
           previousList:

diff --git a/lib/paginate_firestore.dart b/lib/paginate_firestore.dart
@@ -45,6 +45,8 @@ class PaginateFirestore extends StatefulWidget {
     this.header,
     this.footer,
     this.isLive = false,
+    this.includeMetadataChanges = false,
+    this.options,
   }) : super(key: key);
 
   final Widget bottomLoader;
@@ -69,12 +71,18 @@ class PaginateFirestore extends StatefulWidget {
   final Widget? header;
   final Widget? footer;
 
+  /// Use this only if `isLive = false`
+  final GetOptions? options;
+
+  /// Use this only if `isLive = true`
+  final bool includeMetadataChanges;
+
   @override
   _PaginateFirestoreState createState() => _PaginateFirestoreState();
 
   final Widget Function(Exception)? onError;
 
-  final Widget Function(int, BuildContext, DocumentSnapshot) itemBuilder;
+  final Widget Function(BuildContext, List<DocumentSnapshot>, int) itemBuilder;
 
   final void Function(PaginationLoaded)? onReachedEnd;
 
@@ -187,7 +195,10 @@ class _PaginateFirestoreState extends State<PaginateFirestore> {
                   return widget.bottomLoader;
                 }
                 return widget.itemBuilder(
-                    index, context, loadedState.documentSnapshots[index]);
+                  context,
+                  loadedState.documentSnapshots,
+                  index,
+                );
               },
               childCount: loadedState.hasReachedEnd
                   ? loadedState.documentSnapshots.length
@@ -233,8 +244,11 @@ class _PaginateFirestoreState extends State<PaginateFirestore> {
                     _cubit!.fetchPaginatedList();
                     return widget.bottomLoader;
                   }
-                  return widget.itemBuilder(itemIndex, context,
-                      loadedState.documentSnapshots[itemIndex]);
+                  return widget.itemBuilder(
+                    context,
+                    loadedState.documentSnapshots,
+                    itemIndex,
+                  );
                 }
                 return widget.separator;
               },
@@ -290,7 +304,10 @@ class _PaginateFirestoreState extends State<PaginateFirestore> {
               return widget.bottomLoader;
             }
             return widget.itemBuilder(
-                index, context, loadedState.documentSnapshots[index]);
+              context,
+              loadedState.documentSnapshots,
+              index,
+            );
           },
           childCount: loadedState.hasReachedEnd
               ? loadedState.documentSnapshots.length