页面

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

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

关于路由规则配置，你可以在混合渲染 > 路由规则中获取更多详细信息。

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

名称	类型	默认	描述
`override`	`boolean`	`false`	覆盖路由规则配置，默认为 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 isAuthenticated (): boolean { return false }
// ---cut---
export default defineNuxtRouteMiddleware((to, from) => {
  // isAuthenticated() is an example method verifying if a user is authenticated
  if (to.path !== '/login' && isAuthenticated() === false) {
    return navigateTo('/login')
  }
})

类型

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`，则将中间件前置到现有中间件之前。

这有帮助吗？

报告问题或在 GitHub 上编辑此页面

Context

Nuxt Kit 提供了一系列实用工具，帮助你处理上下文。

Layout

Nuxt Kit 提供了一系列实用工具，帮助你处理布局。