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

Commit

Permalink
docs: update definePageMeta docs (#7888)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Oct 3, 2022
1 parent a3fd419 commit d045deb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/content/3.api/3.utils/define-page-meta.md
Expand Up @@ -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)
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit d045deb

Please sign in to comment.