Skip to content

Commit 9b09832

Browse files
docs(navigation): correct routerDirection values (#4079)
Co-authored-by: Brandy Smith <[email protected]>
1 parent b24eb56 commit 9b09832

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

docs/react/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ const UsersListPage: React.FC = () => {
197197

198198
Other components that have the `routerLink` prop are `IonButton`, `IonCard`, `IonRouterLink`, `IonFabButton`, and `IonItemOption`.
199199

200-
Each of these components also have a `routerDirection` prop to explicitly set the type of page transition to use ("back", "forward", or "none").
200+
Each of these components also have a `routerDirection` prop to explicitly set the type of page transition to use (`"forward"`, `"back"`, or `"root"`).
201201

202202
Outside of these components that have the `routerLink` prop, you can also use React Routers [`Link`](https://v5.reactrouter.com/web/api/Link) component to navigate between views:
203203

docs/vue/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Both options provide the same navigation mechanism, just fitting different use c
138138

139139
The `router-link` attribute can be set on any Ionic Vue component, and the router will navigate to the route specified when the component is clicked. The `router-link` attribute accepts string values as well as named routes, just like `router.push` from Vue Router. For additional control, the `router-direction` and `router-animation` attributes can be set as well.
140140

141-
The `router-direction` attribute accepts values of `forward`, `back`, or `none` and is used to control the direction of the page transition.
141+
The `router-direction` attribute accepts values of `"forward"`, `"back"`, or `"root"` and is used to control the direction of the page transition.
142142

143143
The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. See the [Animations documentation](../utilities/animations) for more information on using animations in Ionic Vue.
144144

docs/vue/utility-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ interface UseIonRouterResult {
7272
forward: (routerAnimation?: AnimationBuilder) => void;
7373
navigate: (
7474
location: string | Location,
75-
routerDirection?: 'forward' | 'back' | 'root' | 'none',
75+
routerDirection?: 'forward' | 'back' | 'root',
7676
routerAction?: 'push' | 'pop' | 'replace',
7777
routerAnimation?: AnimationBuilder
7878
) => void;

versioned_docs/version-v7/react/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ const UsersListPage: React.FC = () => {
197197

198198
Other components that have the `routerLink` prop are `IonButton`, `IonCard`, `IonRouterLink`, `IonFabButton`, and `IonItemOption`.
199199

200-
Each of these components also have a `routerDirection` prop to explicitly set the type of page transition to use ("back", "forward", or "none").
200+
Each of these components also have a `routerDirection` prop to explicitly set the type of page transition to use (`"forward"`, `"back"`, or `"root"`).
201201

202202
Outside of these components that have the `routerLink` prop, you can also use React Routers [`Link`](https://v5.reactrouter.com/web/api/Link) component to navigate between views:
203203

versioned_docs/version-v7/vue/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Both options provide the same navigation mechanism, just fitting different use c
138138

139139
The `router-link` attribute can be set on any Ionic Vue component, and the router will navigate to the route specified when the component is clicked. The `router-link` attribute accepts string values as well as named routes, just like `router.push` from Vue Router. For additional control, the `router-direction` and `router-animation` attributes can be set as well.
140140

141-
The `router-direction` attribute accepts values of `forward`, `back`, or `none` and is used to control the direction of the page transition.
141+
The `router-direction` attribute accepts values of `"forward"`, `"back"`, or `"root"` and is used to control the direction of the page transition.
142142

143143
The `router-animation` attribute accepts an `AnimationBuilder` function and is used to provide a custom page transition that is only used when clicking the component it is provided on. The `AnimationBuilder` type is a function that returns an Ionic Animation instance. See the [Animations documentation](../utilities/animations) for more information on using animations in Ionic Vue.
144144

versioned_docs/version-v7/vue/utility-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ interface UseIonRouterResult {
7272
forward: (routerAnimation?: AnimationBuilder) => void;
7373
navigate: (
7474
location: string | Location,
75-
routerDirection?: 'forward' | 'back' | 'root' | 'none',
75+
routerDirection?: 'forward' | 'back' | 'root',
7676
routerAction?: 'push' | 'pop' | 'replace',
7777
routerAnimation?: AnimationBuilder
7878
) => void;

0 commit comments

Comments
 (0)