已合并
API扫描问题修改 #33440
yangcan18创建于 6月2日
API扫描问题修改 #33440
已合并
共 4 个文件变更+25-12
| @@ -240,7 +240,7 @@ declare interface ListItemGroupOptions { | |||
| 240 | space?: number | string; | 240 | space?: number | string; |
| 241 | 241 | ||
| 242 | /** | 242 | /** |
| 243 | - * Spacing between list items along the main axis. | 243 | + * Spacing between list items along the main axis.<br>Unit: vp |
| 244 | * | 244 | * |
| 245 | * <p><strong>NOTE</strong> | 245 | * <p><strong>NOTE</strong> |
| 246 | * <br>If this parameter is set to a negative number or a value greater than or equal to the length of the list | 246 | * <br>If this parameter is set to a negative number or a value greater than or equal to the length of the list |
| @@ -283,7 +283,7 @@ declare interface ListItemGroupOptions { | |||
| 283 | 283 | ||
| 284 | /** | 284 | /** |
| 285 | * Describes the ListItemGroup header style. | 285 | * Describes the ListItemGroup header style. |
| 286 | - * @default ListItemGroupAttribute.NONE | 286 | + * @default ListItemGroupHeaderFooterStyle.NONE |
| 287 | * SystemCapability.ArkUI.ArkUI.Full | 287 | * SystemCapability.ArkUI.ArkUI.Full |
| 288 | * | 288 | * |
| 289 | * | 289 | * |
| @@ -294,7 +294,7 @@ declare interface ListItemGroupOptions { | |||
| 294 | 294 | ||
| 295 | /** | 295 | /** |
| 296 | * Describes the ListItemGroup footer style. | 296 | * Describes the ListItemGroup footer style. |
| 297 | - * @default ListItemGroupAttribute.NONE | 297 | + * @default ListItemGroupHeaderFooterStyle.NONE |
| 298 | * SystemCapability.ArkUI.ArkUI.Full | 298 | * SystemCapability.ArkUI.ArkUI.Full |
| 299 | * | 299 | * |
| 300 | * | 300 | * |
| @@ -465,7 +465,7 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> { | |||
| 465 | /** | 465 | /** |
| 466 | * The pull-down offset to trigger refresh. | 466 | * The pull-down offset to trigger refresh. |
| 467 | * | 467 | * |
| 468 | - * @param { number } value | 468 | + * @param { number } value - The pull-down offset to trigger refresh, in vp. |
| 469 | * { RefreshAttribute } | 469 | * { RefreshAttribute } |
| 470 | * SystemCapability.ArkUI.ArkUI.Full | 470 | * SystemCapability.ArkUI.ArkUI.Full |
| 471 | * | 471 | * |
| @@ -478,7 +478,7 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> { | |||
| 478 | /** | 478 | /** |
| 479 | * The pull-down offset to trigger refresh. | 479 | * The pull-down offset to trigger refresh. |
| 480 | * | 480 | * |
| 481 | - * @param { number | Resource } value - The pull-down offset to trigger refresh. | 481 | + * @param { number | Resource } value - The pull-down offset to trigger refresh, in vp. |
| 482 | * { RefreshAttribute } | 482 | * { RefreshAttribute } |
| 483 | * SystemCapability.ArkUI.ArkUI.Full | 483 | * SystemCapability.ArkUI.ArkUI.Full |
| 484 | * | 484 | * |
| @@ -544,8 +544,12 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> { | |||
| 544 | /** | 544 | /** |
| 545 | * The max pull down distance for Refresh. | 545 | * The max pull down distance for Refresh. |
| 546 | * | 546 | * |
| 547 | - * @param { Optional<number> } distance - The max pull down distance for Refresh, | 547 | + * @param { Optional<number> } distance - The max pull down distance for Refresh, in vp. |
| 548 | - * value range is [0, +∞), default value is { undefined }. | 548 | + * The value must be greater than or equal to 0. Values less than 0 are treated as 0. |
| 549 | + * If this value is less than the refresh pull-down offset (<em>refreshOffset</em>), | ||
| 550 | + * releasing after pull-down will not trigger a refresh. | ||
| 551 | + * <br>Setting the value to <em>undefined</em> or <em>null</em> means this attribute is not set, | ||
| 552 | + * i.e., there is no maximum pull-down distance limit. | ||
| 549 | * { RefreshAttribute } The attribute of the Refresh. | 553 | * { RefreshAttribute } The attribute of the Refresh. |
| 550 | * SystemCapability.ArkUI.ArkUI.Full | 554 | * SystemCapability.ArkUI.ArkUI.Full |
| 551 | * | 555 | * |
| @@ -558,8 +562,12 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> { | |||
| 558 | /** | 562 | /** |
| 559 | * The max pull down distance for Refresh. | 563 | * The max pull down distance for Refresh. |
| 560 | * | 564 | * |
| 561 | - * @param { number | Resource | undefined } distance - The max pull down distance for Refresh, | 565 | + * @param { number | Resource | undefined } distance - The max pull down distance for Refresh, in vp. |
| 562 | - * value range is [0, +∞), default value is { undefined }. | 566 | + * The value must be greater than or equal to 0. Values less than 0 are treated as 0. |
| 567 | + * If this value is less than the refresh pull-down offset (<em>refreshOffset</em>), | ||
| 568 | + * releasing after pull-down will not trigger a refresh. | ||
| 569 | + * <br>Setting the value to <em>undefined</em> or <em>null</em> means this attribute is not set, | ||
| 570 | + * i.e., there is no maximum pull-down distance limit. | ||
| 563 | * { RefreshAttribute } The attribute of the Refresh. | 571 | * { RefreshAttribute } The attribute of the Refresh. |
| 564 | * SystemCapability.ArkUI.ArkUI.Full | 572 | * SystemCapability.ArkUI.ArkUI.Full |
| 565 | * | 573 | * |
| @@ -85,7 +85,7 @@ export declare class LazyWaterFlowLayoutAttribute<T> extends CommonMethod<T> { | |||
| 85 | * Called when the first or last item displayed in the component changes. | 85 | * Called when the first or last item displayed in the component changes. |
| 86 | * It is triggered once when the component is initialized. | 86 | * It is triggered once when the component is initialized. |
| 87 | * | 87 | * |
| 88 | - * @param { onVisibleIndexesChangeCallback | undefined } callback - callback function, triggered | 88 | + * @param { OnVisibleIndexesChangeCallback | undefined } callback - callback function, triggered |
| 89 | * when the index of child components in the visible area changes. | 89 | * when the index of child components in the visible area changes. |
| 90 | * <br>Passing undefined will unregister the callback. | 90 | * <br>Passing undefined will unregister the callback. |
| 91 | * { T } | 91 | * { T } |
| @@ -95,7 +95,7 @@ export declare class LazyWaterFlowLayoutAttribute<T> extends CommonMethod<T> { | |||
| 95 | * | 95 | * |
| 96 | * 26.0.0 dynamic | 96 | * 26.0.0 dynamic |
| 97 | */ | 97 | */ |
| 98 | - onVisibleIndexesChange(callback: onVisibleIndexesChangeCallback | undefined): T; | 98 | + onVisibleIndexesChange(callback: OnVisibleIndexesChangeCallback | undefined): T; |
| 99 | } | 99 | } |
| 100 | 100 | ||
| 101 | /** | 101 | /** |
| @@ -114,6 +114,11 @@ export declare class LazyVWaterFlowLayoutAttribute extends LazyWaterFlowLayoutAt | |||
| 114 | * | 114 | * |
| 115 | * { string | ItemFillPolicy | undefined } value - Number of columns in the layout. | 115 | * { string | ItemFillPolicy | undefined } value - Number of columns in the layout. |
| 116 | * <br>Default value: '1fr' | 116 | * <br>Default value: '1fr' |
| 117 | + * <br>When the value is a string, it sets the number of columns or the minimum column width | ||
| 118 | + * of the current <em>LazyVWaterFlowLayout</em>. For example, | ||
| 119 | + * <em>columnsTemplate('1fr 1fr 2fr')</em> divides the <em>LazyVWaterFlowLayout</em> into 3 columns, | ||
| 120 | + * splitting the width into 4 equal parts: column 1 takes 1 part, column 2 takes 1 part, | ||
| 121 | + * and column 3 takes 2 parts. | ||
| 117 | * { LazyVWaterFlowLayoutAttribute } | 122 | * { LazyVWaterFlowLayoutAttribute } |
| 118 | * SystemCapability.ArkUI.ArkUI.Full | 123 | * SystemCapability.ArkUI.ArkUI.Full |
| 119 | * | 124 | * |
| @@ -703,7 +703,7 @@ export declare interface GridAttribute extends ScrollableCommonMethod { | |||
| 703 | * Sets the focus wrap mode of the Gird component. | 703 | * Sets the focus wrap mode of the Gird component. |
| 704 | * | 704 | * |
| 705 | * @param { FocusWrapMode | undefined } mode - the focus wrap mode of the Grid component. | 705 | * @param { FocusWrapMode | undefined } mode - the focus wrap mode of the Grid component. |
| 706 | - * <br>Default value: **FocusWrapMode.DEFAULT**. Passing undefined will restore the default value. | 706 | + * <br>Default value: <em>FocusWrapMode.DEFAULT</em>. Passing undefined will restore the default value. |
| 707 | * @returns { this } the attribute of the Grid. | 707 | * @returns { this } the attribute of the Grid. |
| 708 | * @syscap SystemCapability.ArkUI.ArkUI.Full | 708 | * @syscap SystemCapability.ArkUI.ArkUI.Full |
| 709 | * @stagemodelonly | 709 | * @stagemodelonly |