Skip to content

[go_router] Allow users to specify onExit as optional #11150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auto-submit merged 13 commits into from
May 26, 2026
Merged

[go_router] Allow users to specify onExit as optional #11150

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a67ce0b
Adds `overrideOnExit` parameter to `TypedGoRoute` and `TypedRelativeG…
hantrungkien Feb 26, 2026
0105c20
Update test for `TypedGoRoute` and `TypedRelativeGoRoute`
hantrungkien Mar 2, 2026
a444b62
Add hasOverriddenOnExit parameter to TypedGoRoute and TypedRelativeGo…
hantrungkien Mar 9, 2026
01c14d8
Remove hasOverriddenOnExit parameter to TypedGoRoute and TypedRelativ…
hantrungkien Mar 9, 2026
be31651
Update CHANGELOG.md
hantrungkien Mar 9, 2026
cad6d9d
Update hasOverriddenOnExit default value to null
hantrungkien Mar 13, 2026
0a31816
Merge branch 'main' into go-router/support-on-exit-optional
hantrungkien Mar 13, 2026
53bffe8
Update hasOverriddenOnExit default value to null
hantrungkien Mar 13, 2026
54acedc
update pending_changelogs
hantrungkien Mar 31, 2026
88e0d2a
Merge branch 'main' into go-router/support-on-exit-optional
hantrungkien Mar 31, 2026
af42f21
update pending_changelogs
hantrungkien Apr 8, 2026
e08bcd9
default hasOverriddenOnExit = null for RelativeGoRouteData.$route
hantrungkien Apr 8, 2026
9c73b1c
add a comment about that when hasOverriddenOnExit is null
hantrungkien May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions packages/go_router/lib/src/route_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,20 @@ class _GoRouteParameters {
required this.builder,
required this.pageBuilder,
required this.redirect,
required this.onExit,
this.onExit,
});

final GoRouterWidgetBuilder builder;
final GoRouterPageBuilder pageBuilder;
final GoRouterRedirect redirect;
final ExitCallback onExit;
final ExitCallback? onExit;
}

/// Helper to create [GoRoute] parameters from a factory function and an Expando.
_GoRouteParameters _createGoRouteParameters<T extends _GoRouteDataBase>({
required T Function(GoRouterState) factory,
required Expando<_GoRouteDataBase> expando,
bool? hasOverriddenOnExit,

@hannah-hyj hannah-hyj May 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add a comment about that when hasOverriddenOnExit is null it's handled the same as true for backward compatibility?

@hantrungkien hantrungkien May 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hannah-hyj I've added. Please help me review.

}) {
Comment thread
hantrungkien marked this conversation as resolved.
T factoryImpl(GoRouterState state) {
final Object? extra = state.extra;
Expand All @@ -123,8 +124,10 @@ _GoRouteParameters _createGoRouteParameters<T extends _GoRouteDataBase>({
factoryImpl(state).buildPage(context, state),
redirect: (BuildContext context, GoRouterState state) =>
factoryImpl(state).redirect(context, state),
onExit: (BuildContext context, GoRouterState state) =>
factoryImpl(state).onExit(context, state),
onExit: hasOverriddenOnExit == null || hasOverriddenOnExit
? (BuildContext context, GoRouterState state) =>
factoryImpl(state).onExit(context, state)
: null,
);
}

Expand Down Expand Up @@ -156,10 +159,12 @@ abstract class GoRouteData extends _GoRouteDataBase {
required T Function(GoRouterState) factory,
GlobalKey<NavigatorState>? parentNavigatorKey,
List<RouteBase> routes = const <RouteBase>[],
bool? hasOverriddenOnExit,
}) {
final _GoRouteParameters params = _createGoRouteParameters<T>(
factory: factory,
expando: _GoRouteDataBase.stateObjectExpando,
hasOverriddenOnExit: hasOverriddenOnExit,
);

return GoRoute(
Expand Down Expand Up @@ -227,10 +232,12 @@ abstract class RelativeGoRouteData extends _GoRouteDataBase {
required T Function(GoRouterState) factory,
GlobalKey<NavigatorState>? parentNavigatorKey,
List<RouteBase> routes = const <RouteBase>[],
bool hasOverriddenOnExit = false,
}) {
final _GoRouteParameters params = _createGoRouteParameters<T>(
factory: factory,
expando: _GoRouteDataBase.stateObjectExpando,
hasOverriddenOnExit: hasOverriddenOnExit,
);

return GoRoute(
Expand Down
3 changes: 3 additions & 0 deletions packages/go_router/pending_changelogs/11150-allow-onexit-as-optional .yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
changelog: |
- Adds `hasOverriddenOnExit` parameter to `GoRouteData.$route` and `RelativeGoRouteData.$route` helper methods for type-safe routes. When set to `true`, enables custom `onExit` callback invocation from route data classes extending `GoRouteData` or `RelativeGoRouteData` when the route is removed from the navigation stack.
version: minor
Loading