From 71afc62a5df962ff2d80644db28a6c61df359ccd Mon Sep 17 00:00:00 2001 From: DaTeng Date: Thu, 13 Jun 2024 06:29:53 +0000 Subject: [PATCH] =?UTF-8?q?=E9=83=A8=E5=88=86=E6=96=87=E4=BB=B6=E8=A1=A5?= =?UTF-8?q?=E5=85=85=E5=85=83=E6=9C=8D=E5=8A=A1=E6=A0=87=E7=AD=BE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: DaTeng --- api/@internal/component/ets/units.d.ts | 49 +++++++++++++++++ api/@ohos.arkui.UIContext.d.ts | 58 ++++++++++++++++++++ api/@ohos.arkui.advanced.SegmentButton.d.ets | 6 ++ 3 files changed, 113 insertions(+) diff --git a/api/@internal/component/ets/units.d.ts b/api/@internal/component/ets/units.d.ts index 441e6a81eb..cd873de280 100644 --- a/api/@internal/component/ets/units.d.ts +++ b/api/@internal/component/ets/units.d.ts @@ -404,6 +404,7 @@ declare type Padding = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare interface LocalizedPadding { @@ -414,6 +415,7 @@ declare interface LocalizedPadding { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ top?: LengthMetrics; @@ -425,6 +427,7 @@ declare interface LocalizedPadding { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ end?: LengthMetrics; @@ -436,6 +439,7 @@ declare interface LocalizedPadding { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ bottom?: LengthMetrics; @@ -447,6 +451,7 @@ declare interface LocalizedPadding { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ start?: LengthMetrics; @@ -650,6 +655,7 @@ declare type EdgeWidths = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare interface LocalizedEdgeWidths { @@ -660,6 +666,7 @@ declare interface LocalizedEdgeWidths { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ top?: LengthMetrics; @@ -671,6 +678,7 @@ declare interface LocalizedEdgeWidths { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ end?: LengthMetrics; @@ -682,6 +690,7 @@ declare interface LocalizedEdgeWidths { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ bottom?: LengthMetrics; @@ -693,6 +702,7 @@ declare interface LocalizedEdgeWidths { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ start?: LengthMetrics; @@ -910,6 +920,7 @@ declare type BorderRadiuses = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare interface LocalizedBorderRadiuses { @@ -920,6 +931,7 @@ declare interface LocalizedBorderRadiuses { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ topStart?: LengthMetrics; @@ -931,6 +943,7 @@ declare interface LocalizedBorderRadiuses { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ topEnd?: LengthMetrics; @@ -942,6 +955,7 @@ declare interface LocalizedBorderRadiuses { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ bottomStart?: LengthMetrics; @@ -953,6 +967,7 @@ declare interface LocalizedBorderRadiuses { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ bottomEnd?: LengthMetrics; @@ -1230,6 +1245,7 @@ declare interface LocalizedEdgeColors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare type LocalizedMargin = LocalizedPadding; @@ -1647,6 +1663,7 @@ declare type VoidCallback = () => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUnit; @@ -1657,6 +1674,7 @@ declare type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUn * @typedef { import('../api/arkui/Graphics').LengthMetrics } LengthMetrics * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics; @@ -1667,6 +1685,7 @@ declare type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics; * @typedef { import('../api/arkui/Graphics').ColorMetrics } ColorMetrics * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type ColorMetrics = import('../api/arkui/Graphics').ColorMetrics; @@ -2095,6 +2114,7 @@ declare interface Position { * @interface LocalizedPosition * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface LocalizedPosition { @@ -2104,6 +2124,7 @@ declare interface LocalizedPosition { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ start?: LengthMetrics; @@ -2114,6 +2135,7 @@ declare interface LocalizedPosition { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ top?: LengthMetrics; @@ -2185,6 +2207,7 @@ declare interface Edges { * @interface LocalizedEdges * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface LocalizedEdges { @@ -2194,6 +2217,7 @@ declare interface LocalizedEdges { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ top?: LengthMetrics; @@ -2204,6 +2228,7 @@ declare interface LocalizedEdges { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ start?: LengthMetrics; @@ -2214,6 +2239,7 @@ declare interface LocalizedEdges { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ bottom?: LengthMetrics; @@ -2224,6 +2250,7 @@ declare interface LocalizedEdges { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ end?: LengthMetrics; @@ -2618,6 +2645,16 @@ declare interface SizeOptions { * @since 11 * @form */ +/** + * Defines the options of border. + * + * @interface BorderOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + * @form + */ declare interface BorderOptions { /** * Defines the border width. @@ -2799,6 +2836,7 @@ declare interface BorderOptions { * @type { ?(EdgeWidths | LengthMetrics | LocalizedEdgeWidths) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ dashGap?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; @@ -2809,6 +2847,7 @@ declare interface BorderOptions { * @type { ?(EdgeWidths | LengthMetrics | LocalizedEdgeWidths) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ dashWidth?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; @@ -3108,6 +3147,7 @@ declare interface TouchPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ declare interface DirectionalEdgesT { @@ -3118,6 +3158,7 @@ declare interface DirectionalEdgesT { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ start: T; @@ -3129,6 +3170,7 @@ declare interface DirectionalEdgesT { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ end: T; @@ -3140,6 +3182,7 @@ declare interface DirectionalEdgesT { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ top: T; @@ -3151,6 +3194,7 @@ declare interface DirectionalEdgesT { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form + * @atomicservice * @since 12 */ bottom: T; @@ -3162,6 +3206,7 @@ declare interface DirectionalEdgesT { * @interface DividerStyleOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare interface DividerStyleOptions { @@ -3171,6 +3216,7 @@ declare interface DividerStyleOptions { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ strokeWidth?: LengthMetrics; @@ -3181,6 +3227,7 @@ declare interface DividerStyleOptions { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ color?: ResourceColor; @@ -3191,6 +3238,7 @@ declare interface DividerStyleOptions { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ startMargin?: LengthMetrics; @@ -3201,6 +3249,7 @@ declare interface DividerStyleOptions { * @type { ?LengthMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ endMargin?: LengthMetrics; diff --git a/api/@ohos.arkui.UIContext.d.ts b/api/@ohos.arkui.UIContext.d.ts index 94dd3be7c7..4dfcca5899 100644 --- a/api/@ohos.arkui.UIContext.d.ts +++ b/api/@ohos.arkui.UIContext.d.ts @@ -190,6 +190,14 @@ export class UIInspector { * @atomicservice * @since 11 */ +/** + * class Router + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ export class Router { /** * Navigates to a specified page in the application based on the page URL and parameters. @@ -497,6 +505,7 @@ export class Router { * @param { Object } [params] - params of page. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ back(index: number, params?: Object): void; @@ -563,6 +572,7 @@ export class Router { * @returns { router.RouterState | undefined } Page state. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getStateByIndex(index: number): router.RouterState | undefined; @@ -574,6 +584,7 @@ export class Router { * @returns { Array } Page state. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ getStateByUrl(url: string): Array; @@ -976,6 +987,21 @@ export class PromptAction { * @atomicservice * @since 11 */ + /** + * Displays the dialog box. + * + * @param { promptAction.ShowDialogOptions } options - Options. + * @param { AsyncCallback } callback - the callback of showDialog. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameters types. + *
3. Parameter verification failed. + * @throws { BusinessError } 100001 - Internal error. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 12 + */ showDialog(options: promptAction.ShowDialogOptions, callback: AsyncCallback): void; /** @@ -1142,6 +1168,7 @@ export class PromptAction { * @param { FrameNode } [node] - the information of frameNode * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) => void; @@ -1156,6 +1183,7 @@ declare type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) * @param { FrameNode } [node] - the information of frameNode * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ declare type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNode) => void; @@ -1276,6 +1304,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the scroll event start or stop. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'scrollEvent', options: observer.ObserverOptions, callback: Callback): void; @@ -1289,6 +1318,7 @@ export class UIObserver { * scroll ID will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'scrollEvent', options: observer.ObserverOptions, callback?: Callback): void; @@ -1300,6 +1330,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the scroll event start or stop. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'scrollEvent', callback: Callback): void; @@ -1312,6 +1343,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'scrollEvent', callback?: Callback): void; @@ -1367,6 +1399,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the screen density is updated. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'densityUpdate', callback: Callback): void; @@ -1379,6 +1412,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'densityUpdate', callback?: Callback): void; @@ -1390,6 +1424,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the draw command will be drawn. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'willDraw', callback: Callback): void; @@ -1402,6 +1437,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'willDraw', callback?: Callback): void; @@ -1413,6 +1449,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the layout is done. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'didLayout', callback: Callback): void; @@ -1425,6 +1462,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'didLayout', callback?: Callback): void; @@ -1436,6 +1474,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on( @@ -1451,6 +1490,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off( @@ -1466,6 +1506,7 @@ export class UIObserver { * @param { Callback } callback - The callback function to be called when the navigation switched to a new navDestination. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on( @@ -1483,6 +1524,7 @@ export class UIObserver { * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off( @@ -1499,6 +1541,7 @@ export class UIObserver { * when the clickEvent will be trigger or after. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'willClick', callback: ClickEventListenerCallback): void; @@ -1511,6 +1554,7 @@ export class UIObserver { * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'willClick', callback?: ClickEventListenerCallback): void; @@ -1523,6 +1567,7 @@ export class UIObserver { * when the clickEvent will be trigger or after. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'didClick', callback: ClickEventListenerCallback): void; @@ -1535,6 +1580,7 @@ export class UIObserver { * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'didClick', callback?: ClickEventListenerCallback): void; @@ -1547,6 +1593,7 @@ export class UIObserver { * when the clickEvent will be trigger or after. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'willClick', callback: GestureEventListenerCallback): void; @@ -1559,6 +1606,7 @@ export class UIObserver { * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'willClick', callback?: GestureEventListenerCallback): void; @@ -1571,6 +1619,7 @@ export class UIObserver { * when the clickEvent will be trigger or after. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ on(type: 'didClick', callback: GestureEventListenerCallback): void; @@ -1583,6 +1632,7 @@ export class UIObserver { * all callbacks for the given event type will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ off(type: 'didClick', callback?: GestureEventListenerCallback): void; @@ -1626,6 +1676,7 @@ export class ComponentUtils { * class OverlayManager * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ export class OverlayManager { @@ -1636,6 +1687,7 @@ export class OverlayManager { * @param { number } [ index ] - The index at which to add the ComponentContent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ addComponentContent(content: ComponentContent, index?: number): void; @@ -1646,6 +1698,7 @@ export class OverlayManager { * @param { ComponentContent } content - The content will be removed from the OverlayManager. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ removeComponentContent(content: ComponentContent): void; @@ -1656,6 +1709,7 @@ export class OverlayManager { * @param { ComponentContent } content - The content will be shown. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ showComponentContent(content: ComponentContent): void; @@ -1666,6 +1720,7 @@ export class OverlayManager { * @param { ComponentContent } content - The content will be hidden. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ hideComponentContent(content: ComponentContent): void; @@ -1675,6 +1730,7 @@ export class OverlayManager { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ showAllComponentContents(): void; @@ -1684,6 +1740,7 @@ export class OverlayManager { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ hideAllComponentContents(): void; @@ -2118,6 +2175,7 @@ export abstract class FrameCallback { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @crossplatform + * @atomicservice * @since 12 */ export type Context = common.Context; diff --git a/api/@ohos.arkui.advanced.SegmentButton.d.ets b/api/@ohos.arkui.advanced.SegmentButton.d.ets index f382dd1b33..543cbc4103 100644 --- a/api/@ohos.arkui.advanced.SegmentButton.d.ets +++ b/api/@ohos.arkui.advanced.SegmentButton.d.ets @@ -445,6 +445,7 @@ interface CommonSegmentButtonOptions { * {{ top: LengthMetrics.vp(6), end: LengthMetrics.vp(8), bottom: LengthMetrics.vp(6), start: LengthMetrics.vp(8) }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ localizedButtonPadding?: LocalizedPadding; @@ -476,6 +477,7 @@ interface CommonSegmentButtonOptions { * @type { ?LocalizedPadding } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ localizedTextPadding?: LocalizedPadding; @@ -505,6 +507,7 @@ interface CommonSegmentButtonOptions { * @type { ?Direction } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ direction?: Direction; @@ -1336,6 +1339,7 @@ declare class SegmentButtonOptions { * @type { ?LocalizedPadding } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ localizedButtonPadding?: LocalizedPadding; @@ -1365,6 +1369,7 @@ declare class SegmentButtonOptions { * @type { ?LocalizedPadding } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ localizedTextPadding?: LocalizedPadding; @@ -1459,6 +1464,7 @@ declare class SegmentButtonOptions { * @type { ?Direction } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform + * @atomicservice * @since 12 */ direction?: Direction;