Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

Commit c804daa

Browse files
committed
docs: add back deleted sections in definePageMeta
1 parent 5f003a9 commit c804daa

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

docs/content/3.api/3.utils/define-page-meta.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,42 +44,56 @@ interface PageMeta {
4444

4545
An object accepting the following page metadata:
4646

47-
**`pageTransition`**
48-
49-
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components.html#transition)
47+
**`alias`**
48+
49+
- **Type**: `string | string[]`
5050

51-
Set name of the transition to apply for current page. You can also set this value to `false` to disable the page transition.
51+
Aliases for the record. Allows defining extra paths that will behave like a copy of the record. Allows having paths shorthands like `/users/:id` and `/u/:id`. All `alias` and `path` values must share the same params.
5252

53-
**`layoutTransition`**
53+
**`keepalive`**
5454

55-
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components.html#transition)
55+
- **Type**: `boolean` | [`KeepAliveProps`](https://vuejs.org/api/built-in-components.html#keepalive)
5656

57-
Set name of the transition to apply for current layout. You can also set this value to `false` to disable the layout transition.
57+
Set to `true` when you want to preserve page state across route changes or use the [`KeepAliveProps`](https://vuejs.org/api/built-in-components.html#keepalive) for a fine-grained control.
5858

5959
**`key`**
6060

6161
- **Type**: `false` | `string` | `((route: RouteLocationNormalizedLoaded) => string)`
6262

6363
Set `key` value when you need more control over when the `<NuxtPage>` component is re-rendered.
6464

65-
**`keepalive`**
66-
67-
- **Type**: `boolean` | [`KeepAliveProps`](https://vuejs.org/api/built-in-components.html#keepalive)
68-
69-
Set to `true` when you want to preserve page state across route changes or use the [`KeepAliveProps`](https://vuejs.org/api/built-in-components.html#keepalive) for a fine-grained control.
70-
7165
**`layout`**
7266

7367
- **Type**: `false` | `LayoutKey` | `Ref<LayoutKey>` | `ComputedRef<LayoutKey>`
7468

7569
Set a static or dynamic name of the layout for each route. This can be set to `false` in case the default layout needs to be disabled.
7670

71+
**`layoutTransition`**
72+
73+
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components.html#transition)
74+
75+
Set name of the transition to apply for current layout. You can also set this value to `false` to disable the layout transition.
76+
7777
**`middleware`**
7878

7979
- **Type**: `MiddlewareKey` | [`NavigationGuard`](https://router.vuejs.org/api/interfaces/NavigationGuard.html#navigationguard) | `Array<MiddlewareKey | NavigationGuard>`
8080

8181
Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/directory-structure/middleware).
8282

83+
**`pageTransition`**
84+
85+
- **Type**: `boolean` | [`TransitionProps`](https://vuejs.org/api/built-in-components.html#transition)
86+
87+
Set name of the transition to apply for current page. You can also set this value to `false` to disable the page transition.
88+
89+
**`redirect`**
90+
91+
- **Type**: [`RouteRecordRedirectOption`](https://router.vuejs.org/guide/essentials/redirect-and-alias.html#redirect-and-alias)
92+
93+
Where to redirect if the route is directly matched. The redirection happens before any navigation guard and triggers a new navigation with the new target location.
94+
95+
:StabilityEdge
96+
8397
**`validate`**
8498

8599
- **Type**: `(route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>`

0 commit comments

Comments
 (0)