Skip to content

Document subtitle parameter for screen push #2735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guyca merged 2 commits into from
Feb 18, 2018
Merged

Document subtitle parameter for screen push #2735

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed3e1ab
Document subtitle parameter for screen push
davidliu Feb 16, 2018
acdbdb9
Merge branch 'master' into patch-1
guyca Feb 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/screen-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Push a new screen into this screen's navigation stack.
this.props.navigator.push({
screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
title: undefined, // navigation bar title of the pushed screen (optional)
subtitle: undefined, // navigation bar subtitle of the pushed screen (optional)
titleImage: require('../../img/my_image.png'), // iOS only. navigation bar title image instead of the title text of the pushed screen (optional)
passProps: {}, // Object that will be passed as props to the pushed screen (optional)
animated: true, // does the push have transition animation or does it happen immediately (optional)
Expand Down Expand Up @@ -369,4 +370,4 @@ https://developer.apple.com/library/content/documentation/UserExperience/Concept

You can define actions and listen for interactions on the pushed screen with the `PreviewActionPress` event.

Previewed screens will have the prop `isPreview` that can be used to render different things when the screen is in the "Peek" state and will then recieve a navigator event of `willCommitPreview` when in the "Pop" state.
Previewed screens will have the prop `isPreview` that can be used to render different things when the screen is in the "Peek" state and will then recieve a navigator event of `willCommitPreview` when in the "Pop" state.