当开发者创建了自定义组件,并想对该组件添加特定功能时,例如在自定义组件中添加一个点击跳转操作。若直接在组件内嵌入事件方法,将会导致所有引入该自定义组件的地方均增加了该功能。为解决此问题,ArkUI引入了@BuilderParam装饰器,@BuilderParam用来装饰指向@Builder方法的变量,开发者可在初始化自定义组件时对此属性进行赋值,为自定义组件增加特定的功能。该装饰器用于声明任意UI描述的一个元素,类似slot占位符。
说明:
从API version 9开始,该装饰器支持在ArkTS卡片中使用。
装饰器使用说明
初始化@BuilderParam装饰的方法
@BuildParam装饰的方法只能被自定义构建函数(@Builder装饰的方法)初始化。
● 使用所属自定义组件的自定义构建函数或者全局的自定义构建函数,在本地初始化@BuilderParam。
1 2 3 4 5 6 7 8 9 10 | @Builder function GlobalBuilder0() {} @Component struct Child { @Builder doNothingBuilder() {}; @BuilderParam aBuilder0: () => void = this .doNothingBuilder; @BuilderParam aBuilder1: () => void = GlobalBuilder0; build(){} } |
● 用父组件自定义构建函数初始化子组件@BuildParam装饰的方法。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | @Component struct Child { @Builder componentBuilder() { Text(`Parent builder `) } @BuilderParam aBuilder0: () => void = this .componentBuilder; build() { Column() { this .aBuilder0() } } } @Entry @Component struct Parent { @Builder componentBuilder() { Text(`Parent builder `) } build() { Column() { Child({ aBuilder0: this .componentBuilder }) } } } |
● 需注意this指向正确。
以下示例中,Parent组件在调用this.componentBuilder()时,this.label指向其所属组件,即“Parent”。@Builder componentBuilder()传给子组件@BuilderParam aBuilder0,在Child组件中调用this.aBuilder0()时,this.label指向在Child的label,即“Child”。对于@BuilderParam aBuilder1,在将this.componentBuilder传给aBuilder1时,调用bind绑定了this,因此其this.label指向Parent的label。
说明:
开发者谨慎使用bind改变函数调用的上下文,可能会使this指向混乱。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | @Component struct Child { @Builder componentBuilder() { Text(`Child builder `) } label: string = `Child` @BuilderParam aBuilder0: () => void = this .componentBuilder; @BuilderParam aBuilder1: () => void = this .componentBuilder; build() { Column() { this .aBuilder0() this .aBuilder1() } } } @Entry @Component struct Parent { label: string = `Parent` @Builder componentBuilder() { Text(`${ this .label}`) } build() { Column() { this .componentBuilder() Child({ aBuilder0: this .componentBuilder, aBuilder1: this .componentBuilder }) } } } |
使用场景
参数初始化组件
@BuilderParam装饰的方法可以是有参数和无参数的两种形式,需与指向的@Builder方法类型匹配。@BuilderParam装饰的方法类型需要和@Builder方法类型一致。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | class GlobalBuilderParam { label: string = "" } @Builder function GlobalBuilder1($$ : GlobalBuilderParam) { Text($$.label) .width(400) .height(50) .backgroundColor(Color.Blue) } @Component struct Child { @Builder componentBuilder() { Text(`Child builder `) } label: string = 'Child' // 无参数类,指向的componentBuilder也是无参数类型 @BuilderParam aBuilder0: () => void = this .componentBuilder; // 有参数类型,指向的GlobalBuilder1也是有参数类型的方法 @BuilderParam aBuilder1: ($$ : GlobalBuilderParam) => void = this .componentBuilder; build() { Column() { this .aBuilder0() this .aBuilder1({label: 'global Builder label' } ) } } } @Entry @Component struct Parent { label: string = 'Parent' @Builder componentBuilder() { Text(`${ this .label}`) } build() { Column() { this .componentBuilder() Child({ aBuilder0: this .componentBuilder, aBuilder1: GlobalBuilder1 }) } } } |
尾随闭包初始化组件
在自定义组件中使用@BuilderParam装饰的属性时也可通过尾随闭包进行初始化。在初始化自定义组件时,组件后紧跟一个大括号“{}”形成尾随闭包场景。
说明:
此场景下自定义组件内有且仅有一个使用@BuilderParam装饰的属性。
开发者可以将尾随闭包内的内容看做@Builder装饰的函数传给@BuilderParam。示例如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | // xxx.ets class CustomContainerParam { header: string = '' ; } @Component struct CustomContainer { @Builder componentCloser() { Text(`Custom closer `) } @Prop header: string = '' ; @BuilderParam closer: () => void = this .componentCloser; build() { Column() { Text( this .header) .fontSize(30) this .closer() } } } @Builder function specificParam(label1: string , label2: string ) { Column() { Text(label1) .fontSize(30) Text(label2) .fontSize(30) } } @Entry @Component struct CustomContainerUser { @State text: string = 'header' ; param: CustomContainerParam = { header: this .text }; build() { Column() { // 创建CustomContainer,在创建CustomContainer时,通过其后紧跟一个大括号“{}”形成尾随闭包 // 作为传递给子组件CustomContainer @BuilderParam closer: () => void的参数 CustomContainer( this .param) { Column() { specificParam( 'testA' , 'testB' ) }.backgroundColor(Color.Yellow) .onClick(() => { this .text = 'changeHeader' ; }) } } } } |
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· 上周热点回顾(2.17-2.23)
2022-09-27 4步成功将三方库——speexdsp移植到OpenHarmony