diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index d6b0b08d4..c04fe7824 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -10675,3 +10675,23 @@ declare module 'DragControllerParam' { export type { CustomBuilder, DragItemInfo, DragEvent }; } } + +/** + * Define EdgeEffect Options. + * + * @interface EdgeEffectOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ +declare interface EdgeEffectOptions { + /** + * Enable Sliding effect when component does not full screen. + * + * @type { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + alwaysEnabled: boolean; +} \ No newline at end of file diff --git a/api/@internal/component/ets/grid.d.ts b/api/@internal/component/ets/grid.d.ts index e189899a8..afe1a5aa0 100644 --- a/api/@internal/component/ets/grid.d.ts +++ b/api/@internal/component/ets/grid.d.ts @@ -656,7 +656,17 @@ declare class GridAttribute extends CommonMethod { * @crossplatform * @since 10 */ - edgeEffect(value: EdgeEffect): GridAttribute; + /** + * Called when the sliding effect is set. + * + * @param { EdgeEffect } value + * @param { EdgeEffectOptions } options + * @returns { GridAttribute } The attribute of the grid + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + edgeEffect(value: EdgeEffect, options?: EdgeEffectOptions): GridAttribute; /** * Called to setting the nested scroll options. diff --git a/api/@internal/component/ets/list.d.ts b/api/@internal/component/ets/list.d.ts index 9712f8467..c542d4159 100644 --- a/api/@internal/component/ets/list.d.ts +++ b/api/@internal/component/ets/list.d.ts @@ -666,7 +666,18 @@ declare class ListAttribute extends CommonMethod { * @since 10 * @form */ - edgeEffect(value: EdgeEffect): ListAttribute; + /** + * Called when the sliding effect is set. + * + * @param { EdgeEffect } value + * @param { EdgeEffectOptions } options + * @returns { ListAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + * @form + */ + edgeEffect(value: EdgeEffect, options?: EdgeEffectOptions): ListAttribute; /** * Called when the ListItem split line style is set. diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index 5169c3c1d..a390dd561 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -643,7 +643,17 @@ declare class ScrollAttribute extends CommonMethod { * @crossplatform * @since 10 */ - edgeEffect(edgeEffect: EdgeEffect): ScrollAttribute; + /** + * Called when the sliding effect is set. + * + * @param { EdgeEffect } edgeEffect + * @param { EdgeEffectOptions } options + * @returns { ScrollAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 11 + */ + edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): ScrollAttribute; /** * Called when scrolling begin each frame.