[go_router_builder] Add go_router StatefulShellRoute support to go_router_builder

packages/go_router_builder/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.3.0
+
+* Adds Support for StatefulShellRoute
+* Updates the documentation to go_router v9.0.3
+* Bumps go_router version in example folder to v9.0.3
+
 ## 2.2.1
 
 * Cleans up go_router_builder code.

packages/go_router_builder/README.md

@@ -8,12 +8,12 @@ To use `go_router_builder`, you need to have the following dependencies in
 ```yaml
 dependencies:
   # ...along with your other dependencies
-  go_router: ^7.0.0
+  go_router: ^9.0.3
 
 dev_dependencies:
   # ...along with your other dev-dependencies
   build_runner: ^2.0.0
-  go_router_builder: ^2.0.0
+  go_router_builder: ^2.3.0
 ```
 
 ### Source code

packages/go_router_builder/example/lib/all_types.dart

@@ -58,7 +58,7 @@ class BigIntRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('BigIntRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -84,7 +84,7 @@ class BoolRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('BoolRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -107,7 +107,7 @@ class DateTimeRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('DateTimeRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -133,7 +133,7 @@ class DoubleRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('DoubleRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -159,7 +159,7 @@ class IntRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('IntRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -185,7 +185,7 @@ class NumRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('NumRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -212,7 +212,7 @@ class EnumRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('EnumRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -239,7 +239,7 @@ class EnhancedEnumRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('EnhancedEnumRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -265,7 +265,7 @@ class StringRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('StringRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -288,7 +288,7 @@ class UriRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('UriRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -361,7 +361,7 @@ class IterableRoute extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('IterableRoute'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -430,7 +430,7 @@ class IterableRouteWithDefaultValues extends GoRouteData {
   Widget drawerTile(BuildContext context) => ListTile(
         title: const Text('IterableRouteWithDefaultValues'),
         onTap: () => go(context),
-        selected: GoRouter.of(context).location == location,
+        selected: GoRouterState.of(context).location == location,
       );
 }
 
@@ -536,7 +536,7 @@ class BasePage<T> extends StatelessWidget {
               Text(
                 'Query param with default value: $queryParamWithDefaultValue',
               ),
-              SelectableText(GoRouter.of(context).location),
+              SelectableText(GoRouterState.of(context).location),
             ],
           ),
         ),

packages/go_router_builder/example/lib/shell_route_example.dart

@@ -77,7 +77,7 @@ class MyShellRouteScreen extends StatelessWidget {
   final Widget child;
 
   int getCurrentIndex(BuildContext context) {
-    final String location = GoRouter.of(context).location;
+    final String location = GoRouterState.of(context).location;
     if (location == '/bar') {
       return 1;
     }

packages/go_router_builder/example/lib/shell_route_with_keys_example.dart

@@ -57,7 +57,7 @@ class MyShellRouteScreen extends StatelessWidget {
   final Widget child;
 
   int getCurrentIndex(BuildContext context) {
-    final String location = GoRouter.of(context).location;
+    final String location = GoRouterState.of(context).location;
     if (location.startsWith('/users')) {
       return 1;
     }

packages/go_router_builder/example/lib/stateful_shell_route_example.dart

@@ -0,0 +1,193 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// ignore_for_file: public_member_api_docs
+
+import 'package:flutter/material.dart';
+import 'package:go_router/go_router.dart';
+
+part 'stateful_shell_route_example.g.dart';
+
+final GlobalKey<NavigatorState> _sectionANavigatorKey =
+    GlobalKey<NavigatorState>(debugLabel: 'sectionANav');
+void main() => runApp(App());
+
+class App extends StatelessWidget {
+  App({super.key});
+
+  @override
+  Widget build(BuildContext context) => MaterialApp.router(
+        routerConfig: _router,
+      );
+
+  final GoRouter _router = GoRouter(
+    routes: $appRoutes,
+    initialLocation: '/detailsA',
+  );
+}
+
+class HomeScreen extends StatelessWidget {
+  const HomeScreen({super.key});
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+        appBar: AppBar(title: const Text('foo')),
+      );
+}
+
+@TypedStatefulShellRoute<MyShellRouteData>(
+  branches: <TypedStatefulShellBranch<StatefulShellBranchData>>[
+    TypedStatefulShellBranch<BranchAData>(
+      routes: <TypedRoute<RouteData>>[
+        TypedGoRoute<DetailsARouteData>(path: '/detailsA'),
+      ],
+    ),
+    TypedStatefulShellBranch<BranchBData>(
+      routes: <TypedRoute<RouteData>>[
+        TypedGoRoute<DetailsBRouteData>(path: '/detailsB'),
+      ],
+    ),
+  ],
+)
+class MyShellRouteData extends StatefulShellRouteData {
+  const MyShellRouteData();
+
+  @override
+  Widget builder(
+    BuildContext context,
+    GoRouterState state,
+    StatefulNavigationShell navigationShell,
+  ) {
+    return ScaffoldWithNavBar(navigationShell: navigationShell);
+  }
+}
+
+class BranchAData extends StatefulShellBranchData {
+  const BranchAData();
+}
+
+class BranchBData extends StatefulShellBranchData {
+  const BranchBData();
+
+  static final GlobalKey<NavigatorState> $navigatorKey = _sectionANavigatorKey;
+}
+
+class DetailsARouteData extends GoRouteData {
+  const DetailsARouteData();
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return const DetailsScreen(label: 'A');
+  }
+}
+
+class DetailsBRouteData extends GoRouteData {
+  const DetailsBRouteData();
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return const DetailsScreen(label: 'B');
+  }
+}
+
+/// Builds the "shell" for the app by building a Scaffold with a
+/// BottomNavigationBar, where [child] is placed in the body of the Scaffold.
+class ScaffoldWithNavBar extends StatelessWidget {
+  /// Constructs an [ScaffoldWithNavBar].
+  const ScaffoldWithNavBar({
+    required this.navigationShell,
+    Key? key,
+  }) : super(key: key ?? const ValueKey<String>('ScaffoldWithNavBar'));
+
+  /// The navigation shell and container for the branch Navigators.
+  final StatefulNavigationShell navigationShell;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      body: navigationShell,
+      bottomNavigationBar: BottomNavigationBar(
+        items: const <BottomNavigationBarItem>[
+          BottomNavigationBarItem(icon: Icon(Icons.home), label: 'Section A'),
+          BottomNavigationBarItem(icon: Icon(Icons.work), label: 'Section B'),
+        ],
+        currentIndex: navigationShell.currentIndex,
+        onTap: (int index) => _onTap(context, index),
+      ),
+    );
+  }
+
+  void _onTap(BuildContext context, int index) {
+    navigationShell.goBranch(
+      index,
+      initialLocation: index == navigationShell.currentIndex,
+    );
+  }
+}
+
+/// The details screen for either the A or B screen.
+class DetailsScreen extends StatefulWidget {
+  /// Constructs a [DetailsScreen].
+  const DetailsScreen({
+    required this.label,
+    this.param,
+    this.extra,
+    super.key,
+  });
+
+  /// The label to display in the center of the screen.
+  final String label;
+
+  /// Optional param
+  final String? param;
+
+  /// Optional extra object
+  final Object? extra;
+  @override
+  State<StatefulWidget> createState() => DetailsScreenState();
+}
+
+/// The state for DetailsScreen
+class DetailsScreenState extends State<DetailsScreen> {
+  int _counter = 0;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: Text('Details Screen - ${widget.label}'),
+      ),
+      body: _build(context),
+    );
+  }
+
+  Widget _build(BuildContext context) {
+    return Center(
+      child: Column(
+        mainAxisSize: MainAxisSize.min,
+        children: <Widget>[
+          Text('Details for ${widget.label} - Counter: $_counter',
+              style: Theme.of(context).textTheme.titleLarge),
+          const Padding(padding: EdgeInsets.all(4)),
+          TextButton(
+            onPressed: () {
+              setState(() {
+                _counter++;
+              });
+            },
+            child: const Text('Increment counter'),
+          ),
+          const Padding(padding: EdgeInsets.all(8)),
+          if (widget.param != null)
+            Text('Parameter: ${widget.param!}',
+                style: Theme.of(context).textTheme.titleMedium),
+          const Padding(padding: EdgeInsets.all(8)),
+          if (widget.extra != null)
+            Text('Extra: ${widget.extra!}',
+                style: Theme.of(context).textTheme.titleMedium),
+        ],
+      ),
+    );
+  }
+}