ArkTS学习笔记_封装复用之@builderParam装饰器
- 作用:
在自定义组件中,该装饰器用于装饰函数成员变量,@builderParam装饰的函数成员变量的值必须是经过@builder装饰的方法。变量初始化后可以在自定义组件内调用。 - 初始化:
可以使用自定义组件的自定义构建函数进行初始化;也可以使用全局自定义构建函数初始化。初始化的工作一般由使用者进行。 - 运用场景:
比方,封装了一个组件,这个组件有一个对外的回调函数(@builderParam装饰的函数变量),当想让调用者添加额外的新功能时,可以实现其回调函数(初始化@builderParam装饰的函数变量)。 - 简单的说:
@builderParam装饰器用于声明一个的成员函数变量,相当于在自定义组件中添加了一个占位符,调用该函数的地方就是占位的地方,当开发者调用该自定义组件时,想添加新的UI描述,就初始化即可,不需要添加新的U描述,可以不初始化。有点类似有容器功能的组件,可以让调用者往里添加新组件。
装饰器使用说明
- 使用组件自身的自定义构建函数或者全局的自定义构建函数
javascript
// 全局构建函数
@Builder function overBuilder() {}
@Component
struct Child {
// 组件自定义构建函数
@Builder doNothingBuilder() {};
// 使用自定义组件的自定义构建函数初始化@BuilderParam
@BuilderParam customBuilderParam: () => void = this.doNothingBuilder;
// 使用全局自定义构建函数初始化@BuilderParam
@BuilderParam customOverBuilderParam: () => void = overBuilder;
build(){}
}
- 用父组件自定义的构建函数初始化子组件@BuilderParam装饰的方法。
javascript
@Component
struct Child {
// 声明一个@BuilderParam函数变量
@BuilderParam customBuilderParam: () => void;
build() {
Column() {
// 占位的地方,会在此构建外面传进来的组件
this.customBuilderParam()
}
}
}
@Entry
@Component
struct Parent {
// 组件自定义构建函数
@Builder componentBuilder() {
Text(`Parent builder `)
}
build() {
Column() {
// 使用父组件的构建函数初始化子组件的@BuilderParam函数变量
Child({ customBuilderParam: this.componentBuilder })
}
}
}