docs: add freezeOnBlur documentation

callstackincubator · Dec 16, 2024 · 44176dd · 44176dd
1 parent c9f13ad
commit 44176dd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/docs/docs/guides/standalone-usage.md b/docs/docs/docs/guides/standalone-usage.md
@@ -184,6 +184,7 @@ Each route in the `routes` array can have the following properties:
 - `badge`: Badge text to display on the tab
 - `activeTintColor`: Custom active tint color for this specific tab
 - `lazy`: Whether to lazy load this tab's content
+- `freezeOnBlur`: Whether to freeze this tab's content when it's not visible
 
 ### Helper Props
 
@@ -224,3 +225,8 @@ Function to determine if a tab should be hidden.
 
 Function to get the test ID for a tab item.
 - Default: Uses `route.testID`
+
+#### `getFreezeOnBlur`
+
+Function to determine if a screen should be frozen on blur.
+- Default: Uses `route.freezeOnBlur`
diff --git a/docs/docs/docs/guides/usage-with-react-navigation.mdx b/docs/docs/docs/guides/usage-with-react-navigation.mdx
@@ -233,6 +233,12 @@ Whether this screens should render the first time it's accessed. Defaults to tru
 
 Test ID for the tab item. This can be used to find the tab item in the native view hierarchy.
 
+#### `freezeOnBlur`
+
+Boolean indicating whether to prevent inactive screens from re-rendering. Defaults to false. Defaults to true when `enableFreeze()` from `react-native-screens` package is run at the top of the application.
+
+Only supported on iOS and Android.
+
 ### Events
 
 The navigator can emit events on certain actions. Supported events are: