Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-26 07:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add name param to PageMeta interface description (#23107)

Browse Source
This commit is contained in:
Maxim 2023-09-11 01:40:13 +02:00 committed by GitHub
parent 5e33d316aa
commit a07b34a6ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/3.api/3.utils/define-page-meta.md
View File

@ -25,6 +25,7 @@ definePageMeta(meta: PageMeta) => void
interface PageMeta { interface PageMeta {
validate?: (route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>> validate?: (route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>
redirect?: RouteRecordRedirectOption redirect?: RouteRecordRedirectOption
name?: string
path?: string path?: string
alias?: string | string[] alias?: string | string[]
pageTransition?: boolean | TransitionProps pageTransition?: boolean | TransitionProps
@ -46,6 +47,12 @@ interface PageMeta {
An object accepting the following page metadata: An object accepting the following page metadata:
**`name`**
- **Type**: `string`
You may define a name for this page's route. By default, name is generated based on path inside the [`pages/` directory](/docs/guide/directory-structure/pages).
**`path`** **`path`**
- **Type**: `string` - **Type**: `string`