Pages

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

`extendPages`

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

观看关于 extendPages 的 Vue School 视频。

用法

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: 一个将被调用的函数，传入页面配置。您可以通过添加、删除或修改其元素来更改此数组。注意：您应直接修改提供的页面数组，因为对复制数组的更改不会反映在配置中。

属性	类型	必需	描述
`name`	`string`	`false`	路由的名称。用于编程导航和识别路由。
`path`	`string`	`false`	路由的 URL 路径。如果未设置，Nuxt 将从文件位置推断。
`file`	`string`	`false`	用作路由组件的 Vue 文件路径。
`meta`	`Record<string, any>`	`false`	路由的自定义元数据。可用于布局、中间件或导航守卫。
`alias`	`string[] \| string`	`false`	路由的一个或多个别名路径。用于支持多个 URL。
`redirect`	`RouteLocationRaw`	`false`	路由的重定向规则。支持命名路由、对象或字符串路径。
`children`	`NuxtPage[]`	`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: 要应用于匹配路由的路由规则配置。

关于路由规则配置，您可以在 Hybrid Rendering > Route Rules 中获取更多详细信息。

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

名称	类型	默认值	描述
`override`	`boolean`	`false`	覆盖路由规则配置，默认值为 false

`addRouteMiddleware`

注册路由中间件以供所有路由或特定路由使用。

路由中间件也可以通过 addRouteMiddleware 组合在插件中定义。

在 Route middleware 文档中阅读更多关于路由中间件的信息。

观看关于添加路由规则和路由中间件的 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'),
      global: true,
    }, { prepend: true })
  },
})

类型

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

参数

input: 一个中间件对象或中间件对象数组，具有以下属性：

属性	类型	必需	描述
`name`	`string`	`true`	中间件的名称。
`path`	`string`	`true`	中间件的文件路径。
`global`	`boolean`	`false`	如果设置为 `true`，则将中间件应用于所有路由。

options: 一个具有以下属性的对象：

属性	类型	默认值	描述
`override`	`boolean`	`false`	如果 `true`，替换具有相同名称的中间件。
`prepend`	`boolean`	`false`	如果 `true`，在现有中间件之前添加中间件。

※此页面是 Nuxt.js 官方文档的非官方翻译页面。

官方文档中的相应页面在此处：
https://nuxt.com/docs/3.x/api/kit/pages