Skip to content

Commit b9ac631

Browse files
committed
Make sure defaultNavigationOptions is clearly documented in navigators
1 parent 460922b commit b9ac631

File tree

5 files changed

+9
-0
lines changed

5 files changed

+9
-0
lines changed

docs/bottom-tab-navigator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ The route configs object is a mapping from route name to a route config, which t
2020
## BottomTabNavigatorConfig
2121

2222
* `initialRouteName` - The routeName for the initial tab route when first loading.
23+
* `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator
24+
* `defaultNavigationOptions` - Default navigation options to use for screens
2325
* `resetOnBlur` - Reset the state of any nested navigators when switching away from a screen. Defaults to `false`.
2426
* `order` - Array of routeNames which defines the order of the tabs.
2527
* `paths` - Provide a mapping of routeName to path config, which overrides the paths set in the routeConfigs.

docs/drawer-navigator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ The route configs object is a mapping from route name to a route config, which t
2121
- `useNativeAnimations` - Enable native animations. Default is `true`.
2222
- `drawerBackgroundColor` - Use the Drawer background for some color. The Default is `white`.
2323
- `drawerType` - One of `front` | `back` | `slide`
24+
- `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator
25+
- `defaultNavigationOptions` - Default navigation options to use for screens
2426

2527
Several options get passed to the underlying router to modify navigation logic:
2628

docs/material-top-tab-navigator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The route configs object is a mapping from route name to a route config.
1717
## TabNavigatorConfig
1818

1919
* `initialRouteName` - The routeName for the initial tab route when first loading.
20+
- `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator
21+
- `defaultNavigationOptions` - Default navigation options to use for screens
2022
* `order` - Array of routeNames which defines the order of the tabs.
2123
* `paths` - Provide a mapping of routeName to path config, which overrides the paths set in the routeConfigs.
2224
* `backBehavior` - `initialRoute` to return to initial tab, `order` to return to previous tab, `history` to return to last visited tab, or `none`.

docs/stack-navigator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Options for the router:
4747
* `initialRouteName` - Sets the default screen of the stack. Must match one of the keys in route configs.
4848
* `initialRouteParams` - The params for the initial route
4949
* `initialRouteKey` - Optional identifier of the initial route
50+
* `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator
5051
* `defaultNavigationOptions` - Default navigation options to use for screens
5152
* `paths` - A mapping of overrides for the paths set in the route configs
5253

docs/switch-navigator.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The route configs object is a mapping from route name to a route config, which t
2222
Several options get passed to the underlying router to modify navigation logic:
2323

2424
- `initialRouteName` - The routeName for the initial tab route when first loading.
25+
* `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator
26+
* `defaultNavigationOptions` - Default navigation options to use for screens
2527
- `resetOnBlur` - Reset the state of any nested navigators when switching away from a screen. Defaults to `true`.
2628
- `paths` - Provide a mapping of routeName to path config, which overrides the paths set in the routeConfigs.
2729
- `backBehavior` - `initialRoute` to return to initial route, `order` to return to previous route, `history` to return to last visited route, or `none`.

0 commit comments

Comments
 (0)