[go_router_builder] Allow users to specify onExit as optional

packages/go_router_builder/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.3.0
+
+- Adds support for `overrideOnExit` parameter in `TypedGoRoute` and `TypedRelativeGoRoute` annotations.
+  When set to `true`, the generated route will include `overrideOnExit: true` in the GoRoute constructor, enabling custom `onExit` callback implementation for the route. Defaults to `false`.
+
 ## 4.2.0
 
 - Adds supports for `TypedQueryParameter` annotation.

packages/go_router_builder/example/lib/not_override_on_exit_example.dart

@@ -0,0 +1,112 @@
+// Copyright 2013 The Flutter Authors
+// 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 'not_override_on_exit_example.g.dart';
+
+void main() => runApp(App());
+
+class App extends StatelessWidget {
+  App({super.key});
+
+  @override
+  Widget build(BuildContext context) =>
+      MaterialApp.router(routerConfig: _router, title: _appTitle);
+
+  final GoRouter _router = GoRouter(routes: $appRoutes);
+}
+
+@TypedGoRoute<HomeRoute>(path: '/')
+class HomeRoute extends GoRouteData with $HomeRoute {
+  const HomeRoute();
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) => const HomeScreen();
+}
+
+@TypedGoRoute<Sub1Route>(path: '/sub-1-route')
+class Sub1Route extends GoRouteData with $Sub1Route {
+  const Sub1Route();
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) => const Sub1Screen();
+}
+
+@TypedGoRoute<Sub2Route>(path: '/sub-2-route')
+class Sub2Route extends GoRouteData with $Sub2Route {
+  const Sub2Route();
+
+  @override
+  Widget build(BuildContext context, GoRouterState state) => const Sub2Screen();
+}
+
+class HomeScreen extends StatefulWidget {
+  const HomeScreen({super.key});
+
+  @override
+  State<HomeScreen> createState() => _HomeScreenState();
+}
+
+class _HomeScreenState extends State<HomeScreen> {
+  String? _result;
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+    appBar: AppBar(title: const Text(_appTitle)),
+    body: Center(
+      child: ElevatedButton(
+        onPressed: () async {
+          final String? result = await const Sub1Route().push<String?>(context);
+          if (!context.mounted) {
+            return;
+          }
+          setState(() => _result = result);
+        },
+        child: Text(_result ?? 'Go to sub 1 screen'),
+      ),
+    ),
+  );
+}
+
+class Sub1Screen extends StatelessWidget {
+  const Sub1Screen({super.key});
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+    appBar: AppBar(title: const Text('$_appTitle Sub 1 screen')),
+    body: Center(
+      child: ElevatedButton(
+        onPressed: () async {
+          final String? result = await const Sub2Route().push<String?>(context);
+          if (!context.mounted) {
+            return;
+          }
+          context.pop(result);
+        },
+        child: const Text('Go to sub 2 screen'),
+      ),
+    ),
+  );
+}
+
+class Sub2Screen extends StatelessWidget {
+  const Sub2Screen({super.key});
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+    appBar: AppBar(title: const Text('$_appTitle Sub 2 screen')),
+    body: Center(
+      child: ElevatedButton(
+        onPressed: () => context.pop('Sub2Screen'),
+        child: const Text('Go back to sub 1 screen'),
+      ),
+    ),
+  );
+}
+
+const String _appTitle = 'GoRouter Example: builder';

packages/go_router_builder/example/lib/on_exit_example.dart

