[go_router] Add parentNavigatorKey to ShellRoute

[johnpryan]

Right now, ShellRoute does not support parentNavigatorKey. The behavior would be the same as GoRoute. For example, in this configuration, navigating to /a/b/c would place a new page on top of the root ShellRoute's page for routes b and c:

ShellRoute(
  routes: [
    GoRoute(
      path: '/a',
      routes: [
        ShellRoute(
          parentNavigatorKey: root
          routes: [
            GoRoute(
              path: 'b'
              routes: [
                GoRoute(
                  path: 'c',
                ),
              ],
            ),
          ],
        ),
      ],
    ),
  ],
)

[chunhtai]

Hi Hangyu, can you take a look, this should be an easy fix

[Walrus117]

This would be an extremely helpful feature for displaying sheet routes for example. This way the animation of the ShellRoute entering would control the entrance of the sheet whilst the secondaryAnimation could transition out the sheet below.

Looking at line 182 to line 199 of
https://github.com/flutter/packages/blob/main/packages/go_router/lib/src/builder.dart

seems to imply this would be possible. Right now the ShellRoute is configured to use the NavigatorKey whilst the GoRoute is configured to accept the property of its route.parentNavigatorKey.

[Walrus117]

Further to my earlier comment, I have successfully implemented this into the code. I added a property to ShellRoute: parentNavigatorKey and altered the builder file to use this key if it is declared. I will continue testing and get back to you with the recommended updates if it proves viable.

[chunhtai]

@88RIK88 Feel free to open a pr if you are up for it and pin me for review

[Walrus117]

@chunhtai Sorry for the delay. It works perfectly. I'm not accustomed to GitHub and how a PR works but I do understand code. This change requires a one field to be added to ShellBaseRoute 'parentNavigatorKey' and then adding the same line as a super to ShellRoute and anything else that extends ShellBaseRoute. It then requires a one line modification to builder.dart in the main go router library. It works perfectly and I have test all situations I can think of. It has never failed. How do we submit a PR? (ps don't use the library in my profile, I've modified it locally so I could debug and check with GoRouter 7.1. I've looked at the code for 8.0 and there is nothing that will break it that I can see.

[Walrus117]

In builder.dart

Under the _buildRecursive method after else if (route is ShellRouteBase) { the following needs to be the parentNavigatorKey line needs to be changed to final GlobalKey<NavigatorState> parentNavigatorKey = route.parentNavigatorKey ?? navigatorKey;

in route.dart

Under ShellRouteBase add the following property
final GlobalKey<NavigatorState>? parentNavigatorKey;
Then update the constructor to reflect this and add it as a super.parentNavigatorKey to ShellRoute and any other ShellRouteBase extension.

That's all that is needed to make this work. I don't know much about PR's but that's got to be a really simple one. The functionality to make this work was almost already in GoRouter. I don't know if there is a reason why they didn't include it but from all my tests, this works every time and is a very small change.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.