docs: mention Settings would be the route an app would be displaying for listed JS state#1105
docs: mention Settings would be the route an app would be displaying for listed JS state#1105rctay wants to merge 1 commit intoreact-navigation:mainfrom
Conversation
|
✔️ Deploy Preview for react-navigation-docs ready! 🔨 Explore the source changes: fca5bd1 🔍 Inspect the deploy log: https://app.netlify.com/sites/react-navigation-docs/deploys/61de9d6a1f03f70008a4e569 😎 Browse the preview: https://deploy-preview-1105--react-navigation-docs.netlify.app |
…for listed JS state Further flesh out which route an app is displayed that would correspond to the navigation state represented by the listed JavaScript object. For example, it might not be immediately obvious to a newcomer that among the 2 routes of `Home` and `Settings`, it would be the `Settings` route that is displayed, and not `Home`. Signed-off-by: Ray Chuan Tay <rtay@vmware.com>
rctay
force-pushed
the
rc/describe-index
branch
from
c515b1b to
fca5bd1
Compare
rctay
changed the title
satya164
force-pushed
the
main
branch
2 times, most recently
from
a2a5d9e to
fcb5e31
Compare
satya164
force-pushed
the
main
branch
5 times, most recently
from
65c6448 to
df873a5
Compare
satya164
force-pushed
the
main
branch
2 times, most recently
from
a739841 to
35a6db3
Compare
satya164
force-pushed
the
main
branch
2 times, most recently
from
7dbaa57 to
9e2af9d
Compare
|
Thanks for the PR. The intention here is not to understand how the state object is displayed, but just to show how it maybe structured. How it is displayed would depend on the navigator. For example, a navigator may decide to display both screens side by side. If we describe what it may show, I'd prefer to do it after explaining what each property is, e.g. in the state object that's shown after the descriptions. So I'm closing this for now. Feel free to add a description to the later state object that explains what it may show. |
2 participants
READ ME PLEASE!
TL;DR: Make sure to add your changes to versioned docs
Thanks for opening a PR!
The docs cover several versions of
react-navigation, and in some cases there are several files (for version 1, version 2 and etc.) that all describe a single page of the docs (eg. "Getting Started").Please make sure that the edit you're making in
docs/file-you-edited.mdis also included in the file for the correct version, eg./versioned_docs/version-3.x/file-you-edited.mdfor version 3. If such file doesn't exist, please create it. 👍Hi there, this change further fleshes out which route is displayed by an app that would correspond to the navigation state represented by the listed JavaScript object. For example, it might not be immediately obvious to a newcomer that among the 2 routes of
HomeandSettings, it would beSettingsthat is displayed, and notHome.