目录

如何为自定义组件添加一个控制器

问题现象

在自定义组件中,除通过状态管理装饰器控制UI变化外,能否通过在外部(父组件)使用控制器控制其UI显示?

背景知识

解决方案

实现思路如下:
  • 父组件负责创建子组件控制器实例并触发控制逻辑。
  • 子组件中进行注册和绑定,使得子组件控制器得到子组件实例引用,建立双向通信通道。

    参考示例:父组件初始化时创建共享Scroller和控制器,通过构造函数将Scroller注入控制器,在子组件完成Scroller绑定。

    // 子组件控制器
    class HelloComponentController {
      private helloComponent?: HelloComponent;
      scroller: Scroller = new Scroller();
    
      constructor(scroller: Scroller) {
        this.scroller = scroller;
      }
    
      bindHelloComponentController(helloComponent: HelloComponent) {
        this.helloComponent = helloComponent;
      }
    
      customFunc() {
        this.helloComponent?.customFunc();
      }
    }
    
    @Entry
    @Component
    struct ComponentController {
      scroller: Scroller = new Scroller();
      controller: HelloComponentController = new HelloComponentController(this.scroller);
    
      build() {
        Column() {
          Column() {
            Button('示例: 父组件通过controller控制子组件').onClick(() => {
              // 通过子组件控制器触发子组件滚动
              this.controller?.scroller.scrollTo({ xOffset: 0, yOffset: 200, animation: true });
              // 通过子组件控制器间接调用子组件自定义方法
              this.controller?.customFunc();
            })
              .type(ButtonType.Capsule);
            HelloComponent({ controller: this.controller });
          }
          .height('100%')
          .alignItems(HorizontalAlign.Start);
        };
      }
    }
    
    @Component
    export struct HelloComponent {
      controller?: HelloComponentController;
    
      customFunc() {
        console.info('子组件中自定义方法被调用了');
      }
    
      aboutToAppear(): void {
        // 子组件实例注册到子组件控制器,确保控制器持有子组件实例引用
        this.controller?.bindHelloComponentController(this);
      }
    
      build() {
        Row() {
          Scroll(this.controller?.scroller) {
            Column() {
              ForEach(new Array(5).fill(''), (_: string, index: number) => {
                Row() {
                  Text(index.toString())
                    .fontSize(18);
                }
                .height(200)
                .width('100%')
                .border({ width: 1 })
                .justifyContent(FlexAlign.Center);
              });
            };
          }
          .scrollBar(BarState.Off);
        };
      }
    }