自定义路由
在 Nuxt 3 中，路由由 pages 目录中文件的结构定义。但是，由于 Nuxt 在底层使用了 vue-router，它为您提供了几种在项目中添加自定义路由的方法。
添加自定义路由
在 Nuxt 3 中，路由由 pages 目录中文件的结构定义。但是，由于 Nuxt 在底层使用了 vue-router，它为您提供了几种在项目中添加自定义路由的方法。
路由配置
使用路由选项，您可以选择使用一个函数来覆盖或扩展您的路由，该函数接受扫描的路由并返回自定义路由。
如果它返回 null 或 undefined，Nuxt 将回退到默认路由（用于修改输入数组很有用）。
app/router.options.ts
import type { RouterConfig } from '@nuxt/schema'
export default {
// https://router.vuejs.ac.cn/api/interfaces/routeroptions.html#routes
routes: (_routes) => [
{
name: 'home',
path: '/',
component: () => import('~/pages/home.vue')
}
],
} satisfies RouterConfig
Nuxt 不会使用您提供的组件的 definePageMeta 中定义的元数据来增强您从 routes 函数返回的任何新路由。 如果您希望这样做，则应使用在构建时调用的 pages:extend 钩子。
页面钩子
您可以使用 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 模块。
extendPages(回调函数: pages => void)extendRouteRules(路由: string, 规则: NitroRouteConfig, 选项: ExtendRouteRulesOptions)
路由选项
除了自定义 vue-router 的选项之外，Nuxt 还提供了 其他选项来自定义路由器。
使用 app/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/app/router-options'),
optional: true
})
}
}
})
使用 nuxt.config
注意：只有 JSON 可序列化的 选项是可配置的
linkActiveClasslinkExactActiveClassendsensitivestricthashModescrollBehaviorType
nuxt.config
export default defineNuxtConfig({
router: {
options: {}
}
})
Hash 模式 (SPA)
您可以使用 hashMode 配置在 SPA 模式下启用 hash 历史记录。 在此模式下，路由器在内部传递的实际 URL 之前使用 hash 字符 (#)。 启用后，URL 永远不会发送到服务器，并且不支持 SSR。
nuxt.config.ts
export default defineNuxtConfig({
ssr: false,
router: {
options: {
hashMode: true
}
}
})
hash 链接的滚动行为
您可以选择自定义 hash 链接的滚动行为。 当您将 配置设置为 smooth 并加载带有 hash 链接的页面（例如 https://example.com/blog/my-article#comments）时，您将看到浏览器平滑滚动到此锚点。
nuxt.config.ts
export default defineNuxtConfig({
router: {
options: {
scrollBehaviorType: 'smooth'
}
}
})
自定义历史记录 (高级)
您可以选择使用一个函数来覆盖历史记录模式，该函数接受基本 URL 并返回历史记录模式。 如果它返回 null 或 undefined，Nuxt 将回退到默认历史记录。
app/router.options.ts
import type { RouterConfig } from '@nuxt/schema'
import { createMemoryHistory } from 'vue-router'
export default {
// https://router.vuejs.ac.cn/api/interfaces/routeroptions.html
history: base => import.meta.client ? createMemoryHistory(base) : null /* default */
} satisfies RouterConfig