Browse Source

Document subtitle parameter for screen push (#2735)

davidliu 6 years ago
parent
commit
ecba954778
1 changed files with 2 additions and 1 deletions
  1. 2
    1
      docs/screen-api.md

+ 2
- 1
docs/screen-api.md View File

10
 this.props.navigator.push({
10
 this.props.navigator.push({
11
   screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
11
   screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
12
   title: undefined, // navigation bar title of the pushed screen (optional)
12
   title: undefined, // navigation bar title of the pushed screen (optional)
13
+  subtitle: undefined, // navigation bar subtitle of the pushed screen (optional)
13
   titleImage: require('../../img/my_image.png'), // iOS only. navigation bar title image instead of the title text of the pushed screen (optional)
14
   titleImage: require('../../img/my_image.png'), // iOS only. navigation bar title image instead of the title text of the pushed screen (optional)
14
   passProps: {}, // Object that will be passed as props to the pushed screen (optional)
15
   passProps: {}, // Object that will be passed as props to the pushed screen (optional)
15
   animated: true, // does the push have transition animation or does it happen immediately (optional)
16
   animated: true, // does the push have transition animation or does it happen immediately (optional)
369
 
370
 
370
 You can define actions and listen for interactions on the pushed screen with the `PreviewActionPress` event.
371
 You can define actions and listen for interactions on the pushed screen with the `PreviewActionPress` event.
371
 
372
 
372
-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.
373
+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.