Skip to content

Commit 98f2c65

Browse files
author
Johann Hofmann
committed
Add missing documentation for titleProps
1 parent fbf7db5 commit 98f2c65

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ The **`this.props.toRoute()`** callback prop takes one parameter (a JavaScript o
103103
- `hideNavigationBar`: If set to a truthy value will hide the navigationbar out of view, and move the component so that it is at the top of the screen.
104104
- `leftCornerProps`: If you set a `leftCorner` component you can use this property to pass props to that component.
105105
- `rightCornerProps`: If you set a `rightCorner` component you can use this property to pass props to that component.
106+
- `titleProps`: If you set a `titleComponent` you can use this property to pass props to that component.
106107
- `sceneConfig`: Control the animation of the route being switched. Possible values are:
107108
- Navigator.SceneConfigs.FadeAndroid
108109
- Navigator.SceneConfigs.FloatFromBottom
@@ -114,15 +115,15 @@ The **`this.props.toRoute()`** callback prop takes one parameter (a JavaScript o
114115
- Navigator.SceneConfigs.VerticalDownSwipeJump
115116
- Navigator.SceneConfigs.VerticalUpSwipeJump
116117

117-
The **`this.props.replaceRoute`** takes in an object that can contain the same keys as `toRoute()`. The difference is that instead of adding a route to your stack, it replaces the route
118+
The **`this.props.replaceRoute`** function takes in an object that can contain the same keys as `toRoute()`. The difference is that instead of adding a route to your stack, it replaces the route
118119
that you're on with the new route that you pass it.
119120
- This is useful for login or signup screens. If you don't want your user to be able to navigate back to it, then use `replaceRoute()` rather than `toRoute()`.
120121

121-
The **`this.props.resetToRoute`** takes in an object that can contain the same keys as `toRoute()`. The difference is that instead of adding a route to your stack, it replaces the route
122+
The **`this.props.resetToRoute`** function takes in an object that can contain the same keys as `toRoute()`. The difference is that instead of adding a route to your stack, it replaces the route
122123
that you're on with the new route that you pass it, and empties the navigation stack as well.
123124
- This is useful for going to an application after a login or signup screens. If you don't want your user to be able to navigate back to it, then use `resetToRoute()` rather than `replaceRoute()`.
124125

125-
The **`this.props.setRightProps`** and **`this.props.setLeftProps`** take in an object of props and sends that to your navbar's `RightComponent` and `LeftComponent`.
126+
The functions **`this.props.setRightProps`**, **`this.props.setLeftProps`** and **`this.props.setTitleProps`** take in an object of props and sends that to your navbar's `RightComponent`, `LeftComponent` or `TitleComponent`, respectively.
126127
- This allows you to talk directly to your navbar, because previously you could only talk to it when navigating forward or backward.
127128

128129

0 commit comments

Comments
 (0)