定义和使用组件间关系

有时需要实现这样的组件:

  1. <custom-ul>
  2. <custom-li>item 1</custom-li>
  3. <custom-li>item 2</custom-li>
  4. </custom-ul>

这个例子中, custom-ulcustom-li 都是自定义组件,它们有相互间的关系,相互间的通信往往比较复杂。此时在组件定义时加入 relations 定义段,可以解决这样的问题。示例:

在开发者工具中预览效果

  1. // path/to/custom-ul.js
  2. Component({
  3. relations: {
  4. './custom-li': {
  5. type: 'child', // 关联的目标节点应为子节点
  6. linked(target) {
  7. // 每次有custom-li被插入时执行,target是该节点实例对象,触发在该节点attached生命周期之后
  8. },
  9. linkChanged(target) {
  10. // 每次有custom-li被移动后执行,target是该节点实例对象,触发在该节点moved生命周期之后
  11. },
  12. unlinked(target) {
  13. // 每次有custom-li被移除时执行,target是该节点实例对象,触发在该节点detached生命周期之后
  14. }
  15. }
  16. },
  17. methods: {
  18. _getAllLi() {
  19. // 使用getRelationNodes可以获得nodes数组,包含所有已关联的custom-li,且是有序的
  20. const nodes = this.getRelationNodes('path/to/custom-li')
  21. }
  22. },
  23. ready() {
  24. this._getAllLi()
  25. }
  26. })
  1. // path/to/custom-li.js
  2. Component({
  3. relations: {
  4. './custom-ul': {
  5. type: 'parent', // 关联的目标节点应为父节点
  6. linked(target) {
  7. // 每次被插入到custom-ul时执行,target是custom-ul节点实例对象,触发在attached生命周期之后
  8. },
  9. linkChanged(target) {
  10. // 每次被移动后执行,target是custom-ul节点实例对象,触发在moved生命周期之后
  11. },
  12. unlinked(target) {
  13. // 每次被移除时执行,target是custom-ul节点实例对象,触发在detached生命周期之后
  14. }
  15. }
  16. }
  17. })

注意:必须在两个组件定义中都加入relations定义,否则不会生效。

关联一类组件

在开发者工具中预览效果

有时,需要关联的是一类组件,如:

  1. <custom-form>
  2. <view>
  3. input
  4. <custom-input></custom-input>
  5. </view>
  6. <custom-submit>submit</custom-submit>
  7. </custom-form>

custom-form 组件想要关联 custom-inputcustom-submit 两个组件。此时,如果这两个组件都有同一个behavior:

  1. // path/to/custom-form-controls.js
  2. module.exports = Behavior({
  3. // ...
  4. })
  1. // path/to/custom-input.js
  2. const customFormControls = require('./custom-form-controls')
  3. Component({
  4. behaviors: [customFormControls],
  5. relations: {
  6. './custom-form': {
  7. type: 'ancestor', // 关联的目标节点应为祖先节点
  8. }
  9. }
  10. })
  1. // path/to/custom-submit.js
  2. const customFormControls = require('./custom-form-controls')
  3. Component({
  4. behaviors: [customFormControls],
  5. relations: {
  6. './custom-form': {
  7. type: 'ancestor', // 关联的目标节点应为祖先节点
  8. }
  9. }
  10. })

则在 relations 关系定义中,可使用这个behavior来代替组件路径作为关联的目标节点:

  1. // path/to/custom-form.js
  2. const customFormControls = require('./custom-form-controls')
  3. Component({
  4. relations: {
  5. customFormControls: {
  6. type: 'descendant', // 关联的目标节点应为子孙节点
  7. target: customFormControls
  8. }
  9. }
  10. })

relations 定义段

relations 定义段包含目标组件路径及其对应选项,可包含的选项见下表。

选项 类型 是否必填 描述
type String 目标组件的相对关系,可选的值为 parentchildancestordescendant
linked Function 关系生命周期函数,当关系被建立在页面节点树中时触发,触发时机在组件attached生命周期之后
linkChanged Function 关系生命周期函数,当关系在页面节点树中发生改变时触发,触发时机在组件moved生命周期之后
unlinked Function 关系生命周期函数,当关系脱离页面节点树时触发,触发时机在组件detached生命周期之后
target String 如果这一项被设置,则它表示关联的目标节点所应具有的behavior,所有拥有这一behavior的组件节点都会被关联

原文:

https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/relations.html