Document detachInactiveScreens #859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for react-navigation-docs ready! Built with commit 5f035b0 https://deploy-preview-859--react-navigation-docs.netlify.app |
satya164
requested changes
Oct 25, 2020
satya164
requested changes
Oct 26, 2020
|
|
||
| Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true` on Android and `false` on iOS. | ||
|
|
||
| #### `detachPreviousScreen` |
| @@ -51,6 +51,14 @@ The `Stack.Navigator` component accepts following props: | |||
|
|
|||
| The name of the route to render on first load of the navigator. | |||
|
|
|||
| #### `detachInactiveScreens` | |||
There was a problem hiding this comment.
Move custom options to after screenOptions
| @@ -49,6 +49,10 @@ The `Drawer.Navigator` component accepts following props: | |||
|
|
|||
| The name of the route to render on first load of the navigator. | |||
|
|
|||
| #### `detachInactiveScreens` | |||
There was a problem hiding this comment.
Move custom options to after screenOptions
| @@ -49,6 +49,10 @@ The `Tab.Navigator` component accepts following props: | |||
|
|
|||
| The name of the route to render on first load of the navigator. | |||
|
|
|||
| #### `detachInactiveScreens` | |||
There was a problem hiding this comment.
Move custom options to after screenOptions
| @@ -58,6 +58,8 @@ Options for the router: | |||
| - `navigationOptions` - Navigation options for the navigator itself, to configure a parent navigator | |||
| - `defaultNavigationOptions` - Default navigation options to use for screens | |||
| - `paths` - A mapping of overrides for the paths set in the route configs | |||
| - `detachInactiveScreens` - Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true` on Android and `false` on iOS. | |||
| - `detachPreviousScreen` - Boolean used to indicate whether to detach the previous screen from the view hierarchy to save memory. Set it to `false` if you need the previous screen to be seen through the active screen. Only applicable if `detachInactiveScreens` isn't set to `false`. Defaults to `false` for the last screen when `mode='modal'`, otherwise `true`. | |||
There was a problem hiding this comment.
Move this to under navigationOptions
| @@ -29,6 +29,7 @@ The route configs object is a mapping from route name to a route config, which t | |||
| ## BottomTabNavigatorConfig | |||
|
|
|||
| - `initialRouteName` - The routeName for the initial tab route when first loading. | |||
| - `detachInactiveScreens` - Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true`. | |||
There was a problem hiding this comment.
Place navigator related configs after the router related configs (after backBehavior)
satya164
reviewed
Oct 26, 2020
| @@ -29,6 +29,7 @@ The route configs object is a mapping from route name to a route config, which t | |||
| ## BottomTabNavigatorConfig | |||
|
|
|||
| - `initialRouteName` - The routeName for the initial tab route when first loading. | |||
| - `detachInactiveScreens` - Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true`. | |||
There was a problem hiding this comment.
Suggested change
| - `detachInactiveScreens` - Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true`. | |
| - `detachInactiveScreens` - Boolean used to indicate whether inactive screens should be detached from the view hierarchy to save memory. Make sure to call `enableScreens` from [react-native-screens](https://github.com/software-mansion/react-native-screens) to make it work. Defaults to `true` on Android and `false` on iOS. |
There was a problem hiding this comment.
Is bottom-tabs navigator not using RNScreens on iOS by default?
There was a problem hiding this comment.
Did you mean to add this in stack-naviagtor probably?
satya164
requested changes
Oct 26, 2020
| @@ -79,6 +79,14 @@ Visual options: | |||
|
|
|||
| String that can be used as a fallback for `headerTitle`. Additionally, will be used as a fallback for `tabBarLabel` (if nested in a TabNavigator) or `drawerLabel` (if nested in a DrawerNavigator). | |||
|
|
|||
| #### `detachInactiveScreens` | |||
There was a problem hiding this comment.
This should be under StackNavigatorConfig
satya164
approved these changes
Oct 26, 2020
satya164
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added information about the new prop to be introduced with
react-navigation/react-navigation#8805 and react-navigation/react-navigation#8816.