@@ -24,7 +24,7 @@ class App extends StatelessWidget {
 @TypedGoRoute<HomeRoute>(
   path: '/',
   routes: <TypedGoRoute<GoRouteData>>[
-    TypedGoRoute<SubRoute>(path: 'sub-route'),
+    TypedGoRoute<SubRoute>(path: 'sub-route', overrideOnExit: true),
   ],
 )
 class HomeRoute extends GoRouteData with $HomeRoute {

packages/go_router_builder/example/pubspec.yaml

@@ -9,7 +9,7 @@ dependencies:
   collection: ^1.15.0
   flutter:
     sdk: flutter
-  go_router: ^17.1.0
+  go_router: ^17.2.0
   provider: 6.0.5
 
 dev_dependencies:

packages/go_router_builder/example/test/not_override_on_exit_example_test.dart

@@ -0,0 +1,36 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:go_router_builder_example/not_override_on_exit_example.dart';
+
+void main() {
+  testWidgets('HomeScreen should return result from Sub2Screen', (
+    WidgetTester tester,
+  ) async {
+    await tester.pumpWidget(App());
+    expect(find.byType(HomeScreen), findsOne);
+
+    await tester.tap(find.widgetWithText(ElevatedButton, 'Go to sub 1 screen'));
+    await tester.pumpAndSettle();
+
+    expect(find.byType(Sub1Screen), findsOne);
+
+    await tester.tap(find.widgetWithText(ElevatedButton, 'Go to sub 2 screen'));
+    await tester.pumpAndSettle();
+
+    expect(find.byType(Sub2Screen), findsOne);
+
+    await tester.tap(find.widgetWithText(ElevatedButton, 'Go back to sub 1 screen'));
+    await tester.pumpAndSettle();
+
+    expect(find.byType(HomeScreen), findsOne);
+
+    await tester.tap(find.widgetWithText(ElevatedButton, 'Sub2Screen'));
+
+    expect(find.byType(Sub1Screen), findsNothing);
+    expect(find.byType(Sub2Screen), findsNothing);
+  });
+}

packages/go_router_builder/lib/src/route_config.dart

@@ -422,6 +422,7 @@ class GoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
     required this.path,
     required this.name,
     required this.caseSensitive,
+    required this.overrideOnExit,
     required this.parentNavigatorKey,
     required super.routeDataClass,
     required super.parent,
@@ -436,6 +437,15 @@ class GoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
   /// The case sensitivity of the GoRoute to be created by this configuration.
   final bool caseSensitive;
 
+  /// Whether to enable the onExit callback for this route.
+  ///
+  /// When set to true, the route will include an onExit parameter in the
+  /// generated GoRoute constructor, allowing you to implement custom logic
+  /// when navigating away from this route.
+  ///
+  /// Defaults to false.
+  final bool overrideOnExit;
+
   /// The parent navigator key.
   final String? parentNavigatorKey;
 
@@ -505,6 +515,7 @@ mixin $_mixinName on $routeDataClassName {
       'path: ${escapeDartString(path)},'
       '${name != null ? 'name: ${escapeDartString(name!)},' : ''}'
       '${caseSensitive ? '' : 'caseSensitive: $caseSensitive,'}'
+      '${overrideOnExit ? 'overrideOnExit: $overrideOnExit,' : ''}'
       '${parentNavigatorKey == null ? '' : 'parentNavigatorKey: $parentNavigatorKey,'}';
 
   @override
@@ -516,6 +527,7 @@ class RelativeGoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
   RelativeGoRouteConfig._({
     required this.path,
     required this.caseSensitive,
+    required this.overrideOnExit,
     required this.parentNavigatorKey,
     required super.routeDataClass,
     required super.parent,
@@ -527,6 +539,15 @@ class RelativeGoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
   /// The case sensitivity of the GoRoute to be created by this configuration.
   final bool caseSensitive;
 
+  /// Whether to enable the onExit callback for this route.
+  ///
+  /// When set to true, the route will include an onExit parameter in the
+  /// generated GoRoute constructor, allowing you to implement custom logic
+  /// when navigating away from this route.
+  ///
+  /// Defaults to false.
+  final bool overrideOnExit;
+
   /// The parent navigator key.
   final String? parentNavigatorKey;
 
@@ -582,6 +603,7 @@ mixin $_mixinName on $routeDataClassName {
   String get routeConstructorParameters =>
       'path: ${escapeDartString(path)},'
       '${caseSensitive ? '' : 'caseSensitive: $caseSensitive,'}'
+      '${overrideOnExit ? 'overrideOnExit: $overrideOnExit,' : ''}'
       '${parentNavigatorKey == null ? '' : 'parentNavigatorKey: $parentNavigatorKey,'}';
 
   @override
@@ -717,10 +739,14 @@ abstract class RouteBaseConfig {
         }
         final ConstantReader nameValue = reader.read('name');
         final ConstantReader caseSensitiveValue = reader.read('caseSensitive');
+        final ConstantReader overrideOnExitValue = reader.read(
+          'overrideOnExit',
+        );
         value = GoRouteConfig._(
           path: pathValue.stringValue,
           name: nameValue.isNull ? null : nameValue.stringValue,
           caseSensitive: caseSensitiveValue.boolValue,
+          overrideOnExit: overrideOnExitValue.boolValue,
           routeDataClass: classElement,
           parent: parent,
           parentNavigatorKey: _generateParameterGetterCode(
@@ -744,9 +770,13 @@ abstract class RouteBaseConfig {
           );
         }
         final ConstantReader caseSensitiveValue = reader.read('caseSensitive');
+        final ConstantReader overrideOnExitValue = reader.read(
+          'overrideOnExit',
+        );
         value = RelativeGoRouteConfig._(
           path: pathValue.stringValue,
           caseSensitive: caseSensitiveValue.boolValue,
+          overrideOnExit: overrideOnExitValue.boolValue,
           routeDataClass: classElement,
           parent: parent,
           parentNavigatorKey: _generateParameterGetterCode(

packages/go_router_builder/pubspec.yaml

@@ -2,7 +2,7 @@ name: go_router_builder
 description: >-
   A builder that supports generated strongly-typed route helpers for
   package:go_router
-version: 4.2.0
+version: 4.3.0
 repository: https://github.com/flutter/packages/tree/main/packages/go_router_builder
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router_builder%22
 
@@ -27,7 +27,7 @@ dev_dependencies:
   dart_style: ">=2.3.7 <4.0.0"
   flutter:
     sdk: flutter
-  go_router: ^17.1.0
+  go_router: ^17.2.0
   leak_tracker_flutter_testing: ">=3.0.0"
   package_config: ^2.1.1
   pub_semver: ^2.1.5