Key docs #115
Merged
Key docs #115
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
brentvatne
reviewed
Apr 5, 2018
docs/navigation-key.md
Outdated
| ### Idempotent navigation with the [`navigate` call](/docs/navigation-actions.html#navigate) | ||
|
|
||
| `navigate` function accepts an optional `key` parameter which is used as an identifier for the route to navigate to. If you provide the identifier (as for example in `navigate({ routeName: 'someScreen', params: { someParam: 'someValue' }, key: 'someScreen' })`) and user triggers such navigation action multiple times (eg. by pushing a button that calls the navigation action quickly multiple times in a row), the navigation action will be executed only once. | ||
|
|
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
docs/navigation-key.md
Outdated
|
|
||
| ### Usage with [`reset`](/docs/navigation-actions.html#reset) | ||
|
|
||
| When resetting, `key` is also optional and can be a string or null. If set, the navigator with the given key will reset. If null, the root navigator will reset. |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
docs/navigation-key.md
Outdated
|
|
||
| ### Usage with [`replace`](/docs/navigation-actions.html#replace) | ||
|
|
||
| With replace, key is a required parameter used for identifying the route to be replaced. |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
docs/navigation-key.md
Outdated
|
|
||
| ### Usage with `goBack` | ||
|
|
||
| Please refer to the [`goBack docs`](/docs/navigation-prop.html#goback-close-the-active-screen-and-move-back) for a detailed explanation. |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
brentvatne
reviewed
Apr 22, 2018
docs/navigation-key.md
Outdated
|
|
||
| ### Usage with the [`navigate`](/docs/navigation-actions.html#navigate) call | ||
|
|
||
| TL;DR: The behavior of `navigate` together with `key` depends on the version of react-navigation you use. In v1, key has to be provided for navigate to behave idempotently. In v2, this is no longer needed. |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
vonovak
force-pushed
the
@vonovak/key-docs
branch
from
f56dd53 to
c010f5a
Compare
brentvatne
approved these changes
Apr 30, 2018
|
thank you! this will be very helpful for people |
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.
closes #50