From a3663e3b8b3f6054c36d4d86bbbe318562da1560 Mon Sep 17 00:00:00 2001 From: Caoruihong Date: Sun, 6 Jul 2025 22:45:07 +0800 Subject: [PATCH] add java-like overload accessibility apis Signed-off-by: Caoruihong Change-Id: I0d1579244c56ba3bb763743b10a94466fe8bf027 --- api/@internal/component/ets/common.d.ts | 125 +++++++++++++++++++++--- 1 file changed, 113 insertions(+), 12 deletions(-) diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index b0e104b1d5..7186b02bcc 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -27222,11 +27222,24 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ accessibilityGroup(value: boolean): T; + /** + * Sets accessibilityGroup + * + * @param { boolean } value - set group with accessibility + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityGroupWithValue(value: boolean): T; + /** * Sets accessibilityGroup * @@ -27237,11 +27250,32 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'14','1.2':'20'} - * @arkts 1.1&1.2 + * @since 14 */ accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; + /** + * Sets accessibilityGroup + * + * @param { boolean } isGroup - set group with accessibility + * @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityGroupWithIsGroupAccessibilityOptions(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; + + /** + * Sets accessibilityGroup + * + * @since 20 + */ + overload accessibilityGroup { accessibilityGroupWithValue, accessibilityGroupWithIsGroupAccessibilityOptions } + /** * Sets accessibilityText * @@ -27270,11 +27304,24 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ accessibilityText(value: string): T; + /** + * Sets accessibilityText + * + * @param { string } value - set accessibility text + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityTextWithValue(value: string): T; + /** * Sets accessibility next focus id * @param { string } nextId - set component next accessibility focus id @@ -27336,11 +27383,32 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ accessibilityText(text: Resource): T; + /** + * Sets accessibilityText + * + * @param { Resource } text - set accessibility text + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityTextWithText(text: Resource): T; + + /** + * Sets accessibilityText + * + * @since 20 + */ + overload accessibilityText { accessibilityTextWithValue, accessibilityTextWithText } + + /** * Sets accessibility role,role indicates the custom type of the component * @param { AccessibilityRoleType } role - set accessibility component type @@ -27409,11 +27477,24 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ accessibilityDescription(value: string): T; + /** + * Sets accessibilityDescription + * + * @param { string } value - set description of accessibility + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityDescriptionWithValue(value: string): T; + /** * Sets accessibilityDescription * @@ -27423,11 +27504,31 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since arkts {'1.1':'12','1.2':'20'} - * @arkts 1.1&1.2 + * @since 12 */ accessibilityDescription(description: Resource): T; + /** + * Sets accessibilityDescription + * + * @param { Resource } description - set description of accessibility + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + accessibilityDescriptionWithDescription(description: Resource): T; + + /** + * Sets accessibilityDescription + * + * @since 20 + */ + overload accessibilityDescription { accessibilityDescriptionWithValue, accessibilityDescriptionWithDescription } + /** * Sets accessibilityLevel * -- Gitee