-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
[go_router] Documentation for StatefulShellRoute #6308
Conversation
@johnpryan could you have a look at this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding the document. Since we start to use code-excerpt, can you try to follow this when adding the example code in doc? https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#add-or-converting-a-code-block
which is passed as the last argument to the builder function. Example: | ||
|
||
```dart | ||
StatefulShellRoute.indexedStack( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have example that may be easier to follow https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/others/custom_stateful_shell_route.dart
Hi @tolo are you still working on this pr? |
Yes, I'll have a look at code-excerpt and update the code / docs. |
closing this pr for now, feel free to reopen when you have time |
@chunhtai I pushed new commits over a month ago which I don’t think you have reviewed yet (didn’t request a new review though, sorry). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you for your contribution, can you rebase this to the head to resolve version conflicts?
flutter/packages@27896d1...cc9ff47 2024-08-02 [email protected] [tool] Add note about clang version used in CI to tool readme (flutter/packages#7273) 2024-08-02 [email protected] [ci] Re-enable google_maps_flutter_web integration tests. (flutter/packages#7269) 2024-08-01 [email protected] [web] Update package:web to ">=0.5.1 <2.0.0" (flutter/packages#7202) 2024-08-01 [email protected] [go_router] Documentation for StatefulShellRoute (flutter/packages#6308) 2024-08-01 [email protected] [google_maps_flutter] Switch Android examples to TLHC (flutter/packages#7282) 2024-08-01 [email protected] Manual roll Flutter from f817e51 to e2e4398 (5 revisions) (flutter/packages#7276) 2024-08-01 [email protected] [various] Clean up C++ formatting (flutter/packages#7272) 2024-08-01 [email protected] [shared_preferences] fix stringlist bug (flutter/packages#7268) 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 [email protected],[email protected] 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
flutter/packages@27896d1...cc9ff47 2024-08-02 [email protected] [tool] Add note about clang version used in CI to tool readme (flutter/packages#7273) 2024-08-02 [email protected] [ci] Re-enable google_maps_flutter_web integration tests. (flutter/packages#7269) 2024-08-01 [email protected] [web] Update package:web to ">=0.5.1 <2.0.0" (flutter/packages#7202) 2024-08-01 [email protected] [go_router] Documentation for StatefulShellRoute (flutter/packages#6308) 2024-08-01 [email protected] [google_maps_flutter] Switch Android examples to TLHC (flutter/packages#7282) 2024-08-01 [email protected] Manual roll Flutter from f817e51 to e2e4398 (5 revisions) (flutter/packages#7276) 2024-08-01 [email protected] [various] Clean up C++ formatting (flutter/packages#7272) 2024-08-01 [email protected] [shared_preferences] fix stringlist bug (flutter/packages#7268) 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 [email protected],[email protected] 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
flutter/packages@27896d1...cc9ff47 2024-08-02 [email protected] [tool] Add note about clang version used in CI to tool readme (flutter/packages#7273) 2024-08-02 [email protected] [ci] Re-enable google_maps_flutter_web integration tests. (flutter/packages#7269) 2024-08-01 [email protected] [web] Update package:web to ">=0.5.1 <2.0.0" (flutter/packages#7202) 2024-08-01 [email protected] [go_router] Documentation for StatefulShellRoute (flutter/packages#6308) 2024-08-01 [email protected] [google_maps_flutter] Switch Android examples to TLHC (flutter/packages#7282) 2024-08-01 [email protected] Manual roll Flutter from f817e51 to e2e4398 (5 revisions) (flutter/packages#7276) 2024-08-01 [email protected] [various] Clean up C++ formatting (flutter/packages#7272) 2024-08-01 [email protected] [shared_preferences] fix stringlist bug (flutter/packages#7268) 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 [email protected],[email protected] 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
Adds documentation about StatefulShellRoute to the Configuration topic (configuration.md).
Fixes flutter/flutter#127209.
Pre-launch Checklist
dart format
.)[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style.///
).If you need help, consider asking for advice on the #hackers-new channel on Discord.