diff --git a/api/@ohos.arkui.UIContext.d.ets b/api/@ohos.arkui.UIContext.d.ets index 8c70c346347cff2a91af7cd52cc83b91a2287b64..ad231bd85d0910cad79f06ef01280832cbf539af 100644 --- a/api/@ohos.arkui.UIContext.d.ets +++ b/api/@ohos.arkui.UIContext.d.ets @@ -39,22 +39,9 @@ import { ClickEvent,CustomBuilder,ExpectedFrameRateRange,DragItemInfo,AnimatePar import { GestureEvent } from './arkui/component/gesture' import { ResourceStr,SizeOptions } from './arkui/component/units' import { Nullable } from './arkui/component/enums' -import { TimePickerDialogOptions } from './arkui/component/timePicker' -import { AlertDialogParamWithConfirm,AlertDialogParamWithButtons,AlertDialogParamWithOptions } from './arkui/component/alertDialog' -import { ActionSheetOptions } from './arkui/component/actionSheet' -import { TextPickerDialogOptions } from './arkui/component/textPicker' import { LocalStorage } from '@ohos.arkui.stateManagement'; -import { DatePickerDialogOptions } from './arkui/component/datePicker' -import { TabsController } from './arkui/component/tabs' -import { Scroller } from './arkui/component/scroll' import { Color,FontStyle,WidthBreakpoint,HeightBreakpoint } from './arkui/component/enums' -/** - * class Font - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class Font * @@ -64,14 +51,7 @@ import { Color,FontStyle,WidthBreakpoint,HeightBreakpoint } from './arkui/compon * @since 11 */ export declare class Font { - /** - * Register a customized font in the FontManager. - * - * @param { font.FontOptions } options - FontOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Register a customized font in the FontManager. * @@ -83,12 +63,7 @@ export declare class Font { */ registerFont(options: font.FontOptions): void; - /** - * Gets a list of fonts supported by system. - * @returns { Array } A list of font names - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ + /** * Gets a list of fonts supported by system. * @returns { Array } A list of font names @@ -98,13 +73,7 @@ export declare class Font { */ getSystemFontList(): Array; - /** - * Get font details according to the font name. - * @param { string } fontName - font name - * @returns { font.FontInfo } Returns the font info - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ + /** * Get font details according to the font name. * @param { string } fontName - font name @@ -116,13 +85,7 @@ export declare class Font { getFontByName(fontName: string): font.FontInfo; } -/** - * class MediaQuery - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class MediaQuery * @@ -132,15 +95,7 @@ export declare class Font { * @since 11 */ export declare class MediaQuery { - /** - * Sets the media query criteria and returns the corresponding listening handle - * - * @param { string } condition - media conditions - * @returns { mediaQuery.MediaQueryListener } the corresponding listening handle - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Sets the media query criteria and returns the corresponding listening handle * @@ -154,12 +109,7 @@ export declare class MediaQuery { matchMediaSync(condition: string): mediaQuery.MediaQueryListener; } -/** - * class UIInspector - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class UIInspector * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -168,14 +118,7 @@ export declare class MediaQuery { * @since 11 */ export declare class UIInspector { - /** - * Sets the component after layout or draw criteria and returns the corresponding listening handle - * @param { string } id - component id. - * @returns { inspector.ComponentObserver } create listener for observer component event. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Sets the component after layout or draw criteria and returns the corresponding listening handle * @param { string } id - component id. @@ -188,21 +131,8 @@ export declare class UIInspector { createComponentObserver(id: string): inspector.ComponentObserver; } -/** - * class Router - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ -/** - * class Router - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ + + /** * class Router * @@ -212,22 +142,7 @@ export declare class UIInspector { * @since 12 */ export declare class Router { - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * - * @param { router.RouterOptions } options - Options. - * @param { AsyncCallback } callback - the callback of pushUrl. - * @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. - * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @@ -247,22 +162,7 @@ export declare class Router { */ pushUrl(options: router.RouterOptions, callback: AsyncCallback): void; - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * - * @param { router.RouterOptions } options - Options. - * @returns { Promise } the promise returned by the function. - * @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. - * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @@ -282,23 +182,7 @@ export declare class Router { */ pushUrl(options: router.RouterOptions): Promise; - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * - * @param { router.RouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @param { AsyncCallback } callback - the callback of pushUrl. - * @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. - * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @@ -319,23 +203,7 @@ export declare class Router { */ pushUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * - * @param { router.RouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @returns { Promise } the promise returned by the function. - * @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. - * @throws { BusinessError } 100002 - Uri error. The URI of the page to redirect is incorrect or does not exist - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @@ -356,21 +224,7 @@ export declare class Router { */ pushUrl(options: router.RouterOptions, mode: router.RouterMode): Promise; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * - * @param { router.RouterOptions } options - Options. - * @param { AsyncCallback } callback - the callback of replaceUrl. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @@ -389,21 +243,7 @@ export declare class Router { */ replaceUrl(options: router.RouterOptions, callback: AsyncCallback): void; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * - * @param { router.RouterOptions } options - Options. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @@ -422,22 +262,7 @@ export declare class Router { */ replaceUrl(options: router.RouterOptions): Promise; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * - * @param { router.RouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @param { AsyncCallback } callback - the callback of replaceUrl. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @@ -457,22 +282,7 @@ export declare class Router { */ replaceUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * - * @param { router.RouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system. - * @throws { BusinessError } 200002 - Uri error. The URI of the page to be used for replacement is incorrect or does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @@ -492,14 +302,7 @@ export declare class Router { */ replaceUrl(options: router.RouterOptions, mode: router.RouterMode): Promise; - /** - * Returns to the previous page or a specified page. - * - * @param { router.RouterOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Returns to the previous page or a specified page. * @@ -523,13 +326,7 @@ export declare class Router { */ back(index: number, params?: Object): void; - /** - * Clears all historical pages and retains only the current page at the top of the stack. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Clears all historical pages and retains only the current page at the top of the stack. * @@ -540,14 +337,7 @@ export declare class Router { */ clear(): void; - /** - * Obtains the number of pages in the current stack. - * - * @returns { string } Number of pages in the stack. The maximum value is 32. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Obtains the number of pages in the current stack. * @@ -559,14 +349,7 @@ export declare class Router { */ getLength(): string; - /** - * Obtains information about the current page state. - * - * @returns { router.RouterState } Page state. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Obtains information about the current page state. * @@ -602,19 +385,7 @@ export declare class Router { */ getStateByUrl(url: string): Array; - /** - * Pop up alert dialog to ask whether to back. - * - * @param { router.EnableAlertOptions } options - Options. - * @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 - * @since 10 - */ + /** * Pop up alert dialog to ask whether to back. * @@ -631,13 +402,7 @@ export declare class Router { */ showAlertBeforeBackPage(options: router.EnableAlertOptions): void; - /** - * Hide alert before back page. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Hide alert before back page. * @@ -648,14 +413,7 @@ export declare class Router { */ hideAlertBeforeBackPage(): void; - /** - * Obtains information about the current page params. - * - * @returns { Object } Page params. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Obtains information about the current page params. * @@ -667,21 +425,7 @@ export declare class Router { */ getParams(): Object; - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * @param { router.NamedRouterOptions } options - Options. - * @param { AsyncCallback } callback - the callback of pushNamedRoute. - * @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. - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @param { router.NamedRouterOptions } options - Options. @@ -700,21 +444,7 @@ export declare class Router { */ pushNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback): void; - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * @param { router.NamedRouterOptions } options - Options. - * @returns { Promise } the promise returned by the function. - * @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. - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Navigates to a specified page in the application based on the page URL and parameters. * @param { router.NamedRouterOptions } options - Options. @@ -729,50 +459,16 @@ export declare class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 - */ - pushNamedRoute(options: router.NamedRouterOptions): Promise; - - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * @param { router.NamedRouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @param { AsyncCallback } callback - the callback of pushNamedRoute. - * @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. - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * Navigates to a specified page in the application based on the page URL and parameters. - * @param { router.NamedRouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @param { AsyncCallback } callback - the callback of pushNamedRoute. - * @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. - * @throws { BusinessError } 100003 - Page stack error. Too many pages are pushed. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; + * @since 11 + */ + pushNamedRoute(options: router.NamedRouterOptions): Promise; + /** * Navigates to a specified page in the application based on the page URL and parameters. * @param { router.NamedRouterOptions } options - Options. * @param { router.RouterMode } mode - RouterMode. - * @returns { Promise } the promise returned by the function. + * @param { AsyncCallback } callback - the callback of pushNamedRoute. * @throws { BusinessError } 401 - Parameter error. Possible causes: *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. @@ -782,8 +478,12 @@ export declare class Router { * @throws { BusinessError } 100004 - Named route error. The named route does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 10 + * @atomicservice + * @since 11 */ + pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; + + /** * Navigates to a specified page in the application based on the page URL and parameters. * @param { router.NamedRouterOptions } options - Options. @@ -803,20 +503,7 @@ export declare class Router { */ pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * @param { router.NamedRouterOptions } options - Options. - * @param { AsyncCallback } callback - the callback of replaceNamedRoute. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @param { router.NamedRouterOptions } options - Options. @@ -834,20 +521,7 @@ export declare class Router { */ replaceNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback): void; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * @param { router.NamedRouterOptions } options - Options. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @param { router.NamedRouterOptions } options - Options. @@ -862,21 +536,7 @@ export declare class Router { */ replaceNamedRoute(options: router.NamedRouterOptions): Promise; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * @param { router.NamedRouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @param { AsyncCallback } callback - the callback of replaceNamedRoute. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - The UI execution context is not found. This error code is thrown only in the standard system. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @param { router.NamedRouterOptions } options - Options. @@ -892,21 +552,7 @@ export declare class Router { */ replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; - /** - * Replaces the current page with another one in the application. The current page is destroyed after replacement. - * @param { router.NamedRouterOptions } options - Options. - * @param { router.RouterMode } mode - RouterMode. - * @returns { Promise } the promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - Failed to get the delegate. This error code is thrown only in the standard system. - * @throws { BusinessError } 100004 - Named route error. The named route does not exist. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Replaces the current page with another one in the application. The current page is destroyed after replacement. * @param { router.NamedRouterOptions } options - Options. @@ -926,13 +572,7 @@ export declare class Router { replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise; } -/** - * class PromptAction - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class PromptAction * @@ -942,19 +582,7 @@ export declare class Router { * @since 11 */ export declare class PromptAction { - /** - * Displays the notification text. - * - * @param { promptAction.ShowToastOptions } options - Options. - * @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 - * @since 10 - */ + /** * Displays the notification text. * @@ -1004,35 +632,8 @@ export declare class PromptAction { */ closeToast(toastId: number): void; - /** - * 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 - * @since 10 - */ - /** - * 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 11 - */ + + /** * Displays the dialog box. * @@ -1050,20 +651,7 @@ export declare class PromptAction { */ showDialog(options: promptAction.ShowDialogOptions, callback: AsyncCallback): void; - /** - * Displays the dialog box. - * - * @param { promptAction.ShowDialogOptions } options - Options. - * @returns { Promise } the promise returned by the function. - * @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 - * @since 10 - */ + /** * Displays the dialog box. * @@ -1116,20 +704,7 @@ export declare class PromptAction { */ showActionMenu(options: promptAction.ActionMenuOptions, callback: AsyncCallback): void; - /** - * Displays the menu. - * - * @param { promptAction.ActionMenuOptions } options - Options. - * @returns { Promise } callback - the callback of showActionMenu. - * @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 - * @since 10 - */ + /** * Displays the menu. * @@ -1303,13 +878,7 @@ export interface PageInfo { } export interface NavigationOptions { navigationId: ResourceStr } -/** - * Register callbacks to observe ArkUI behavior. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ + /** * Register callbacks to observe ArkUI behavior. * @@ -1811,12 +1380,7 @@ export declare class UIObserver { // off(type: 'tabContentUpdate', callback?: Callback): void; } -/** - * class ComponentUtils - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class ComponentUtils * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1825,15 +1389,7 @@ export declare class UIObserver { * @since 11 */ export declare class ComponentUtils { - /** - * Provide the ability to obtain the coordinates and size of component drawing areas. - * - * @param { string } id - ID of the component whose attributes are to be obtained. - * @returns { componentUtils.ComponentInfo } the object of ComponentInfo. - * @throws { BusinessError } 100001 - UI execution context not found. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ + /** * Provide the ability to obtain the coordinates and size of component drawing areas. * @@ -1921,13 +1477,7 @@ export declare class OverlayManager { hideAllComponentContents(): void; } -/** - * interface AtomicServiceBar - * @interface AtomicServiceBar - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ + /** * interface AtomicServiceBar * @interface AtomicServiceBar @@ -1947,13 +1497,7 @@ export interface AtomicServiceBar { */ setVisible(visible: boolean): void; - /** - * Set the background color of the bar. - * - * @param { Nullable< Color | number | string> } color - the color to set, undefined indicates using default. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Set the background color of the bar. * @@ -1964,13 +1508,7 @@ export interface AtomicServiceBar { */ setBackgroundColor(color: Nullable< Color | number | string>): void; - /** - * Set the title of the bar. - * - * @param { string } content - the content of the bar. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Set the title of the bar. * @@ -1981,13 +1519,7 @@ export interface AtomicServiceBar { */ setTitleContent(content: string): void; - /** - * Set the font style of the bar's title. - * - * @param { FontStyle } font - the font style of the bar's title. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Set the font style of the bar's title. * @@ -1998,13 +1530,7 @@ export interface AtomicServiceBar { */ setTitleFontStyle(font: FontStyle): void; - /** - * Set the color of the icon on the bar. - * - * @param { Nullable< Color | number | string> } color - the color to set to icon, undefined indicates using default. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Set the color of the icon on the bar. * @@ -2085,11 +1611,7 @@ export declare class MarqueeDynamicSyncScene extends DynamicSyncScene { readonly type: MarqueeDynamicSyncSceneType; } -/** - * class DragController - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * class DragController * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -2097,20 +1619,7 @@ export declare class MarqueeDynamicSyncScene extends DynamicSyncScene { * @since 12 */ export declare class DragController { - /** - * Execute a drag event. - * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. - * @param { dragController.DragInfo } dragInfo - Information about the drag event. - * @param { AsyncCallback<{ event: DragEvent, extraParams: string }> } callback - Callback that contains - * the drag event information. - * @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 handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Execute a drag event. * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. @@ -2123,25 +1632,13 @@ export declare class DragController { *
3. Parameter verification failed. * @throws { BusinessError } 100001 - Internal handling failed. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 12 - */ - executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo, - callback: AsyncCallback): void; - - /** - * Execute a drag event. - * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. - * @param { dragController.DragInfo } dragInfo - Information about the drag event. - * @returns { Promise<{ event: DragEvent, extraParams: string }> } A Promise with the drag event information. - * @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 handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @atomicservice + * @since 12 */ + executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo, + callback: AsyncCallback): void; + + /** * Execute a drag event. * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. @@ -2159,19 +1656,7 @@ export declare class DragController { executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo) : Promise; - /** - * Create one drag action object, which can be used for starting drag later or monitoring the drag status after drag started. - * @param { Array } customArray - Objects used for prompts displayed when the objects are dragged. - * @param { dragController.DragInfo } dragInfo - Information about the drag event. - * @returns { dragController.DragAction } one drag action object - * @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 handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Create one drag action object, which can be used for starting drag later or monitoring the drag status after drag started. * @param { Array } customArray - Objects used for prompts displayed when the objects are dragged. @@ -2188,12 +1673,7 @@ export declare class DragController { */ createDragAction(customArray: Array, dragInfo: dragController.DragInfo): dragController.DragAction; - /** - * Get a drag preview object, which provides the functions of setting color or updating animation and has no effect in OnDrop and OnDragEnd callback. - * @returns { dragController.DragPreview } A drag preview object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Get a drag preview object. * @returns { dragController.DragPreview } A drag preview object. @@ -2508,13 +1988,7 @@ export declare class ComponentSnapshot { getSync(id: string, options?: componentSnapshot.SnapshotOptions): image.PixelMap; } -/** - * class UIContext - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * class UIContext * @@ -2524,14 +1998,7 @@ export declare class ComponentSnapshot { * @since 11 */ export declare class UIContext { - /** - * get object font. - * - * @returns { Font } object Font. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object font. * @@ -2543,14 +2010,7 @@ export declare class UIContext { */ getFont(): Font; - /** - * get object mediaQuery. - * - * @returns { MediaQuery } object MediaQuery. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object mediaQuery. * @@ -2562,13 +2022,7 @@ export declare class UIContext { */ getMediaQuery(): MediaQuery; - /** - * get object UIInspector. - * @returns { UIInspector } object UIInspector. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object UIInspector. * @returns { UIInspector } object UIInspector. @@ -2611,14 +2065,7 @@ export declare class UIContext { */ getFilteredInspectorTreeById(id: string, depth: number, filters?: Array): string; - /** - * get object router. - * - * @returns { Router } object Router. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object router. * @@ -2630,14 +2077,7 @@ export declare class UIContext { */ getRouter(): Router; - /** - * get object PromptAction. - * - * @returns { PromptAction } object PromptAction. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object PromptAction. * @@ -2649,13 +2089,7 @@ export declare class UIContext { */ getPromptAction(): PromptAction; - /** - * get object ComponentUtils. - * @returns { ComponentUtils } object ComponentUtils. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * get object ComponentUtils. * @returns { ComponentUtils } object ComponentUtils. @@ -2666,14 +2100,7 @@ export declare class UIContext { */ getComponentUtils(): ComponentUtils; - /** - * Get the UI observer. - * - * @returns { UIObserver } The UI observer. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ + /** * Get the UI observer. * @@ -2696,19 +2123,7 @@ export declare class UIContext { */ getOverlayManager(): OverlayManager; - /** - * Create an animator object for custom animation. - * - * @param { AnimatorOptions } options - Options. - * @returns { AnimatorResult } - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Create an animator object for custom animation. * @@ -2725,15 +2140,7 @@ export declare class UIContext { */ createAnimator(options: AnimatorOptions): AnimatorResult; - /** - * Defining animation function - * - * @param { AnimateParam } value - parameters for animation. - * @param { function } event - the closure base on which, the system will create animation automatically - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + /** * Defining animation function * @@ -2746,109 +2153,6 @@ export declare class UIContext { */ animateTo(value: AnimateParam, event: () => void): void; - /** - * alertDialog display. - * - * @param { AlertDialogParamWithConfirm | AlertDialogParamWithButtons | AlertDialogParamWithOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * alertDialog display. - * - * @param { AlertDialogParamWithConfirm | AlertDialogParamWithButtons | AlertDialogParamWithOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - showAlertDialog(options: AlertDialogParamWithConfirm | AlertDialogParamWithButtons | AlertDialogParamWithOptions): void; - - /** - * actionSheet display. - * - * @param { ActionSheetOptions } value - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * actionSheet display. - * - * @param { ActionSheetOptions } value - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - showActionSheet(value: ActionSheetOptions): void; - - /** - * datePickerDialog display. - * - * @param { DatePickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * datePickerDialog display. - * - * @param { DatePickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - showDatePickerDialog(options: DatePickerDialogOptions): void; - - /** - * timePickerDialog display. - * - * @param { TimePickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * timePickerDialog display. - * - * @param { TimePickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - showTimePickerDialog(options: TimePickerDialogOptions): void; - - /** - * textPickerDialog display. - * - * @param { TextPickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ - /** - * textPickerDialog display. - * - * @param { TextPickerDialogOptions } options - Options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 11 - */ - showTextPickerDialog(options: TextPickerDialogOptions): void; - - /** - * Run custom functions inside the UIContext scope. - * - * @param { function } callback - The function called through UIContext. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ /** * Run custom functions inside the UIContext scope. * @@ -2891,12 +2195,7 @@ export declare class UIContext { */ getAtomicServiceBar(): Nullable; - /** - * Get DragController. - * @returns { DragController } the DragController - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Get DragController. * @returns { DragController } the DragController @@ -2916,15 +2215,7 @@ export declare class UIContext { */ getMeasureUtils(): MeasureUtils; - /** - * Defining keyframe animation function. - * - * @param { KeyframeAnimateParam } param - overall animation parameters - * @param { Array } keyframes - all keyframe states - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 11 - */ + /** * Defining keyframe animation function. * @@ -3274,16 +2565,7 @@ export declare class UIContext { */ requireDynamicSyncScene(id: string): Array; - /** - * Clear the cache generated by using $r/$rawfile to retrieve resources. This cache is used to accelerate the process - * of repeatedly loading resources. Clearing this cache may slow down the loading speed of resources during page overload. - * - * @throws { BusinessError } 202 - The caller is not a system application. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @systemapi - * @atomicservice - * @since 12 - */ + /** * Clear the cache generated by using $r/$rawfile to retrieve resources. This cache is used to accelerate the process * of repeatedly loading resources. Clearing this cache may slow down the loading speed of resources during page overload. @@ -3317,55 +2599,6 @@ export declare class UIContext { */ getMaxFontScale(): number; - /** - * Bind tabs to scrollable container component to automatically hide tab bar. - * - * @param { TabsController } tabsController - The controller of the tabs. - * @param { Scroller } scroller - The controller of the scrollable container component. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 13 - */ - bindTabsToScrollable(tabsController: TabsController, scroller: Scroller): void; - - /** - * Unbind tabs from scrollable container component. - * - * @param { TabsController } tabsController - The controller of the tabs. - * @param { Scroller } scroller - The controller of the scrollable container component. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 13 - */ - unbindTabsFromScrollable(tabsController: TabsController, scroller: Scroller): void; - - /** - * Bind tabs to nested scrollable container components to automatically hide tab bar. - * - * @param { TabsController } tabsController - The controller of the tabs. - * @param { Scroller } parentScroller - The controller of the parent scrollable container component. - * @param { Scroller } childScroller - The controller of the child scrollable container component. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 13 - */ - bindTabsToNestedScrollable(tabsController: TabsController, parentScroller: Scroller, childScroller: Scroller): void; - - /** - * Unbind tabs from nested scrollable container components. - * - * @param { TabsController } tabsController - The controller of the tabs. - * @param { Scroller } parentScroller - The controller of the parent scrollable container component. - * @param { Scroller } childScroller - The controller of the child scrollable container component. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 13 - */ - unbindTabsFromNestedScrollable(tabsController: TabsController, parentScroller: Scroller, childScroller: Scroller): void; } /** diff --git a/api/@ohos.arkui.component.d.ets b/api/@ohos.arkui.component.d.ets index 4496d661804b3335022b27f27b20f2a32c5cee7d..90c190a547e8d64091b20e8c36ae82a17293bcfa 100644 --- a/api/@ohos.arkui.component.d.ets +++ b/api/@ohos.arkui.component.d.ets @@ -12,153 +12,42 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - /** * @file * @kit ArkUI * @arkts 1.2 */ - export * from './arkui/UserView'; -export * from './arkui/component/customComponent'; -export * from './arkui/component/common'; -export * from './arkui/component/column'; export * from './arkui/component/text'; -export * from './arkui/component/styledString'; export * from './arkui/component/enums'; export * from './arkui/component/units'; -export * from './arkui/component/abilityComponent'; -export * from './arkui/component/actionSheet'; -export * from './arkui/component/alertDialog'; -export * from './arkui/component/alphabetIndexer'; -export * from './arkui/component/animator'; -export * from './arkui/component/badge'; export * from './arkui/component/blank'; export * from './arkui/component/button'; -export * from './arkui/component/calendar'; -export * from './arkui/component/calendarPicker'; -export * from './arkui/component/canvas'; -export * from './arkui/component/checkbox'; -export * from './arkui/component/checkboxgroup'; -export * from './arkui/component/circle'; export * from './arkui/component/column'; -export * from './arkui/component/columnSplit'; +export * from './arkui/component/row'; export * from './arkui/component/common'; -export * from './arkui/component/component3d'; -export * from './arkui/component/containerSpan'; -export * from './arkui/component/contentSlot'; -export * from './arkui/component/contextMenu'; -export * from './arkui/component/counter'; export * from './arkui/component/customComponent'; -export * from './arkui/component/customDialogController'; -export * from './arkui/component/dataPanel'; -export * from './arkui/component/datePicker'; -export * from './arkui/component/divider'; -export * from './arkui/component/effectComponent'; -export * from './arkui/component/ellipse'; -export * from './arkui/component/embeddedComponent'; export * from './arkui/component/enums'; -export * from './arkui/component/flex'; -export * from './arkui/component/flowItem'; -export * from './arkui/component/focus'; -export * from './arkui/component/folderStack'; export * from './arkui/component/forEach'; -export * from './arkui/component/formComponent'; -export * from './arkui/component/formLink'; -export * from './arkui/component/gauge'; export * from './arkui/component/gesture'; export * from './arkui/component/grid'; -export * from './arkui/component/gridCol'; -export * from './arkui/component/gridContainer'; -export * from './arkui/component/gridRow'; export * from './arkui/component/griditem'; -export * from './arkui/component/hyperlink'; export * from './arkui/component/image'; -export * from './arkui/component/imageAnimator'; export * from './arkui/component/imageCommon'; -export * from './arkui/component/imageSpan'; -export * from './arkui/component/indicatorcomponent'; -export * from './arkui/component/inspector'; -export * from './arkui/component/isolatedComponent'; export * from './arkui/component/lazyForEach'; -export * from './arkui/component/line'; -export * from './arkui/component/linearindicator'; export * from './arkui/component/list'; -export * from './arkui/component/listItem'; -export * from './arkui/component/listItemGroup'; -export * from './arkui/component/loadingProgress'; -export * from './arkui/component/locationButton'; -export * from './arkui/component/marquee'; -export * from './arkui/component/matrix2d'; export * from './arkui/component/mediaCachedImage'; -export * from './arkui/component/menu'; -export * from './arkui/component/menuItem'; -export * from './arkui/component/menuItemGroup'; -export * from './arkui/component/navDestination'; -export * from './arkui/component/navRouter'; export * from './arkui/component/navigation'; -export * from './arkui/component/navigator'; -export * from './arkui/component/nodeContainer'; -export * from './arkui/component/pageTransition'; -export * from './arkui/component/panel'; -export * from './arkui/component/particle'; -export * from './arkui/component/pasteButton'; -export * from './arkui/component/path'; -export * from './arkui/component/patternLock'; -export * from './arkui/component/pluginComponent'; -export * from './arkui/component/polygon'; -export * from './arkui/component/polyline'; export * from './arkui/component/progress'; -export * from './arkui/component/qrcode'; -export * from './arkui/component/radio'; -export * from './arkui/component/rating'; -export * from './arkui/component/rect'; -export * from './arkui/component/refresh'; -export * from './arkui/component/relativeContainer'; -export * from './arkui/component/remoteWindow'; -export * from './arkui/component/repeat'; -export * from './arkui/component/richEditor'; -export * from './arkui/component/richText'; -export * from './arkui/component/rootScene'; -export * from './arkui/component/row'; -export * from './arkui/component/rowSplit'; -export * from './arkui/component/saveButton'; -export * from './arkui/component/screen'; export * from './arkui/component/scroll'; export * from './arkui/component/scrollBar'; -export * from './arkui/component/search'; -export * from './arkui/component/securityComponent'; -export * from './arkui/component/select'; -export * from './arkui/component/shape'; -export * from './arkui/component/sidebar'; -export * from './arkui/component/slider'; -export * from './arkui/component/span'; export * from './arkui/component/stack'; -export * from './arkui/component/stateManagement'; -export * from './arkui/component/stepper'; -export * from './arkui/component/stepperItem'; -export * from './arkui/component/styledString'; -export * from './arkui/component/swiper'; -export * from './arkui/component/symbolSpan'; export * from './arkui/component/symbolglyph'; -export * from './arkui/component/tabContent'; -export * from './arkui/component/tabs'; -export * from './arkui/component/text'; -export * from './arkui/component/textArea'; -export * from './arkui/component/textClock'; -export * from './arkui/component/textCommon'; -export * from './arkui/component/textInput'; -export * from './arkui/component/textPicker'; -export * from './arkui/component/textTimer'; -export * from './arkui/component/timePicker'; -export * from './arkui/component/toggle'; -export * from './arkui/component/type-replacements'; -export * from './arkui/component/uiExtensionComponent'; export * from './arkui/component/units'; -export * from './arkui/component/video'; -export * from './arkui/component/waterFlow'; -export * from './arkui/component/web'; -export * from './arkui/component/windowScene'; -export * from './arkui/component/withTheme'; -export * from './arkui/component/xcomponent'; export * from './arkui/component/resources'; +export * from './arkui/component/locationButton'; +export * from './arkui/component/pasteButton'; +export * from './arkui/component/saveButton'; +export * from './arkui/component/securityComponent'; +export * from './arkui/component/web'; +export * from './arkui/component/textCommon'; \ No newline at end of file diff --git a/api/@ohos.promptAction.d.ets b/api/@ohos.promptAction.d.ets index 308e649e763df46ef0de61469cf14d20a6d9b234..ceed2c49d243f1be77924e04e3bc5351dbe6b8f1 100644 --- a/api/@ohos.promptAction.d.ets +++ b/api/@ohos.promptAction.d.ets @@ -22,22 +22,12 @@ import { ResourceColor, Offset, Dimension, EdgeStyles, EdgeColors } from './arkui/component/units'; import { AsyncCallback,Callback } from './@ohos.base'; import { BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, Rectangle, TransitionEffect, KeyboardAvoidMode, CustomBuilder, DismissReason } from './arkui/component/common'; -import { DialogAlignment } from './arkui/component/alertDialog'; import { BorderStyle,Alignment } from './arkui/component/enums'; import { EdgeWidths, BorderRadiuses} from './arkui/component/units' import { Resource } from './global/resource' -/** - * @namespace promptAction - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ -/** - * @namespace promptAction - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * @namespace promptAction * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -46,17 +36,8 @@ import { Resource } from './global/resource' * @since 11 */ declare namespace promptAction { - /** - * @typedef ShowToastOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * @typedef ShowToastOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -66,21 +47,8 @@ declare namespace promptAction { */ export interface ShowToastOptions { - /** - * Text to display. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * Text to display. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * Text to display. * @@ -92,25 +60,8 @@ declare namespace promptAction { */ message: string | Resource; - /** - * Duration of toast dialog box. The default value is 1500. - * The recommended value ranges from 1500ms to 10000ms. - * NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * Duration of toast dialog box. The default value is 1500. - * The recommended value ranges from 1500ms to 10000ms. - * NOTE: A value less than 1500 is automatically changed to 1500. The maximum value is 10000ms. - * - * @type { ?number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * Duration of toast dialog box. The default value is 1500. * The recommended value ranges from 1500ms to 10000ms. @@ -124,21 +75,8 @@ declare namespace promptAction { */ duration?: number; - /** - * The distance between toast dialog box and the bottom of screen. - * - * @type { ?(string | number) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * The distance between toast dialog box and the bottom of screen. - * - * @type { ?(string | number) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * The distance between toast dialog box and the bottom of screen. * @@ -150,14 +88,7 @@ declare namespace promptAction { */ bottom?: string | number; - /** - * Determine the show mode of the toast. - * - * @type { ?ToastShowMode } - * @default ToastShowMode.DEFAULT - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Determine the show mode of the toast. * @@ -255,13 +186,7 @@ declare namespace promptAction { hoverModeArea?: HoverModeAreaType; } - /** - * Enum for the toast showMode. - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Enum for the toast showMode. * @@ -272,12 +197,7 @@ declare namespace promptAction { * @since 12 */ export enum ToastShowMode { - /** - * Toast shows in app. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Toast shows in app. * @@ -288,12 +208,7 @@ declare namespace promptAction { */ DEFAULT = 0, - /** - * Toast shows at the top. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 - */ + /** * Toast shows at the top. * @@ -314,17 +229,8 @@ declare namespace promptAction { SYSTEM_TOP_MOST = 2 } - /** - * @typedef Button - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * @typedef Button - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -334,21 +240,8 @@ declare namespace promptAction { */ export interface Button { - /** - * The text displayed in the button. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * The text displayed in the button. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * The text displayed in the button. * @@ -360,21 +253,8 @@ declare namespace promptAction { */ text: string | Resource; - /** - * The foreground color of button. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * The foreground color of button. - * - * @type { string | Resource } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * The foreground color of button. * @@ -397,17 +277,8 @@ declare namespace promptAction { primary?: boolean; } - /** - * @typedef ShowDialogSuccessResponse - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * @typedef ShowDialogSuccessResponse - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -417,21 +288,8 @@ declare namespace promptAction { */ export interface ShowDialogSuccessResponse { - /** - * Index of the selected button, starting from 0. - * - * @type { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * Index of the selected button, starting from 0. - * - * @type { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * Index of the selected button, starting from 0. * @@ -444,17 +302,8 @@ declare namespace promptAction { index: number; } - /** - * @typedef ShowDialogOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * @typedef ShowDialogOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -464,21 +313,8 @@ declare namespace promptAction { */ export interface ShowDialogOptions { - /** - * Title of the text to display. - * - * @type { ?(string | Resource) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * Title of the text to display. - * - * @type { ?(string | Resource) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * Title of the text to display. * @@ -490,21 +326,8 @@ declare namespace promptAction { */ title?: string | Resource; - /** - * Text body. - * - * @type { ?(string | Resource) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 9 - */ - /** - * Text body. - * - * @type { ?(string | Resource) } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ + + /** * Text body. * @@ -516,26 +339,8 @@ declare namespace promptAction { */ message?: string | Resource; - /** - * Array of buttons in the dialog box. - * The array structure is {text:'button', color: '#666666'}. - * One to three buttons are supported. - * The first button is of the positiveButton type, the second is of the negativeButton type, and the third is of the neutralButton type. - * - * @type { ?Array