uni.$emit(eventName,OBJECT)

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

属性 类型 描述
eventName String 事件名
OBJECT Object 触发事件携带的附加参数

代码示例

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

uni.$on(eventName,callback)

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

属性 类型 描述
eventName String 事件名
callback Function 事件的回调函数


代码示例**

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

uni.$once(eventName,callback)

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

属性 类型 描述
eventName String 事件名
callback Function 事件的回调函数

代码示例

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

uni.$off([eventName, callback])

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

属性 类型 描述
eventName Array<String> 事件名
callback Function 事件的回调函数

Tips

  • 如果没有提供参数,则移除所有的事件监听器;
  • 如果只提供了事件,则移除该事件所有的监听器;
  • 如果同时提供了事件与回调,则只移除这个回调的监听器;
  • 提供的回调必须跟$on的回调为同一个才能移除这个回调的监听器;

代码示例
$emit$on$off常用于跨页面、跨组件通讯,这里为了方便演示放在同一个页面

  1. <template>
  2. <view class="content">
  3. <view class="data">
  4. <text>{{val}}</text>
  5. </view>
  6. <button type="primary" @click="comunicationOff">结束监听</button>
  7. </view>
  8. </template>
  9. <script>
  10. export default {
  11. data() {
  12. return {
  13. val: 0
  14. }
  15. },
  16. onLoad() {
  17. setInterval(()=>{
  18. uni.$emit('add', {
  19. data: 2
  20. })
  21. },1000)
  22. uni.$on('add', this.add)
  23. },
  24. methods: {
  25. comunicationOff() {
  26. uni.$off('add', this.add)
  27. },
  28. add(e) {
  29. this.val += e.data
  30. }
  31. }
  32. }
  33. </script>
  34. <style>
  35. .content {
  36. display: flex;
  37. flex-direction: column;
  38. align-items: center;
  39. justify-content: center;
  40. }
  41. .data {
  42. text-align: center;
  43. line-height: 40px;
  44. margin-top: 40px;
  45. }
  46. button {
  47. width: 200px;
  48. margin: 20px 0;
  49. }
  50. </style>

注意事项

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