@Extend装饰器:定义扩展组件样式

93 阅读1分钟

在前文的示例中,可以使用@Styles用于样式的扩展,在@Styles的基础上,我们提供了@Extend,用于扩展原生组件样式。

说明

从API version 9开始,该装饰器支持在ArkTS卡片中使用。

从API version 11开始,该装饰器支持在元服务中使用。

装饰器使用说明

语法

@Extend(UIComponentName) function functionName { ... }

使用规则

  • 和@Styles不同,@Extend仅支持在全局定义,不支持在组件内部定义。

说明

只能在当前文件内使用,不支持export

  • 和@Styles不同,@Extend支持封装指定组件的私有属性、私有事件和自身定义的全局方法。

    // @Extend(Text)可以支持Text的私有属性fontColor@Extend(Text) function fancy () {  .fontColor(Color.Red)}// superFancyText可以调用预定义的fancy@Extend(Text) function superFancyText(size:number) {    .fontSize(size)    .fancy()}
    
  • 和@Styles不同,@Extend装饰的方法支持参数,开发者可以在调用时传递参数,调用遵循TS方法传值调用。

    // xxx.ets@Extend(Text) function fancy (fontSize: number) {  .fontColor(Color.Red)  .fontSize(fontSize)}
    @Entry@Componentstruct FancyUse {  build() {    Row({ space: 10 }) {      Text('Fancy')        .fancy(16)      Text('Fancy')        .fancy(24)    }  }}
    
  • @Extend装饰的方法的参数可以为function,作为Event事件的句柄。

    @Extend(Text) function makeMeClick(onClick: () => void) {  .backgroundColor(Color.Blue)  .onClick(onClick)}
    @Entry@Componentstruct FancyUse {  @State label: string = 'Hello World';
      onClickHandler() {    this.label = 'Hello ArkUI';  }
      build() {    Row({ space: 10 }) {      Text(`${this.label}`)        .makeMeClick(() => {this.onClickHandler()})    }  }}
    
  • @Extend的参数可以为状态变量,当状态变量改变时,UI可以正常的被刷新渲染。

    @Extend(Text) function fancy (fontSize: number) {  .fontColor(Color.Red)  .fontSize(fontSize)}
    @Entry@Componentstruct FancyUse {  @State fontSizeValue: number = 20  build() {    Row({ space: 10 }) {      Text('Fancy')        .fancy(this.fontSizeValue)        .onClick(() => {          this.fontSizeValue = 30        })    }  }}
    

使用场景

以下示例声明了3个Text组件,每个Text组件均设置了fontStyle、fontWeight和backgroundColor样式。

@Entry@Componentstruct FancyUse {  @State label: string = 'Hello World'
  build() {    Row({ space: 10 }) {      Text(`${this.label}`)        .fontStyle(FontStyle.Italic)        .fontWeight(100)        .backgroundColor(Color.Blue)      Text(`${this.label}`)        .fontStyle(FontStyle.Italic)        .fontWeight(200)        .backgroundColor(Color.Pink)      Text(`${this.label}`)        .fontStyle(FontStyle.Italic)        .fontWeight(300)        .backgroundColor(Color.Orange)    }.margin('20%')  }}

@Extend将样式组合复用,示例如下。

@Extend(Text) function fancyText(weightValue: number, color: Color) {  .fontStyle(FontStyle.Italic)  .fontWeight(weightValue)  .backgroundColor(color)}

通过@Extend组合样式后,使得代码更加简洁,增强可读性。

@Entry@Componentstruct FancyUse {  @State label: string = 'Hello World'
  build() {    Row({ space: 10 }) {      Text(`${this.label}`)        .fancyText(100, Color.Blue)      Text(`${this.label}`)        .fancyText(200, Color.Pink)      Text(`${this.label}`)        .fancyText(300, Color.Orange)    }.margin('20%')  }}
import { NavigatorBean } from '../viewmodel/NavigatorBean';
import { CommonConstant as Const } from '../common/CommonConstant';

@Extend(Button)
function fancy(top: string) {
  //@Extend可以用来扩展原生组件样式  @Extend(UIComponentName) function functionName { ... }
  //@Extend装饰的方法的参数可以为function,作为Event事件的句柄。
  .fontSize(Const.MAIN_CONSTANT_BUTTON_FONT_SIZE)
  .fontColor($r('app.color.start_window_background'))
  .width(Const.MAIN_CONSTANT_BUTTON_WIDTH)
  .height(Const.MAIN_CONSTANT_BUTTON_HEIGHT)
  .margin({ top: top })
  .backgroundColor($r('app.color.blue'))
  .borderRadius(Const.MAIN_CONSTANT_BUTTON_BORDER_RADIUS)
}

@Entry
@Component
struct MainPage {
  build() {
    Column() {
      Image($r('app.media.background'))
        .width(Const.MAIN_CONSTANT_FULL_HEIGHT)
        .height(Const.MAIN_CONSTANT_IMAGE_HEIGHT)
      Navigator({ target: Const.WEB_PAGE_URI, type: NavigationType.Push }) {
        Button($r('app.string.loadLocalH5'))
          .fancy(Const.MAIN_CONSTANT_BUTTON_MARGIN_TOP)//对应@Extend Button的function fancy()
      }
      .params({ path: Const.LOCAL_PATH, tips: $r('app.string.local') } as NavigatorBean)

      Navigator({ target: Const.WEB_PAGE_URI, type: NavigationType.Push }) {
        Button($r('app.string.loadCloudH5'))
          .fancy(Const.MAIN_CONSTANT_BUTTON_MARGIN_TOP_BUTTON)
      }
      .params({ path: Const.CLOUD_PATH, tips: $r('app.string.online') } as NavigatorBean)

      Navigator({ target: Const.VUE_PAGE_URI, type: NavigationType.Push }) {
        Button($r('app.string.loadVue'))
          .fancy(Const.MAIN_CONSTANT_BUTTON_MARGIN_TOP_BUTTON)
      }
      .params({ path: Const.VUE_PATH, tips: $r('app.string.local') } as NavigatorBean)

      Navigator({ target: Const.VUE_PAGE_URI, type: NavigationType.Push }) {
        Button($r('app.string.loadCloudVue'))
          .fancy(Const.MAIN_CONSTANT_BUTTON_MARGIN_TOP_BUTTON)
      }
      .params({ path: Const.VUE_CLOUD_PATH, tips: $r('app.string.online') } as NavigatorBean)
    }
    .height(Const.MAIN_CONSTANT_FULL_HEIGHT)
    .backgroundColor($r('app.color.navy_blue'))
  }
}

developer.huawei.com/consumer/cn…