useRouter

源文件
useRouter 可组合函数返回路由器实例。
app/pages/index.vue
<script setup lang="ts">
const router = useRouter()
</script>

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

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

如果你拥有 app/pages/ 目录，useRouter 的行为与 vue-router 提供的实例完全相同。

请阅读 vue-router 关于 Router 接口的文档。

基础操作

  • addRoute()：向路由器实例添加新路由。可以提供 parentName 将新路由添加为现有路由的子路由。
  • removeRoute()：通过名称删除现有路由。
  • getRoutes()：获取所有路由记录的完整列表。
  • hasRoute()：检查是否存在指定名称的路由。
  • resolve()：返回路由位置的规范化版本。它还包含一个 href 属性，其中包含任何现有的 base 路径。
示例
const router = useRouter()

router.addRoute({ name: 'home', path: '/home', component: Home })
router.removeRoute('home')
router.getRoutes()
router.hasRoute('home')
router.resolve({ name: 'home' })
router.addRoute() 将路由详情添加到路由数组中，这在构建 Nuxt 插件 时非常有用；而 router.push() 则会立即触发新的导航，适用于页面、Vue 组件和可组合函数中。

基于 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' })
阅读更多关于浏览器 History API 的信息。

导航守卫

useRouter 可组合函数提供了 afterEach、beforeEach 和 beforeResolve 辅助方法，它们充当导航守卫。

然而，Nuxt 引入了 路由中间件 (route middleware) 的概念，它简化了导航守卫的实现并提供了更好的开发体验。

在 文档 > 4.x > 目录结构 > App > Middleware 中阅读更多内容。

Promise 和错误处理

  • isReady()：返回一个在路由器完成初始导航时解析的 Promise。
  • onError：添加一个错误处理器，该处理器会在导航过程中每次发生未捕获的错误时被调用。
在Vue Router 文档中了解更多。

通用路由器实例

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