微信小程序 組件間通信與事件

組件間通信與事件

組件間通信

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

• WXML 數據綁定：用于父組件向子組件的指定屬性設置數據，僅能設置 JSON 兼容數據（自基礎庫版本 2.0.9 開始，還可以在數據中包含函數）。具體在 組件模板和樣式 章節(jié)中介紹。
• 事件：用于子組件向父組件傳遞數據，可以傳遞任意數據。
• 如果以上兩種方式不足以滿足需要，父組件還可以通過 this.selectComponent 方法獲取子組件實例對象，這樣就可以直接訪問組件的任意數據和方法。

監(jiān)聽事件

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

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

代碼示例：

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

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

觸發(fā)事件

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

代碼示例：

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

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

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

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

代碼示例：

在開發(fā)者工具中預覽效果

// 頁面 page.wxml
<another-component bindcustomevent="pageEventListener1">
  <my-component bindcustomevent="pageEventListener2"></my-component>
</another-component>

// 組件 another-component.wxml
<view bindcustomevent="anotherEventListener">
  <slot />
</view>

// 組件 my-component.wxml
<view bindcustomevent="myEventListener">
  <slot />
</view>

// 組件 my-component.js
Component({
  methods: {
    onTap: function(){
      this.triggerEvent('customevent', {}) // 只會觸發(fā) pageEventListener2
      this.triggerEvent('customevent', {}, { bubbles: true }) // 會依次觸發(fā) pageEventListener2 、 pageEventListener1
      this.triggerEvent('customevent', {}, { bubbles: true, composed: true }) // 會依次觸發(fā) pageEventListener2 、 anotherEventListener 、 pageEventListener1
    }
  }
})

獲取組件實例

可在父組件里調用 this.selectComponent ，獲取子組件的實例對象。（插件的自定義組件將返回 null）

調用時需要傳入一個匹配選擇器 selector，如：this.selectComponent(".my-component")。

selector 詳細語法可查看 selector 語法參考文檔。

代碼示例：

// 父組件
Page({
  data: {},
  getChildComponent: function () {
    const child = this.selectComponent('.my-component');
    console.log(child)
  }
})

在上例中，父組件將會獲取 class 為 my-component 的子組件實例對象，即子組件的 this 。

若需要自定義 selectComponent 返回的數據，可使用內置 behavior: wx://component-export

從基礎庫版本 2.2.3 開始提供支持。

使自定義組件中支持 export 定義段，這個定義段可以用于指定組件被 selectComponent 調用時的返回值。

代碼示例：

// 自定義組件 my-component 內部
Component({
  behaviors: ['wx://component-export'],
  export() {
    return { myField: 'myValue' }
  }
})

<!-- 使用自定義組件時 -->
<my-component id="the-id" />

// 父組件調用
const child = this.selectComponent('#the-id') // 等于 { myField: 'myValue' }

在上例中，父組件獲取 id 為 the-id 的子組件實例的時候，得到的是對象 { myField: 'myValue' } 。