From ed3e1abf2c0930fcff2809cf0c20302c6ba95298 Mon Sep 17 00:00:00 2001 From: davidliu Date: Thu, 15 Feb 2018 16:39:09 -0800 Subject: [PATCH] Document subtitle parameter for screen push --- docs/screen-api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/screen-api.md b/docs/screen-api.md index 47645e9fea9..fb135fe649e 100644 --- a/docs/screen-api.md +++ b/docs/screen-api.md @@ -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) @@ -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. \ No newline at end of file +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.