[go_router_builder] Add support for relative routes

packages/go_router/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 14.6.5
+
+- Adds `TypedRelativeGoRoute`
+
 ## 14.6.4
 
 - Rephrases readme.

packages/go_router/lib/src/route_data.dart

@@ -390,6 +390,28 @@ class TypedGoRoute<T extends GoRouteData> extends TypedRoute<T> {
   final List<TypedRoute<RouteData>> routes;
 }
 
+/// A superclass for each typed go route descendant
+@Target(<TargetKind>{TargetKind.library, TargetKind.classType})
+class TypedRelativeGoRoute<T extends GoRouteData> extends TypedRoute<T> {
+  /// Default const constructor
+  const TypedRelativeGoRoute({
+    required this.path,
+    this.routes = const <TypedRoute<RouteData>>[],
+  });
+
+  /// The relative path that corresponds to this route.
+  ///
+  /// See [GoRoute.path].
+  ///
+  ///
+  final String path;
+
+  /// Child route definitions.
+  ///
+  /// See [RouteBase.routes].
+  final List<TypedRoute<RouteData>> routes;
+}
+
 /// A superclass for each typed shell route descendant
 @Target(<TargetKind>{TargetKind.library, TargetKind.classType})
 class TypedShellRoute<T extends ShellRouteData> extends TypedRoute<T> {

packages/go_router/pubspec.yaml

@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 14.6.4
+version: 14.6.5
 repository: https://github.com/flutter/packages/tree/main/packages/go_router
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22
 

packages/go_router_builder/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.7.4
+
+- Adds `TypedRelativeGoRoute` annotation which supports relative routes.
 
 ## 2.7.3
 

packages/go_router_builder/example/lib/go_relative.dart

@@ -0,0 +1,156 @@
+// 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, unreachable_from_main
+
+import 'package:flutter/material.dart';
+import 'package:go_router/go_router.dart';
+
+part 'go_relative.g.dart';
+
+void main() => runApp(const MyApp());
+
+/// The main app.
+class MyApp extends StatelessWidget {
+  /// Constructs a [MyApp]
+  const MyApp({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp.router(
+      routerConfig: _router,
+    );
+  }
+}
+
+/// The route configuration.
+final GoRouter _router = GoRouter(
+  routes: $appRoutes,
+);
+const TypedRelativeGoRoute<DetailsRoute> detailRoute =
+    TypedRelativeGoRoute<DetailsRoute>(
+  path: 'details/:detailId',
+  routes: <TypedRoute<RouteData>>[
+    TypedRelativeGoRoute<SettingsRoute>(path: 'settings/:settingId'),
+  ],
+);
+
+@TypedGoRoute<HomeRoute>(
+  path: '/',
+  routes: <TypedRoute<RouteData>>[detailRoute],
+)
+class HomeRoute extends GoRouteData {
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return const HomeScreen();
+  }
+}
+
+class DetailsRoute extends GoRouteData {
+  const DetailsRoute({required this.detailId});
+  final String detailId;
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return DetailsScreen(id: detailId);
+  }
+}
+
+class SettingsRoute extends GoRouteData {
+  const SettingsRoute({
+    required this.settingId,
+  });
+  final String settingId;
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return SettingsScreen(id: settingId);
+  }
+}
+
+/// The home screen
+class HomeScreen extends StatefulWidget {
+  /// Constructs a [HomeScreen]
+  const HomeScreen({super.key});
+
+  @override
+  State<HomeScreen> createState() => _HomeScreenState();
+}
+
+class _HomeScreenState extends State<HomeScreen> {
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('Home Screen')),
+      body: Center(
+        child: ElevatedButton(
+          onPressed: () {
+            const DetailsRoute(detailId: 'DetailsId').goRelative(context);
+          },
+          child: const Text('Go to the Details screen'),
+        ),
+      ),
+    );
+  }
+}
+
+/// The details screen
+class DetailsScreen extends StatelessWidget {
+  /// Constructs a [DetailsScreen]
+  const DetailsScreen({
+    super.key,
+    required this.id,
+  });
+
+  final String id;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: Text('Details Screen $id')),
+      body: Center(
+        child: Column(
+          children: <Widget>[
+            ElevatedButton(
+              onPressed: () => HomeRoute().go(context),
+              child: const Text('Go back'),
+            ),
+            ElevatedButton(
+              onPressed: () => const SettingsRoute(
+                settingId: 'SettingsId',
+              ).goRelative(context),
+              child: const Text('Go to the Settings screen'),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+}
+
+/// The details screen
+class SettingsScreen extends StatelessWidget {
+  /// Constructs a [SettingsScreen]
+  const SettingsScreen({
+    super.key,
+    required this.id,
+  });
+
+  final String id;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: Text('Settings Screen $id')),
+      body: Center(
+        child: TextButton(
+          onPressed: () {
+            context.pop();
+          },
+          child: const Text('Go back'),
+        ),
+      ),
+    );
+  }
+}

packages/go_router_builder/example/pubspec.yaml

@@ -21,5 +21,9 @@ dev_dependencies:
     path: ..
   test: ^1.17.0
 
+dependency_overrides:
+  go_router: 
+    path: ../../go_router
+
 flutter:
   uses-material-design: true

packages/go_router_builder/example/test/go_relative_test.dart

@@ -0,0 +1,29 @@
+// 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.
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:go_router_builder_example/go_relative.dart' as example;
+
+void main() {
+  testWidgets('example works', (WidgetTester tester) async {
+    await tester.pumpWidget(const example.MyApp());
+    expect(find.byType(example.HomeScreen), findsOneWidget);
+
+    await tester.tap(find.text('Go to the Details screen'));
+    await tester.pumpAndSettle();
+    expect(find.byType(example.DetailsScreen), findsOneWidget);
+
+    await tester.tap(find.text('Go to the Settings screen'));
+    await tester.pumpAndSettle();
+    expect(find.byType(example.SettingsScreen), findsOneWidget);
+
+    await tester.tap(find.text('Go back'));
+    await tester.pumpAndSettle();
+    expect(find.byType(example.DetailsScreen), findsOneWidget);
+
+    await tester.tap(find.text('Go back'));
+    await tester.pumpAndSettle();
+    expect(find.byType(example.HomeScreen), findsOneWidget);
+  });
+}

packages/go_router_builder/lib/src/go_router_generator.dart

@@ -15,6 +15,7 @@ const String _routeDataUrl = 'package:go_router/src/route_data.dart';
 
 const Map<String, String> _annotations = <String, String>{
   'TypedGoRoute': 'GoRouteData',
+  'TypedRelativeRoute': 'GoRouteData',
   'TypedShellRoute': 'ShellRouteData',
   'TypedStatefulShellBranch': 'StatefulShellBranchData',
   'TypedStatefulShellRoute': 'StatefulShellRouteData',