Renamed StatefulShellRoute to StackedShellRoute

packages/go_router/CHANGELOG.md

@@ -1,11 +1,11 @@
 ## 6.6.0
 
-- Introduces `StatefulShellRoute` to support using separate
+- Introduces `StackedShellRoute` to support using separate
   navigators for child routes as well as preserving state in each navigation tree
   (flutter/flutter#99124).
 - Updates documentation for `pageBuilder` and `builder` fields of `ShellRoute`, to more correctly
   describe the meaning of the child argument in the builder functions.
-- Adds support for restorationId to ShellRoute (and StatefulShellRoute).
+- Adds support for restorationId to ShellRoute (and StackedShellRoute).
 - Adds support for restoring imperatively pushed routes.
 
 ## 6.5.2

packages/go_router/example/README.md

@@ -30,10 +30,10 @@ An example to demonstrate how to use redirect to handle a synchronous sign-in fl
 
 An example to demonstrate how to use handle a sign-in flow with a stream authentication service.
 
-## [Stateful Nested Navigation](https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/stateful_shell_route.dart)
-`flutter run lib/stateful_shell_route.dart`
+## [Stateful Nested Navigation](https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/stacked_shell_route.dart)
+`flutter run lib/stacked_shell_route.dart`
 
-An example to demonstrate how to use a `StatefulShellRoute` to create stateful nested navigation, with a
+An example to demonstrate how to use a `StackedShellRoute` to create stateful nested navigation, with a
 `BottomNavigationBar`.
 
 ## [Books app](https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/books)

packages/go_router/example/lib/others/stateful_shell_state_restoration.dart → packages/go_router/example/lib/others/stacked_shell_state_restoration.dart

@@ -11,24 +11,24 @@ final GlobalKey<NavigatorState> _rootNavigatorKey =
 final GlobalKey<NavigatorState> _tabANavigatorKey =
     GlobalKey<NavigatorState>(debugLabel: 'tabANav');
 
-void main() => runApp(RestorableStatefulShellRouteExampleApp());
+void main() => runApp(RestorableStackedShellRouteExampleApp());
 
-/// An example demonstrating how to use StatefulShellRoute with state
+/// An example demonstrating how to use StackedShellRoute with state
 /// restoration.
-class RestorableStatefulShellRouteExampleApp extends StatelessWidget {
+class RestorableStackedShellRouteExampleApp extends StatelessWidget {
   /// Creates a NestedTabNavigationExampleApp
-  RestorableStatefulShellRouteExampleApp({super.key});
+  RestorableStackedShellRouteExampleApp({super.key});
 
   final GoRouter _router = GoRouter(
     navigatorKey: _rootNavigatorKey,
     initialLocation: '/a',
     restorationScopeId: 'router',
     routes: <RouteBase>[
-      StatefulShellRoute(
+      StackedShellRoute(
         restorationScopeId: 'shell1',
-        branches: <StatefulShellBranch>[
+        branches: <StackedShellBranch>[
           /// The route branch for the first tab of the bottom navigation bar.
-          StatefulShellBranch(
+          StackedShellBranch(
             navigatorKey: _tabANavigatorKey,
             restorationScopeId: 'branchA',
             routes: <RouteBase>[
@@ -59,16 +59,16 @@ class RestorableStatefulShellRouteExampleApp extends StatelessWidget {
           ),
 
           /// The route branch for the third tab of the bottom navigation bar.
-          StatefulShellBranch(
+          StackedShellBranch(
             restorationScopeId: 'branchB',
             routes: <RouteBase>[
-              StatefulShellRoute(
+              StackedShellRoute(
                 restorationScopeId: 'shell2',
 
                 /// This bottom tab uses a nested shell, wrapping sub routes in a
                 /// top TabBar.
-                branches: <StatefulShellBranch>[
-                  StatefulShellBranch(
+                branches: <StackedShellBranch>[
+                  StackedShellBranch(
                       restorationScopeId: 'branchB1',
                       routes: <GoRoute>[
                         GoRoute(
@@ -96,7 +96,7 @@ class RestorableStatefulShellRouteExampleApp extends StatelessWidget {
                           ],
                         ),
                       ]),
-                  StatefulShellBranch(
+                  StackedShellBranch(
                       restorationScopeId: 'branchB2',
                       routes: <GoRoute>[
                         GoRoute(
@@ -126,13 +126,13 @@ class RestorableStatefulShellRouteExampleApp extends StatelessWidget {
                       ]),
                 ],
                 pageBuilder: (BuildContext context,
-                    StatefulShellRouteState state, Widget child) {
+                    StackedShellRouteState state, Widget child) {
                   return MaterialPage<void>(
                       restorationId: 'shellWidget2',
-                      child: StatefulNavigationShell(
+                      child: StackedNavigationShell(
                         shellRouteState: state,
                         containerBuilder: (BuildContext context,
-                                StatefulShellRouteState state,
+                                StackedShellRouteState state,
                                 List<Widget> children) =>
                             TabbedRootScreen(
                                 shellState: state, children: children),
@@ -142,8 +142,8 @@ class RestorableStatefulShellRouteExampleApp extends StatelessWidget {
             ],
           ),
         ],
-        pageBuilder: (BuildContext context, StatefulShellRouteState state,
-            Widget child) {
+        pageBuilder:
+            (BuildContext context, StackedShellRouteState state, Widget child) {
           return MaterialPage<void>(
               restorationId: 'shellWidget1',
               child: ScaffoldWithNavBar(shellState: state, body: child));
@@ -175,8 +175,8 @@ class ScaffoldWithNavBar extends StatelessWidget {
     Key? key,
   }) : super(key: key ?? const ValueKey<String>('ScaffoldWithNavBar'));
 
-  /// The current state of the parent StatefulShellRoute.
-  final StatefulShellRouteState shellState;
+  /// The current state of the parent StackedShellRoute.
+  final StackedShellRouteState shellState;
 
   /// Body, i.e. the container for the branch Navigators.
   final Widget body;
@@ -346,8 +346,8 @@ class TabbedRootScreen extends StatefulWidget {
   const TabbedRootScreen(
       {required this.shellState, required this.children, super.key});
 
-  /// The current state of the parent StatefulShellRoute.
-  final StatefulShellRouteState shellState;
+  /// The current state of the parent StackedShellRoute.
+  final StackedShellRouteState shellState;
 
   /// The children (Navigators) to display in the [TabBarView].
   final List<Widget> children;

packages/go_router/example/lib/stateful_shell_route.dart → packages/go_router/example/lib/stacked_shell_route.dart

@@ -16,7 +16,7 @@ final GlobalKey<NavigatorState> _tabANavigatorKey =
 // navigation state is maintained separately for each tab. This setup also
 // enables deep linking into nested pages.
 //
-// This example demonstrates how to display routes within a StatefulShellRoute,
+// This example demonstrates how to display routes within a StackedShellRoute,
 // that are places on separate navigators. The example also demonstrates how
 // state is maintained when switching between different tabs (and thus branches
 // and Navigators).
@@ -40,10 +40,10 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
         builder: (BuildContext context, GoRouterState state) =>
             const ModalScreen(),
       ),
-      StatefulShellRoute(
-        branches: <StatefulShellBranch>[
+      StackedShellRoute(
+        branches: <StackedShellBranch>[
           /// The route branch for the first tab of the bottom navigation bar.
-          StatefulShellBranch(
+          StackedShellBranch(
             navigatorKey: _tabANavigatorKey,
             routes: <RouteBase>[
               GoRoute(
@@ -67,7 +67,7 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
           ),
 
           /// The route branch for the second tab of the bottom navigation bar.
-          StatefulShellBranch(
+          StackedShellBranch(
             /// It's not necessary to provide a navigatorKey if it isn't also
             /// needed elsewhere. If not provided, a default key will be used.
             // navigatorKey: _tabBNavigatorKey,
@@ -98,18 +98,18 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
           ),
 
           /// The route branch for the third tab of the bottom navigation bar.
-          StatefulShellBranch(
-            /// StatefulShellBranch will automatically use the first descendant
+          StackedShellBranch(
+            /// StackedShellBranch will automatically use the first descendant
             /// GoRoute as the initial location of the branch. If another route
             /// is desired, specify the location of it using the defaultLocation
             /// parameter.
             // defaultLocation: '/c2',
             routes: <RouteBase>[
-              StatefulShellRoute(
+              StackedShellRoute(
                 /// This bottom tab uses a nested shell, wrapping sub routes in a
                 /// top TabBar.
-                branches: <StatefulShellBranch>[
-                  StatefulShellBranch(routes: <GoRoute>[
+                branches: <StackedShellBranch>[
+                  StackedShellBranch(routes: <GoRoute>[
                     GoRoute(
                       path: '/c1',
                       builder: (BuildContext context, GoRouterState state) =>
@@ -129,7 +129,7 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
                       ],
                     ),
                   ]),
-                  StatefulShellBranch(routes: <GoRoute>[
+                  StackedShellBranch(routes: <GoRoute>[
                     GoRoute(
                       path: '/c2',
                       builder: (BuildContext context, GoRouterState state) =>
@@ -150,21 +150,21 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
                     ),
                   ]),
                 ],
-                builder: (BuildContext context, StatefulShellRouteState state,
+                builder: (BuildContext context, StackedShellRouteState state,
                     Widget child) {
-                  /// This nested StatefulShellRoute demonstrates the use of a
+                  /// This nested StackedShellRoute demonstrates the use of a
                   /// custom container (TabBarView) for the branch Navigators.
                   /// Here, the default branch Navigator container (`child`) is
-                  /// ignored, and the class StatefulNavigationShell is
+                  /// ignored, and the class StackedNavigationShell is
                   /// instead used to provide access to the widgets representing
                   /// the branch Navigators (`List<Widget> children`).
                   ///
                   /// See TabbedRootScreen for more details on how the children
                   /// are used in the TabBarView.
-                  return StatefulNavigationShell(
+                  return StackedNavigationShell(
                     shellRouteState: state,
                     containerBuilder: (BuildContext context,
-                            StatefulShellRouteState state,
+                            StackedShellRouteState state,
                             List<Widget> children) =>
                         TabbedRootScreen(shellState: state, children: children),
                   );
@@ -173,18 +173,18 @@ class NestedTabNavigationExampleApp extends StatelessWidget {
             ],
           ),
         ],
-        builder: (BuildContext context, StatefulShellRouteState state,
-            Widget child) {
+        builder:
+            (BuildContext context, StackedShellRouteState state, Widget child) {
           /// This builder implementation uses the default container for the
           /// branch Navigators (provided in through the `child` argument). This
-          /// is the simplest way to use StatefulShellRoute, where the shell is
+          /// is the simplest way to use StackedShellRoute, where the shell is
           /// built around the Navigator container (see ScaffoldWithNavBar).
           return ScaffoldWithNavBar(shellState: state, body: child);
         },
 
-        /// If it's necessary to customize the Page for StatefulShellRoute,
+        /// If it's necessary to customize the Page for StackedShellRoute,
         /// provide a pageBuilder function instead of the builder, for example:
-        // pageBuilder: (BuildContext context, StatefulShellRouteState state,
+        // pageBuilder: (BuildContext context, StackedShellRouteState state,
         //     Widget child) {
         //   return NoTransitionPage<dynamic>(
         //       child: ScaffoldWithNavBar(shellState: state, body: child));
@@ -215,8 +215,8 @@ class ScaffoldWithNavBar extends StatelessWidget {
     Key? key,
   }) : super(key: key ?? const ValueKey<String>('ScaffoldWithNavBar'));
 
-  /// The current state of the parent StatefulShellRoute.
-  final StatefulShellRouteState shellState;
+  /// The current state of the parent StackedShellRoute.
+  final StackedShellRouteState shellState;
 
   /// Body, i.e. the container for the branch Navigators.
   final Widget body;
@@ -461,8 +461,8 @@ class TabbedRootScreen extends StatefulWidget {
   const TabbedRootScreen(
       {required this.shellState, required this.children, super.key});
 
-  /// The current state of the parent StatefulShellRoute.
-  final StatefulShellRouteState shellState;
+  /// The current state of the parent StackedShellRoute.
+  final StackedShellRouteState shellState;
 
   /// The children (Navigators) to display in the [TabBarView].
   final List<Widget> children;

packages/go_router/lib/go_router.dart

@@ -13,10 +13,10 @@ export 'src/configuration.dart'
         RouteBase,
         ShellRoute,
         ShellNavigatorContainerBuilder,
-        StatefulNavigationShell,
-        StatefulShellBranch,
-        StatefulShellRoute,
-        StatefulShellRouteState;
+        StackedNavigationShell,
+        StackedShellBranch,
+        StackedShellRoute,
+        StackedShellRouteState;
 export 'src/misc/extensions.dart';
 export 'src/misc/inherited_router.dart';
 export 'src/pages/custom_transition_page.dart';
@@ -36,5 +36,5 @@ export 'src/typedefs.dart'
         GoRouterWidgetBuilder,
         ShellRouteBuilder,
         ShellRoutePageBuilder,
-        StatefulShellRouteBuilder,
-        StatefulShellRoutePageBuilder;
+        StackedShellRouteBuilder,
+        StackedShellRoutePageBuilder;

packages/go_router/lib/src/builder.dart

@@ -153,10 +153,9 @@ class RouteBuilder {
     } finally {
       /// Clean up previous cache to prevent memory leak, making sure any nested
       /// stateful shell routes for the current match list are kept.
-      final Iterable<StatefulShellRoute> matchListShellRoutes = matchList
-          .matches
+      final Iterable<StackedShellRoute> matchListShellRoutes = matchList.matches
           .map((RouteMatch e) => e.route)
-          .whereType<StatefulShellRoute>();
+          .whereType<StackedShellRoute>();
 
       final Set<Key> activeKeys = keyToPage.keys.toSet()
         ..addAll(_nestedStatefulNavigatorKeys(matchListShellRoutes));
@@ -166,11 +165,11 @@ class RouteBuilder {
   }
 
   Set<GlobalKey<NavigatorState>> _nestedStatefulNavigatorKeys(
-      Iterable<StatefulShellRoute> routes) {
+      Iterable<StackedShellRoute> routes) {
     return RouteConfiguration.routesRecursively(routes)
-        .whereType<StatefulShellRoute>()
-        .expand((StatefulShellRoute e) =>
-            e.branches.map((StatefulShellBranch b) => b.navigatorKey))
+        .whereType<StackedShellRoute>()
+        .expand((StackedShellRoute e) =>
+            e.branches.map((StackedShellBranch b) => b.navigatorKey))
         .toSet();
   }