definePageMeta

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

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

类型

export function 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
    你可以为该页面的路由定义一个名称。默认情况下，名称是基于 app/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 文件中启用 时可用
    启用/禁用当前页面的视图过渡（View Transitions）。 如果设置为 true，Nuxt 会在用户的浏览器匹配 prefers-reduced-motion: reduce 时不应用过渡（推荐）。如果设置为 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 定义中间件，或者设置为与位于 app/middleware/ 目录中的中间件文件名相匹配的 string：

<script setup lang="ts">
definePageMeta({
  // define middleware as a function
  middleware: [
    function (to, from) {
      const auth = useState('auth')

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

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

  // ... or a string
  middleware: 'auth',

  // ... or multiple strings
  middleware: ['auth', 'another-named-middleware'],
})
</script>

使用自定义正则表达式

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

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

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

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

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

定义布局

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

<script setup lang="ts">
definePageMeta({
  // set custom layout
  layout: 'admin',

  // ... or disable a default layout
  layout: false,
})
</script>