document status transitions

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.1.0
+
+* Adds [animated status transitions](https://pub.dev/packages/infinite_scroll_pagination/example#animating-status-transitions).
+
 ## 3.0.1+1
 
 * Adds [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) status to the README.

example/example.md

@@ -85,6 +85,23 @@ Widget build(BuildContext context) =>
     );
 ```
 
+## Animating Status Transitions
+```dart
+@override
+Widget build(BuildContext context) =>
+    PagedListView<int, CharacterSummary>(
+      pagingController: _pagingController,
+      builderDelegate: PagedChildBuilderDelegate<CharacterSummary>(
+        animateTransitions: true,
+        // [transitionDuration] has a default value of 250 milliseconds.
+        transitionDuration: const Duration(milliseconds: 500),
+        itemBuilder: (context, item, index) => CharacterListItem(
+          character: item,
+        ),
+      ),
+    );
+```
+
 ## Separators
 ```dart
 @override

example/lib/presentation/pull_to_refresh/character_list_view.dart

@@ -48,6 +48,7 @@ class _CharacterListViewState extends State<CharacterListView> {
         child: PagedListView<int, CharacterSummary>.separated(
           pagingController: _pagingController,
           builderDelegate: PagedChildBuilderDelegate<CharacterSummary>(
+            animateTransitions: true,
             itemBuilder: (context, item, index) => CharacterListItem(
               character: item,
             ),

example/lib/presentation/search_snackbar/character_sliver_list.dart

@@ -73,6 +73,7 @@ class _CharacterSliverListState extends State<CharacterSliverList> {
           PagedSliverList<int, CharacterSummary>(
             pagingController: _pagingController,
             builderDelegate: PagedChildBuilderDelegate<CharacterSummary>(
+              animateTransitions: true,
               itemBuilder: (context, item, index) => CharacterListItem(
                 character: item,
               ),

example/pubspec.lock

@@ -136,7 +136,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "3.0.1+1"
+    version: "3.1.0"
   matcher:
     dependency: transitive
     description:

lib/src/core/paged_child_builder_delegate.dart

@@ -44,9 +44,9 @@ class PagedChildBuilderDelegate<ItemType> {
   /// The builder for an indicator that all items have been fetched.
   final WidgetBuilder? noMoreItemsIndicatorBuilder;
 
-  /// Whether to animate transitions between various Widget states
+  /// Whether status transitions should be animated.
   final bool animateTransitions;
 
-  /// If animateTransitions is true, use this duration for the transition spped.
+  /// The duration of animated transitions when [animateTransitions] is `true`.
   final Duration transitionDuration;
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: infinite_scroll_pagination
 description: Lazily load and display pages of items as the user scrolls down your screen.
-version: 3.0.1+1
+version: 3.1.0
 homepage: https://github.com/EdsonBueno/infinite_scroll_pagination
 
 environment: