分类： 基础

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)

wx.onBeforePageLoad(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

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

示例代码

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

wx.onBeforePageUnload(function listener)

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

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

微信 鸿蒙 OS 版：支持

功能描述

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

参数

function listener

路由事件的监听函数

参数

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

示例代码

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

wx.offAppHide(function listener)

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

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

移除微信小程序切后台事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offAppShow(function listener)

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

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

移除微信小程序切前台事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offAudioInterruptionBegin(function listener)

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

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

微信 Windows 版：支持

微信 Mac 版：支持

功能描述

移除音频因为受到系统占用而被中断开始事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offAudioInterruptionEnd(function listener)

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

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

微信 Windows 版：支持

微信 Mac 版：支持

功能描述

移除音频中断结束事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offError(function listener)

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

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

移除微信小程序错误事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offLazyLoadError(function listener)

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

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 分包异步化

功能描述

移除微信小程序异步组件加载失败事件的监听函数

参数

function listener

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

示例代码

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

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

wx.offPageNotFound(function listener)

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

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

移除微信小程序要打开的页面不存在事件的监听函数

参数

function listener

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

示例代码

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

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