[go_router_builder] Add support for relative routes

packages/go_router/CHANGELOG.md

@@ -3,6 +3,10 @@
 * Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.
 * Fixes typo in API docs.
 
+## 15.1.3
+
+- Adds `TypedRelativeGoRoute`
+
 ## 15.1.2
 
 - Fixes focus request propagation from `GoRouter` to `Navigator` by properly handling the `requestFocus` parameter.

packages/go_router/lib/src/route_data.dart

@@ -406,6 +406,28 @@ class TypedGoRoute<T extends GoRouteData> extends TypedRoute<T> {
   final bool caseSensitive;
 }
 
+/// 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_builder/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.0.1
+
+- Adds `TypedRelativeGoRoute` annotation which supports relative routes.
+
 ## 3.0.0
 
 - Route classes now required to use a mixin `with _$RouteName`.

packages/go_router_builder/example/lib/go_relative.dart

@@ -0,0 +1,198 @@
+// 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>>[
+    TypedGoRoute<DashboardRoute>(
+      path: '/dashboard',
+      routes: <TypedRoute<RouteData>>[detailRoute],
+    ),
+    detailRoute,
+  ],
+)
+class HomeRoute extends GoRouteData {
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return const HomeScreen();
+  }
+}
+
+class DashboardRoute extends GoRouteData {
+  @override
+  Widget build(BuildContext context, GoRouterState state) {
+    return const DashboardScreen();
+  }
+}
+
+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 StatelessWidget {
+  /// Constructs a [HomeScreen]
+  const HomeScreen({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('Home Screen')),
+      body: Column(
+        mainAxisAlignment: MainAxisAlignment.center,
+        children: <Widget>[
+          ElevatedButton(
+            onPressed: () {
+              const DetailsRoute(detailId: 'DetailsId').goRelative(context);
+            },
+            child: const Text('Go to the Details screen'),
+          ),
+          ElevatedButton(
+            onPressed: () {
+              DashboardRoute().go(context);
+            },
+            child: const Text('Go to the Dashboard screen'),
+          ),
+        ],
+      ),
+    );
+  }
+}
+
+/// The home screen
+class DashboardScreen extends StatelessWidget {
+  /// Constructs a [DashboardScreen]
+  const DashboardScreen({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('Dashboard Screen')),
+      body: Column(
+        children: <Widget>[
+          ElevatedButton(
+            onPressed: () {
+              const DetailsRoute(detailId: 'DetailsId').goRelative(context);
+            },
+            child: const Text('Go to the Details screen'),
+          ),
+          ElevatedButton(
+            onPressed: () => context.pop(),
+            child: const Text('Go back'),
+          ),
+        ],
+      ),
+    );
+  }
+}
+
+/// 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: () => context.pop(),
+              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