页面

源文件
Nuxt Kit 提供了一套实用程序，可帮助您创建和使用页面。您可以使用这些实用程序来操作页面配置或定义路由规则。

extendPages

在 Nuxt 中，路由是根据 app/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 Composable 在插件中定义。

在 路由中间件文档 中阅读更多关于路由中间件的信息。
观看 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，则在现有中间件之前添加中间件。