如果每个组件的样式都需要单独设置,在开发过程中会出现大量代码在进行重复样式设置,虽然可以复制粘贴,但为了代码简洁性和后续方便维护,我们推出了可以提炼公共样式进行复用的装饰器@Styles。

@Styles装饰器可以将多条样式设置提炼成一个方法,直接在组件声明的位置调用。通过@Styles装饰器可以快速定义并复用自定义样式。

装饰器使用说明

  • 当前@Styles仅支持 通用属性通用事件
  • @Styles可以定义在组件内或全局,在全局定义时需在方法名前面添加function关键字,组件内定义时则不需要添加function关键字。

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

如果想实现export功能,推荐使用 AttributeModifier

        
ArkTS
12345678910
// 全局 @Styles function functionName() { ... } // 在组件内 @Component struct FancyUse { @Styles fancy() { .height(100) } }

如果要实现跨文件操作的功能,可以参考使用 动态属性设置

        
ArkTS
12345678910111213141516171819202122
// index.ets import { MyButtonModifier } from './setAttribute' @Entry @Component struct AttributeDemo { @State modifier: MyButtonModifier = new MyButtonModifier(); build() { Row() { Column() { Button("Button") .attributeModifier(this.modifier) .onClick(() => { this.modifier.isDark = !this.modifier.isDark }) } .width('100%') } .height('100%') } }
        
ArkTS
1234567891011
// setAttribute.ets export class MyButtonModifier implements AttributeModifier<ButtonAttribute> { isDark: boolean = false; applyNormalAttribute(instance: ButtonAttribute): void { if (this.isDark) { instance.backgroundColor(Color.Black) } else { instance.backgroundColor(Color.Red) } } }
  • 定义在组件内的@Styles可以通过this访问组件的常量和状态变量,并可以在@Styles里通过事件来改变状态变量的值,示例如下:
        
ArkTS
1234567891011
@Component struct FancyUse { @State heightValue: number = 100; @Styles fancy() { .height(this.heightValue) .backgroundColor(Color.Yellow) .onClick(() => { this.heightValue = 200; }) } }
  • 组件内@Styles的优先级高于全局@Styles。框架优先找当前组件内的@Styles,如果找不到,则会全局查找。

注意

  1. @Styles方法不能有参数,编译期会报错,提醒开发者@Styles方法不支持参数。
  2. 不支持在@Styles方法内使用逻辑组件,在逻辑组件内的属性不生效。