页面

Nuxt Kit 提供了一组实用工具,帮助您创建和使用页面。您可以使用这些工具来操作页面配置或定义路由规则。

extendPages

在 Nuxt 中,路由会根据 pages 目录中文件的结构自动生成。然而,在某些场景下,您可能希望自定义这些路由。例如,您可能需要为 Nuxt 未生成的动态页面添加路由、删除现有路由或修改路由的配置。对于此类自定义,Nuxt 提供了 extendPages 功能,允许您扩展和更改页面配置。

观看 Vue School 关于 extendPages 的视频。

使用

import { createResolver, defineNuxtModule, extendPages } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options) {
    const { resolve } = createResolver(import.meta.url)

    extendPages((pages) => {
      pages.unshift({
        name: 'prismic-preview',
        path: '/preview',
        file: resolve('runtime/preview.vue'),
      })
    })
  },
})

类型

function extendPages(callback: (pages: NuxtPage[]) => void): void

参数

callback: 一个函数,将接收页面配置作为参数。您可以通过添加、删除或修改数组元素来更改此数组。注意:您应直接修改提供的页面数组,因为对复制数组的更改不会反映在配置中。

属性类型必需描述
namestringfalse路由的名称。用于程序化导航和识别路由。
pathstringfalse路由的 URL 路径。如果未设置,Nuxt 将根据文件位置推断。
filestringfalse用作路由组件的 Vue 文件路径。
metaRecord<string, any>false路由的自定义元数据。可用于布局、中间件或导航守卫。
aliasstring[] | stringfalse路由的一个或多个别名路径。用于支持多个 URL。
redirectRouteLocationRawfalse路由的重定向规则。支持命名路由、对象或字符串路径。
childrenNuxtPage[]false该路由下的嵌套子路由,用于布局或视图嵌套。

extendRouteRules

Nuxt 由 Nitro 服务器引擎驱动。通过 Nitro,您可以直接在配置中融入高级逻辑,这对于重定向、代理、缓存以及为路由追加头部等操作非常有用。此配置通过将路由模式与特定的路由设置关联来实现。

您可以在 Nitro 文档 中了解更多关于 Nitro 路由规则的信息。
观看 Vue School 关于添加路由规则和路由中间件的视频。

使用

import { createResolver, defineNuxtModule, extendPages, extendRouteRules } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options) {
    const { resolve } = createResolver(import.meta.url)

    extendPages((pages) => {
      pages.unshift({
        name: 'preview-new',
        path: '/preview-new',
        file: resolve('runtime/preview.vue'),
      })
    })

    extendRouteRules('/preview', {
      redirect: {
        to: '/preview-new',
        statusCode: 302,
      },
    })

    extendRouteRules('/preview-new', {
      cache: {
        maxAge: 60 * 60 * 24 * 7,
      },
    })
  },
})

类型

function extendRouteRules(route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void

参数

route: 要匹配的路由模式。
rule: 应用于匹配路由的路由规则配置。

关于路由规则配置的更多细节,您可以查看 混合渲染 > 路由规则

options: 传递给路由配置的对象。如果 override 设置为 true,将覆盖现有的路由配置。

名称类型默认值描述
overridebooleanfalse覆盖路由规则配置,默认为 false

addRouteMiddleware

注册路由中间件,使其对所有路由或特定路由可用。

路由中间件也可以通过插件中的 addRouteMiddleware 组合式函数定义。

路由中间件文档 中了解更多关于路由中间件的信息。
观看 Vue School 关于添加路由规则和路由中间件的视频。

使用

import { addRouteMiddleware, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    const { resolve } = createResolver(import.meta.url)

    addRouteMiddleware({
      name: 'auth',
      path: resolve('runtime/auth.ts'),
      global: true,
    }, { prepend: true })
  },
})

类型

function addRouteMiddleware(input: NuxtMiddleware | NuxtMiddleware[], options?: AddRouteMiddlewareOptions): void

参数

input: 中间件对象或中间件对象数组,包含以下属性:

属性类型必需描述
namestringtrue中间件的名称。
pathstringtrue中间件的文件路径。
globalbooleanfalse如果设置为 true,中间件将应用于所有路由。

options: 包含以下属性的对象:

属性类型默认值描述
overridebooleanfalse如果为 true,将替换同名的中间件。
prependbooleanfalse如果为 true,将中间件前置到现有中间件之前。