v4 (4.0.0)
Nuxt on GitHub

自定义路由

在 Nuxt 中，路由由 pages 目录中的文件结构定义。然而，由于底层使用 vue-router，Nuxt 提供了多种方式在你的项目中添加自定义路由。

添加自定义路由

在 Nuxt 中，路由由 pages 目录 中的文件结构定义。然而，由于底层使用 vue-router，Nuxt 提供了多种方式在你的项目中添加自定义路由。

路由配置

通过 路由选项，你可以选择性地使用一个接受扫描路由并返回自定义路由的函数来覆盖或扩展你的路由。

如果返回 null 或 undefined，Nuxt 将回退到默认路由（适用于修改输入数组）。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'

export default {
  // https://router.vuejs.org/api/interfaces/routeroptions.html#routes
  routes: (_routes) => [
    {
      name: 'home',
      path: '/',
      component: () => import('~/pages/home.vue')
    }
  ],
} satisfies RouterConfig
Nuxt 不会为你从 routes 函数返回的新路由中提供的组件中的 definePageMeta 定义的元数据进行增强。如果需要这种行为，你应该使用 pages:extend 钩子，它在构建时调用。

页面钩子

你可以通过 pages:extend Nuxt 钩子添加、更改或移除扫描路由中的页面。

例如，防止为任何 .ts 文件创建路由：

nuxt.config.ts
import type { NuxtPage } from '@nuxt/schema'

export default defineNuxtConfig({
  hooks: {
    'pages:extend' (pages) {
      // 添加路由
      pages.push({
        name: 'profile',
        path: '/profile',
        file: '~/extra-pages/profile.vue'
      })

      // 移除路由
      function removePagesMatching (pattern: RegExp, pages: NuxtPage[] = []) {
        const pagesToRemove: NuxtPage[] = []
        for (const page of pages) {
          if (page.file && pattern.test(page.file)) {
            pagesToRemove.push(page)
          } else {
            removePagesMatching(pattern, page.children)
          }
        }
        for (const page of pagesToRemove) {
          pages.splice(pages.indexOf(page), 1)
        }
      }
      removePagesMatching(/\.ts$/, pages)
    }
  }
})

Nuxt 模块

如果你计划添加与特定功能相关的一整套页面，你可能想使用 Nuxt 模块。

Nuxt kit 提供了几种添加路由的方式：

路由选项

除了为 vue-router 自定义选项外，Nuxt 还提供了额外的选项来自定义路由。

使用 router.options

这是指定路由选项的推荐方式。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'

export default {
} satisfies RouterConfig

可以通过在 pages:routerOptions 钩子中添加文件来添加更多的路由选项文件。数组中后面的项会覆盖前面的项。

在此钩子中添加路由选项文件将启用基于页面的路由，除非设置了 optional，在这种情况下，它仅在已启用基于页面路由时应用。
nuxt.config.ts
import { createResolver } from '@nuxt/kit'

export default defineNuxtConfig({
  hooks: {
    'pages:routerOptions' ({ files }) {
      const resolver = createResolver(import.meta.url)
      // 添加路由
      files.push({
        path: resolver.resolve('./runtime/router-options'),
        optional: true
      })
    }
  }
})

使用 nuxt.config

注意： 仅可配置 JSON 可序列化的选项：

  • linkActiveClass
  • linkExactActiveClass
  • end
  • sensitive
  • strict
  • hashMode
  • scrollBehaviorType
nuxt.config
export default defineNuxtConfig({
  router: {
    options: {}
  }
})

哈希模式 (SPA)

你可以使用 hashMode 配置 在 SPA 模式下启用哈希历史记录。在此模式下，路由器会在实际内部传递的 URL 前使用哈希字符 (#)。启用后，URL 永远不会发送到服务器，并且不支持 SSR。

nuxt.config.ts
export default defineNuxtConfig({
  ssr: false,
  router: {
    options: {
      hashMode: true
    }
  }
})

哈希链接的滚动行为

你可以选择性地为哈希链接自定义滚动行为。当你将配置设置为 smooth 并且加载带有哈希链接的页面（例如 https://example.com/blog/my-article#comments）时，你会看到浏览器平滑滚动到该锚点。

nuxt.config.ts
export default defineNuxtConfig({
  router: {
    options: {
      scrollBehaviorType: 'smooth'
    }
  }
})

自定义历史记录（高级）

你可以选择性地使用接受基本 URL 并返回历史记录模式的函数来覆盖历史记录模式。如果返回 null 或 undefined，Nuxt 将回退到默认历史记录。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'
import { createMemoryHistory } from 'vue-router'

export default {
  // https://router.vuejs.org/api/interfaces/routeroptions.html
  history: base => import.meta.client ? createMemoryHistory(base) : null /* 默认 */
} satisfies RouterConfig