From 9acfca2643f5a91aa07218798536a48245153f48 Mon Sep 17 00:00:00 2001
From: wujinhui
Date: Thu, 24 Jul 2025 14:32:16 +0800
Subject: [PATCH] bug fix common method
Signed-off-by: wujinhui
---
api/arkui/AttributeUpdater.d.ets | 14 +-
api/arkui/CommonModifier.d.ets | 2 +-
api/arkui/component/button.static.d.ets | 65 ++-
api/arkui/component/common.static.d.ets | 513 ++++++++++++------------
4 files changed, 327 insertions(+), 267 deletions(-)
diff --git a/api/arkui/AttributeUpdater.d.ets b/api/arkui/AttributeUpdater.d.ets
index 0966ac8b0a..8f66c39964 100644
--- a/api/arkui/AttributeUpdater.d.ets
+++ b/api/arkui/AttributeUpdater.d.ets
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2024 Huawei Device Co., Ltd.
+ * Copyright (c) 2025 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -20,12 +20,22 @@
import { AttributeModifier } from './component/common'
+/**
+ * attribute updaater Initializer
+ *
+ * @typedef { function } Initializer
+ * @syscap SystemCapability.ArkUI.ArkUI.Full
+ * @crossplatform
+ * @form
+ * @atomicservice
+ * @since 20
+ */
export type Initializer = (...params:FixedArray
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -10982,7 +10997,7 @@ export declare interface CommonMethod {
* @param { function } event - this function callback executed when the click action is recognized
* @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action
* @default (2^31-1)vp
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -10994,7 +11009,7 @@ export declare interface CommonMethod {
* Trigger a hover event.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11005,7 +11020,7 @@ export declare interface CommonMethod {
* Trigger a hover move event.
*
* @param { Callback } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11016,7 +11031,7 @@ export declare interface CommonMethod {
* Trigger a accessibility hover event.
*
* @param { AccessibilityCallback } callback - A callback instance used when the component is touched after accessibility mode is enabled.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11027,7 +11042,7 @@ export declare interface CommonMethod {
* Set hover effect.
*
* @param { HoverEffect } value - Hover effect of the component in hover state.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11038,7 +11053,7 @@ export declare interface CommonMethod {
* Triggered when the component is clicked by a mouse button or the mouse pointer moves on the component.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11048,7 +11063,7 @@ export declare interface CommonMethod {
* Invoked when a touch event is triggered.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11059,7 +11074,7 @@ export declare interface CommonMethod {
* Keyboard input
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11070,7 +11085,7 @@ export declare interface CommonMethod {
* Keyboard input
*
* @param { Callback } event - Callback for handling the key event.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11081,7 +11096,7 @@ export declare interface CommonMethod {
* Digital crown input.
*
* @param { Callback } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11091,7 +11106,7 @@ export declare interface CommonMethod {
* Handle keyboard events before input method events.
*
* @param { Callback } event - Callback for handling the key event.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11102,7 +11117,7 @@ export declare interface CommonMethod {
* Customize the handling and distribution of key events.
*
* @param { Callback } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11113,7 +11128,7 @@ export declare interface CommonMethod {
* Trigger a FocusAxisEvent.
*
* @param { Callback } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11123,7 +11138,7 @@ export declare interface CommonMethod {
* Handle axis events.
*
* @param { Callback } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11136,7 +11151,7 @@ export declare interface CommonMethod {
* event.
*
* @param { boolean } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11147,7 +11162,7 @@ export declare interface CommonMethod {
* Set nextFocus.
*
* @param { FocusMovement } nextStep
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11158,7 +11173,7 @@ export declare interface CommonMethod {
* Set TabStop on component focus
*
* @param { boolean } isTabStop
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11169,7 +11184,7 @@ export declare interface CommonMethod {
* Trigger a event when got focus.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11180,7 +11195,7 @@ export declare interface CommonMethod {
* Triggered when the current component loses focus.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11191,7 +11206,7 @@ export declare interface CommonMethod {
* Set focus index by key tab.
* The tabIndex and focusScopeId cannot be used together.
* @param { number } index
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11202,7 +11217,7 @@ export declare interface CommonMethod {
* Set default focused component when a page create.
*
* @param { boolean } value - True means to set the component as the default focus, and the value false has no effect.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11214,7 +11229,7 @@ export declare interface CommonMethod {
*
* @param { boolean } value - True means the component is the default focus of the parent container, and
* false means the component is not the default focus of the parent container.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11225,7 +11240,7 @@ export declare interface CommonMethod {
* Set a component focused when the component be touched.
*
* @param { boolean } value - True means the component is focusable on touch, false means the component is not focusable on touch.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11236,7 +11251,7 @@ export declare interface CommonMethod {
* Set the component's focusBox style.
*
* @param { FocusBoxStyle } style - Component's focusBox style.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11248,13 +11263,13 @@ export declare interface CommonMethod {
*
* @param { string } id - focus scope identifier.
* @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default focusScopeId(id: string | undefined, isGroup?: boolean | undefined): this;
+ default focusScopeId(id: string | undefined, isGroup?: boolean): this;
/**
* Set container as a focus group with a specific identifier.
*
@@ -11262,30 +11277,30 @@ export declare interface CommonMethod {
* @param { boolean } [isGroup] - whether this scope is a focus group, the default value is false.
* @param { boolean } [arrowStepOut] - whether the arrow keys can move focus from inside the focus group to outside,
* only effective when isGroup is true, the default value is true.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default focusScopeId(id: string | undefined, isGroup?: boolean | undefined, arrowStepOut?: boolean | undefined): this;
+ default focusScopeId(id: string | undefined, isGroup?: boolean, arrowStepOut?: boolean): this;
/**
* Set the focus priority of component in a specific focus scope.
*
* @param { string } scopeId
* @param { FocusPriority } [priority] - the default value is AUTO
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default focusScopePriority(scopeId: string | undefined, priority?: FocusPriority | undefined): this;
+ default focusScopePriority(scopeId: string | undefined, priority?: FocusPriority): this;
/**
* animation
*
* @param { AnimateParam } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11297,7 +11312,7 @@ export declare interface CommonMethod {
* Set the transition effect of component when it appears and disappears.
*
* @param { TransitionEffect } value - transition effect
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11310,7 +11325,7 @@ export declare interface CommonMethod {
*
* @param { TransitionEffect } effect - transition effect
* @param { Optional } onFinish - transition finish callback.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11324,39 +11339,39 @@ export declare interface CommonMethod {
*
* @param { GestureType } gesture
* @param { GestureMask } mask
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default gesture(gesture: GestureType | undefined, mask?: GestureMask | undefined): this;
+ default gesture(gesture: GestureType | undefined, mask?: GestureMask): this;
/**
* Binding Preferential Recognition Gestures
* gesture:Bound Gesture Type,mask:GestureMask;
*
* @param { GestureType } gesture
* @param { GestureMask } mask
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default priorityGesture(gesture: GestureType | undefined, mask?: GestureMask | undefined): this;
+ default priorityGesture(gesture: GestureType | undefined, mask?: GestureMask): this;
/**
* Binding gestures that can be triggered simultaneously with internal component gestures
* gesture:Bound Gesture Type,mask:GestureMask;
*
* @param { GestureType } gesture
* @param { GestureMask } mask
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default parallelGesture(gesture: GestureType | undefined, mask?: GestureMask | undefined): this;
+ default parallelGesture(gesture: GestureType | undefined, mask?: GestureMask): this;
/**
* Adds the content blurring effect for the current component. The input parameter is the blurring radius.
* The larger the blurring radius, the more blurring the content.
@@ -11364,14 +11379,14 @@ export declare interface CommonMethod {
*
* @param { number } value - value indicates radius of backdrop blur.
* @param { BlurOptions } [options] - options indicates blur options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default blur(value: number | undefined, options?: BlurOptions | undefined): this;
+ default blur(value: number | undefined, options?: BlurOptions): this;
/**
* Adds the content blurring effect for the current component. The input parameter is the blurring radius.
* The larger the blurring radius, the more blurring the content.
@@ -11380,21 +11395,21 @@ export declare interface CommonMethod {
* @param { Optional } blurRadius - value indicates radius of backdrop blur.
* @param { BlurOptions } [options] - options indicates blur options.
* @param { SystemAdaptiveOptions } [sysOptions] - system adaptive options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default blur(blurRadius: number | undefined, options?: BlurOptions | undefined, sysOptions?: SystemAdaptiveOptions | undefined): this;
+ default blur(blurRadius: number | undefined, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): this;
/**
* Applies a linear gradient foreground blur effect to the component.
*
* @param { number } value - the blurring radius.
* The larger the blurring radius, the more blurring the content, and if the value is 0, the content blurring effect is not blurring.
* @param { LinearGradientBlurOptions } options - the linear gradient blur options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11416,7 +11431,7 @@ export declare interface CommonMethod {
* 6.To avoid unexpected results, set the blur radius to a value less than 1.
*
* @param { MotionBlurOptions } value - Motion blur options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11434,7 +11449,7 @@ export declare interface CommonMethod {
*
**NOTE**
*
A value less than 0 evaluates to the value **0**.
*
**Widget capability**: This API can be used in ArkTS widgets since API version 9.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11454,7 +11469,7 @@ export declare interface CommonMethod {
*
Recommended value range: [0, 10).
*
**NOTE**
*
A value less than 0 evaluates to the value **0**.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11475,7 +11490,7 @@ export declare interface CommonMethod {
*
A value less than **0.0** evaluates to the value **0.0**.
*
A value greater than **1.0** evaluates to the value **1.0**.
*
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11487,7 +11502,7 @@ export declare interface CommonMethod {
* Applies a color blend effect to the component.
*
* @param { Color | string | Resource } value - Color to blend with the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11507,7 +11522,7 @@ export declare interface CommonMethod {
*
Recommended value range: [0, 50).
*
**NOTE**
*
A value less than 0 evaluates to the value **0**.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11521,7 +11536,7 @@ export declare interface CommonMethod {
* @param { number } value - Sepia conversion ratio of the component. If the value is **1**, the image
* is completely sepia. If the value is **0**, the component remains unchanged. The unit is percentage.
*
Value range: [0, +∞).
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11534,7 +11549,7 @@ export declare interface CommonMethod {
* A value of 0% does not change the image. (Percentage)
*
* @param { number | InvertOptions } value - value indicates the scale of the conversion or the options of invert.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11545,7 +11560,7 @@ export declare interface CommonMethod {
/**
* Applies a system bar effect to the component, which means to invert colors based on the background and add a blur.
*
- * @returns { T } return the component attribute.
+ * @returns { this } return the component attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11558,7 +11573,7 @@ export declare interface CommonMethod {
*
A rotation of 360 degrees leaves the color unchanged.
*
A rotation of 180 degrees and then -180 degrees also leaves the color unchanged.
*
When the data type is number, the value **90** is equivalent to **'90deg'**.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11579,7 +11594,7 @@ export declare interface CommonMethod {
* when the feature is enabled.
*
2. Avoid nesting **useShadowBatching**. When used in nested mode, **useShadowBatching**
* takes effect for the current child node only and cannot be recursively used.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11599,7 +11614,7 @@ export declare interface CommonMethod {
* @param { EffectType } [effectType] - Type of effect to apply to the component, which is defined by
* the parent **EffectComponent** or the window.
*
Default value: **EffectType.DEFAULT**.
- * @returns { T } return the component attribute.
+ * @returns { this } return the component attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11612,7 +11627,7 @@ export declare interface CommonMethod {
* **EffectComponent** component.
The value **true** means that the component inherits the
* special effect settings of the **EffectComponent** component, and **false** means the opposite.
*
Default value: **false**.
- * @returns { T } return the component attribute.
+ * @returns { this } return the component attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11625,14 +11640,14 @@ export declare interface CommonMethod {
*
The input parameter is the blur radius. The larger the radius is, the more blurred the background is.
*
If the value is **0**, the background is not blurred.
* @param { BlurOptions } [options] - Grayscale parameters.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default backdropBlur(value: number | undefined, options?: BlurOptions | undefined): this;
+ default backdropBlur(value: number | undefined, options?: BlurOptions): this;
/**
* Adds the background blur effect for the current component. The input parameter is the blur radius.
* The larger the blur radius, the more blurred the background. If the value is 0, the background blur is not blurred.
@@ -11640,14 +11655,14 @@ export declare interface CommonMethod {
* @param { Optional } radius - radius indicates radius of backdrop blur.
* @param { BlurOptions } [options] - options indicates the backdrop blur options.
* @param { SystemAdaptiveOptions } [sysOptions] - system adaptive options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default backdropBlur(radius: number | undefined, options?: BlurOptions | undefined, sysOptions?: SystemAdaptiveOptions | undefined): this;
+ default backdropBlur(radius: number | undefined, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): this;
/**
* Sets whether the component and its child components are rendered off
* the screen as a whole before being blended with its parent.
@@ -11658,7 +11673,7 @@ export declare interface CommonMethod {
*
Default value: **false**.
*
The value **true** means the component and its child components are rendered off
* the screen as a whole, and **false** means the opposite.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11676,7 +11691,7 @@ export declare interface CommonMethod {
*
Default value: **false**.
*
**true**: Freeze the component.
*
**false**: Do not freeze the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -11687,7 +11702,7 @@ export declare interface CommonMethod {
*
* @param { TranslateOptions } value - Translation effect for page transitions
*
specifying the start value for entrance and the end value for exit. default:{x:0,y:0,z:0}
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11701,7 +11716,7 @@ export declare interface CommonMethod {
* @param { ScaleOptions } value - Scale ratio along the x-, y-, and z-axis. The default value is **1**.
*
**centerX** and **centerY** are used to set the scale center point.
*
default:{x:1,y:1,z:1,centerX:'50%',centerY:'50%'}
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11713,7 +11728,7 @@ export declare interface CommonMethod {
* Set component rotation.
*
* @param { RotateOptions } value default:{x:0,y:0,z:0,centerX:'50%',centerY:'50%',centerZ:0,perspective:0}
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11725,7 +11740,7 @@ export declare interface CommonMethod {
* Sets the transformation matrix of the component.
*
* @param { object } value - Transformation matrix of the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11736,7 +11751,7 @@ export declare interface CommonMethod {
* This callback is triggered when a component mounts a display.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11748,7 +11763,7 @@ export declare interface CommonMethod {
* This callback is triggered when component uninstallation disappears.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11760,7 +11775,7 @@ export declare interface CommonMethod {
* This callback is triggered when a component mounts to view tree.
*
* @param { VoidCallback } callback
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11771,7 +11786,7 @@ export declare interface CommonMethod {
* This callback is triggered when a component is detached from view tree.
*
* @param { VoidCallback } callback
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11782,7 +11797,7 @@ export declare interface CommonMethod {
* This callback is triggered when the size or position of this component change finished.
*
* @param { function } event - event callback.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -11793,7 +11808,7 @@ export declare interface CommonMethod {
* Controls the display or hide of the current component.
*
* @param { Visibility } value - Whether the component is visible.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11806,7 +11821,7 @@ export declare interface CommonMethod {
* Default value: **0**.
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11819,7 +11834,7 @@ export declare interface CommonMethod {
* Default value: 0 when the parent container is Column or Row, 1 when the parent container is Flex..
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11832,7 +11847,7 @@ export declare interface CommonMethod {
* Default value: **'auto'**.
*
* @param { number | string } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11845,7 +11860,7 @@ export declare interface CommonMethod {
* Default value: **ItemAlign.Auto**.
*
* @param { ItemAlign } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11858,7 +11873,7 @@ export declare interface CommonMethod {
*
This parameter is only effective in Row, Column, and Flex (single-line) container components.
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11870,7 +11885,7 @@ export declare interface CommonMethod {
* The sibling components in the same container are hierarchically displayed. A larger value of z indicates a higher display level.
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11889,19 +11904,19 @@ export declare interface CommonMethod {
*
this component is considered as a shared element of the pages.
*
If the **id** value is an empty string, no transition will be applied to the component.
* @param { sharedTransitionOptions } options - Parameters of the shared element transition animation.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default sharedTransition(id: string | undefined, options?: sharedTransitionOptions | undefined): this;
+ default sharedTransition(id: string | undefined, options?: sharedTransitionOptions): this;
/**
* Sets how elements are laid out along the main axis of the container.
* Default value: **Direction.Auto**.
*
* @param { Direction } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11914,7 +11929,7 @@ export declare interface CommonMethod {
* Default value: **Alignment.Center**.
*
* @param { Alignment } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11927,7 +11942,7 @@ export declare interface CommonMethod {
*
The attribute is not available for a layout container whose width and height are zero.
*
* @param { Position | Edges | LocalizedEdges } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11940,7 +11955,7 @@ export declare interface CommonMethod {
* further away from the position specified by position or offset.
*
* @param { Position | LocalizedPosition} value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11954,7 +11969,7 @@ export declare interface CommonMethod {
* It adjusts the component position only during drawing.
*
* @param { Position | Edges | LocalizedEdges } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11967,7 +11982,7 @@ export declare interface CommonMethod {
* If it is set to false, click operations are not responded.
*
* @param { boolean } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11980,7 +11995,7 @@ export declare interface CommonMethod {
* This API is valid only when the container is RelativeContainer.
*
* @param { AlignRuleOption } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -11996,7 +12011,7 @@ export declare interface CommonMethod {
* child components in the relative container.
*
* @param { LocalizedAlignRuleOptions } alignRule
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12013,7 +12028,7 @@ export declare interface CommonMethod {
*
* @param { Axis } direction - indicates direction of the chain
* @param { ChainStyle } style - indicates style of the chain
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12029,7 +12044,7 @@ export declare interface CommonMethod {
*
This parameter takes effect only when a valid value greater than 0 is specified.
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12041,7 +12056,7 @@ export declare interface CommonMethod {
* The click effect level and scale number.
*
* @param { ClickEffect | null } value
- * @returns { T } return the component attribute.
+ * @returns { this } return the component attribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12056,87 +12071,87 @@ export declare interface CommonMethod {
* The global builder is not supported.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDragStart(event: ((event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo) | undefined): this;
+ default onDragStart(event: ((event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo)): this;
/**
* After binding, a callback is triggered when the component is dragged to the range of the component.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDragEnter(event: ((event: DragEvent, extraParams?: string) => void) | undefined): this;
+ default onDragEnter(event: ((event: DragEvent, extraParams?: string) => void)): this;
/**
* After binding, a callback is triggered when the drag moves within the range of a placeable component.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDragMove(event: ((event: DragEvent, extraParams?: string) => void) | undefined): this;
+ default onDragMove(event: ((event: DragEvent, extraParams?: string) => void)): this;
/**
* After binding, a callback is triggered when the component is dragged out of the component range.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDragLeave(event: ((event: DragEvent, extraParams?: string) => void) | undefined): this;
+ default onDragLeave(event: ((event: DragEvent, extraParams?: string) => void)): this;
/**
* The component bound to this event can be used as the drag release target.
* This callback is triggered when the drag behavior is stopped within the scope of the component.
*
* @param { function } event
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDrop(event: ((event: DragEvent, extraParams?: string) => void) | undefined): this;
+ default onDrop(event: ((event: DragEvent, extraParams?: string) => void)): this;
/**
* The component bound to this event can be used as the drag release target.
* This callback is triggered when the drag behavior is stopped within the scope of the component.
*
* @param { OnDragEventCallback } eventCallback - event callback.
* @param { DropOptions } [dropOptions] - the drop handling options.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDrop(eventCallback: OnDragEventCallback | undefined, dropOptions?: DropOptions | undefined): this;
+ default onDrop(eventCallback: OnDragEventCallback | undefined, dropOptions?: DropOptions): this;
/**
* This function is called when the drag event is end.
*
* @param { function } event - indicates the function to be called.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default onDragEnd(event: ((event: DragEvent, extraParams?: string) => void) | undefined): this;
+ default onDragEnd(event: ((event: DragEvent, extraParams?: string) => void)): this;
/**
* Allowed drop uniformData type for this node.
*
* @param { Array | null } value - the uniformData type for this node.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12148,7 +12163,7 @@ export declare interface CommonMethod {
*
* @param { boolean } value - true means the area can be dragged, false means the area can't be dragged.
* The default value is false.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12159,7 +12174,7 @@ export declare interface CommonMethod {
* Set preview of the component for dragging process
*
* @param { CustomBuilder | DragItemInfo | string } value - preview of the component for dragging process
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -12170,28 +12185,28 @@ export declare interface CommonMethod {
*
* @param { CustomBuilder | DragItemInfo | string } preview - preview of the component for dragging process
* @param { PreviewConfiguration } config - drag preview configuration.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
*/
- default dragPreview(preview: CustomBuilder | DragItemInfo | string | undefined, config?: PreviewConfiguration | undefined): this;
+ default dragPreview(preview: CustomBuilder | DragItemInfo | string | undefined, config?: PreviewConfiguration): this;
/**
* Set the selectable area drag preview options.
*
* @param { DragPreviewOptions } value - preview options value.
* @param { DragInteractionOptions } options - drag interaction options value.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
*/
- default dragPreviewOptions(value: DragPreviewOptions | undefined, options?: DragInteractionOptions | undefined): this;
+ default dragPreviewOptions(value: DragPreviewOptions | undefined, options?: DragInteractionOptions): this;
/**
* After binding, a callback is triggered when the preDrag status change finished.
*
* @param { Callback } callback callback - The callback will be triggered when the preDrag status change.
- * @returns { T } property value of type T.
+ * @returns { this } property value of type T.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -12202,14 +12217,14 @@ export declare interface CommonMethod {
*
* @param { string | CustomBuilder | ComponentContent } value
* @param { OverlayOptions } options
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default overlay(value: string | CustomBuilder | ComponentContent | undefined, options?: OverlayOptions | undefined): this;
+ default overlay(value: string | CustomBuilder | ComponentContent | undefined, options?: OverlayOptions): this;
/**
* Linear Gradient
* angle: Angle of Linear Gradient. The default value is 180;
@@ -12219,7 +12234,7 @@ export declare interface CommonMethod {
*
* @param { object } value - Linear gradient.
*
If **options** is **undefined**, the linear gradient is disabled.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12249,7 +12264,7 @@ export declare interface CommonMethod {
*
When **start**, **end**, or **rotation** is specified with a string, the string must be a number
* or a number followed by one of the following units: deg, rad, grad, and turn. Valid value examples
* are "90", "90deg", and "1.57rad".
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12272,7 +12287,7 @@ export declare interface CommonMethod {
* of a color and its stop position. Invalid colors are automatically skipped.
*
- **repeating**: whether the colors are repeated.
*
Default value: **false**.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12284,7 +12299,7 @@ export declare interface CommonMethod {
* Set the motion path of the component.
*
* @param { MotionPathOptions } value - Motion path of the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12298,7 +12313,7 @@ export declare interface CommonMethod {
*
When the value type is **ShadowOptions**, the blur radius, shadow color,
* and offset along the x-axis and y-axis can be specified.
*
When the value type is **ShadowStyle**, the shadow style can be specified.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12324,14 +12339,14 @@ export declare interface CommonMethod {
* onto the offscreen canvas, and blended with the existing content on the canvas below using
* the specified blend mode. This approach may cause issues with screen capture for APIs such
* as linearGradientBlur12+, backgroundEffect, and brightness.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
- default blendMode(value: BlendMode | undefined, type?: BlendApplyType | undefined): this;
+ default blendMode(value: BlendMode | undefined, type?: BlendApplyType): this;
/**
@@ -12339,7 +12354,7 @@ export declare interface CommonMethod {
*
* @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes.
* @param { BlendApplyType } [type] - Different blend apply type
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @form
@@ -12355,7 +12370,7 @@ export declare interface CommonMethod {
*
**true**: Perform clipping. **false**: Do not perform clipping.
*
If this parameter is set to **true**.
*
child components exceeding the current component's bounds will not respond to bound gesture events.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12368,7 +12383,7 @@ export declare interface CommonMethod {
*
* @param { CircleShape | EllipseShape | PathShape | RectShape } value - Shape that the component to be clipped into.
*
The clipped area remains responsive to bound gesture events.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12381,7 +12396,7 @@ export declare interface CommonMethod {
*
* @param { ProgressMask } value - Mask to add to the component, which allows for dynamic
* adjustment of progress, maximum value, and color settings.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12393,7 +12408,7 @@ export declare interface CommonMethod {
*
* @param { CircleShape | EllipseShape | PathShape | RectShape } value - Mask of the specified
* shape to add to the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12405,7 +12420,7 @@ export declare interface CommonMethod {
* Key. User can set an key to the component to identify it.
*
* @param { string } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -12416,7 +12431,7 @@ export declare interface CommonMethod {
* Id. User can set an id to the component to identify it.
*
* @param { string } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12428,7 +12443,7 @@ export declare interface CommonMethod {
* geometryTransition
*
* @param { string } id
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12440,25 +12455,25 @@ export declare interface CommonMethod {
*
* @param { string } id - geometry transition id
* @param { GeometryTransitionOptions } options - Indicates the options of geometry transition.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default geometryTransition(id: string | undefined, options?: GeometryTransitionOptions | undefined): this;
+ default geometryTransition(id: string | undefined, options?: GeometryTransitionOptions): this;
/**
* Tips control
*
* @param { TipsMessageType } message
* @param { TipsOptions } [options]
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindTips(message: TipsMessageType | undefined, options?: TipsOptions | undefined): this;
+ default bindTips(message: TipsMessageType | undefined, options?: TipsOptions): this;
/**
* Popup control
* NOTE:
@@ -12468,7 +12483,7 @@ export declare interface CommonMethod {
*
* @param { boolean } show - Whether to show the popup, default is false.
* @param { PopupOptions | CustomPopupOptions } popup
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12480,26 +12495,26 @@ export declare interface CommonMethod {
*
* @param { Array | CustomBuilder } content - Indicates the content of menu.
* @param { MenuOptions } options - Indicates the options of menu.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindMenu(content: Array | CustomBuilder | undefined, options?: MenuOptions | undefined): this;
+ default bindMenu(content: Array | CustomBuilder | undefined, options?: MenuOptions): this;
/**
* Menu control
*
* @param { boolean } isShow true means display menu, false means hide menu, default is false.
* @param { Array | CustomBuilder } content - Indicates the content of menu.
* @param { MenuOptions } options - Indicates the options of menu.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindMenu(isShow: boolean | undefined, content: Array | CustomBuilder | undefined, options?: MenuOptions | undefined): this;
+ default bindMenu(isShow: boolean | undefined, content: Array | CustomBuilder | undefined, options?: MenuOptions): this;
/**
* Binds a context menu to this component, which is displayed when the user long-presses or right-clicks the
* component. Only custom menu items are supported.
@@ -12508,13 +12523,13 @@ export declare interface CommonMethod {
* @param { ResponseType } responseType - Indicates response type of context menu, Long pressing with a mouse device
* is not supported.
* @param { ContextMenuOptions } options - Indicates the options of context menu.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindContextMenu(content: CustomBuilder | undefined, responseType: ResponseType | undefined, options?: ContextMenuOptions | undefined): this;
+ default bindContextMenu(content: CustomBuilder | undefined, responseType: ResponseType | undefined, options?: ContextMenuOptions): this;
/**
* Binds a context menu to the component, whose visibility is subject to the isShown settings.
*
@@ -12527,57 +12542,57 @@ export declare interface CommonMethod {
*
* @param { CustomBuilder } content - Indicates the content of context menu.
* @param { ContextMenuOptions } [options] - Indicates the options of context menu.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindContextMenu(isShown: boolean | undefined, content: CustomBuilder | undefined, options?: ContextMenuOptions | undefined): this;
+ default bindContextMenu(isShown: boolean | undefined, content: CustomBuilder | undefined, options?: ContextMenuOptions): this;
/**
* Binds a modal page to the component, whose visibility is subject to the isShow settings.
*
* @param { boolean | Bindable} isShow - true means display content, false means hide content.
* @param { CustomBuilder } builder - the content to be displayed.
* @param { ModalTransition } [type] - transition type.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindContentCover(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, type?: ModalTransition | undefined): this;
+ default bindContentCover(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, type?: ModalTransition): this;
/**
* Bind content cover
*
* @param { boolean | Bindable } isShow - true means display content, false means hide content.
* @param { CustomBuilder } builder - the content to be displayed.
* @param { ContentCoverOptions } [options] - options of content cover.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindContentCover(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, options?: ContentCoverOptions | undefined): this;
+ default bindContentCover(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, options?: ContentCoverOptions): this;
/**
* Bind sheet
*
* @param { boolean | Bindable} isShow - true means display sheet, false means hide sheet.
* @param { CustomBuilder } builder - the sheet to be displayed.
* @param { SheetOptions } [options] - options of sheet.
- * @returns { T } - template type
+ * @returns { this } - template type
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default bindSheet(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, options?: SheetOptions | undefined): this;
+ default bindSheet(isShow: boolean | Bindable | undefined, builder: CustomBuilder | undefined, options?: SheetOptions): this;
/**
* Sets styles for component state.
*
* @param { StateStyles } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12589,7 +12604,7 @@ export declare interface CommonMethod {
* id for distribute identification.
*
* @param { number } value
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12602,7 +12617,7 @@ export declare interface CommonMethod {
* @param { Array } ratios - Threshold array. Each threshold represents a ratio of the component's visible area to the component's total area.
* The value range of the threshold is [0.0, 1.0].
* @param { VisibleAreaChangeCallback } event - Callback for visible area changes of the component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12636,7 +12651,7 @@ export declare interface CommonMethod {
* transparent offscreen buffer. To update the component attributes, set the value to **0**.
*
*
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12652,7 +12667,7 @@ export declare interface CommonMethod {
*
Between **0** and **1**, a larger value indicates higher luminance.
*
A value less than 0 is handled as the value **0**.
*
A value greater than 1 is handled as the value **1**.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12680,7 +12695,7 @@ export declare interface CommonMethod {
*
(3) If the input value is invalid, the image is displayed as {0, 0, 0, 0}, that is, the image is the same as
* the original image.
*
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12693,13 +12708,13 @@ export declare interface CommonMethod {
* @param { string | FunctionKey } value - Character of the combination key.
* @param { Array } keys - The modifier keys modify the action of key when the key are pressed at the same time.
* @param { function } [action] - Callback function, triggered when the shortcut keyboard is pressed.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 20
*/
- default keyboardShortcut(value: string | FunctionKey | undefined, keys: Array | undefined, action?: (() => void) | undefined): this;
+ default keyboardShortcut(value: string | FunctionKey | undefined, keys: Array | undefined, action?: () => void): this;
/**
* Sets whether to enable accessibility grouping.
*
@@ -12709,7 +12724,7 @@ export declare interface CommonMethod {
*
service will no longer focus on the individual child components.
*
* @param { boolean } value - set group with accessibility, default value is false.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12733,7 +12748,7 @@ export declare interface CommonMethod {
*
* @param { boolean } isGroup - set group with accessibility, default value is false.
* @param { AccessibilityOptions } accessibilityOptions - accessibilityOptions for accessibility, default value is false.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12747,7 +12762,7 @@ export declare interface CommonMethod {
* text attribute, so that accessibility services can announce the specified content for the component.
*
* @param { string } value - set accessibility text, default value is "".
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12758,7 +12773,7 @@ export declare interface CommonMethod {
/**
* Sets accessibility next focus id
* @param { string } nextId - set component next accessibility focus id
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12769,7 +12784,7 @@ export declare interface CommonMethod {
/**
* Sets the accessibility default foucs flag
* @param { boolean } focus - if the component is accessibility default focus,focus set true
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12780,7 +12795,7 @@ export declare interface CommonMethod {
/**
* Sets accessibility same page mode
* @param { AccessibilitySamePageMode } pageMode - accessibility same page mode
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12791,7 +12806,7 @@ export declare interface CommonMethod {
/**
* Sets accessibilityScrollTriggerable
* @param { boolean } isTriggerable - set property of supporting scroll in accessibility
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12808,7 +12823,7 @@ export declare interface CommonMethod {
*
To prioritize accessibility text concatenation, set accessibilityPreferred in accessibilityGroup.
*
* @param { Resource } text - set accessibility text
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12819,7 +12834,7 @@ export declare interface CommonMethod {
/**
* Sets accessibility role,role indicates the custom type of the component
* @param { AccessibilityRoleType } role - set accessibility component type
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12830,7 +12845,7 @@ export declare interface CommonMethod {
/**
* Register accessibility focus callback,when the component is focused or out of focus,the callback will be executed
* @param { AccessibilityFocusCallback } callback - accessibility focus callback function
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12842,7 +12857,7 @@ export declare interface CommonMethod {
* Sets accessibilityTextHint
*
* @param { string } value - set accessibility text hint
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12854,7 +12869,7 @@ export declare interface CommonMethod {
* Sets accessibilityDescription
*
* @param { string } value - set description of accessibility, default value is "".
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12875,7 +12890,7 @@ export declare interface CommonMethod {
*
both text information and the accessibility description, the text is read first and then the
*
accessibility description, when the component is selected.
* @param { Resource } description - set description of accessibility
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12901,7 +12916,7 @@ export declare interface CommonMethod {
*
3. If the parent component's accessibilityLevel is set to "no-hide-descendants", the component will not be
*
recognized by accessibility services.
* @param { string } value - set accessibility level, default value is auto.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12913,7 +12928,7 @@ export declare interface CommonMethod {
* Sets accessibilityVirtualNode
*
* @param { CustomBuilder } builder - set virtual node of accessibility
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12925,7 +12940,7 @@ export declare interface CommonMethod {
* Sets accessibilityChecked
*
* @param { boolean } isCheck - set accessibility checked status
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12937,7 +12952,7 @@ export declare interface CommonMethod {
* Sets accessibilitySelected
*
* @param { boolean } isSelect - set accessibility selected status
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12949,7 +12964,7 @@ export declare interface CommonMethod {
* Sets obscured
*
* @param { Array } reasons - reasons of obscuration
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12960,7 +12975,7 @@ export declare interface CommonMethod {
* Reuse id is used for identify the reuse type for each custom node.
*
* @param { string } id - The id for reusable custom node.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12971,7 +12986,7 @@ export declare interface CommonMethod {
* Reuse id is used for identify the reuse type of each @ComponentV2 custom component, which can give user control of sub-component recycle and reuse.
*
* @param { ReuseOptions } options - The configuration parameter for reusable custom component.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -12984,7 +12999,7 @@ export declare interface CommonMethod {
* @param { RenderFit } fitMode - How the final state of the component's content is rendered during.
*
its width and height animation process.
*
If **renderFit** is not set, the default value **RenderFit.TOP_LEFT** is used.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -12996,7 +13011,7 @@ export declare interface CommonMethod {
* Sets the gesture modifier.
*
* @param { GestureModifier } modifier
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13007,7 +13022,7 @@ export declare interface CommonMethod {
* Sets the background brightness of the component.
*
* @param { BackgroundBrightnessOptions } params - Parameters for setting the background brightness.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 20
@@ -13017,7 +13032,7 @@ export declare interface CommonMethod {
* When a gesture bound to this component will be accepted, a user-defined callback is triggered to get the result
*
* @param { function } callback - A callback instance used when a gesture bound to this component will be accepted.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13028,7 +13043,7 @@ export declare interface CommonMethod {
* Binds a custom gesture recognizer judgment callback to the component.
*
* @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13048,7 +13063,7 @@ export declare interface CommonMethod {
* @param { GestureRecognizerJudgeBeginCallback } callback - A callback instance used when a gesture bound to this component will be accepted.
* @param { boolean } exposeInnerGesture - This parameter is a flag. This flag determines whether to expose internal gestures.
* @default false
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13059,7 +13074,7 @@ export declare interface CommonMethod {
* Provides a callback to set the parallel relationship between built-in gestures and gestures of other components in the response chain.
*
* @param { ShouldBuiltInRecognizerParallelWithCallback } callback - A callback instance used when a component is doing touch test.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13072,7 +13087,7 @@ export declare interface CommonMethod {
*
* @param { boolean } monopolize - indicate the monopoly of events
* @default false
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13083,7 +13098,7 @@ export declare interface CommonMethod {
* When the component does a touch test, a user-defined callback is triggered.
*
* @param { Callback } callback - A callback instance used when the component does a touch test.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@@ -13095,7 +13110,7 @@ export declare interface CommonMethod {
* This event is not triggered for render attribute changes caused by re-rendering.
*
* @param { SizeChangeCallback } event - event callback.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
@@ -13107,7 +13122,7 @@ export declare interface CommonMethod {
* Accessibility focus draw level, and the default value is FocusDrawLevel.SELF.
*
* @param { FocusDrawLevel } drawLevel - indicates accessibility focus draw level.
- * @returns { T }
+ * @returns { this }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @form
--
Gitee