docs: update definePageMeta docs (#7888)

This commit is contained in:
Daniel Roe 2022-10-03 14:41:22 +01:00 committed by GitHub
parent a3fd4193ce
commit d045deb9fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,6 +19,8 @@
definePageMeta(meta: PageMeta) => void
interface PageMeta {
redirect?: RouteRecordRedirectOption
alias?: string | string[]
pageTransition?: boolean | TransitionProps
layoutTransition?: boolean | TransitionProps
key?: false | string | ((route: RouteLocationNormalizedLoaded) => string)
@ -73,6 +75,20 @@ interface PageMeta {
Define anonymous or named middleware directly within `definePageMeta`. Learn more about [route middleware](/docs/directory-structure/middleware).
**`redirect`**
- **Type**: [`RouteRecordRedirectOption`](https://router.vuejs.org/guide/essentials/redirect-and-alias.html#redirect-and-alias)
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.
:StabilityEdge
**`alias`**
- **Type**: `string | string[]`
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.
**`[key: string]`**
- **Type**: `any`