[router] rework unstable_settings.initialRouteName to unstable_settings.anchor #28644
Conversation
This file contains 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
marklawlor
requested review from
Simek,
amandeepmittal and
EvanBacon
as code owners
expo-bot
added
bot: passed checks
|
amandeepmittal
approved these changes
May 6, 2024
marklawlor
changed the title
marklawlor
force-pushed
the
marklawlor/router/preverve-initial-screen
branch
2 times, most recently
from
c591f81
to
7cfc92c
Compare
Co-authored-by: Expo Bot <[email protected]>
Co-authored-by: Aman Mittal <[email protected]>
Co-authored-by: Aman Mittal <[email protected]>
marklawlor
force-pushed
the
marklawlor/router/preverve-initial-screen
branch
from
7cfc92c
to
5e8a665
Compare
EvanBacon
reviewed
May 9, 2024
| @@ -44,4 +44,13 @@ export const unstable_settings = { | |||
| }; | |||
| ``` | |||
|
|
|||
| The `initialRouteName` is only used when deep-linking to a route. During app navigation, the route you are navigating to will be the initial route. You can disable this behavior using the `initial` prop on the `<Link />` component or by passing the option to the imperative APIs. | |||
There was a problem hiding this comment.
Should add a notice about this in the migration doc for React Navigation.
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.
Why
During normal navigation, the target screen will the initial route of a navigator. React Navigation allows users to disable this behaviour (via the
initial: falseoption when dispatching a navigation event). When disabled, the navigator determines the index of the target route (e.g it might have aninitialRouteNamewhich will be used as the initial route).I'm adding this as a feature, as it has both been requested and also is a stumbling block for new users.
How
initial={Boolean}prop to<Link />router.{navigate,push,replace}()now accepts a second options argument. The only option is{ initialScreen: Boolean }Test Plan
Updated unit tests
Checklist
npx expo prebuild& EAS Build (eg: updated a module plugin).