router.addRouteBuilder(string routeType, function routeBuilder)

微信小程序插件:不支持

相关文档: 自定义路由

功能描述

添加自定义路由配置

参数

string routeType

路由类型

function routeBuilder

路由动画定义函数

自定义路由示例

在开发者工具中预览效果

// 定义自定义效果,从右侧推入
const slideRouteBuilder = (customRouteContext) => {
  const { primaryAnimation } = customRouteContext
  const handlePrimaryAnimation = () => {
    'worklet'
    const transX = windowWidth * (1 - primaryAnimation.value)
       return {
           transform: `translateX(${transX}px)`,
       }
  }
  return {
    handlePrimaryAnimation
  }
}

wx.router.addRouteBuilder('slide', slideRouteBuilder)

// 使用自定义路由
wx.navigateTo({
  url: 'xxx',
  routeType: 'slide'
})

wx.router

基础库 2.29.2 开始支持,低版本需做兼容处理。

相关文档: 自定义路由

router 对象,可以通过 wx.router 获取。

方法

router.addRouteBuilder(string routeType, CustomRouteBuilder routeBuilder)

添加自定义路由配置

router.removeRouteBuilder(string routeType)

移除自定义路由配置

router.getRouteContext(Object this)

获取页面对应的自定义路由上下文对象

EventChannel

基础库 2.7.3 开始支持,低版本需做兼容处理。

页面间事件通信通道

方法

EventChannel.emit(string eventName, any args)

触发一个事件

EventChannel.on(string eventName, EventCallback fn)

持续监听一个事件

EventChannel.once(string eventName, EventCallback fn)

监听一个事件一次,触发后失效

EventChannel.off(string eventName, EventCallback fn)

取消监听一个事件。给出第二个参数时,只取消给出的监听函数,否则取消所有监听函数

wx.navigateBack(Object object)

以 Promise 风格 调用:支持

需要页面权限:当前是插件页面时,宿主微信小程序不能调用该接口,反之亦然

微信小程序插件:支持,需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时,只能在当前插件的页面中调用

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

功能描述

关闭当前页面,返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈,决定需要返回几层。

参数

Object object

属性 类型 默认值 必填 说明
delta number 1 返回的页面数,如果 delta 大于现有页面数,则返回到页面栈中只剩一个页面为止。
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
})