useRouter
useRouter 组合式函数返回路由器实例。
pages/index.vue
const router = useRouter()
如果您只需要在模板中使用路由器实例,请使用 $router
:
pages/index.vue
<template>
<button @click="$router.back()">返回</button>
</template>
如果您有一个 pages/
目录,useRouter
的行为与 vue-router
提供的相同。
基本操作
addRoute()
: 向路由器实例添加新路由。可以提供parentName
以将新路由作为现有路由的子路由添加。removeRoute()
: 通过名称删除现有路由。getRoutes()
: 获取所有路由记录的完整列表。hasRoute()
: 检查是否存在具有给定名称的路由。resolve()
: 返回路由位置的规范化版本。还包括一个包含任何现有基址的href
属性。
Example
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 组件和组合式函数中很有用。
基于历史记录 API
back()
: 如果可能,返回历史记录,与router.go(-1)
相同。forward()
: 如果可能,前进历史记录,与router.go(1)
相同。go()
: 在历史记录中前进或后退,而不受router.back()
和router.forward()
中的层次限制。push()
: 通过在历史记录堆栈中推送一个条目以编程方式导航到新 URL。建议使用navigateTo
代替。replace()
: 通过替换路由历史记录堆栈中的当前条目以编程方式导航到新 URL。建议使用navigateTo
代替。
Example
const router = useRouter()
router.back()
router.forward()
router.go(3)
router.push({ path: "/home" })
router.replace({ hash: "#bio" })
导航守卫
useRouter
组合式函数提供了 afterEach
、beforeEach
和 beforeResolve
辅助方法,作为导航守卫。
然而,Nuxt 有一个 路由中间件 的概念,它简化了导航守卫的实现,并提供了更好的开发者体验。
另请参阅 guide > directory-structure > middlewarePromise 和错误处理
另请参阅 Vue Router Docs通用路由器实例
如果您没有 pages/
文件夹,那么 useRouter
将返回一个具有类似辅助方法的通用路由器实例,但请注意,并非所有功能都可能被支持或与 vue-router
的行为完全相同。