组件间通信与事件

组件间通信

组件间的基本通信方式有以下几种。

  • WXML 数据绑定：用于父组件向子组件的指定属性设置数据，仅能设置 JSON 兼容数据（自基础库版本 2.0.9 开始，还可以在数据中包含函数）。具体在 组件模板和样式 章节中介绍。
  • 事件：用于子组件向父组件传递数据，可以传递任意数据。
  • 如果以上两种方式不足以满足需要，父组件还可以通过 this.selectComponent 方法获取子组件实例对象，这样就可以直接访问组件的任意数据和方法。

监听事件

事件系统是组件间通信的主要方式之一。自定义组件可以触发任意的事件，引用组件的页面可以监听这些事件。关于事件的基本概念和用法，参见 事件 。

监听自定义组件事件的方法与监听基础组件事件的方法完全一致：

代码示例：

  1. <!-- 当自定义组件触发“myevent”事件时，调用“onMyEvent”方法 -->
  2. <component-tag-name bindmyevent="onMyEvent" />
  3. <!-- 或者可以写成 -->
  4. <component-tag-name bind:myevent="onMyEvent" />
  1. Page({
  2.   onMyEvent: function(e){
  3.     e.detail // 自定义组件触发事件时提供的detail对象
  4.   }
  5. })

触发事件

自定义组件触发事件时，需要使用 triggerEvent 方法，指定事件名、detail对象和事件选项：

代码示例：

在开发者工具中预览效果

  1. <!-- 在自定义组件中 -->
  2. <button bindtap="onTap">点击这个按钮将触发“myevent”事件</button>
  1. Component({
  2.   properties: {},
  3.   methods: {
  4.     onTap: function(){
  5.       var myEventDetail = {} // detail对象，提供给事件监听函数
  6.       var myEventOption = {} // 触发事件的选项
  7.       this.triggerEvent('myevent', myEventDetail, myEventOption)
  8.     }
  9.   }
  10. })

触发事件的选项包括：

选项名类型是否必填默认值描述
bubblesBoolean否false事件是否冒泡
composedBoolean否false事件是否可以穿越组件边界，为false时，事件将只能在引用组件的节点树上触发，不进入其他任何组件内部
capturePhaseBoolean否false事件是否拥有捕获阶段

关于冒泡和捕获阶段的概念，请阅读 事件 章节中的相关说明。

代码示例：

在开发者工具中预览效果

  1. // 页面 page.wxml
  2. <another-component bindcustomevent="pageEventListener1">
  3.   <my-component bindcustomevent="pageEventListener2"></my-component>
  4. </another-component>
  1. // 组件 another-component.wxml
  2. <view bindcustomevent="anotherEventListener">
  3.   <slot />
  4. </view>
  1. // 组件 my-component.wxml
  2. <view bindcustomevent="myEventListener">
  3.   <slot />
  4. </view>
  1. // 组件 my-component.js
  2. Component({
  3.   methods: {
  4.     onTap: function(){
  5.       this.triggerEvent('customevent', {}) // 只会触发 pageEventListener2
  6.       this.triggerEvent('customevent', {}, { bubbles: true }) // 会依次触发 pageEventListener2 、 pageEventListener1
  7.       this.triggerEvent('customevent', {}, { bubbles: true, composed: true }) // 会依次触发 pageEventListener2 、 anotherEventListener 、 pageEventListener1
  8.     }
  9.   }
  10. })