页面

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

extendPages

在 Nuxt 中，路由是根据 app/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: 一个将在页面配置上被调用的函数。你可以通过添加、删除或修改数组元素来更改此数组。注意：应直接修改提供的 pages 数组，因为对复制数组所做的更改不会反映在配置中。

属性类型必填描述
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: 应用于匹配路由的路由规则配置。

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

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'),
      global: true,
    }, { prepend: true })
  },
})

类型

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

参数

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

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

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

属性类型默认描述
overridebooleanfalse如果为 true，则替换具有相同名称的中间件。
prependbooleanfalse如果为 true，将在现有中间件之前预先添加该中间件。