[go_router] Add `topRoute` to `GoRouterState` #5736

getBoolean · 2023-12-22T06:55:39Z

This PR exposes the current top route to GoRouterState, this allows ShellRoute to know what is the current child and process the state accordingly.

Issue: [go_router] ShellRoute needs a way to identify the current top route flutter#140297

This could be used like this, given that each GoRoute had the name parameter given

StatefulShellRoute.indexedStack(
  parentNavigatorKey: rootNavigatorKey,
  builder: (
    BuildContext context,
    GoRouterState state,
    StatefulNavigationShell navigationShell,
  ) {
    final String? routeName =
        GoRouterState.of(context).topRoute.name;
    final String title = switch (routeName) {
      'a' => 'A',
      'b' => 'B',
      _ => 'Unknown',
    };
    return Column(
      children: <Widget>[
        Text(title),
        Expanded(child: navigationShell),
      ],
    );
  },
  ...
}

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

chunhtai

I think the code LGTM, would be good to add an example in the example/ to showcase how to use this new property as well

packages/go_router/lib/src/match.dart

chunhtai · 2023-12-27T22:40:10Z

packages/go_router/lib/src/state.dart

  /// ```
  final ValueKey<String> pageKey;

+  /// The current matched top route


This needs more description. May be mention what this mean if you this is a this GoRouteState represent a shellroute.

I've updated the documentation with the following, is this what you were thinking of?

/// The current matched top route associated with this state. /// /// If this state represents a [ShellRoute], the top [GoRoute] will be the current /// matched location associated with the [ShellRoute]. This allows the [ShellRoute]'s /// associated GoRouterState to be uniquely identified using [GoRoute.name] final GoRoute? topRoute;

…top_route

getBoolean · 2024-01-06T08:41:17Z

packages/go_router/example/lib/shell_route_top_route.dart

+  Widget _buildLeadingButton(BuildContext context) {
+    final RouteMatchList currentConfiguration =
+        GoRouter.of(context).routerDelegate.currentConfiguration;
+    final RouteMatch lastMatch = currentConfiguration.last;
+    final Uri location = lastMatch is ImperativeRouteMatch
+        ? lastMatch.matches.uri
+        : currentConfiguration.uri;
+    final bool canPop = location.pathSegments.length > 1;
+    final Widget button = canPop
+        ? BackButton(onPressed: GoRouter.of(context).pop)
+        : const SizedBox.shrink(key: ValueKey<String>('NoLeadingButton'));
+    return button;
+  }


In the example, I had to manually create the leading button since this is in a scaffold above the children. Is there a better way of doing this? For context, auto_route has AutoLeadingButton

hannah-hyj

LGTM

hannah-hyj · 2024-01-11T00:47:40Z

@johnpryan hi john, chun-heng is on vacation, can you take a second look at this PR?

johnpryan · 2024-01-11T16:18:55Z

Yep I can review.

johnpryan

Looks great!

packages/go_router/example/lib/shell_route_top_route.dart

Removed to keep the example simple and make it more readable.

Return null from `_buildLeadingButton` if it shouldn't show a leading button

johnpryan

LGTM, we should also add this API to go_router_builder if we haven't already.

getBoolean · 2024-01-16T18:01:52Z

I don't use go_router_builder so i haven't checked. Should that be done in a separate PR?

hannah-hyj · 2024-01-19T01:12:02Z

yes, go_router_builder changes are usually done in separated PRs.

@johnpryan i don't think we need to change go_router_builder to add this topRoute API. topRoute here is just part of GoRouterState. we don't need to set it when GoRouter is built.

getBoolean · 2024-01-27T22:10:21Z

Are we waiting for @chunhtai to return before merging this?

getBoolean · 2024-01-28T00:36:11Z

Thanks!

…es#5736)

