• uni.$emit(eventName,OBJECT)
  • uni.$on(eventName,callback)
  • uni.$once(eventName,callback)
  • uni.$off([eventName, callback])

    自 HBuilderX 2.0.0 起自定义组件编译模式支持,使用指南

    uni.$emit(eventName,OBJECT)

    触发全局的自定事件。附加参数都会传给监听器回调。

    属性类型描述
    eventNameString事件名
    OBJECTObject触发事件携带的附加参数

    代码示例

    1. uni.$emit('update',{msg:'页面更新'})

    uni.$on(eventName,callback)

    监听全局的自定义事件。事件可以由 uni.$emit 触发,回调函数会接收所有传入事件触发函数的额外参数。

    属性类型描述
    eventNameString事件名
    callbackFunction事件的回调函数

    代码示例

    1. uni.$on('update',function(data){
    2. console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    3. })

    uni.$once(eventName,callback)

    监听全局的自定义事件。事件可以由 uni.$emit 触发,但是只触发一次,在第一次触发之后移除监听器。

    属性类型描述
    eventNameString事件名
    callbackFunction事件的回调函数

    代码示例

    1. uni.$once('update',function(data){
    2. console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    3. })

    uni.$off([eventName, callback])

    移除全局自定义事件监听器。

    属性类型描述
    eventNameArray<String>事件名
    callbackFunction事件的回调函数

    Tips

    • 如果没有提供参数,则移除所有的事件监听器;
    • 如果只提供了事件,则移除该事件所有的监听器;
    • 如果同时提供了事件与回调,则只移除这个回调的监听器;代码示例
    1. uni.$off('update',function(data){
    2. console.log('移除 update 自定义事件');
    3. })

    注意事项

    • uni.$emit、 uni.$on 、 uni.$once 、uni.$off 触发的事件都是 App 全局级别的,跨任意组件,页面,nvue,vue 等
    • 使用时,注意及时销毁事件监听,比如,页面 onLoad 里边 uni.$on 注册监听,onUnload 里边 uni.$off 移除,或者一次性的事件,直接使用 uni.$once 监听

    发现错误?想参与编辑?在 GitHub 上编辑此页面!