- For PersistentTabView.custom, List<Widget> screens has been replaced with List<CustomNavBarScreen> screens.

    - Property `routeAndNavigatorSettings` has been removed from `PersistentTabView.custom`. You now define `RouteAndNavigatorSettings` for each screen separately in `CustomNavBarScreen`. Please refer to the [Readme](https://pub.dev/packages/persistent_bottom_nav_bar#custom-navigation-bar-styling) file for more instructions.

Author: BilalShahid13

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.2.0] - 2024-07-11
+- **Breaking Changes**
+    - For `PersistentTabView.custom`, `List<Widget> screens` has been replaced with `List<CustomNavBarScreen> screens`. 
+    - Property `routeAndNavigatorSettings` has been removed from `PersistentTabView.custom`. You now define `RouteAndNavigatorSettings` for each screen separately in `CustomNavBarScreen`. Please refer to the [Readme](https://pub.dev/packages/persistent_bottom_nav_bar#custom-navigation-bar-styling) file for more instructions.
+
 ## [6.1.1] - 2024-07-11
 - Updated README.md
 

README.md

@@ -206,6 +206,17 @@ If you are pushing a new `modal` screen, use the following function:
 
 ```
 
+Pop all screens until the first screen on the selected tab
+
+```dart
+
+    PersistentNavBarNavigator.popUntilFirstScreenOnSelectedTabScreen(
+        context,
+        routeName: "/", //If you haven't defined a routeName for the first screen of the selected tab then don't use the optional property `routeName`. Otherwise it may not work as intended
+    );
+
+```
+
 ### Some Useful Tips
 
 - Pop to any screen in the navigation graph for a given tab:
@@ -342,7 +353,48 @@ If you want to have your own style for the navigation bar, follow these steps:
             return PersistentTabView.custom(
                 context,
                 controller: _controller,
-                screens: _buildScreens(),
+                screens: [
+                    CustomNavBarScreen(
+                        //You can declare route settings for custom navigation bar screen here
+                        routeAndNavigatorSettings: RouteAndNavigatorSettings(
+                        initialRoute: "/",
+                        routes: {
+                                "/first": (final context) => const MainScreen2(),
+                                "/second": (final context) => const MainScreen3(),
+                            },
+                        ),
+                        screen: MainScreen(
+                            menuScreenContext: widget.menuScreenContext,
+                            scrollController: _scrollControllers.first,
+
+                        ),                    ),
+                    CustomNavBarScreen(
+                        screen: MainScreen(
+                            menuScreenContext: widget.menuScreenContext,
+                            scrollController: _scrollControllers[1],
+
+                        ),
+                    ),
+                    CustomNavBarScreen(
+                        screen: MainScreen(
+                            menuScreenContext: widget.menuScreenContext,
+                            scrollController: _scrollControllers[2],
+                        ),
+                    ),
+                    CustomNavBarScreen(
+                        screen: MainScreen(
+                            menuScreenContext: widget.menuScreenContext,
+                            scrollController: _scrollControllers[3],
+
+                        ),
+                    ),
+                    CustomNavBarScreen(
+                        screen: MainScreen(
+                            menuScreenContext: widget.menuScreenContext,
+                            scrollController: _scrollControllers.last,
+                        ),
+                    ),
+                ],
                 itemCount: 5,
                 isVisible: true,
                 hideOnScrollSettings: HideOnScrollSettings(
@@ -351,8 +403,7 @@ If you want to have your own style for the navigation bar, follow these steps:
                 ),
                 backgroundColor: Colors.grey.shade900,
                 customWidget: CustomNavBarWidget(
-                        _navBarsItems(),
-                        onItemSelected: (final index) {
+                        _navBarsItems(),                        onItemSelected: (final index) {
                              //Scroll to top for custom widget. For non custom widget, declare property `scrollController` in `PersistentBottomNavBarItem`.
                             if (index == _controller.index) {
                                 _scrollControllers[index].animateTo(0, duration: const Duration(milliseconds: 200), curve: Curves.ease);
@@ -364,8 +415,7 @@ If you want to have your own style for the navigation bar, follow these steps:
                         selectedIndex: _controller.index,
                     ),
                 ),
-        }
-    }
+        }    }
 
     ```
 

example/lib/custom-widget-tabs.widget.dart

@@ -43,61 +43,78 @@ class _CustomWidgetExampleState extends State<CustomWidgetExample> {
     super.dispose();
   }
 
-  List<Widget> _buildScreens() => [
-        MainScreen(
-          menuScreenContext: widget.menuScreenContext,
-          scrollController: _scrollControllers.first,
-          hideStatus: _hideNavBar,
-          showNavBarStyles: false,
-          onScreenHideButtonPressed: () {
-            setState(() {
-              _hideNavBar = !_hideNavBar;
-            });
-          },
+  List<CustomNavBarScreen> _buildScreens() => [
+        CustomNavBarScreen(
+          routeAndNavigatorSettings: RouteAndNavigatorSettings(
+            initialRoute: "/",
+            routes: {
+              "/first": (final context) => const MainScreen2(),
+              "/second": (final context) => const MainScreen3(),
+            },
+          ),
+          screen: MainScreen(
+            menuScreenContext: widget.menuScreenContext,
+            scrollController: _scrollControllers.first,
+            hideStatus: _hideNavBar,
+            showNavBarStyles: false,
+            onScreenHideButtonPressed: () {
+              setState(() {
+                _hideNavBar = !_hideNavBar;
+              });
+            },
+          ),
         ),
-        MainScreen(
-          menuScreenContext: widget.menuScreenContext,
-          scrollController: _scrollControllers[1],
-          hideStatus: _hideNavBar,
-          showNavBarStyles: false,
-          onScreenHideButtonPressed: () {
-            setState(() {
-              _hideNavBar = !_hideNavBar;
-            });
-          },
+        CustomNavBarScreen(
+          screen: MainScreen(
+            menuScreenContext: widget.menuScreenContext,
+            scrollController: _scrollControllers[1],
+            hideStatus: _hideNavBar,
+            showNavBarStyles: false,
+            onScreenHideButtonPressed: () {
+              setState(() {
+                _hideNavBar = !_hideNavBar;
+              });
+            },
+          ),
         ),
-        MainScreen(
-          menuScreenContext: widget.menuScreenContext,
-          scrollController: _scrollControllers[2],
-          hideStatus: _hideNavBar,
-          showNavBarStyles: false,
-          onScreenHideButtonPressed: () {
-            setState(() {
-              _hideNavBar = !_hideNavBar;
-            });
-          },
+        CustomNavBarScreen(
+          screen: MainScreen(
+            menuScreenContext: widget.menuScreenContext,
+            scrollController: _scrollControllers[2],
+            hideStatus: _hideNavBar,
+            showNavBarStyles: false,
+            onScreenHideButtonPressed: () {
+              setState(() {
+                _hideNavBar = !_hideNavBar;
+              });
+            },
+          ),
         ),
-        MainScreen(
-          menuScreenContext: widget.menuScreenContext,
-          scrollController: _scrollControllers[3],
-          hideStatus: _hideNavBar,
-          showNavBarStyles: false,
-          onScreenHideButtonPressed: () {
-            setState(() {
-              _hideNavBar = !_hideNavBar;
-            });
-          },
+        CustomNavBarScreen(
+          screen: MainScreen(
+            menuScreenContext: widget.menuScreenContext,
+            scrollController: _scrollControllers[3],
+            hideStatus: _hideNavBar,
+            showNavBarStyles: false,
+            onScreenHideButtonPressed: () {
+              setState(() {
+                _hideNavBar = !_hideNavBar;
+              });
+            },
+          ),
         ),
-        MainScreen(
-          menuScreenContext: widget.menuScreenContext,
-          scrollController: _scrollControllers.last,
-          hideStatus: _hideNavBar,
-          showNavBarStyles: false,
-          onScreenHideButtonPressed: () {
-            setState(() {
-              _hideNavBar = !_hideNavBar;
-            });
-          },
+        CustomNavBarScreen(
+          screen: MainScreen(
+            menuScreenContext: widget.menuScreenContext,
+            scrollController: _scrollControllers.last,
+            hideStatus: _hideNavBar,
+            showNavBarStyles: false,
+            onScreenHideButtonPressed: () {
+              setState(() {
+                _hideNavBar = !_hideNavBar;
+              });
+            },
+          ),
         ),
       ];
 

lib/models/persistent_bottom_nav_item.widget.dart

@@ -18,7 +18,7 @@ class PersistentBottomNavBarItem {
       this.onSelectedTabPressWhenNoScreensPushed,
       this.iconAnimationController,
       this.scrollController,
-      this.routeAndNavigatorSettings = const RouteAndNavigatorSettings(),
+      this.routeAndNavigatorSettings,
       this.scrollToTopOnNavBarItemPress = true,
       this.onPressed})
       : assert(opacity >= 0 && opacity <= 1.0,
@@ -75,7 +75,7 @@ class PersistentBottomNavBarItem {
 
   final double iconSize;
 
-  final RouteAndNavigatorSettings routeAndNavigatorSettings;
+  final RouteAndNavigatorSettings? routeAndNavigatorSettings;
 
   ///For animated icons to work, this property must not be `null` or left empty.
   final AnimationController? iconAnimationController;

lib/models/route_settings.model.dart

@@ -44,46 +44,10 @@ class RouteAndNavigatorSettings {
       );
 }
 
-class CustomWidgetRouteAndNavigatorSettings {
-  const CustomWidgetRouteAndNavigatorSettings({
-    this.defaultTitle,
-    this.routes,
-    this.onGenerateRoute,
-    this.onUnknownRoute,
-    this.initialRoute,
-    this.navigatorObservers = const <NavigatorObserver>[],
-    this.navigatorKeys,
-  });
-  final String? defaultTitle;
+class CustomNavBarScreen {
+  const CustomNavBarScreen(
+      {required this.screen, this.routeAndNavigatorSettings});
 
-  final Map<String, WidgetBuilder>? routes;
-
-  final RouteFactory? onGenerateRoute;
-
-  final RouteFactory? onUnknownRoute;
-
-  final String? initialRoute;
-
-  final List<NavigatorObserver> navigatorObservers;
-
-  final List<GlobalKey<NavigatorState>>? navigatorKeys;
-
-  CustomWidgetRouteAndNavigatorSettings copyWith({
-    final String? defaultTitle,
-    final Map<String, WidgetBuilder>? routes,
-    final RouteFactory? onGenerateRoute,
-    final RouteFactory? onUnknownRoute,
-    final String? initialRoute,
-    final List<NavigatorObserver>? navigatorObservers,
-    final List<GlobalKey<NavigatorState>>? navigatorKeys,
-  }) =>
-      CustomWidgetRouteAndNavigatorSettings(
-        defaultTitle: defaultTitle ?? this.defaultTitle,
-        routes: routes ?? this.routes,
-        onGenerateRoute: onGenerateRoute ?? this.onGenerateRoute,
-        onUnknownRoute: onUnknownRoute ?? this.onUnknownRoute,
-        initialRoute: initialRoute ?? this.initialRoute,
-        navigatorObservers: navigatorObservers ?? this.navigatorObservers,
-        navigatorKeys: navigatorKeys ?? this.navigatorKeys,
-      );
+  final Widget screen;
+  final RouteAndNavigatorSettings? routeAndNavigatorSettings;
 }