flutter/packages@cbe8100...516648a 2024-01-28 19920697+getBoolean@users.noreply.github.com [go_router] Add `topRoute` to `GoRouterState` (flutter/packages#5736) 2024-01-27 stuartmorgan@google.com Add Kotlin to CONTRIBUTING.md (flutter/packages#5970) 2024-01-26 engine-flutter-autoroll@skia.org Roll Flutter (stable) from 67457e6 to 4145645 (1 revision) (flutter/packages#5979) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

getBoolean added 4 commits December 21, 2023 23:51

Added topRoute to GoRouterState

3574cd8

Add RouteMatchList.lastOrNull

745e532

Fix crash if matchList was empty

6c8f16f

Update version and changelog

51213c1

getBoolean requested a review from chunhtai as a code owner December 22, 2023 06:55

github-actions bot added the p: go_router label Dec 22, 2023

getBoolean mentioned this pull request Dec 22, 2023

[go_router] Add titleBuilder to GoRoute and GoRouterState #5701

Closed

11 tasks

chunhtai reviewed Dec 27, 2023

View reviewed changes

chunhtai requested a review from hannah-hyj December 27, 2023 22:41

getBoolean added 5 commits January 5, 2024 22:11

Reuse existing last getter

39a0677

Merge remote-tracking branch 'upstream/main' into feature/shellroute_…

3225dc5

…top_route

Add more documentation to GoRouterState.topRoute

4f43da3

Add ShellRoute topRoute example

d93657f

Remove drawer logic from topRoute example

091b31a

getBoolean commented Jan 6, 2024

View reviewed changes

hannah-hyj approved these changes Jan 11, 2024

View reviewed changes

hannah-hyj requested a review from johnpryan January 11, 2024 00:45

johnpryan approved these changes Jan 11, 2024

View reviewed changes

packages/go_router/example/lib/shell_route_top_route.dart Outdated Show resolved Hide resolved

packages/go_router/example/lib/shell_route_top_route.dart Show resolved Hide resolved

packages/go_router/example/lib/shell_route_top_route.dart Outdated Show resolved Hide resolved

getBoolean added 6 commits January 15, 2024 22:42

Update comments

13b838b

Update example comment

b03cb7d

Remove example's animation from AppBar

afa2e69

Removed to keep the example simple and make it more readable.

Update comment for _buildLeadingButton method

93e318b

Update go_router example

e491f6e

Return null from `_buildLeadingButton` if it shouldn't show a leading button

Merge branch 'main' into feature/shellroute_top_route

988e860

johnpryan approved these changes Jan 16, 2024

View reviewed changes

hannah-hyj added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 28, 2024

auto-submit bot merged commit 516648a into flutter:main Jan 28, 2024

engine-flutter-autoroll mentioned this pull request Jan 29, 2024

Roll Packages from cbe810031b88 to 516648afb6be (3 revisions) flutter/flutter#142445

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 29, 2024

516648a [go_router] Add topRoute to GoRouterState (flutter/packag…

390aaf6

…es#5736)

reidbaker mentioned this pull request Feb 19, 2024

[in_app_purchase_android] Add UserChoiceBilling mode. #6162

Merged

16 tasks

[go_router] Add topRoute to GoRouterState #5736

[go_router] Add topRoute to GoRouterState #5736

Uh oh!

Conversation

getBoolean commented Dec 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chunhtai Dec 27, 2023

Choose a reason for hiding this comment

Uh oh!

getBoolean Jan 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

getBoolean Jan 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hannah-hyj left a comment

Choose a reason for hiding this comment

Uh oh!

hannah-hyj commented Jan 11, 2024

Uh oh!

johnpryan commented Jan 11, 2024

Uh oh!

johnpryan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

johnpryan left a comment

Choose a reason for hiding this comment

Uh oh!

getBoolean commented Jan 16, 2024

Uh oh!

hannah-hyj commented Jan 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

getBoolean commented Jan 27, 2024

Uh oh!

getBoolean commented Jan 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[go_router] Add `topRoute` to `GoRouterState` #5736

[go_router] Add `topRoute` to `GoRouterState` #5736

getBoolean commented Dec 22, 2023 •

edited

Loading

getBoolean Jan 6, 2024 •

edited

Loading

getBoolean Jan 6, 2024 •

edited

Loading

hannah-hyj commented Jan 19, 2024 •

edited

Loading