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 有一个 路由中间件 的概念，它简化了导航守卫的实现，并提供了更好的开发人员体验。

Promise 和错误处理

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

通用路由器实例

如果没有 pages/ 文件夹，那么 useRouter 将返回一个具有类似辅助方法的通用路由器实例，但请注意，并非所有功能都可能被支持或行为方式与 vue-router 完全相同。