页面

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：一个函数，会接收页面配置作为参数。你可以通过添加、删除或修改数组元素来更改该数组。注意：你应该直接修改提供的 pages 数组，因为对复制的数组所做的更改不会反映到配置中。

属性	类型	是否必需	描述
`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 组合式 API 来定义。

在路由中间件文档中了解更多关于路由中间件的内容。

观看 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 })
  },
})

export default defineNuxtRouteMiddleware((to, from) => {
  // isAuthenticated() 是一个示例方法，用于验证用户是否已认证
  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`，则将中间件添加到现有中间件之前。

Was this helpful?

Report an issue or Edit this page on GitHub

上下文

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

布局

Nuxt Kit 提供了一组工具，帮助你处理布局。