title: EventChannel

sidebar_label: EventChannel

页面间事件通信通道

支持情况：EventChannel - 图1 EventChannel - 图2 EventChannel - 图3

参考文档

方法

emit

触发一个事件

支持情况：EventChannel - 图4 EventChannel - 图5 EventChannel - 图6

参考文档

  1. (eventName: string, ...args: any) => void
参数 类型 说明
eventName string 事件名称
args any 事件参数

on

持续监听一个事件

支持情况：EventChannel - 图7 EventChannel - 图8 EventChannel - 图9

参考文档

  1. (eventName: string, fn: TaroGeneral.EventCallback) => void
参数 类型 说明
eventName string 事件名称
fn TaroGeneral.EventCallback 事件监听函数

once

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

支持情况：EventChannel - 图10 EventChannel - 图11 EventChannel - 图12

参考文档

  1. (eventName: string, fn: TaroGeneral.EventCallback) => void
参数 类型 说明
eventName string 事件名称
fn TaroGeneral.EventCallback 事件监听函数

off

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

支持情况：EventChannel - 图13 EventChannel - 图14 EventChannel - 图15

参考文档

  1. (eventName: string, fn: TaroGeneral.EventCallback) => void
参数 类型 说明
eventName string 事件名称
fn TaroGeneral.EventCallback 事件监听函数

API 支持度

API 微信小程序 H5 React Native
EventChannel ✔️
EventChannel.emit ✔️
EventChannel.on ✔️
EventChannel.once ✔️
EventChannel.off ✔️