definePageMeta

definePageMeta 是一个编译器宏，你可以用来为位于 pages/ 目录（除非另行设置）中的 页面 组件设置元数据。通过这种方式，你可以为 Nuxt 应用的每个静态或动态路由设置自定义元数据。

<script setup lang="ts">
definePageMeta({
  layout: 'default'
})
</script>

类型

definePageMeta(meta: PageMeta) => void

interface PageMeta {
  validate?: (route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>
  redirect?: RouteRecordRedirectOption
  name?: string
  path?: string
  props?: RouteRecordRaw['props']
  alias?: string | string[]
  pageTransition?: boolean | TransitionProps
  layoutTransition?: boolean | TransitionProps
  viewTransition?: boolean | 'always'
  key?: false | string | ((route: RouteLocationNormalizedLoaded) => string)
  keepalive?: boolean | KeepAliveProps
  layout?: false | LayoutKey | Ref<LayoutKey> | ComputedRef<LayoutKey>
  middleware?: MiddlewareKey | NavigationGuard | Array<MiddlewareKey | NavigationGuard>
  scrollToTop?: boolean | ((to: RouteLocationNormalizedLoaded, from: RouteLocationNormalizedLoaded) => boolean)
  [key: string]: unknown
}

参数

meta

• 类型: PageMeta
  接受以下页面元数据的对象：
  name
  • 类型: string
    你可以为该页面路由定义一个名称。默认情况下，名称会根据 pages/ 目录 中的路径生成。
  
  path
  • 类型: string
    如果你需要比文件名更复杂的模式，可以定义一个自定义正则表达式。
  
  props
  • 类型: RouteRecordRaw['props']
    允许将路由 params 作为 props 传递给页面组件。
  
  alias
  • 类型: string | string[]
    为记录定义别名。允许定义额外的路径，这些路径将表现得像记录的副本。支持像 /users/:id 和 /u/:id 这样的路径缩写。所有 alias 和 path 值必须共享相同的参数。
  
  keepalive
  • 类型: boolean | KeepAliveProps
    当你希望在路由切换时保留页面状态时，设置为 true，或使用 KeepAliveProps 进行精细控制。
  
  key
  • 类型: false | string | ((route: RouteLocationNormalizedLoaded) => string)
    当你需要更多控制 <NuxtPage> 组件何时重新渲染时，设置 key 值。
  
  layout
  • 类型: false | LayoutKey | Ref<LayoutKey> | ComputedRef<LayoutKey>
    为每个路由设置静态或动态布局名称。如果需要禁用默认布局，可以设置为 false。
  
  layoutTransition
  • 类型: boolean | TransitionProps
    设置当前布局的过渡效果名称。你也可以将此值设置为 false 以禁用布局过渡。
  
  middleware
  • 类型: MiddlewareKey | NavigationGuard | Array<MiddlewareKey | NavigationGuard>
    在 definePageMeta 中直接定义匿名或命名的中间件。了解更多关于路由中间件的信息。
  
  pageTransition
  • 类型: boolean | TransitionProps
    设置当前页面的过渡效果名称。你也可以将此值设置为 false 以禁用页面过渡。
  
  viewTransition
  • 类型: boolean | 'always'
    实验性功能，仅在 nuxt.config 文件中启用时可用
    为当前页面启用/禁用视图过渡。 如果设置为 true，当用户浏览器匹配 prefers-reduced-motion: reduce 时，Nuxt 不会应用过渡（推荐）。如果设置为 always，Nuxt 将始终应用过渡。
  
  redirect
  • 类型: RouteRecordRedirectOption
    如果路由被直接匹配，重定向到指定位置。重定向会在任何导航守卫之前发生，并触发新的目标位置导航。
  
  validate
  • 类型: (route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>
    验证给定路由是否可以有效渲染此页面。如果有效返回 true，否则返回 false。如果找不到其他匹配项，将返回 404。你也可以直接返回一个带有 statusCode/statusMessage 的对象以立即响应错误（不会检查其他匹配项）。
  
  scrollToTop
  • 类型: boolean | (to: RouteLocationNormalized, from: RouteLocationNormalized) => boolean
    告诉 Nuxt 在渲染页面前是否滚动到顶部。如果想覆盖 Nuxt 的默认滚动行为，可以在 ~/router.options.ts 中进行设置（详见自定义路由）。
  
  [key: string]
  • 类型: any
    除了上述属性外，你还可以设置 自定义 元数据。你可能希望以类型安全的方式通过增强 meta 对象的类型来实现。

示例

基本用法

以下示例展示了：

• key 如何作为函数返回一个值；
• keepalive 属性如何确保在多个组件切换时 <modal> 组件不被缓存；
• 添加 pageType 作为自定义属性：

<script setup lang="ts">
definePageMeta({
  key: (route) => route.fullPath,

  keepalive: {
    exclude: ['modal']
  },

  pageType: 'Checkout'
})
</script>

定义中间件

以下示例展示了如何在 definePageMeta 中直接使用 function 定义中间件，或设置为与 middleware/ 目录中的中间件文件名匹配的 string：

<script setup lang="ts">
definePageMeta({
  // 作为函数定义中间件
  middleware: [
    function (to, from) {
      const auth = useState('auth')

      if (!auth.value.authenticated) {
          return navigateTo('/login')
      }

      if (to.path !== '/checkout') {
        return navigateTo('/checkout')
      }
    }
  ],

  // ... 或作为字符串
  middleware: 'auth'

  // ... 或多个字符串
  middleware: ['auth', 'another-named-middleware']
})
</script>

使用自定义正则表达式

自定义正则表达式是解决重叠路由冲突的好方法，例如：

路由 "/test-category" 和 "/1234-post" 同时匹配 [postId]-[postSlug].vue 和 [categorySlug].vue 页面路由。

为了确保 [postId]-[postSlug] 路由中的 postId 只匹配数字（\d+），可以在 [postId]-[postSlug].vue 页面模板中添加以下内容：

<script setup lang="ts">
definePageMeta({
  path: '/:postId(\\d+)-:postSlug' 
})
</script>

更多示例请参见 Vue Router 的匹配语法。

定义布局

你可以定义与（默认）位于 layouts/ 目录 中的布局文件名匹配的布局。你也可以通过将 layout 设置为 false 来禁用布局：

<script setup lang="ts">
definePageMeta({
  // 设置自定义布局
  layout: 'admin'

  // ... 或禁用默认布局
  layout: false
})
</script>