自定义路由
在 Nuxt 3 中，你的路由由 `pages` 目录中文件的结构定义。然而，由于它在底层使用了 vue-router，Nuxt 为你在项目中添加自定义路由提供了几种方法。
添加自定义路由
在 Nuxt 3 中，你的路由是由你的文件在 pages 目录中的结构定义的。 然而，由于它在底层使用了 vue-router，Nuxt 为你在项目中添加自定义路由提供了几种方法。
路由器配置
使用路由器选项，你可以选择使用一个函数来覆盖或扩展你的路由，这个函数接受扫描的路由并返回自定义的路由。
如果它返回 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(callback: pages => void)extendRouteRules(route: string, rule: NitroRouteConfig, options: 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: {}
}
})
哈希模式 (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 将回退到默认历史记录。
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