[go_router] Adds void replace() and replaceNamed to GoRouterDelegate, GoRouter and GoRouterHelper
#2306
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@chunhtai please look into this |
chunhtai
reviewed
Jul 18, 2022
| @@ -70,6 +70,26 @@ extension GoRouterHelper on BuildContext { | |||
| extra: extra, | |||
| ); | |||
|
|
|||
| /// Replaces the current location with the given one w/ optional query | |||
There was a problem hiding this comment.
Suggested change
| /// Replaces the current location with the given one w/ optional query | |
| /// Replaces the top-most page of page stack with the given URL location w/ optional query |
| @@ -70,6 +70,26 @@ extension GoRouterHelper on BuildContext { | |||
| extra: extra, | |||
| ); | |||
|
|
|||
| /// Replaces the current location with the given one w/ optional query | |||
| /// parameters, e.g. `/family/f2/person/p1?color=blue | |||
There was a problem hiding this comment.
maybe also mention go/push use
See also:
* [go], which ....
* [push], which ...
| void replace(String location, {Object? extra}) => | ||
| GoRouter.of(this).replace(location, extra: extra); | ||
|
|
||
| /// Replaces the current location with the named route w/ optional parameters, |
There was a problem hiding this comment.
Suggested change
| /// Replaces the current location with the named route w/ optional parameters, | |
| /// Replaces the top-most page of page stack with the named route w/ optional parameters, |
| GoRouter.of(this).replace(location, extra: extra); | ||
|
|
||
| /// Replaces the current location with the named route w/ optional parameters, | ||
| /// e.g. `name='person', params={'fid': 'f2', 'pid': 'p1'}` |
There was a problem hiding this comment.
also use the See also to mention goNamed and pushNamed
|
there is a merge conflict, can you resolve them before this pr can merge? |
# Conflicts: # packages/go_router/CHANGELOG.md # packages/go_router/pubspec.yaml
I fixed the conflicts in a9019f9 |
chunhtai
reviewed
Jul 20, 2022
| @@ -1,3 +1,6 @@ | |||
| ## 4.2.0 | |||
|
|
|||
| - Adds `void replace()` and `replaceNamed` to `GoRouterDelegate`, `GoRouter` and `GoRouterHelper`. | |||
There was a problem hiding this comment.
nit: add an empty line between two versions
There was a problem hiding this comment.
Oops sorry for that, I added that in 8ec9776
|
cc @johnpryan for a secondary review |
johnpryan
approved these changes
Jul 21, 2022
| @@ -78,6 +78,52 @@ void main() { | |||
| ); | |||
| }); | |||
|
|
|||
| group('replace', () { | |||
There was a problem hiding this comment.
consider adding a test for replaceNamed too?
There was a problem hiding this comment.
I added a test for replaceNamed in 44e35ef Tell me what you think about it
johnpryan
added a commit
to johnpryan/flutter_packages
that referenced
this pull request
Jul 22, 2022
johnpryan
added a commit
that referenced
this pull request
Jul 22, 2022
* Refactor internal classes and methods - Separate matching from redirection - Add RouteRedirector typedef - Add RouteMatcher class - Add RouteBuilder class - Add RouteConfiguration class - Rename and reorganize internal classes and libraries - Add todo comments * format * Sort imports * Update changelog * Address code review comments - Change name back to GoRouterRefreshStream - Update toString() methods for new naming - Make fields final - Add logging to parser - Add comments - add tests - Move function-scope to new library-scope _addRedirect function - import widgets instead of material where possible * remove routing library * Move classes in go_router.dart into separate libraries * Move Configuration.validate() into constructor * Remove comment * use continue in redirect loop * Fix comments * Sort imports * Fix logging in configuration * add visibleForTesting annotation * Updates from merge with main * Format * Add TODOs to make Router implementation classes private * Add copyright headers * Fix tests * format * fix comment * Update packages/go_router/lib/src/parser.dart Co-authored-by: Loïc Sharma <[email protected]> * add whitespace * format * Hide typedefs that weren't previously exported * Delete empty file * add missing import * Specify version 4.1.2 in pubspec.yaml * Update packages/go_router/lib/src/builder.dart Co-authored-by: chunhtai <[email protected]> * Fix comment * Add isError and error getters to RouteMatchList * Add issue links to TODO comments * Add link to issue for TODO * Re-apply code from #2306 due to merge conflicts * Add issue references Co-authored-by: Loïc Sharma <[email protected]> Co-authored-by: chunhtai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR Adds
void replace()andreplaceNamedtoGoRouterDelegate,GoRouterandGoRouterHelper.It should fix flutter/flutter#106402
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
dart format.)[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.mdto 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.