自定义路由

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

添加自定义路由

在 Nuxt 中，路由是由您的文件在 app/pages 目录中的结构定义的。然而，由于它底层使用了Vue Router，Nuxt 为您提供了几种在项目中添加自定义路由的方法。

路由配置

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

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

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

export default {
  // https://router.vuejs.ac.cn/api/interfaces/routeroptions#routes
  routes: _routes => [
    {
      name: 'home',
      path: '/',
      component: () => import('~/pages/home.vue'),
    },
  ],
} satisfies RouterConfig
Nuxt 不会为您从 routes 函数返回的任何新路由添加在您提供的组件的 definePageMeta 中定义的元数据。如果您希望这样做，您应该使用在 构建时调用 的 pages:extend 钩子。

Pages 钩子

您可以使用 pages:extend nuxt 钩子从扫描到的路由中添加、更改或删除页面。

例如，为了阻止为任何 .ts 文件创建路由

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

export default defineNuxtConfig({
  hooks: {
    'pages:extend' (pages) {
      // add a route
      pages.push({
        name: 'profile',
        path: '/profile',
        file: '~/extra-pages/profile.vue',
      })

      // remove routes
      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

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

app/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)
      // add a route
      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.ac.cn/api/interfaces/routeroptions
  history: base => import.meta.client ? createMemoryHistory(base) : null, /* default */
} satisfies RouterConfig