packages
packages copied to clipboard
flutter
[go_router] Return a value on pop
In this PR I'm adding 2 new methods, pushAsync and pushNamedAsync, that allows you to wait for a value when the widget pushed pops, like in navigator 1.0.
Fixes https://github.com/flutter/flutter/issues/99663. Fixes https://github.com/flutter/flutter/issues/107217 Fixes https://github.com/flutter/flutter/issues/100969
This PR will not conflict with older versions of go_router when updated.
Here's the link of the document with the changes: https://docs.google.com/document/d/1bcPV8yNAETmlxTFTMpO_JcJ7-yMoF8qaCPa884hFmXA/edit?usp=sharing&resourcekey=0-73tg8sZOVf0YXBmz-MLwQw.
Pre-launch Checklist
- [x] I read the Contributor Guide and followed the process outlined there for submitting PRs.
- [x] I read the Tree Hygiene wiki page, which explains my responsibilities.
- [x] 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.) - [x] I signed the CLA.
- [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g.
[shared_preferences] - [x] I listed at least one issue that this PR fixes in the description above.
- [x] I updated
pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes. - [x] I updated
CHANGELOG.mdto add a description of the change, following repository CHANGELOG style. - [x] I updated/added relevant documentation (doc comments with
///). - [x] I added new tests to check the change I am making, or this PR is test-exempt.
- [x] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel on Discord.
Awesome! This is what’s stopping us from using go_router, hopefully is merged!
I updated the PR, so now instead of doing:
final result = await context.pushNamedAsync(routeName) as bool?;
context.pop(someValue);
you can do:
final result = await context.pushNamedAsync<bool>(routeName);
context.pop<bool>(someValue);
Or even:
bool? result = await context.pushNamedAsync(routeName);
In both cases the returned value will be nullable.
After some tests I came to the conclusion that you can use pushAsync as normal push, so because of that I decided to change those methods so we don't need to add new ones. Instead of:
final result = await context.pushNamedAsync(routeName) as bool?;
context.pop(someValue);
you do:
final result = await context.pushNamed<bool>(routeName);
context.pop<bool>(someValue);
and if you don't need any promise at all you can keep doing:
context.pushNamed(routeName);
context.pop();
Now because we save the completer in the RouteMatch it'll not break when pushing the same screen over and over again
We should not merge this until we figure out this how to support imperative API moving forward https://github.com/flutter/flutter/issues/99112. Closing for now
I know this is a missing feature, and probably a big one. But we would like to do a refactoring on the imperative API which may make this fix obsolete or hard to maintain. Sorry for the inconvenience.
One should be patient, for the sake of a good API, where flaws are temporary and respectable and rigorous.
@chunhtai when do you think we can add this feature to go_router? I have a branch with the implementation updated and all the tests ready to be reviewed. Also that code has been in production in multiple apps working flawlessly.
@chunhtai您认为我们什么时候可以将此功能添加到go_router？我有一个分支，其实现已更新，所有测试都已准备好接受审查。此外，该代码已经在多个应用程序中完美地工作。
I currently need to return to the previous page to carry parameters. How should I do it before you merge it? I don’t know how to do it
I have a package called go_router_flow in pub, it's updated to the last go_router update, returning values work the same as navigator 1.0
We should not merge this until we figure out this how to support imperative API moving forward flutter/flutter#99112. Closing for now
So we can't get async push and go until removeRoute, popUntil pushAndRemoveUntil, and replace are implemented? Why?
I think this is already fixed when i refactor the pop. See https://pub.dev/documentation/go_router/latest/go_router/GoRouter/pop.html
I think this is already fixed when i refactor the pop. See https://pub.dev/documentation/go_router/latest/go_router/GoRouter/pop.html
Wich version this will be merged? I can't find this pop in API (6.0.1)
Right, so now pop can come with a value after @chunhtai refactor. But how can I retrieve this value? Since both push and go return void and void can't be used? Someone understand how this will work?
hmmm, I mainly added for show dialog and imperative API. We should probably expose return future for gorouter push.
@chunhtai just to let you know, this PR is outdated. If you want I can make the update. I have another branch with a better/cleaner implementation of this.
Sure feel free to open a new pr and pin me to review. I think what's left is the push need to return a future