diff --git a/docs/bottom-tab-navigator.md b/docs/bottom-tab-navigator.md index 260abed697e..0d5ca1c8a7e 100644 --- a/docs/bottom-tab-navigator.md +++ b/docs/bottom-tab-navigator.md @@ -23,6 +23,7 @@ The route configs object is a mapping from route name to a route config, which t * `order` - Array of routeNames which defines the order of the tabs. * `paths` - Provide a mapping of routeName to path config, which overrides the paths set in the routeConfigs. * `backBehavior` - Should the back button cause a tab switch to the initial tab? If yes, set to `initialRoute`, otherwise `none`. Defaults to `initialRoute` behavior. +* `lazy` - Defaults to `true`. If `false`, all tabs are rendered immediately. When `true`, tabs are rendered only when they are made active for the first time. Note: tabs are **not** re-rendered upon subsequent visits. * `tabBarComponent` - Optional, override component to use as the tab bar. * `tabBarOptions` - An object with the following properties: * `activeTintColor` - Label and icon color of the active tab. diff --git a/docs/tab-navigator.md b/docs/tab-navigator.md index 98cb13f13de..de7a7afc754 100644 --- a/docs/tab-navigator.md +++ b/docs/tab-navigator.md @@ -20,7 +20,7 @@ The route configs object is a mapping from route name to a route config, which t * `tabBarPosition` - Position of the tab bar, can be `'top'` or `'bottom'`. * `swipeEnabled` - Whether to allow swiping between tabs. * `animationEnabled` - Whether to animate when changing tabs. -* `lazy` - Defaults to `true`. If `false`, all tabs are rendered immediately. When `true`, tabs are rendered only when they are made active. +* `lazy` - Defaults to `true`. If `false`, all tabs are rendered immediately. When `true`, tabs are rendered only when they are made active for the first time. Note: tabs are **not** re-rendered upon subsequent visits. * `removeClippedSubviews` - Defaults to `true`. An optimization to reduce memory usage by freeing resources used by inactive tabs. * `initialLayout` - Optional object containing the initial `height` and `width`, can be passed to prevent the one frame delay in [react-native-tab-view](https://github.com/react-native-community/react-native-tab-view#avoid-one-frame-delay) rendering. * `tabBarOptions` - Configure the tab bar, see below. diff --git a/website/versioned_docs/version-3.x/bottom-tab-navigator.md b/website/versioned_docs/version-3.x/bottom-tab-navigator.md index a9521a88168..c403b0ce6d8 100644 --- a/website/versioned_docs/version-3.x/bottom-tab-navigator.md +++ b/website/versioned_docs/version-3.x/bottom-tab-navigator.md @@ -24,6 +24,7 @@ The route configs object is a mapping from route name to a route config, which t * `order` - Array of routeNames which defines the order of the tabs. * `paths` - Provide a mapping of routeName to path config, which overrides the paths set in the routeConfigs. * `backBehavior` - Should the back button cause a tab switch to the initial tab? If yes, set to `initialRoute`, otherwise `none`. Defaults to `initialRoute` behavior. +* `lazy` - Defaults to `true`. If `false`, all tabs are rendered immediately. When `true`, tabs are rendered only when they are made active for the first time. Note: tabs are **not** re-rendered upon subsequent visits. * `tabBarComponent` - Optional, override component to use as the tab bar. * `tabBarOptions` - An object with the following properties: * `activeTintColor` - Label and icon color of the active tab.