feat: add a refreshindicator to the timeline with an extra callback onRefresh

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Set an optional max length on the default post title input field
 - Add a postCreationFloatingActionButtonColor to the timeline theme to set the color of the floating action button
 - Add a post and a category to the postViewOpenPageBuilder function
+- Add a refresh functionality to the timeline with a pull to refresh callback to allow additional functionality when refreshing the timeline
 
 ## 3.0.1
 

packages/flutter_timeline/lib/src/flutter_timeline_gorouter_userstory.dart

@@ -33,6 +33,7 @@ List<GoRoute> getTimelineStoryRoutes({
         var timelineScreen = TimelineScreen(
           userId: config.getUserId?.call(context) ?? config.userId,
           onUserTap: (user) => config.onUserTap?.call(context, user),
+          onRefresh: config.onRefresh,
           service: service,
           options: config.optionsBuilder(context),
           onPostTap: (post) async =>

packages/flutter_timeline/lib/src/flutter_timeline_navigator_userstory.dart

@@ -60,6 +60,7 @@ Widget _timelineScreenRoute({
             ),
           ),
         ),
+    onRefresh: config.onRefresh,
     filterEnabled: config.filterEnabled,
     postWidgetBuilder: config.postWidgetBuilder,
   );

packages/flutter_timeline/lib/src/models/timeline_configuration.dart

@@ -57,6 +57,7 @@ class TimelineUserStoryConfiguration {
     this.postOverviewOpenPageBuilder,
     this.onPostTap,
     this.onUserTap,
+    this.onRefresh,
     this.onPostDelete,
     this.filterEnabled = false,
     this.postWidgetBuilder,
@@ -127,6 +128,9 @@ class TimelineUserStoryConfiguration {
   /// A callback function invoked when the user's profile is tapped.
   final Function(BuildContext context, String userId)? onUserTap;
 
+  /// A callback function invoked when the timeline is refreshed by pulling down
+  final Function(BuildContext context, String? category)? onRefresh;
+
   /// A callback function invoked when a post deletion is requested.
   final Widget Function(BuildContext context, TimelinePost post)? onPostDelete;
 

packages/flutter_timeline_view/lib/src/screens/timeline_screen.dart

@@ -16,6 +16,7 @@ class TimelineScreen extends StatefulWidget {
     this.onPostTap,
     this.scrollController,
     this.onUserTap,
+    this.onRefresh,
     this.posts,
     this.timelineCategory,
     this.postWidgetBuilder,
@@ -45,6 +46,9 @@ class TimelineScreen extends StatefulWidget {
   /// Called when a post is tapped
   final Function(TimelinePost)? onPostTap;
 
+  /// Called when the timeline is refreshed by pulling down
+  final Function(BuildContext context, String? category)? onRefresh;
+
   /// If this is not null, the user can tap on the user avatar or name
   final Function(String userId)? onUserTap;
 
@@ -218,13 +222,19 @@ class _TimelineScreenState extends State<TimelineScreen> {
               height: 12,
             ),
             Expanded(
+              child: RefreshIndicator(
+                onRefresh: () async {
+                  await widget.onRefresh?.call(context, category);
+                  await loadPosts();
+                },
                 child: SingleChildScrollView(
                   controller: controller,
                   child: Column(
                     mainAxisSize: MainAxisSize.min,
                     children: [
                       /// Add a optional custom header to the list of posts
-                    widget.options.listHeaderBuilder?.call(context, category) ??
+                      widget.options.listHeaderBuilder
+                              ?.call(context, category) ??
                           const SizedBox.shrink(),
                       ...posts.map(
                         (post) => Padding(
@@ -252,7 +262,8 @@ class _TimelineScreenState extends State<TimelineScreen> {
                                           options: widget.options,
                                           post: post,
                                           onPostDelete: () {
-                                          service.postService.deletePost(post);
+                                            service.postService
+                                                .deletePost(post);
                                             Navigator.of(context).pop();
                                           },
                                         ),
@@ -279,7 +290,8 @@ class _TimelineScreenState extends State<TimelineScreen> {
                                   ? widget.options.translations.noPosts!
                                   : widget
                                       .options.translations.noPostsWithFilter!,
-                            style: widget.options.theme.textStyles.noPostsStyle,
+                              style:
+                                  widget.options.theme.textStyles.noPostsStyle,
                             ),
                           ),
                         ),
@@ -287,6 +299,7 @@ class _TimelineScreenState extends State<TimelineScreen> {
                   ),
                 ),
               ),
+            ),
             SizedBox(
               height: widget.options.padding.bottom,
             ),