update
uni-simple-router 3.0 版本已发布,欢迎你的使用!

# 编程式及组件式导航

注意

除了使用 uni-app 官方组件导航外 你还可以使用 uni-simple-router 提供的两种方式进行导航。

# 编程式导航

我们可以借助 router 的实例方法,通过编写代码来实现,这个过程叫做编程式导航。

# router.push() 等同于 uni.navigateTo()

注意:在 Vue 实例内部,你可以通过 $Router 访问路由实例。因此你可以调用 this.$Router.push。

想要导航到不同的 URL,则使用 router.push 方法。这个方法会向 history 栈添加一个新的记录,所以,当用户点击浏览器后退按钮时,则回到之前的 URL。

该方法的参数可以是一个字符串路径,或者一个描述地址的对象。例如:

// 字符串
this.$Router.push('/pages/router/router1')

// 对象
this.$Router.push({path:'/pages/router/router1'})

// 命名的路由
this.$Router.push({ name: 'router1', params: { userId: '123' }})

// 带查询参数,变成 /router1?plan=private
this.$Router.push({ path: 'router1', query: { plan: 'private' }})
1
2
3
4
5
6
7
8
9
10
11

注意:如果提供了 path,params 会被忽略,上述例子中的 query 并不属于这种情况。所以字符串时必须是绝对的路径,name 时传递的参数必须为 params,相反 path 必须对应 query。

const userId = '123'
this.$Router.push({ name: 'user', params: { userId }}) // -> /user/123
// 这里的 params 不生效
this.$Router.push({ path: '/user', params: { userId }}) // -> /user
1
2
3
4

# router.replace() 等同于 uni.redirectTo()

router.push 很像,唯一的不同就是,它不会向 history 添加新记录,而是跟它的方法名一样 —— 替换掉当前的 history 记录。

this.$Router.replace(...)
1

# router.replaceAll() 等同于 uni.reLaunch()

router.replace 很像,唯一的不同就是,它不会向 history 添加新记录,而是将所有的页面都关掉,打开一个新的页面。

this.$Router.replaceAll(...)
1

# router.pushTab() 等同于 uni.switchTab()

router.push 很像,打开 uni-app 自带的tab 菜单

注意:router.pushTab 在传递参数的时候 H5 暂时不支持,需要开发者自行处理下,这是官方的一个 bug,后续会修复。不过可以使用此一个变通的方法获取到,临时解决!

this.$Router.pushTab(...)

//变通方法获取参数 H5端
const router = new Router({
    routes:[
        {
          path: "/pages/tabbar/tabbar-4/tabbar-4",
          name: 'tabbar-4',
          H5Params:{
              H5Name:''       //使用一个临时变量来存储
          },
          beforeEnter:(to,from,next)=>{   
              to.H5Params.H5Name=to.query.name
              next();
          }
        },
    ]
})
//获取方式
this.$Route.H5Params.H5Name
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

注意:使用变通方法时可以在临时变量上复制,虽然 this.$Route.query 无法获取到,但是禁用路由守卫时是携带完整参数的,所有可以再此做一些手脚。页面刷新后参数将会丢失。

# router.back(n) 等同于 uni.navigateBack()

这个方法的参数是一个整数,意思是在 history 记录中后退多少步,类似 window.history.go(n)

例子

// 后退 2 步记录
this.$Router.back(2)

// 如果 history 记录不够用,那就默默地失败呗
this.$Router.back(100)
1
2
3
4
5

# 组件式导航 V 1.2.2+

如果你不习惯 编程是导航 ,你也可以通过 组件式导航 进行编写。一个通用的组件 必须在main.js中进行注册。

注意:为了兼容小程序端,所有的组件应该在 mian.js 进行注册才可以。

注册组件:

// main.js
import routerLink from './node_modules/uni-simple-router/component/router-link.vue'
Vue.component('router-link',routerLink)
1
2
3

使用组件:

<!-- 一个简单的name跳转 -->
<router-link to="{name: tabbar-4,params: {name: 'router-link'}}">
  <button type="primary">使用name对象跳转</button>
</router-link>

<!-- 通过path直接跳转 并指定跳转类型 -->
<router-link to="/tabbar-4" navType="pushTab">
  <button type="primary">使用path对象跳转</button>
</router-link>
1
2
3
4
5
6
7
8
9

学习更多配置,请点击这里

# 多模式路由

设置 uni-simple-router 不同模式时,获取的实例对象完全不同。如果选用 完全使用vue-router开发 你应该使用 this.$router 而非 this.$Routerthis.$route 而非 this.$Route。可以查看 vue-router配置学习和制定。脱离 uni-app 配置时 uni-app 的所有生命周期及其他都会失效。请注意!