useRouter

<script setup lang="ts">
const router = useRouter()
</script>

如果你只需要在模板中使用路由器实例，请使用 $router:

<template>
  <button @click="$router.back()">Back</button>
</template>

如果你有一个 pages/ 目录，useRouter 的行为与 vue-router 提供的行为相同。

基本操作

• addRoute(): 向路由器实例添加一个新的路由。可以使用 parentName 来将新路由添加为现有路由的子路由。
• removeRoute(): 通过名称移除一个现有路由。
• getRoutes(): 获取所有路由记录的完整列表。
• hasRoute(): 检查是否存在具有给定名称的路由。
• resolve(): 返回路由位置的规范化版本。还包括一个 href 属性，其中包含任何现有的基。

const router = useRouter()

router.addRoute({ name: 'home', path: '/home', component: Home })
router.removeRoute('home')
router.getRoutes()
router.hasRoute('home')
router.resolve({ name: 'home' })

基于 History API

• back(): 如果可能，返回历史记录，与 router.go(-1) 相同。
• forward(): 如果可能，向前移动历史记录，与 router.go(1) 相同。
• go(): 向前或向后移动历史记录，不包括 router.back() 和 router.forward() 强制执行的层次限制。
• push(): 通过将新条目推入历史记录栈，程序化地导航到一个新 URL。建议使用 navigateTo 代替。
• replace(): 通过替换当前历史记录栈中的条目，程序化地导航到一个新 URL。建议使用 navigateTo 代替。

const router = useRouter()

router.back()
router.forward()
router.go(3)
router.push({ path: "/home" })
router.replace({ hash: "#bio" })

导航守卫

useRouter 组合函数提供了 afterEach、beforeEach 和 beforeResolve 帮助方法，这些方法作为导航守卫。

然而，Nuxt 有一个“路由中间件”的概念，它简化了导航守卫的实现，并提供了更好的开发者体验。

承诺和错误处理

• isReady(): 返回一个Promise，当路由器完成了初始导航后解析。
• onError: 添加一个错误处理器，每当导航期间发生未捕获的错误时调用。

通用路由器实例

如果你没有一个 pages/ 文件夹，那么 useRouter 将会返回一个具有类似帮助方法的通用路由器实例，但是请注意，不是所有功能都可能被支持，或者以与 vue-router 完全相同的方式表现。