自定义路由

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

添加自定义路由

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

路由配置

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

如果它返回 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 不会使用你在提供的组件的 definePageMeta 中定义的元数据来增强你从 routes 函数返回的任何新路由。如果你希望发生这种情况，你应该使用 pages:extend hook，它会在构建时调用。

页面 Hook

你可以使用 pages:extend nuxt hook 来添加、更改或删除扫描到的路由中的页面。

例如，要阻止为任何 .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 hook 中添加文件来添加更多路由选项文件。数组中较后的项目会覆盖较早的项目。

在此 hook 中添加路由选项文件将启用基于页面的路由，除非设置了 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)

你可以在 SPA 模式下使用 hashMode配置来启用哈希历史。在此模式下，路由使用实际 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