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

示例

基本用法

下面的示例演示了

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

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

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

  pageType: 'Checkout'
})
</script>

定义中间件

下面的示例展示了如何使用 function 直接在 definePageMeta 中定义中间件，或者设置为与位于 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] 路由中的 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({
  // set custom layout
  layout: 'admin'

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