Document isReady method

react-navigation · Dec 1, 2023 · 2129b35 · 2129b35
1 parent f111a4c
commit 2129b35
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/versioned_docs/version-6.x/navigation-container.md b/versioned_docs/version-6.x/navigation-container.md
@@ -72,6 +72,12 @@ All of these methods will act as if they were called inside the currently focuse
 
 In addition to these methods, the ref object also includes the following special methods:
 
+#### `isReady`
+
+The `isReady` method returns a `boolean` indicating whether the navigation tree is ready. The navigation tree is ready when the `NavigationContainer` contains at least one navigator and all of the navigators have finished mounting.
+
+This can be used to determine whether it's safe to dispatch navigation actions without getting an error. See [handling initialization](navigating-without-navigation-prop.md#handling-initialization) for more details.
+
 #### `resetRoot`
 
 The `resetRoot` method lets you reset the state of the navigation tree to the specified state object:

diff --git a/versioned_docs/version-7.x/navigation-container.md b/versioned_docs/version-7.x/navigation-container.md
@@ -73,6 +73,12 @@ All of these methods will act as if they were called inside the currently focuse
 
 In addition to these methods, the ref object also includes the following special methods:
 
+#### `isReady`
+
+The `isReady` method returns a `boolean` indicating whether the navigation tree is ready. The navigation tree is ready when the `NavigationContainer` contains at least one navigator and all of the navigators have finished mounting.
+
+This can be used to determine whether it's safe to dispatch navigation actions without getting an error. See [handling initialization](navigating-without-navigation-prop.md#handling-initialization) for more details.
+
 #### `resetRoot`
 
 The `resetRoot` method lets you reset the state of the navigation tree to the specified state object:
@@ -214,6 +220,10 @@ Example:
 </NavigationContainer>
 ```
 
+This callback won't fire if there are no navigators rendered inside the container.
+
+The current status can be obtained with the [`isReady`](#isready) method on the ref.
+
 ### `onUnhandledAction`
 
 Function which is called when a navigation action is not handled by any of the navigators.