字節(jié)跳動小程序開發(fā)框架 組件間通信與事件

組件間通信

組件間的基本通信方式有以下幾種。

• ttml/wxml 數(shù)據(jù)綁定：用于父組件向子組件的指定屬性設(shè)置數(shù)據(jù)，僅能設(shè)置 json 兼容數(shù)據(jù)
• 事件：用于子組件向父組件傳遞數(shù)據(jù)，可以傳遞任意數(shù)據(jù)。

監(jiān)聽事件

事件系統(tǒng)是組件間通信的主要方式之一。自定義組件可以觸發(fā)任意的事件，引用組件的頁面可以監(jiān)聽這些事件。關(guān)于事件的基本概念和用法，參見 事件 。

監(jiān)聽自定義組件事件的方法與監(jiān)聽基礎(chǔ)組件事件的方法完全一致：

<!-- 當(dāng)自定義組件觸發(fā) myevent 事件時，調(diào)用“onMyEvent”方法 -->
<my-component bindmyevent="onMyEvent" />
<!-- 或者可以寫成 -->
<my-component bind:myevent="onMyEvent" />

Page({
  onMyEvent(e) {
    // 自定義組件觸發(fā)事件時提供的detail對象
    console.log(e.detail);
  }
})

觸發(fā)事件

自定義組件觸發(fā)事件時，需要使用 triggerEvent 方法，指定事件名、detail 對象和事件選項：

代碼示例

<!-- 在自定義組件中 -->
<button bindtap="onTap">點擊這個按鈕將觸發(fā) myevent 事件</button>

Component({
  properties: {}
  methods: {
    onTap() {
      var myEventDetail = {} // detail對象，提供給事件監(jiān)聽函數(shù)
      var myEventOption = {} // 觸發(fā)事件的選項

      this.triggerEvent(
        'myevent',
        myEventDetail,
        myEventOption
      )
    }
  }
})

觸發(fā)事件的選項包括：

關(guān)于冒泡和捕獲階段的概念，請閱讀 事件 章節(jié)中的相關(guān)說明。

代碼示例

頁面 page.ttml 中:

<another-component bindcustomevent="pageEventListener1">
  <my-component bindcustomevent="pageEventListener2"></my-component>
</another-component>

組件 another-component.ttml 中:

<view bindcustomevent="anotherEventListener">
  <slot />
</view>

組件 my-component.ttml 中:

<view bindcustomevent="myEventListener">
  <slot />
</view>

組件代碼中:

// 組件 my-component.js
Component({
  methods: {
    onTap: function(){
      // 只會觸發(fā) pageEventListener2
      this.triggerEvent('customevent', {})

      // 會依次觸發(fā) pageEventListener2 、 pageEventListener1
      this.triggerEvent('customevent', {}, { bubbles: true })

      // 會依次觸發(fā) pageEventListener2 、 anotherEventListener 、 pageEventListener1
      this.triggerEvent('customevent', {}, { bubbles: true, composed: true })
    }
  }
})