小程序——API(路由)

总结

  • navigateTo, redirectTo 只能打开非 tabBar 页面。
  • switchTab 只能打开 tabBar 页面。
  • reLaunch 可以打开任意页面。
  • 页面底部的 tabBar 由页面决定,即只要是定义为 tabBar 的页面,底部都有 tabBar。
  • switchTab的url不能携带参数,reLaunch,redirectTo,navigateTo的url均可携带参数
  • 调用页面路由带的参数可以在目标页面的onLoad中获取。
  • navigateTo可以使用event参数实现监听被打开页面发送到当前页面的数据
  • navigateBack可以使用delta参数设置回到哪一级页面,默认1,当设置的数字大于现有页面数,会直接返回首页

1. wx.switchTab(Object object)

作用:跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面
参数:
  • url:string,必须,需要跳转的 tabBar 页面的路径 (代码包路径)(需在 app.json 的tabBar字段定义的页面),路径后不能带参数
  • success:function,接口调用成功的回调函数
  • fail:function,接口调用失败的回调函数
  • complete:function,接口调用结束的回调函数(调用成功、失败都会执行)

2. wx.reLaunch(Object object)

作用:关闭所有页面,打开到应用内的某个页面
参数:
  • url:string,必须,需要跳转的应用内页面路径 (代码包路径),路径后可以带参数。参数与路径之间使用?分隔,参数键与参数值用=相连,不同参数用&分隔;如 'path?key=value&key2=value2'
  • success:function,接口调用成功的回调函数
  • fail:function,接口调用失败的回调函数
  • complete:function,接口调用结束的回调函数(调用成功、失败都会执行)
wx.reLaunch({
  url: 'test?id=1'
})

3. wx.redirectTo(Object object)

作用:关闭当前页面,跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
参数:
  • url:string,必须,需要跳转的应用内非 tabBar 的页面的路径 (代码包路径), 路径后可以带参数。参数与路径之间使用 ? 分隔,参数键与参数值用 = 相连,不同参数用 & 分隔;如 'path?key=value&key2=value2'
  • success:function,接口调用成功的回调函数
  • fail:function,接口调用失败的回调函数
  • complete:function,接口调用结束的回调函数(调用成功、失败都会执行)

4. wx.navigateTo(Object object)

作用:
  • 保留当前页面,跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用wx.navigateBack可以返回到原页面
  • 小程序中页面栈最多十层。
参数:
  • url:string,必须,需要跳转的应用内非 tabBar 的页面的路径 (代码包路径), 路径后可以带参数。参数与路径之间使用 ? 分隔,参数键与参数值用 = 相连,不同参数用 & 分隔;如 'path?key=value&key2=value2'
  • events:Object,页面间通信接口,用于监听被打开页面发送到当前页面的数据。基础库 2.7.3 开始支持。
  • success:function,接口调用成功的回调函数
  • fail:function,接口调用失败的回调函数
  • complete:function,接口调用结束的回调函数(调用成功、失败都会执行)
object.success 回调函数:
  • 参数:eventChannel,用于和被打开页面进行通信
示例
wx.navigateTo({
  url: 'test?id=1',
  events: {
    // 为指定事件添加一个监听器,获取被打开页面传送到当前页面的数据
    acceptDataFromOpenedPage: function(data) {
      console.log(data)
    },
    someEvent: function(data) {
      console.log(data)
    }
    ...
  },
  success: function(res) {
    // 通过eventChannel向被打开页面传送数据
    res.eventChannel.emit('acceptDataFromOpenerPage', { data: 'test' })
  }
})
//test.js
Page({
  onLoad: function(option){
    console.log(option.query)
    const eventChannel = this.getOpenerEventChannel()
    eventChannel.emit('acceptDataFromOpenedPage', {data: 'test'});
    eventChannel.emit('someEvent', {data: 'test'});
    // 监听acceptDataFromOpenerPage事件,获取上一页面通过eventChannel传送到当前页面的数据
    eventChannel.on('acceptDataFromOpenerPage', function(data) {
      console.log(data)
    })
  }
})

5. wx.navigateBack(Object object)

作用:
  • 关闭当前页面,返回上一页面或多级页面,可通过 getCurrentPages 获取当前的页面栈,决定需要返回几层。
参数:
  • delta:number,默认值是1,关闭当前页面,返回上一页面或多级页面。可通过 getCurrentPages获取当前的页面栈,决定需要返回几层。
  • success:function,接口调用成功的回调函数
  • fail:function,接口调用失败的回调函数
  • complete:function,接口调用结束的回调函数(调用成功、失败都会执行)
示例
// 注意:调用 navigateTo 跳转时,调用该方法的页面会被加入堆栈,而 redirectTo 方法则不会。见下方示例代码

// 此处是A页面
wx.navigateTo({
  url: 'B?id=1'
})

// 此处是B页面
wx.navigateTo({
  url: 'C?id=1'
})

// 在C页面内 navigateBack,将返回A页面
wx.navigateBack({
  delta: 2
})

6. EventChannel:页面间事件通信通道

  • EventChannel.emit(事件名, 事件参数):触发一个事件
  • EventChannel.off(事件名, 事件监听函数(触发事件参数)):取消监听一个事件。给出第二个参数时,只取消给出的监听函数,否则取消所有监听函数
  • EventChannel.on(事件名, 事件监听函数(触发事件参数)):持续监听一个事件
  • EventChannel.once(事件名, 事件监听函数(触发事件参数)):监听一个事件一次,触发后失效
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。