分类： API

wx.offAppRoute(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

移除路由事件的监听函数

参数

function listener

onAppRoute 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onAppRoute(listener)
wx.offAppRoute(listener) // 需传入与监听时同一个的函数对象

wx.offAppRouteDone(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

移除当前路由动画执行完成的事件的监听函数

参数

function listener

onAppRouteDone 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onAppRouteDone(listener)
wx.offAppRouteDone(listener) // 需传入与监听时同一个的函数对象

wx.offBeforeAppRoute(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

移除路由事件的监听函数

参数

function listener

onBeforeAppRoute 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onBeforeAppRoute(listener)
wx.offBeforeAppRoute(listener) // 需传入与监听时同一个的函数对象

wx.offBeforePageLoad(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

移除路由事件的监听函数

参数

function listener

onBeforePageLoad 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onBeforePageLoad(listener)
wx.offBeforePageLoad(listener) // 需传入与监听时同一个的函数对象

wx.offBeforePageUnload(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

移除路由事件的监听函数

参数

function listener

onBeforePageUnload 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function (res) { console.log(res) }

wx.onBeforePageUnload(listener)
wx.offBeforePageUnload(listener) // 需传入与监听时同一个的函数对象

wx.onAfterPageLoad(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

监听路由事件引起新的页面实例化时，页面实例化完成的事件监听，详见 页面路由监听。

参数

function listener

路由事件的监听函数

参数

Object res
属性 类型 说明
path string 页面路径
query Object 路由参数
componentFramework string 组件框架
合法值 说明
exparser 旧版微信小程序组件框架
glass-easel 新版微信小程序组件框架
openType string 路由打开类型
routeEventId string 路由事件 id
page Object 页面实例

新旧版本微信小程序组件框架的说明详见：glass-easel：新版微信小程序组件框架

示例代码

const func = function (res) {
  console.log(res)
}
wx.onAfterPageLoad(func)
// 取消监听
wx.offAfterPageLoad(func)

wx.onAfterPageUnload(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

监听路由事件引起现有页面实例销毁时，页面实例销毁后的事件监听，详见 页面路由监听。

参数

function listener

路由事件的监听函数

参数

Object res
属性 类型 说明
path string 页面路径
routeEventId string 路由事件 id

示例代码

const func = function (res) {
  console.log(res)
}
wx.onAfterPageUnload(func)
// 取消监听
wx.offAfterPageUnload(func)

wx.onAppRoute(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

监听路由事件下发后，执行路由逻辑后的事件监听，详见 页面路由监听。

参数

function listener

路由事件的监听函数

参数

Object res
属性 类型 说明
path string 页面路径
query Object 路由参数
renderer string 渲染引擎
合法值 说明
webview Webview 渲染引擎
skyline Skyline 渲染引擎
xr-frame xr-frame 解决方案
openType string 路由打开类型
webviewId number 当前页面 id
timeStamp number 路由下发的时间戳
routeEventId string 路由事件 id
pipMode string
合法值 说明
min 视频页面缩小为小窗
max 视频小窗还原为页面
notFound boolean 是否未找到页面
page Object 当前打开页面的相关配置

Skyline 渲染引擎相关说明：详情 xr-frame 解决方案相关说明：详情

注意

在低于 3.5.5 版本的基础库中也存在此接口，但参数可能与当前文档不同，请注意。

示例代码

const func = function (res) {
  console.log(res)
}
wx.onAppRoute(func)
// 取消监听
wx.offAppRoute(func)

wx.onAppRouteDone(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

监听当前路由动画执行完成的事件，详见页面路由监听。

参数

function listener

当前路由动画执行完成的事件的监听函数

参数

Object res
属性 类型 说明
path string 页面路径
query Object 路由参数
openType string 路由打开类型
webviewId number 当前页面 id
timeStamp number 路由下发的时间戳
routeEventId string 路由事件 id

注意

在低于 3.5.5 版本的基础库中也存在此接口，但参数可能与当前文档不同，请注意。

示例代码

const func = function (res) {
  console.log(res)
}
wx.onAppRouteDone(func)
// 取消监听
wx.offAppRouteDone(func)

wx.onBeforeAppRoute(function listener)

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

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.5.5

微信 鸿蒙 OS 版：支持

功能描述

监听路由事件下发后，执行路由逻辑前的事件监听，详见 页面路由监听。

参数

function listener

路由事件的监听函数

参数

Object res
属性 类型 说明
path string 页面路径
query Object 路由参数
renderer string 渲染引擎
合法值 说明
webview Webview 渲染引擎
skyline Skyline 渲染引擎
xr-frame xr-frame 解决方案
openType string 路由打开类型
webviewId number 当前页面 id
routeEventId string 路由事件 id
pipMode string
合法值 说明
min 视频页面缩小为小窗
max 视频小窗还原为页面
notFound boolean 是否未找到页面
page Object 当前打开页面的相关配置

Skyline 渲染引擎相关说明：详情 xr-frame 解决方案相关说明：详情

示例代码

const func = function (res) {
  console.log(res)
}
wx.onBeforeAppRoute(func)
// 取消监听
wx.offBeforeAppRoute(func)