Skip to content

[go_router] Add new StatefulShellBranch dynamically during runtime - #8863

Closed
matl-swissas wants to merge 11 commits into
flutter:mainfrom
SwissAS:main
Closed

[go_router] Add new StatefulShellBranch dynamically during runtime#8863
matl-swissas wants to merge 11 commits into
flutter:mainfrom
SwissAS:main

Conversation

@matl-swissas

@matl-swissas matl-swissas commented Mar 13, 2025 •
edited
Loading

Copy link
Copy Markdown

Created a new method updateBranches that can be called from the StatefulNavigationShell to update the Map _branchState. This update is required to add StatefulShellBranches during runtime.

Usage example:
branchList is the list were we dynamically add the new StatefulShellBranch

StatefulShellRoute.indexedStack(
   builder: (context, state, navigationShell) {
      navigationShell.updateBranches();
      // do something
   },
   branches: branchList,
)

This fixes issue flutter/flutter#130386

Pre-Review Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I linked to at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under.
  • I updated/added any relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under.
  • All existing and new tests are passing.

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

@matl-swissas
matl-swissas requested a review from chunhtai as a code owner March 13, 2025 09:54
@flutter-dashboard

flutter-dashboard Bot commented Mar 13, 2025

Copy link
Copy Markdown

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@google-cla

google-cla Bot commented Mar 13, 2025

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@stuartmorgan-g

stuartmorgan-g commented Mar 13, 2025

Copy link
Copy Markdown
Contributor

Thanks for the submission!

In the future, please do not delete the checklist that is in the PR template; it is there for a reason. This PR is missing required elements described in the checklist (I’ve restored it to the PR description), which need to be addressed before it moves forward with review.

I am marking the PR as a Draft. Please review the checklist, updating the PR as appropriate, and when that’s complete please feel free to mark the PR as ready for review.

@stuartmorgan-g
stuartmorgan-g marked this pull request as draft March 13, 2025 19:30
@matl-swissas matl-swissas changed the title Add new StatefulShellBranch dynamically during runtime [go_router] Add new StatefulShellBranch dynamically during runtime Mar 14, 2025
@matl-swissas matl-swissas mentioned this pull request Mar 14, 2025
Closed
2 tasks done
matthiaslarisch added 3 commits March 14, 2025 09:02
@matl-swissas
matl-swissas marked this pull request as ready for review March 14, 2025 08:57
chunhtai
chunhtai reviewed Mar 17, 2025
View reviewed changes

@chunhtai chunhtai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this is already possible with current API

Comment thread packages/go_router/lib/src/route.dart

/// trigger an update of [_branchState] to make dynamically added
/// [StatefulShellBranch]es available
void updateBranches() {

@chunhtai chunhtai Mar 17, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think you should be able to achieve the same thing with GoRouter.routerConfig().

@chunhtai

chunhtai commented Mar 17, 2025

Copy link
Copy Markdown
Contributor

Closing this pr as not planned. Feel free to reopen otherwise

@chunhtai chunhtai closed this Mar 17, 2025
@MaximeRougieux MaximeRougieux mentioned this pull request Aug 24, 2026
Merged
11 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chunhtai chunhtai chunhtai left review comments

Assignees

No one assigned

Labels

p: go_router

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@matl-swissas @stuartmorgan-g @chunhtai