diff --git a/zh-cn/application-dev/reference/apis-arkui/js-apis-arkui-CommonModifier.md b/zh-cn/application-dev/reference/apis-arkui/js-apis-arkui-CommonModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..50b6eb715e59c932409fd6a5b4943b989b477495 --- /dev/null +++ b/zh-cn/application-dev/reference/apis-arkui/js-apis-arkui-CommonModifier.md @@ -0,0 +1,62 @@ +# CommonModifier + + 继承自[AttributeModifier](./arkui-ts/ts-universal-attributes-attribute-modifier.md#attributemodifiert),提供了一系列方法可以直接设置组件的属性,每个方法都会返回修饰器本身,从而支持链式调用。 + + +## 导入模块 + +```ts +import { CommonModifier } from '@kit.ArkUI' +``` + +> **使用说明:** +> +> 1. 由于与属性方法同时设置或者在CommonModifier中实现applyNormalAttribute等方法时,涉及到与状态管理更新机制同时使用,易出现混淆,因此不建议在同一组件上同时用两种方法设置相同属性。 +> +> 2. 当与属性方法同时设置时,属性生效的原则为:后设置的生效。 +> 若先进行属性直通更新,后通过状态管理机制更新属性方法,则后更新的属性方法生效; +> 若先通过状态管理机制更新属性方法,后进行属性直通更新,则属性直通更新生效。 + +### applyNormalAttribute +applyNormalAttribute?(instance: CommonAttribute): void + +定义正常态更新属性函数。 + +**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 + +**系统能力:** SystemCapability.ArkUI.ArkUI.Full + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| instance | CommonAttribute | 是 | 组件的通用属性类,用于设置通用属性。| + +**示例:** + +通过链式调用直接设置组件属性。 + +```ts +import { CommonModifier } from '@kit.ArkUI' + +@Entry +@Component +struct Index { + testCommonModifier: CommonModifier = new CommonModifier() + .width(100) + .height(100) + .backgroundColor(Color.Red) + + build() { + Column() { + Column() + .attributeModifier(this.testCommonModifier) + } + .height('100%') + .width('100%') + } +} + +``` + +![commonModifier](../figures/commonModifier.png) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/figures/commonModifier.png b/zh-cn/application-dev/reference/figures/commonModifier.png new file mode 100644 index 0000000000000000000000000000000000000000..7c40553cfc14d34efe1bdcf974109307f0a3743a Binary files /dev/null and b/zh-cn/application-dev/reference/figures/commonModifier.png differ diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 8d24a80d134811da9872dadc31c4fa2e80bd2ac2..88277ea26b9ccfb03535b23b0808690fa94aeba1 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -2392,6 +2392,7 @@ - [NodeController](reference/apis-arkui/js-apis-arkui-nodeController.md) - [RenderNode](reference/apis-arkui/js-apis-arkui-renderNode.md) - [AttributeUpdater](reference/apis-arkui/js-apis-arkui-AttributeUpdater.md) + - [CommonModifier](reference/apis-arkui/js-apis-arkui-CommonModifier.md) - [Content](reference/apis-arkui/js-apis-arkui-Content.md) - [NodeContent](reference/apis-arkui/js-apis-arkui-NodeContent.md) - 窗口管理