Update references to navigation prop

satya164 · satya164 · commit 17b756f29f53 · 2026-07-05T23:26:27.000+02:00
diff --git a/blog/2021-08-14-react-navigation-6.0.md b/blog/2021-08-14-react-navigation-6.0.md
@@ -62,7 +62,7 @@ We simplified many APIs with React Navigation 6 to address common use cases. For
 - Custom header doesn't require setting `headerMode="screen"` manually anymore
 - The `useHeaderHeight` hook now ignores hidden headers and returns the height of the closest visible header in parent
 - New option to set a [custom background](/docs/6.x/bottom-tab-navigator#tabbarbackground) (such as `BlurView`) for tab bar without having to use a custom tab bar
-- New API to manage ref on the container [(`createNavigationContainerRef` and `useNavigationContainerRef`)](/docs/6.x/navigating-without-navigation-prop)
+- New API to manage ref on the container [(`createNavigationContainerRef` and `useNavigationContainerRef`)](/docs/6.x/navigation-ref)
 
 ### New `Group` component for organization
 
diff --git a/versioned_docs/version-5.x/navigation-container.md b/versioned_docs/version-5.x/navigation-container.md
@@ -185,7 +185,7 @@ You can use it to track the focused screen, persist the navigation state etc.
 
 Function which is called after the navigation container and all its children finish mounting for the first time. You can use it for:
 
-- Making sure that the `ref` is usable. See [docs regarding initialization of the ref](navigating-without-navigation-prop.md#handling-initialization) for more details.
+- Making sure that the `ref` is usable. See [Navigation ref](navigation-ref.md#handling-initialization) for more details.
 - Hiding your native splash screen
 
 ### `linking`
diff --git a/versioned_docs/version-5.x/navigation-ref.md b/versioned_docs/version-5.x/navigation-ref.md
@@ -1,7 +1,7 @@
 ---
-id: navigating-without-navigation-prop
-title: Navigating without the navigation prop
-sidebar_label: Navigating without the navigation prop
+id: navigation-ref
+title: Navigation ref
+sidebar_label: Navigation ref
 ---
 
 Sometimes you need to trigger a navigation action from places where you do not have access to the `navigation` prop, such as a Redux middleware. For such cases, you can dispatch navigation actions from the navigation container.
diff --git a/versioned_docs/version-6.x/navigation-container.md b/versioned_docs/version-6.x/navigation-container.md
@@ -57,7 +57,7 @@ function App() {
 
 If you're using a regular ref object, keep in mind that the ref may be initially `null` in some situations (such as when linking is enabled). To make sure that the ref is initialized, you can use the [`onReady`](#onready) callback to get notified when the navigation container finishes mounting.
 
-See the [Navigating without the navigation prop](navigating-without-navigation-prop.md) guide for more details.
+See the [Navigation ref](navigation-ref.md) guide for more details.
 
 ### Methods on the ref
 
@@ -77,7 +77,7 @@ In addition to these methods, the ref object also includes the following special
 
 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.
+This can be used to determine whether it's safe to dispatch navigation actions without getting an error. See [handling initialization](navigation-ref.md#handling-initialization) for more details.
 
 #### `resetRoot`
 
@@ -207,7 +207,7 @@ Example:
 
 Function which is called after the navigation container and all its children finish mounting for the first time. You can use it for:
 
-- Making sure that the `ref` is usable. See [docs regarding initialization of the ref](navigating-without-navigation-prop.md#handling-initialization) for more details.
+- Making sure that the `ref` is usable. See [Navigation ref](navigation-ref.md#handling-initialization) for more details.
 - Hiding your native splash screen
 
 Example:
diff --git a/versioned_docs/version-6.x/navigation-ref.md b/versioned_docs/version-6.x/navigation-ref.md
@@ -1,7 +1,7 @@
 ---
-id: navigating-without-navigation-prop
-title: Navigating without the navigation prop
-sidebar_label: Navigating without the navigation prop
+id: navigation-ref
+title: Navigation ref
+sidebar_label: Navigation ref
 ---
 
 Sometimes you need to trigger a navigation action from places where you do not have access to the `navigation` prop, such as a Redux middleware. For such cases, you can dispatch navigation actions use a [`ref` on the navigation container](navigation-container.md#ref).
diff --git a/versioned_docs/version-6.x/upgrading-from-5.x.md b/versioned_docs/version-6.x/upgrading-from-5.x.md
@@ -280,7 +280,7 @@ See docs for [Navigation Events](navigation-events.md#screenlisteners-prop-on-th
 
 The new `useNavigationContainerRef` hook and `createNavigationContainerRef` helper are useful for simplifying adding a ref to to `NavigationContainer`.
 
-See docs for [`NavigationContainer`](navigation-container.md#ref) and [Navigating without the navigation prop](navigating-without-navigation-prop.md) for more details and examples.
+See docs for [`NavigationContainer`](navigation-container.md#ref) and [Navigation ref](navigation-ref.md) for more details and examples.
 
 ### `useNavigation`, `Link`, `useLinkProps` etc. now work outside a screen
 
diff --git a/versioned_docs/version-7.x/navigation-container.md b/versioned_docs/version-7.x/navigation-container.md
@@ -176,7 +176,7 @@ If you're using a regular ref object, keep in mind that the ref may be initially
 
 Check how to setup `ref` with TypeScript [here](typescript.md#annotating-ref-on-navigationcontainer).
 
-See the [Navigating without the navigation prop](navigating-without-navigation-prop.md) guide for more details.
+See the [Navigation ref](navigation-ref.md) guide for more details.
 
 ### Methods on the ref
 
@@ -196,7 +196,7 @@ In addition to these methods, the ref object also includes the following special
 
 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.
+This can be used to determine whether it's safe to dispatch navigation actions without getting an error. See [handling initialization](navigation-ref.md#handling-initialization) for more details.
 
 #### `resetRoot`
 
@@ -418,7 +418,7 @@ Example:
 
 Function which is called after the navigation container and all its children finish mounting for the first time. You can use it for:
 
-- Making sure that the `ref` is usable. See [docs regarding initialization of the ref](navigating-without-navigation-prop.md#handling-initialization) for more details.
+- Making sure that the `ref` is usable. See [Navigation ref](navigation-ref.md#handling-initialization) for more details.
 - Hiding your native splash screen
 
 Example:
diff --git a/versioned_docs/version-7.x/navigation-object.md b/versioned_docs/version-7.x/navigation-object.md
@@ -24,7 +24,9 @@ The `navigation` object contains various convenience functions that dispatch nav
   - `addListener` - subscribe to events for the screen
   - `removeListener` - unsubscribe from events for the screen
 
-The `navigation` object can be accessed inside any screen component with the [`useNavigation`](use-navigation.md) hook. It's also passed as a prop only to screens components defined with the dynamic API.
+The `navigation` object can be accessed inside any screen component with the [`useNavigation`](use-navigation.md) hook.
+
+Screen components defined with the dynamic API also receive the `navigation` object as a prop. Consider it legacy and prefer using the `useNavigation` hook instead.
 
 :::warning
 
diff --git a/versioned_docs/version-7.x/navigation-ref.md b/versioned_docs/version-7.x/navigation-ref.md
@@ -1,7 +1,7 @@
 ---
-id: navigating-without-navigation-prop
-title: Navigating without the navigation prop
-sidebar_label: Navigation Ref
+id: navigation-ref
+title: Navigation ref
+sidebar_label: Navigation ref
 ---
 
 import Tabs from '@theme/Tabs';
diff --git a/versioned_docs/version-7.x/navigation-state.md b/versioned_docs/version-7.x/navigation-state.md
@@ -141,7 +141,6 @@ The state object is guaranteed to not be stale when accessing it with built-in A
 
 - Navigator's state with [`useNavigationState()`](use-navigation-state.md) or [`navigation.getState()`](navigation-object.md#getstate) - not including child navigators.
 - Complete state of the navigation tree with [`ref.getRootState()`](navigation-container.md#getrootstate) including root navigator and all child navigators.
--
 
 However, if you try to access a child navigator's state with the `state` property on the [`route`](route-object.md) object, it maybe a stale or partial state object. So it's not recommended to use this property directly.
 
diff --git a/versioned_docs/version-7.x/troubleshooting.md b/versioned_docs/version-7.x/troubleshooting.md
@@ -415,7 +415,7 @@ Make sure that:
 - The component using navigation hooks is rendered as a screen or inside a screen.
 - You don't use navigation hooks in components rendered outside the navigation tree, such as a separate root, portal, or modal rendered outside the navigator.
 
-If you need to navigate from a component that isn't rendered inside a navigator, see [navigating without the navigation prop](navigating-without-navigation-prop.md).
+If you need to navigate from a component that isn't rendered inside a navigator, see [Navigation ref](navigation-ref.md).
 
 ## I'm getting "The action 'NAVIGATE' was not handled by any navigator"
 
diff --git a/versioned_docs/version-7.x/typescript.md b/versioned_docs/version-7.x/typescript.md
@@ -343,9 +343,9 @@ type TabParamList = {
 };
 ```
 
-### Combining navigation props
+### Combining navigation objects
 
-When you nest navigators, the navigation prop of the screen is a combination of multiple navigation props. For example, if we have a tab inside a stack, the `navigation` prop will have both [`jumpTo`](tab-actions.md#jumpto) (from the tab navigator) and [`push`](stack-actions.md#push) (from the stack navigator). To make it easier to combine types from multiple navigators, you can use the `CompositeScreenProps` type.
+When you nest navigators, the navigation object of the screen is a combination of multiple navigation objects. For example, if we have a tab inside a stack, the `navigation` object will have both [`jumpTo`](tab-actions.md#jumpto) (from the tab navigator) and [`push`](stack-actions.md#push) (from the stack navigator). To make it easier to combine types from multiple navigators, you can use the `CompositeScreenProps` type.
 
 For example, if we have a `Profile` in a navigator, nested inside `Account` screen of a stack navigator, we can combine the types as follows:
 
diff --git a/versioned_docs/version-8.x/navigation-container.md b/versioned_docs/version-8.x/navigation-container.md
@@ -176,7 +176,7 @@ If you're using a regular ref object, keep in mind that the ref may be initially
 
 Check how to setup `ref` with TypeScript [here](typescript.md#annotating-ref-on-navigationcontainer).
 
-See the [Navigating without the navigation prop](navigating-without-navigation-prop.md) guide for more details.
+See the [Navigation ref](navigation-ref.md) guide for more details.
 
 ### Methods on the ref
 
@@ -196,7 +196,7 @@ In addition to these methods, the ref object also includes the following special
 
 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.
+This can be used to determine whether it's safe to dispatch navigation actions without getting an error. See [handling initialization](navigation-ref.md#handling-initialization) for more details.
 
 #### `resetRoot`
 
@@ -418,7 +418,7 @@ Example:
 
 Function which is called after the navigation container and all its children finish mounting for the first time. You can use it for:
 
-- Making sure that the `ref` is usable. See [docs regarding initialization of the ref](navigating-without-navigation-prop.md#handling-initialization) for more details.
+- Making sure that the `ref` is usable. See [Navigation ref](navigation-ref.md#handling-initialization) for more details.
 - Hiding your native splash screen
 
 Example:
diff --git a/versioned_docs/version-8.x/navigation-object.md b/versioned_docs/version-8.x/navigation-object.md
@@ -26,7 +26,9 @@ The `navigation` object contains various convenience functions that dispatch nav
   - `addListener` - subscribe to events for the screen
   - `removeListener` - unsubscribe from events for the screen
 
-The `navigation` object can be accessed inside any screen component with the [`useNavigation`](use-navigation.md) hook. It's also passed as a prop only to screens components defined with the dynamic API.
+The `navigation` object can be accessed inside any screen component with the [`useNavigation`](use-navigation.md) hook.
+
+Screen components defined with the dynamic API also receive the `navigation` object as a prop. Consider it legacy and prefer using the `useNavigation` hook instead.
 
 :::warning
 
diff --git a/versioned_docs/version-8.x/navigation-ref.md b/versioned_docs/version-8.x/navigation-ref.md
@@ -1,7 +1,7 @@
 ---
-id: navigating-without-navigation-prop
-title: Navigating without the navigation prop
-sidebar_label: Navigation Ref
+id: navigation-ref
+title: Navigation ref
+sidebar_label: Navigation ref
 ---
 
 import Tabs from '@theme/Tabs';
diff --git a/versioned_docs/version-8.x/troubleshooting.md b/versioned_docs/version-8.x/troubleshooting.md
@@ -415,7 +415,7 @@ Make sure that:
 - The component using navigation hooks is rendered as a screen or inside a screen.
 - You don't use navigation hooks in components rendered outside the navigation tree, such as a separate root, portal, or modal rendered outside the navigator.
 
-If you need to navigate from a component that isn't rendered inside a navigator, see [navigating without the navigation prop](navigating-without-navigation-prop.md).
+If you need to navigate from a component that isn't rendered inside a navigator, see [Navigation ref](navigation-ref.md).
 
 ## I'm getting "The action 'NAVIGATE' was not handled by any navigator"
 
diff --git a/versioned_docs/version-8.x/typescript.md b/versioned_docs/version-8.x/typescript.md
@@ -710,9 +710,9 @@ import type { RouteProp } from '@react-navigation/native';
 type ProfileScreenRouteProp = RouteProp<RootStackParamList, 'Profile'>;
 ```
 
-### Combining navigation props
+### Combining navigation objects
 
-When you manually annotate screen props for nested navigators, the navigation prop of the screen is a combination of multiple navigation props. For example, if we have a tab inside a stack, the `navigation` prop will have both [`jumpTo`](tab-actions.md#jumpto) (from the tab navigator) and [`push`](stack-actions.md#push) (from the stack navigator). To make it easier to combine types from multiple navigators, you can use the `CompositeScreenProps` type.
+When you manually annotate screen props for nested navigators, the navigation object of the screen is a combination of multiple navigation objects. For example, if we have a tab inside a stack, the `navigation` object will have both [`jumpTo`](tab-actions.md#jumpto) (from the tab navigator) and [`push`](stack-actions.md#push) (from the stack navigator). To make it easier to combine types from multiple navigators, you can use the `CompositeScreenProps` type.
 
 For example, if we have a `Profile` in a navigator, nested inside `Account` screen of a stack navigator, we can combine the types as follows:
 
diff --git a/versioned_docs/version-8.x/upgrading-from-7.x.md b/versioned_docs/version-8.x/upgrading-from-7.x.md
@@ -127,7 +127,7 @@ If you use the dynamic API, you'll need to pass the type of the nested navigator
 
 Here `FeedStack` is the value returned by `createXNavigator` (e.g. `const FeedStack = createNativeStackNavigator<FeedStackParamList>()`).
 
-Typed hooks handle navigator nesting automatically. If you setup and use typed hooks, you don't need to combine navigation props manually with `CompositeScreenProps` or `CompositeNavigationProp`. The hooks compose the nested navigator types based on the screen name automatically, so manual types for dynamic navigation structures get much simpler:
+Typed hooks handle navigator nesting automatically. If you setup and use typed hooks, you don't need to combine navigation objects manually with `CompositeScreenProps` or `CompositeNavigationProp`. The hooks compose the nested navigator types based on the screen name automatically, so manual types for dynamic navigation structures get much simpler:
 
 ```diff lang=ts
 - type ProfileScreenNavigationProp = CompositeNavigationProp<
diff --git a/versioned_sidebars/version-5.x-sidebars.json b/versioned_sidebars/version-5.x-sidebars.json
@@ -28,7 +28,7 @@
       "preventing-going-back",
       "function-after-focusing-screen",
       "connecting-navigation-prop",
-      "navigating-without-navigation-prop",
+      "navigation-ref",
       "deep-linking",
       "configuring-links",
       "web-support",
diff --git a/versioned_sidebars/version-6.x-sidebars.json b/versioned_sidebars/version-6.x-sidebars.json
@@ -26,7 +26,7 @@
       "preventing-going-back",
       "function-after-focusing-screen",
       "connecting-navigation-prop",
-      "navigating-without-navigation-prop",
+      "navigation-ref",
       "deep-linking",
       "configuring-links",
       "web-support",
diff --git a/versioned_sidebars/version-7.x-sidebars.json b/versioned_sidebars/version-7.x-sidebars.json
@@ -62,7 +62,7 @@
         "shared-element-transitions",
         "preventing-going-back",
         "function-after-focusing-screen",
-        "navigating-without-navigation-prop",
+        "navigation-ref",
         "screen-tracking"
       ]
     },
diff --git a/versioned_sidebars/version-8.x-sidebars.json b/versioned_sidebars/version-8.x-sidebars.json
@@ -64,7 +64,7 @@
         "shared-element-transitions",
         "preventing-going-back",
         "function-after-focusing-screen",
-        "navigating-without-navigation-prop",
+        "navigation-ref",
         "screen-tracking"
       ]
     },
