openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of https://gitee.com/duanhan12345/interface_sdk-js into char_interfaces

Browse Source
This commit is contained in:
duanhan 2024-03-29 17:45:19 +08:00
commit 645953359a
112 changed files with 11969 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
api/@internal/component/ets/action_sheet.d.ts vendored
View File

@ -540,6 +540,16 @@ interface ActionSheetOptions
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showInSubWindow?: boolean;
/**
@ -550,6 +560,15 @@ interface ActionSheetOptions
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
/**
@ -561,6 +580,16 @@ interface ActionSheetOptions
* @crossplatform
* @since 11
*/
/**
* Defines the actionSheet's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -572,6 +601,16 @@ interface ActionSheetOptions
* @crossplatform
* @since 11
*/
/**
* Defines the actionSheet's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

39
api/@internal/component/ets/alert_dialog.d.ts vendored
View File

@ -754,6 +754,16 @@ declare interface AlertDialogParam {
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showInSubWindow?: boolean;
/**
@ -764,6 +774,15 @@ declare interface AlertDialogParam {
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
/**
@ -775,6 +794,16 @@ declare interface AlertDialogParam {
* @crossplatform
* @since 11
*/
/**
* Defines the alertDialog's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -786,6 +815,16 @@ declare interface AlertDialogParam {
* @crossplatform
* @since 11
*/
/**
* Defines the alertDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

10
api/@internal/component/ets/alphabet_indexer.d.ts vendored
View File

@ -758,6 +758,16 @@ declare class AlphabetIndexerAttribute extends CommonMethod<AlphabetIndexerAttri
* @crossplatform
* @since 11
*/
/**
* Automatically collapses the characters when the indexer bar not high enough to display all characters.
*
* @param { boolean } value - A boolean value determines whether auto collapses is enabled for indexer bar.
* @returns { AlphabetIndexerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
autoCollapse(value: boolean): AlphabetIndexerAttribute;
/**

109
api/@internal/component/ets/button.d.ts vendored
View File

@ -159,6 +159,16 @@ declare enum ButtonType {
* @since 11
* @form
*/
/**
* Enum for button style type.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare enum ButtonStyleMode {
/**
* Normal button (with normal background color).
@ -168,6 +178,15 @@ declare enum ButtonStyleMode {
* @since 11
* @form
*/
/**
* Normal button (with normal background color).
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
NORMAL = 0,
/**
@ -178,6 +197,15 @@ declare enum ButtonStyleMode {
* @since 11
* @form
*/
/**
* Emphasized button (with emphasized background color).
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
EMPHASIZED = 1,
/**
@ -188,6 +216,15 @@ declare enum ButtonStyleMode {
* @since 11
* @form
*/
/**
* Textual button (with none background color).
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
TEXTUAL = 2,
}
@ -231,6 +268,16 @@ declare enum ButtonRole {
* @since 11
* @form
*/
/**
* Enum for Control Size.
*
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare enum ControlSize {
/**
* The component size is small.
@ -240,6 +287,15 @@ declare enum ControlSize {
* @since 11
* @form
*/
/**
* The component size is small.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
SMALL = 'small',
/**
@ -250,6 +306,15 @@ declare enum ControlSize {
* @since 11
* @form
*/
/**
* The component size is normal.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
NORMAL = 'normal',
}
@ -370,6 +435,17 @@ declare interface ButtonOptions {
* @since 11
* @form
*/
/**
* Describes the button style.
*
* @type { ?ButtonStyleMode }
* @default ButtonStyleMode.EMPHASIZED
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
buttonStyle?: ButtonStyleMode;
/**
@ -382,6 +458,17 @@ declare interface ButtonOptions {
* @since 11
* @form
*/
/**
* Describes the button size.
*
* @type { ?ControlSize }
* @default ControlSize.NORMAL
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
controlSize?: ControlSize;
/**
@ -811,6 +898,17 @@ declare class ButtonAttribute extends CommonMethod<ButtonAttribute> {
* @since 11
* @form
*/
/**
* Describes the button style.
*
* @param { ButtonStyleMode } value - button style mode
* @returns { ButtonAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
buttonStyle(value: ButtonStyleMode): ButtonAttribute;
/**
@ -823,6 +921,17 @@ declare class ButtonAttribute extends CommonMethod<ButtonAttribute> {
* @since 11
* @form
*/
/**
* Set the Button size.
*
* @param { ControlSize } value - control size
* @returns { ButtonAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
controlSize(value: ControlSize): ButtonAttribute;
/**

20
api/@internal/component/ets/calendar_picker.d.ts vendored
View File

@ -317,6 +317,16 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the calendarPickerDialog's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -328,6 +338,16 @@ declare interface CalendarDialogOptions extends CalendarOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the calendarPickerDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

11
api/@internal/component/ets/checkbox.d.ts vendored
View File

@ -341,6 +341,17 @@ declare class CheckboxAttribute extends CommonMethod<CheckboxAttribute> {
* @since 11
* @form
*/
/**
* setting the shape of checkbox.
*
* @param { CheckBoxShape } value - The configuration of checkbox shape.
* @returns { CheckboxAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
shape(value: CheckBoxShape): CheckboxAttribute;
/**

1570
api/@internal/component/ets/common.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

52
api/@internal/component/ets/container_span.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Span container interface.
*
* @interface ContainerSpanInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface ContainerSpanInterface {
/**
* Called when container is entered in span.
@ -35,6 +44,15 @@ interface ContainerSpanInterface {
* @crossplatform
* @since 11
*/
/**
* Called when container is entered in span.
*
* @returns { ContainerSpanAttribute } The attribute of the container span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(): ContainerSpanAttribute;
}
@ -45,6 +63,14 @@ interface ContainerSpanInterface {
* @crossplatform
* @since 11
*/
/**
* Define the ContainerSpan attribute functions.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ContainerSpanAttribute {
/**
* Span background style.
@ -55,6 +81,16 @@ declare class ContainerSpanAttribute {
* @crossplatform
* @since 11
*/
/**
* Span background style.
*
* @param { TextBackgroundStyle } style - The background style of span.
* @returns { ContainerSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textBackgroundStyle(style: TextBackgroundStyle): ContainerSpanAttribute;
}
@ -65,6 +101,14 @@ declare class ContainerSpanAttribute {
* @crossplatform
* @since 11
*/
/**
* Defines ContainerSpan Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const ContainerSpan: ContainerSpanInterface;
/**
@ -74,4 +118,12 @@ declare const ContainerSpan: ContainerSpanInterface;
* @crossplatform
* @since 11
*/
/**
* Defines ContainerSpan Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const ContainerSpanInstance: ContainerSpanAttribute;

9
api/@internal/component/ets/custom_dialog_controller.d.ts vendored
View File

@ -367,6 +367,15 @@ declare interface CustomDialogControllerOptions {
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
/**

20
api/@internal/component/ets/date_picker.d.ts vendored
View File

@ -749,6 +749,16 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the datePickerDialog's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -760,6 +770,16 @@ declare interface DatePickerDialogOptions extends DatePickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the datePickerDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

193
api/@internal/component/ets/enums.d.ts vendored
View File

@ -27,6 +27,16 @@
* @since 11
* @form
*/
/**
* common enum of the checkbox shape
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare enum CheckBoxShape {
/**
* Circle.
@ -36,6 +46,15 @@ declare enum CheckBoxShape {
* @since 11
* @form
*/
/**
* Circle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
CIRCLE = 0,
/**
@ -46,6 +65,15 @@ declare enum CheckBoxShape {
* @since 11
* @form
*/
/**
* Rounded Square.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
ROUNDED_SQUARE = 1,
}
@ -505,6 +533,14 @@ declare enum ColoringStrategy {
* @crossplatform
* @since 11
*/
/**
* Use the average color strategy. Get the average color of the background. Only applies to shadow.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
AVERAGE = 'average',
/**
@ -514,6 +550,14 @@ declare enum ColoringStrategy {
* @crossplatform
* @since 11
*/
/**
* Use the primary color strategy. Get the color that dominate the background color. Only applies to shadow.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PRIMARY = 'primary',
}
@ -7343,6 +7387,15 @@ declare enum Placement {
* @crossplatform
* @since 11
*/
/**
* ArrowPointPosition enumeration description
*
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum ArrowPointPosition {
/**
* Target start position
@ -7351,6 +7404,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target start position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 'Start',
/**
@ -7360,6 +7421,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target center position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CENTER = 'Center',
/**
@ -7369,6 +7438,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target end position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
END = 'End',
}
@ -7486,6 +7563,15 @@ declare enum CopyOptions {
* @since 11
* @form
*/
/**
* Share in cross Device
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
CROSS_DEVICE = 3,
}
@ -8820,6 +8906,15 @@ declare enum WordBreak {
* @crossplatform
* @since 11
*/
/**
* Enum of ellipsisMode
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum EllipsisMode {
/**
* The ellipsis is in the head.
@ -8828,6 +8923,14 @@ declare enum EllipsisMode {
* @crossplatform
* @since 11
*/
/**
* The ellipsis is in the head.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 0,
/**
@ -8837,6 +8940,14 @@ declare enum EllipsisMode {
* @crossplatform
* @since 11
*/
/**
* The ellipsis is in the middle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CENTER = 1,
/**
@ -8846,6 +8957,14 @@ declare enum EllipsisMode {
* @crossplatform
* @since 11
*/
/**
* The ellipsis is at the end.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
END = 2,
}
@ -8856,6 +8975,14 @@ declare enum EllipsisMode {
* @crossplatform
* @since 11
*/
/**
* A type which can be undefined
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type Nullable<T> = T | undefined;
declare module 'CommonEnums' {
@ -8873,6 +9000,15 @@ declare module 'CommonEnums' {
* @crossplatform
* @since 11
*/
/**
* Decide whether the width of select menu fit the trigger or content
*
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum OptionWidthMode {
/**
* The menu width fit the content.
@ -8881,6 +9017,14 @@ declare enum OptionWidthMode {
* @crossplatform
* @since 11
*/
/**
* The menu width fit the content.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FIT_CONTENT = 'fit_content',
/**
@ -8890,6 +9034,14 @@ declare enum OptionWidthMode {
* @crossplatform
* @since 11
*/
/**
* The menu width fit the trigger.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FIT_TRIGGER = 'fit_trigger',
}
@ -8960,6 +9112,15 @@ declare enum IlluminatedType {
* @crossplatform
* @since 11
*/
/**
* Enumerates the fold status.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum FoldStatus {
/**
* Fold Status Unknown.
@ -8968,6 +9129,14 @@ declare enum FoldStatus {
* @crossplatform
* @since 11
*/
/**
* Fold Status Unknown.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FOLD_STATUS_UNKNOWN = 0,
/**
* Fold Status Expanded.
@ -8976,6 +9145,14 @@ declare enum FoldStatus {
* @crossplatform
* @since 11
*/
/**
* Fold Status Expanded.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FOLD_STATUS_EXPANDED = 1,
/**
* Fold Status Folded.
@ -8984,6 +9161,14 @@ declare enum FoldStatus {
* @crossplatform
* @since 11
*/
/**
* Fold Status Folded.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FOLD_STATUS_FOLDED = 2,
/**
* Fold Status Half Folded.
@ -8992,6 +9177,14 @@ declare enum FoldStatus {
* @crossplatform
* @since 11
*/
/**
* Fold Status Half Folded.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FOLD_STATUS_HALF_FOLDED = 3,
}

82
api/@internal/component/ets/folder_stack.d.ts vendored
View File

@ -34,6 +34,15 @@ declare type WindowMode = import('../api/@ohos.window').WindowMode;
* @crossplatform
* @since 11
*/
/**
* Provides ports for stacking containers.
*
* @interface FolderStackInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface FolderStackInterface {
/**
@ -45,6 +54,16 @@ interface FolderStackInterface {
* @crossplatform
* @since 11
*/
/**
* Defines the constructor of folderStack.
*
* @param { object } value - id of children need to be show in upperItem
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(value?: { upperItems?: Array<string> }): FolderStackAttribute;
}
@ -55,6 +74,13 @@ interface FolderStackInterface {
* @crossplatform
* @since 11
*/
/**
* @extends CommonMethod<FolderStackAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
/**
* Set the alignment of folderStack.
@ -65,6 +91,16 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the alignment of folderStack.
*
* @param { Alignment } value - align of children
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
alignContent(value: Alignment): FolderStackAttribute;
/**
@ -75,6 +111,16 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Callback folderState when the folderState changes
*
* @param { function } callback - executed when folderStatus changed
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFolderStateChange(callback: (event: {
/**
@ -108,6 +154,16 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @crossplatform
* @since 11
*/
/**
* Enable the animation of folderStack.
*
* @param { boolean } value - enable the animation of folderStatus changed
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enableAnimation(value: boolean): FolderStackAttribute;
/**
@ -119,6 +175,16 @@ declare class FolderStackAttribute extends CommonMethod<FolderStackAttribute> {
* @crossplatform
* @since 11
*/
/**
* Enable auto halfFolder when orientation.
*
* @param { boolean } value - enable auto halfFold
* @returns { FolderStackAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
autoHalfFold(value: boolean): FolderStackAttribute;
}
@ -173,6 +239,14 @@ declare interface HoverEventParam {
* @crossplatform
* @since 11
*/
/**
* Defines FolderStack Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const FolderStack: FolderStackInterface;
/**
@ -182,4 +256,12 @@ declare const FolderStack: FolderStackInterface;
* @crossplatform
* @since 11
*/
/**
* Defines FolderStack Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const FolderStackInstance: FolderStackAttribute;

68
api/@internal/component/ets/gauge.d.ts vendored
View File

@ -110,6 +110,15 @@ interface GaugeInterface {
* @crossplatform
* @since 11
*/
/**
* Defines the options of gauge track shadow.
*
* @interface GaugeShadowOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GaugeShadowOptions extends MultiShadowOptions {}
/**
@ -120,6 +129,15 @@ declare interface GaugeShadowOptions extends MultiShadowOptions {}
* @crossplatform
* @since 11
*/
/**
* Defines the options of gauge indicator.
*
* @interface GaugeIndicatorOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GaugeIndicatorOptions {
/**
@ -131,6 +149,16 @@ declare interface GaugeIndicatorOptions {
* @crossplatform
* @since 11
*/
/**
* Current indicator icon path.
*
* @type { ?ResourceStr } option type - the current option type.
* @default system style.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: ResourceStr;
/**
@ -142,6 +170,16 @@ declare interface GaugeIndicatorOptions {
* @crossplatform
* @since 11
*/
/**
* Current indicator space.
*
* @type { ?Dimension } indicator space - the current indicator space.
* @default 8
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
space?: Dimension;
}
@ -381,6 +419,16 @@ declare class GaugeAttribute extends CommonMethod<GaugeAttribute> {
* @crossplatform
* @since 11
*/
/**
* Sets description content of the ring chart.
*
* @param { CustomBuilder } value - description content builder of the gauge drawing.
* @returns { GaugeAttribute } returns the instance of the GaugeAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
description(value: CustomBuilder): GaugeAttribute;
/**
@ -392,6 +440,16 @@ declare class GaugeAttribute extends CommonMethod<GaugeAttribute> {
* @crossplatform
* @since 11
*/
/**
* Sets track shadow of the ring chart.
*
* @param { GaugeShadowOptions } value - track shadow options of the gauge drawing.
* @returns { GaugeAttribute } returns the instance of the GaugeAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
trackShadow(value: GaugeShadowOptions): GaugeAttribute;
/**
@ -403,6 +461,16 @@ declare class GaugeAttribute extends CommonMethod<GaugeAttribute> {
* @crossplatform
* @since 11
*/
/**
* Sets indicator options of the ring chart.
*
* @param { GaugeIndicatorOptions } value - indicator options of the gauge drawing.
* @returns { GaugeAttribute } returns the instance of the GaugeAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
indicator(value: GaugeIndicatorOptions): GaugeAttribute;
}

329
api/@internal/component/ets/gesture.d.ts vendored
View File

@ -521,6 +521,15 @@ declare enum GestureMask {
* @crossplatform
* @since 11
*/
/**
* Creating an Object
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum GestureJudgeResult {
/**
* The system gesture determination is not affected.
@ -529,6 +538,14 @@ declare enum GestureJudgeResult {
* @crossplatform
* @since 11
*/
/**
* The system gesture determination is not affected.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CONTINUE = 0,
/**
@ -538,6 +555,14 @@ declare enum GestureJudgeResult {
* @crossplatform
* @since 11
*/
/**
* The user-defined gesture determination result of the current component is fail.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
REJECT = 1,
}
@ -558,6 +583,15 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* Creating an Object
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enum GestureType {
/**
* TapGesture.
@ -566,6 +600,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* TapGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TAP_GESTURE = 0,
/**
@ -575,6 +617,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* LongPressGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LONG_PRESS_GESTURE = 1,
/**
@ -584,6 +634,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* PanGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PAN_GESTURE = 2,
/**
@ -593,6 +651,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* PinchGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PINCH_GESTURE = 3,
/**
@ -602,6 +668,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* SwipeGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SWIPE_GESTURE = 4,
/**
@ -611,6 +685,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* RotationGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ROTATION_GESTURE = 5,
/**
@ -620,6 +702,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* Drag.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DRAG = 6,
/**
@ -629,6 +719,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* Click.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CLICK = 7,
}
}
@ -641,6 +739,15 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* The description of gesture information.
*
* @interface GestureInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GestureInfo {
/**
* The tag of gesture.
@ -650,6 +757,15 @@ declare interface GestureInfo {
* @crossplatform
* @since 11
*/
/**
* The tag of gesture.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
tag?: string;
/**
@ -660,6 +776,15 @@ declare interface GestureInfo {
* @crossplatform
* @since 11
*/
/**
* The type of gesture.
*
* @type { GestureControl.GestureType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: GestureControl.GestureType;
/**
@ -670,6 +795,15 @@ declare interface GestureInfo {
* @crossplatform
* @since 11
*/
/**
* The flag whether it is a system gesture.
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isSystemGesture: boolean;
}
@ -889,6 +1023,15 @@ declare type GestureType =
* @crossplatform
* @since 11
*/
/**
* Defines the gesture base event.
*
* @interface BaseGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface BaseGestureEvent extends BaseEvent {
/**
* All finger information.
@ -898,6 +1041,15 @@ interface BaseGestureEvent extends BaseEvent {
* @crossplatform
* @since 11
*/
/**
* All finger information.
*
* @type { FingerInfo[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fingerList: FingerInfo[];
}
@ -909,6 +1061,15 @@ interface BaseGestureEvent extends BaseEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for tap gesture.
*
* @interface TapGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface TapGestureEvent extends BaseGestureEvent {
}
@ -920,6 +1081,15 @@ interface TapGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for long press gesture.
*
* @interface LongPressGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface LongPressGestureEvent extends BaseGestureEvent {
/**
* Indicates whether an event is triggered repeatedly.
@ -929,6 +1099,15 @@ interface LongPressGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Indicates whether an event is triggered repeatedly.
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
repeat: boolean;
}
@ -940,6 +1119,15 @@ interface LongPressGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for pan gesture.
*
* @interface PanGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface PanGestureEvent extends BaseGestureEvent {
/**
* Gesture event offset X.
@ -950,6 +1138,16 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Gesture event offset X.
* The unit is vp.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offsetX: number;
/**
@ -961,6 +1159,16 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Gesture event offset Y.
* The unit is vp.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offsetY: number;
/**
@ -970,6 +1178,14 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* X-axis velocity of the gesture.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
velocityX: number;
/**
@ -979,6 +1195,14 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Y-axis velocity of the gesture.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
velocityY: number;
/**
@ -988,6 +1212,14 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* velocity of the gesture.
* @type {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
velocity: number;
}
@ -999,6 +1231,15 @@ interface PanGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for pinch gesture.
*
* @interface PinchGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface PinchGestureEvent extends BaseGestureEvent {
/**
* Scaling ratio.
@ -1008,6 +1249,15 @@ interface PinchGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Scaling ratio.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
scale: number;
/**
@ -1019,6 +1269,16 @@ interface PinchGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* X-axis coordinate of the kneading center point.
* The unit is vp.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pinchCenterX: number;
/**
@ -1030,6 +1290,16 @@ interface PinchGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Y-axis coordinate of the kneading center point.
* The unit is vp.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pinchCenterY: number;
}
@ -1041,6 +1311,15 @@ interface PinchGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for rotation gesture.
*
* @interface RotationGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface RotationGestureEvent extends BaseGestureEvent {
/**
* Gesture event direction angle.
@ -1051,6 +1330,16 @@ interface RotationGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Gesture event direction angle.
* The unit is deg.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
angle: number;
}
@ -1062,6 +1351,15 @@ interface RotationGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Defines event info for swipe gesture.
*
* @interface SwipeGestureEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 112
*/
interface SwipeGestureEvent extends BaseGestureEvent {
/**
* Gesture event direction angle.
@ -1072,6 +1370,16 @@ interface SwipeGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Gesture event direction angle.
* The unit is deg.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
angle: number;
/**
@ -1083,6 +1391,16 @@ interface SwipeGestureEvent extends BaseGestureEvent {
* @crossplatform
* @since 11
*/
/**
* Gesture event slide speed.
* The unit is vp.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
speed: number;
}
@ -1463,6 +1781,17 @@ interface GestureInterface<T> {
* @since 11
*/
tag(tag: string): T;
/**
* Input source type for touch event response.
*
* @param { Array<SourceTool> } value - indicate the input source that allows touch
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
allowedTypes(value: Array<SourceTool>): T;
}
/**

10
api/@internal/component/ets/grid.d.ts vendored
View File

@ -106,6 +106,16 @@ declare interface GridLayoutOptions {
* @crossplatform
* @since 11
*/
/**
* Called to return the size of the grid items with the specified index in
* [rowStart, columnStart, rowSpan, columnSpan].
*
* @type { ?function } onGetRectByIndex
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onGetRectByIndex?: (index: number) => [number, number, number, number]
}

43
api/@internal/component/ets/gridItem.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Defines the grid item style.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum GridItemStyle {
/**
* Show none style.
@ -34,6 +43,14 @@ declare enum GridItemStyle {
* @crossplatform
* @since 11
*/
/**
* Show none style.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NONE = 0,
/**
@ -43,6 +60,14 @@ declare enum GridItemStyle {
* @crossplatform
* @since 11
*/
/**
* Show plain style.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PLAIN = 1,
}
@ -54,6 +79,15 @@ declare enum GridItemStyle {
* @crossplatform
* @since 11
*/
/**
* Defines the grid item options.
*
* @interface GridItemOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface GridItemOptions {
/**
* Describes the GridItem style.
@ -63,6 +97,15 @@ declare interface GridItemOptions {
* @crossplatform
* @since 11
*/
/**
* Describes the GridItem style.
*
* @type { ?GridItemStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
style?: GridItemStyle;
}

37
api/@internal/component/ets/image.d.ts vendored
View File

@ -1330,6 +1330,15 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Enable image analyzer.
*
* @param { boolean} config
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableAnalyzer(enable: boolean): ImageAttribute;
/**
@ -1352,6 +1361,16 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set image resizable options.
*
* @param { ResizableOptions } value - Indicates the resizable options.
* @returns { ImageAttribute } Returns the instance of the ImageAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
resizable(value: ResizableOptions): ImageAttribute;
}
@ -1551,6 +1570,15 @@ declare interface ImageError {
* @crossplatform
* @since 11
*/
/**
* Image resizable options
*
* @interface ResizableOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface ResizableOptions {
/**
* Image slice widths.
@ -1560,5 +1588,14 @@ declare interface ResizableOptions {
* @crossplatform
* @since 11
*/
/**
* Image slice widths.
*
* @type { ?EdgeWidths }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
slice?: EdgeWidths;
}

12
api/@internal/component/ets/image_animator.d.ts vendored
View File

@ -134,7 +134,17 @@ interface ImageFrameInfo {
* @since 11
* @form
*/
src: string | Resource;
/**
* Image path
*
* @type { string | Resource | PixelMap }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
src: string | Resource | PixelMap;
/**
* Image width
*

81
api/@internal/component/ets/list.d.ts vendored
View File

@ -616,6 +616,15 @@ declare interface ChainAnimationOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the close swipe action options.
*
* @interface CloseSwipeActionOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface CloseSwipeActionOptions {
/**
* Called after collapse animation completed.
@ -625,6 +634,15 @@ declare interface CloseSwipeActionOptions {
* @crossplatform
* @since 11
*/
/**
* Called after collapse animation completed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFinish?: ()=>void
}
@ -684,6 +702,13 @@ declare type OnScrollVisibleContentChangeCallback = (start: VisibleListContentIn
* @crossplatform
* @since 11
*/
/**
* @extends Scroller
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class ListScroller extends Scroller {
/**
* Gets the size and position of a ListItem in a ListItemGroup.
@ -697,6 +722,19 @@ declare class ListScroller extends Scroller {
* @crossplatform
* @since 11
*/
/**
* Gets the size and position of a ListItem in a ListItemGroup.
*
* @param { number } index - Index of the ListItemGroup in List.
* @param { number } indexInGroup - Index of the ListItem in ListItemGroup.
* @returns { RectResult } Returns the size and position.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 100004 - Controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getItemRectInGroup(index: number, indexInGroup: number): RectResult;
/**
@ -712,6 +750,20 @@ declare class ListScroller extends Scroller {
* @crossplatform
* @since 11
*/
/**
* Called when sliding to the specified index in specified ListItemGroup.
*
* @param { number } index - Index of the ListItemGroup in List.
* @param { number } indexInGroup - Index of the ListItem in ListItemGroup.
* @param { boolean } smooth - If true, scroll to index item with animation. If false, scroll to index item without animation.
* @param { ScrollAlign } align - Sets the alignment mode of a specified index.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 100004 - Controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
scrollToItemInGroup(index: number, indexInGroup:number, smooth?: boolean, align?: ScrollAlign): void;
/**
@ -724,6 +776,17 @@ declare class ListScroller extends Scroller {
* @crossplatform
* @since 11
*/
/**
* Collapse all listItem.
*
* @param { CloseSwipeActionOptions } options - Options of close Swipe items.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 100004 - Controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
closeAllSwipeActions(options?: CloseSwipeActionOptions): void;
}
@ -1025,6 +1088,15 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when need to decide contentStartOffset the list will show.
* @param { number } value - the value Of startOffset.
* @returns { ListAttribute } the attribute of the list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentStartOffset(value: number): ListAttribute;
/**
@ -1035,6 +1107,15 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when need to decide contentEndOffset the list will show.
* @param { number } value - the value Of endOffset.
* @returns { ListAttribute } the attribute of the list.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentEndOffset(value: number): ListAttribute;
/**

48
api/@internal/component/ets/list_item.d.ts vendored
View File

@ -173,6 +173,15 @@ declare enum SwipeEdgeEffect {
* @crossplatform
* @since 11
*/
/**
* Declare enum SwipeActionState.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SwipeActionState {
/**
* Collapsed type.
@ -180,6 +189,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Collapsed type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
COLLAPSED,
/**
@ -188,6 +204,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* EXPANDED type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
EXPANDED,
/**
@ -196,6 +219,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Action type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ACTIONING,
}
@ -318,6 +348,15 @@ declare interface SwipeActionItem {
* @crossplatform
* @since 11
*/
/**
* Called when component swipe action state changed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onStateChange?: (state: SwipeActionState) => void;
}
@ -438,6 +477,15 @@ declare interface SwipeActionOptions {
* @crossplatform
* @since 11
*/
/**
* Called when swipe action offset changed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onOffsetChange?: (offset: number) => void;
}

97
api/@internal/component/ets/nav_destination.d.ts vendored
View File

@ -182,6 +182,15 @@ declare interface NavDestinationCustomTitle {
* @crossplatform
* @since 11
*/
/**
* NavDestination mode.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum NavDestinationMode {
/**
* Standard mode is default mode of NavDestination.
@ -190,6 +199,14 @@ declare enum NavDestinationMode {
* @crossplatform
* @since 11
*/
/**
* Standard mode is default mode of NavDestination.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
STANDARD = 0,
/**
@ -199,6 +216,14 @@ declare enum NavDestinationMode {
* @crossplatform
* @since 11
*/
/**
* Dialog mode is transparent by default and does not affect the life cycle of other NavDestination.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DIALOG = 1,
}
@ -254,6 +279,46 @@ declare interface NavDestinationInterface {
(): NavDestinationAttribute;
}
/**
* Indicates configuration info of destination.
*
* @interface RouteMapConfig
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface RouteMapConfig {
/**
* Get destination name.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
name: string;
/**
* Get destination builder file position
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
pageSourceFile: string;
/**
* Indicate the custom data of current destination.
*
* @type { Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
data: Object
}
/**
* Indicates the context of NavDestination.
*
@ -285,6 +350,18 @@ declare interface NavDestinationContext {
* @since 11
*/
pathStack: NavPathStack;
/**
* Get configuration of current Destination in module.json
*
* @returns {RouteMapConfig | undefined}
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
getConfigInRouteMap(): RouteMapConfig | undefined;
}
/**
@ -442,6 +519,16 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @crossplatform
* @since 11
*/
/**
* Sets the different mode of NavDestination.
*
* @param { NavDestinationMode } value - NavDestinationMode
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
mode(value: NavDestinationMode): NavDestinationAttribute;
/**
@ -453,6 +540,16 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
* @crossplatform
* @since 11
*/
/**
* Set back button icon.
*
* @param { ResourceStr | PixelMap } value - Indicates icon of back button.
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backButtonIcon(value: ResourceStr | PixelMap): NavDestinationAttribute;
/**

319
api/@internal/component/ets/navigation.d.ts vendored
View File

@ -562,6 +562,15 @@ declare interface NavigationMenuItem {
* @crossplatform
* @since 11
*/
/**
* Indicates the information of the popped page.
*
* @interface PopInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface PopInfo {
/**
* The info of the popped page.
@ -571,6 +580,15 @@ declare interface PopInfo {
* @crossplatform
* @since 11
*/
/**
* The info of the popped page.
*
* @type { NavPathInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
info: NavPathInfo;
/**
@ -581,6 +599,15 @@ declare interface PopInfo {
* @crossplatform
* @since 11
*/
/**
* The result of the popped page.
*
* @type { Object }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
result: Object;
}
@ -668,6 +695,15 @@ declare class NavPathInfo {
* @crossplatform
* @since 11
*/
/**
* The callback when next page returns.
*
* @type { ?import('../api/@ohos.base').Callback<PopInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onPop?: import('../api/@ohos.base').Callback<PopInfo>;
}
@ -738,6 +774,21 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pushes the route page into the stack.
*
* @param { NavPathInfo } info - Indicates the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushDestination(info: NavPathInfo, animated?: boolean): Promise<void>;
/**
@ -773,6 +824,18 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pushes the specified route page into the stack.
*
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushPathByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback<PopInfo>, animated?: boolean): void;
/**
@ -790,6 +853,22 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pushes the specified route page into the stack.
*
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushDestinationByName(name: string, param: Object, animated?: boolean): Promise<void>;
/**
@ -808,6 +887,23 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pushes the specified route page into the stack.
*
* @param { string } name - Indicates the name of the route page to be pushed.
* @param { Object } param - Indicates the detailed parameter of the route page to be pushed.
* @param { import('../api/@ohos.base').Callback<PopInfo> } onPop - The callback when next page returns.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 100001 - Internal error.
* @throws { BusinessError } 100005 - Builder function not registered.
* @throws { BusinessError } 100006 - NavDestination not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pushDestinationByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback<PopInfo>, animated?: boolean): Promise<void>;
/**
@ -819,6 +915,16 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* replace the current page with the specific one.The current page will be destroyed.
*
* @param { NavPathInfo } info - Indicates the the new route page in top of the stack.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacePath(info: NavPathInfo, animated?: boolean): void;
/**
@ -831,6 +937,17 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* replace the current page with the specific one.The current page will be destroyed.
*
* @param { string } name - Indicates name of the new route page in top of stack.
* @param { Object } param - Indicates the detailed parameter of the new route page in top of the stack.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
replacePathByName(name: string, param: Object, animated?: boolean): void;
/**
@ -842,6 +959,16 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Remove the specified pages by indexes.
*
* @param { Array<number> } indexes - Indicates the indexes of the pages to be removed.
* @returns { number } Returns the number of removed pages. Invalid indexes will be ignored.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeByIndexes(indexes: Array<number>): number;
/**
@ -853,6 +980,16 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Remove the specified page by name.
*
* @param { string } name - Indicates the name of the page to be removed.
* @returns { number } Returns the number of removed pages.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeByName(name: string): number;
/**
@ -885,6 +1022,17 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pops the top route page out of the stack.
*
* @param { Object } result - The result of the page.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { NavPathInfo | undefined } Returns the top NavPathInfo if the stack is not empty, otherwise returns undefined.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pop(result: Object, animated?: boolean): NavPathInfo | undefined;
/**
@ -920,6 +1068,18 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* Pops the specified route page out of the stack.
*
* @param { string } name - Indicates the name of the route page to be popped.
* @param { Object } result - The result of the page.
* @param { boolean } [animated] - Indicates whether the transition is animated.
* @returns { number } Returns the index of the route page if it exists in the stack, otherwise returns -1;
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
popToName(name: string, result: Object, animated?: boolean): number;
/**
@ -1135,6 +1295,15 @@ declare class NavPathStack {
* @crossplatform
* @since 11
*/
/**
* disable or enable all transition animation in this navigation stack.
*
* @param { boolean } value - Indicates whether the transition is animated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
disableAnimation(value: boolean): void;
/**
@ -1363,6 +1532,15 @@ declare enum ToolbarItemStatus {
* @crossplatform
* @since 11
*/
/**
* Defines the operation of current navigation transition.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum NavigationOperation {
/**
* Push operation of navigation transition.
@ -1371,6 +1549,14 @@ declare enum NavigationOperation {
* @crossplatform
* @since 11
*/
/**
* Push operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PUSH = 1,
/**
@ -1380,6 +1566,14 @@ declare enum NavigationOperation {
* @crossplatform
* @since 11
*/
/**
* Pop operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
POP = 2,
/**
@ -1389,6 +1583,14 @@ declare enum NavigationOperation {
* @crossplatform
* @since 11
*/
/**
* Replace operation of navigation transition.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
REPLACE = 3,
}
@ -2114,6 +2316,16 @@ declare class NavigationAttribute extends CommonMethod<NavigationAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set custom navigation content transition animation.
*
* @param { function } delegate - Custom transition delegate.
* @returns { NavigationAttribute } Returns the instance of the NavigationAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
customNavContentTransition(delegate: (from: NavContentInfo, to: NavContentInfo, operation: NavigationOperation) => NavigationAnimatedTransition | undefined): NavigationAttribute;
}
@ -2125,6 +2337,15 @@ declare class NavigationAttribute extends CommonMethod<NavigationAttribute> {
* @crossplatform
* @since 11
*/
/**
* Navigation transition animation protocol.
*
* @interface NavigationAnimatedTransition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface NavigationAnimatedTransition {
/**
* This method is called after the transition ends to notify whether the transition was successful.
@ -2134,6 +2355,15 @@ declare interface NavigationAnimatedTransition {
* @crossplatform
* @since 11
*/
/**
* This method is called after the transition ends to notify whether the transition was successful.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onTransitionEnd?: (success: boolean) => void
/**
@ -2144,6 +2374,15 @@ declare interface NavigationAnimatedTransition {
* @crossplatform
* @since 11
*/
/**
* Define the limit duration of the transition animation.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
timeout?: number;
/**
@ -2154,6 +2393,15 @@ declare interface NavigationAnimatedTransition {
* @crossplatform
* @since 11
*/
/**
* Configure the animations associated with custom transition.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
transition: (transitionProxy: NavigationTransitionProxy) => void
}
@ -2165,6 +2413,15 @@ declare interface NavigationAnimatedTransition {
* @crossplatform
* @since 11
*/
/**
* Navigation transition proxy.
*
* @interface NavigationTransitionProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface NavigationTransitionProxy {
/**
* From navigation content info.
@ -2174,6 +2431,15 @@ declare interface NavigationTransitionProxy {
* @crossplatform
* @since 11
*/
/**
* From navigation content info.
*
* @type { NavContentInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
from: NavContentInfo;
/**
@ -2184,6 +2450,15 @@ declare interface NavigationTransitionProxy {
* @crossplatform
* @since 11
*/
/**
* To navigation content info.
*
* @type { NavContentInfo }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
to: NavContentInfo;
/**
@ -2193,6 +2468,14 @@ declare interface NavigationTransitionProxy {
* @crossplatform
* @since 11
*/
/**
* Notification system transition animation completed.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
finishTransition(): void;
}
@ -2204,6 +2487,15 @@ declare interface NavigationTransitionProxy {
* @crossplatform
* @since 11
*/
/**
* Navigation content info.
*
* @interface NavContentInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface NavContentInfo {
/**
* Navigation content name.
@ -2213,6 +2505,15 @@ declare interface NavContentInfo {
* @crossplatform
* @since 11
*/
/**
* Navigation content name.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
name?: string;
/**
@ -2223,6 +2524,15 @@ declare interface NavContentInfo {
* @crossplatform
* @since 11
*/
/**
* Navigation content index.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number;
/**
@ -2233,6 +2543,15 @@ declare interface NavContentInfo {
* @crossplatform
* @since 11
*/
/**
* Navigation content mode.
*
* @type { ?NavDestinationMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
mode?: NavDestinationMode;
}

43
api/@internal/component/ets/node_container.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Defines the Interface of NodeContainer. To display the node build by an associated NodeController.
*
* @interface NodeContainerInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface NodeContainerInterface {
/**
* Constructor parameters
@ -36,6 +45,16 @@ interface NodeContainerInterface {
* @crossplatform
* @since 11
*/
/**
* Constructor parameters
*
* @param { import('../api/@ohos.arkui.node').NodeController } controller - Indicates the controller of the NodeContainer.
* @returns { NodeContainerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(controller: import('../api/@ohos.arkui.node').NodeController): NodeContainerAttribute;
}
@ -46,6 +65,14 @@ interface NodeContainerInterface {
* @crossplatform
* @since 11
*/
/**
* Defines the attribute of NodeContainer, extends from CommonMethod.
* @extends CommonMethod<NodeContainerAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class NodeContainerAttribute extends CommonMethod<NodeContainerAttribute> {}
/**
@ -55,6 +82,14 @@ declare class NodeContainerAttribute extends CommonMethod<NodeContainerAttribute
* @crossplatform
* @since 11
*/
/**
* Defines NodeContainer Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const NodeContainer: NodeContainerInterface;
/**
@ -64,4 +99,12 @@ declare const NodeContainer: NodeContainerInterface;
* @crossplatform
* @since 11
*/
/**
* Defines NodeContainer Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const NodeContainerInstance: NodeContainerAttribute;

13
api/@internal/component/ets/particle.d.ts vendored
View File

@ -435,6 +435,17 @@ interface EmitterOptions<PARTICLE extends ParticleType> {
* @since 11
*/
lifetime?: number;
/**
* Particle lifetimeRange,value range [0, ∞).
* when lifetimeRange>lifetime,minimum lifetime is 0.
* @type { ?number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
lifetimeRange?: number;
};
/**
@ -860,6 +871,7 @@ interface ParticlePropertyAnimation<T> {
/**
* Curve of the particle animation.
* @type { ?(Curve | ICurve) }
* @default Curve.Linear
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 10
@ -867,6 +879,7 @@ interface ParticlePropertyAnimation<T> {
/**
* Curve of the particle animation.
* @type { ?(Curve | ICurve) }
* @default Curve.Linear
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

9
api/@internal/component/ets/qrcode.d.ts vendored
View File

@ -217,6 +217,15 @@ declare class QRCodeAttribute extends CommonMethod<QRCodeAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the opacity of the QR code content color.
* @param { number | Resource } value - indicates the opacity of the QR code content color. The value is between 0 and 1, with a default value of 1.
* @returns { QRCodeAttribute } the attribute of the QR code
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
contentOpacity(value: number | Resource): QRCodeAttribute;
}

543
api/@internal/component/ets/rich_editor.d.ts vendored
View File

@ -142,6 +142,15 @@ declare enum RichEditorSpanType {
* @crossplatform
* @since 11
*/
/**
* ResponseType for contextMenu
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum RichEditorResponseType {
/**
* Right click.
@ -150,6 +159,14 @@ declare enum RichEditorResponseType {
* @crossplatform
* @since 11
*/
/**
* Right click.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
RIGHT_CLICK = 0,
/**
@ -159,6 +176,14 @@ declare enum RichEditorResponseType {
* @crossplatform
* @since 11
*/
/**
* Long press.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LONG_PRESS = 1,
/**
@ -168,6 +193,14 @@ declare enum RichEditorResponseType {
* @crossplatform
* @since 11
*/
/**
* Selected by mouse.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SELECT = 2,
}
@ -395,6 +428,15 @@ declare interface RichEditorTextStyle {
* @crossplatform
* @since 11
*/
/**
* Text shadow
*
* @type { ?(ShadowOptions | Array<ShadowOptions>) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textShadow?: ShadowOptions | Array<ShadowOptions>;
/**
@ -427,6 +469,15 @@ declare interface RichEditorTextStyle {
* @crossplatform
* @since 11
*/
/**
* Defines the leading margin placeholder of a paragraph.
*
* @interface LeadingMarginPlaceholder
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface LeadingMarginPlaceholder {
/**
* Placeholder pixelMap.
@ -436,6 +487,15 @@ declare interface LeadingMarginPlaceholder {
* @crossplatform
* @since 11
*/
/**
* Placeholder pixelMap.
*
* @type { PixelMap }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pixelMap: PixelMap;
/**
@ -446,6 +506,15 @@ declare interface LeadingMarginPlaceholder {
* @crossplatform
* @since 11
*/
/**
* Placeholder size.
*
* @type { [Dimension, Dimension] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size: [Dimension, Dimension];
}
@ -457,6 +526,15 @@ declare interface LeadingMarginPlaceholder {
* @crossplatform
* @since 11
*/
/**
* Defines the paragraph style.
*
* @interface RichEditorParagraphStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorParagraphStyle {
/**
* Text alignment.
@ -466,6 +544,15 @@ declare interface RichEditorParagraphStyle {
* @crossplatform
* @since 11
*/
/**
* Text alignment.
*
* @type { ?TextAlign }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textAlign?: TextAlign;
/**
@ -476,6 +563,15 @@ declare interface RichEditorParagraphStyle {
* @crossplatform
* @since 11
*/
/**
* Leading margin.
*
* @type { ?(Dimension | LeadingMarginPlaceholder) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
leadingMargin?: Dimension | LeadingMarginPlaceholder;
/**
@ -600,6 +696,15 @@ interface RichEditorLayoutStyle {
* @crossplatform
* @since 11
*/
/**
* Outer Margin.
*
* @type { ?(Dimension | Margin) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
margin?: Dimension | Margin;
/**
@ -610,6 +715,15 @@ interface RichEditorLayoutStyle {
* @crossplatform
* @since 11
*/
/**
* Border radius.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderRadius?: Dimension | BorderRadiuses;
}
@ -692,6 +806,15 @@ declare interface RichEditorImageSpanStyle {
* @crossplatform
* @since 11
*/
/**
* RichEditor ImageSpan Layout Style.
*
* @type { ?RichEditorLayoutStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
layoutStyle?: RichEditorLayoutStyle;
}
@ -703,6 +826,15 @@ declare interface RichEditorImageSpanStyle {
* @crossplatform
* @since 11
*/
/**
* Defines the symbol span style.
*
* @interface RichEditorSymbolSpanStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorSymbolSpanStyle {
/**
* The font size.
@ -712,6 +844,15 @@ declare interface RichEditorSymbolSpanStyle {
* @crossplatform
* @since 11
*/
/**
* The font size.
*
* @type { ?(number | string | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize?: number | string | Resource;
/**
@ -722,6 +863,15 @@ declare interface RichEditorSymbolSpanStyle {
* @crossplatform
* @since 11
*/
/**
* The font color.
*
* @type { ?Array<ResourceColor> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: Array<ResourceColor>;
/**
@ -732,6 +882,15 @@ declare interface RichEditorSymbolSpanStyle {
* @crossplatform
* @since 11
*/
/**
* The font weight.
*
* @type { ?(number | FontWeight | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight?: number | FontWeight | string;
/**
@ -742,6 +901,15 @@ declare interface RichEditorSymbolSpanStyle {
* @crossplatform
* @since 11
*/
/**
* The symbol span effect strategy.
*
* @type { ?SymbolEffectStrategy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
effectStrategy?: SymbolEffectStrategy;
/**
@ -752,6 +920,15 @@ declare interface RichEditorSymbolSpanStyle {
* @crossplatform
* @since 11
*/
/**
* The symbol span rendering strategy.
*
* @type { ?SymbolRenderingStrategy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
renderingStrategy?: SymbolRenderingStrategy;
}
@ -909,6 +1086,15 @@ declare interface RichEditorTextStyleResult {
* @crossplatform
* @since 11
*/
/**
* Defines the paragraph result.
*
* @interface RichEditorParagraphResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorParagraphResult {
/**
* The paragraph style.
@ -918,6 +1104,15 @@ declare interface RichEditorParagraphResult {
* @crossplatform
* @since 11
*/
/**
* The paragraph style.
*
* @type { RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
style: RichEditorParagraphStyle;
/**
@ -928,6 +1123,15 @@ declare interface RichEditorParagraphResult {
* @crossplatform
* @since 11
*/
/**
* The range of paragraph based on character indices.
*
* @type { [number, number] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
range: [number, number];
}
@ -939,6 +1143,15 @@ declare interface RichEditorParagraphResult {
* @crossplatform
* @since 11
*/
/**
* Defines the symbol span style result.
*
* @interface RichEditorSymbolSpanStyleResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorSymbolSpanStyleResult {
/**
* The font size.
@ -948,6 +1161,15 @@ declare interface RichEditorSymbolSpanStyleResult {
* @crossplatform
* @since 11
*/
/**
* The font size.
*
* @type { number | string | Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize: number | string | Resource;
/**
@ -958,6 +1180,15 @@ declare interface RichEditorSymbolSpanStyleResult {
* @crossplatform
* @since 11
*/
/**
* The font color.
*
* @type { Array<ResourceColor> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor: Array<ResourceColor>;
/**
@ -968,6 +1199,15 @@ declare interface RichEditorSymbolSpanStyleResult {
* @crossplatform
* @since 11
*/
/**
* The font weight.
*
* @type { number | FontWeight | string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight: number | FontWeight | string;
/**
@ -978,6 +1218,15 @@ declare interface RichEditorSymbolSpanStyleResult {
* @crossplatform
* @since 11
*/
/**
* The symbol span effect strategy.
*
* @type { SymbolEffectStrategy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
effectStrategy: SymbolEffectStrategy;
/**
@ -988,6 +1237,15 @@ declare interface RichEditorSymbolSpanStyleResult {
* @crossplatform
* @since 11
*/
/**
* The symbol span rendering strategy.
*
* @type { SymbolRenderingStrategy }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
renderingStrategy: SymbolRenderingStrategy;
}
@ -1088,6 +1346,15 @@ declare interface RichEditorTextSpanResult {
* @crossplatform
* @since 11
*/
/**
* Symbol span style.
*
* @type { ?RichEditorSymbolSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolSpanStyle?: RichEditorSymbolSpanStyle;
/**
@ -1098,6 +1365,15 @@ declare interface RichEditorTextSpanResult {
* @crossplatform
* @since 11
*/
/**
* The resource string of the symbol span.
*
* @type { ?Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
valueResource?: Resource;
/**
@ -1439,6 +1715,15 @@ declare interface RichEditorRange {
* @crossplatform
* @since 11
*/
/**
* Defines the richEditor Gestures.
*
* @interface RichEditorGesture
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorGesture {
/**
* Trigger a click event when a click is clicked.
@ -1448,6 +1733,15 @@ declare interface RichEditorGesture {
* @crossplatform
* @since 11
*/
/**
* Trigger a click event when a click is clicked.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onClick?: (event: ClickEvent) => void;
/**
@ -1458,6 +1752,15 @@ declare interface RichEditorGesture {
* @crossplatform
* @since 11
*/
/**
* Trigger a gesture event when long press event is complete.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onLongPress?: (event: GestureEvent) => void;
}
@ -1522,6 +1825,15 @@ declare interface RichEditorTextSpanOptions {
* @crossplatform
* @since 11
*/
/**
* Paragraph style.
*
* @type { ?RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
paragraphStyle?: RichEditorParagraphStyle;
/**
@ -1532,6 +1844,15 @@ declare interface RichEditorTextSpanOptions {
* @crossplatform
* @since 11
*/
/**
* RichEditor gesture.
*
* @type { ?RichEditorGesture }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
gesture?: RichEditorGesture;
}
@ -1636,6 +1957,15 @@ declare interface RichEditorImageSpanOptions {
* @crossplatform
* @since 11
*/
/**
* RichEditor gesture.
*
* @type { ?RichEditorGesture }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
gesture?: RichEditorGesture;
}
@ -1647,6 +1977,15 @@ declare interface RichEditorImageSpanOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the builder span options of RichEditor.
*
* @interface RichEditorBuilderSpanOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorBuilderSpanOptions {
/**
* The offset that add custom builder span at.
@ -1656,6 +1995,15 @@ declare interface RichEditorBuilderSpanOptions {
* @crossplatform
* @since 11
*/
/**
* The offset that add custom builder span at.
*
* @type { ?number } Indicates the index where the builder will be inserted
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offset?: number;
}
@ -1717,6 +2065,15 @@ declare interface RichEditorSpanStyleOptions extends RichEditorRange { }
* @crossplatform
* @since 11
*/
/**
* Defines paragraph style option of RichEditor.
*
* @interface RichEditorParagraphStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
/**
* Paragraph style.
@ -1726,6 +2083,15 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
* @crossplatform
* @since 11
*/
/**
* Paragraph style.
*
* @type { RichEditorParagraphStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
style: RichEditorParagraphStyle;
}
@ -1809,6 +2175,15 @@ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanSt
* @crossplatform
* @since 11
*/
/**
* Defines symbol span style option of RichEditor.
*
* @interface RichEditorUpdateSymbolSpanStyleOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanStyleOptions {
/**
* Update the symbol span style.
@ -1818,6 +2193,15 @@ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanS
* @crossplatform
* @since 11
*/
/**
* Update the symbol span style.
*
* @type { RichEditorSymbolSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
symbolStyle: RichEditorSymbolSpanStyle;
}
@ -1838,6 +2222,15 @@ declare interface RichEditorSymbolSpanOptions {
* @crossplatform
* @since 11
*/
/**
* The offset that add custom symbol span at.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offset?: number;
/**
@ -1848,6 +2241,15 @@ declare interface RichEditorSymbolSpanOptions {
* @crossplatform
* @since 11
*/
/**
* The style that add custom symbol span at.
*
* @type { ?RichEditorSymbolSpanStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
style?: RichEditorSymbolSpanStyle;
}
@ -2248,6 +2650,17 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Add a builder span.
*
* @param { CustomBuilder } value - Indicates the custom builder node
* @param { RichEditorBuilderSpanOptions } [options] - span option.
* @returns { number } span index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
addBuilderSpan(value: CustomBuilder, options?: RichEditorBuilderSpanOptions): number;
/**
@ -2260,6 +2673,17 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Add a symbol span.
*
* @param { Resource } value - symbol span value
* @param { RichEditorSymbolSpanOptions } [options] - symbol span option.
* @returns { number } symbol span index
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
addSymbolSpan(value: Resource, options?: RichEditorSymbolSpanOptions ): number;
/**
@ -2288,6 +2712,15 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Modify span style.
*
* @param { RichEditorParagraphStyleOptions } value
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
updateParagraphStyle(value: RichEditorParagraphStyleOptions): void;
/**
@ -2337,6 +2770,16 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Get span content.
*
* @param { RichEditorRange } [value] - range for getting span info.
* @returns { Array<RichEditorParagraphResult> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getParagraphs(value?: RichEditorRange): Array<RichEditorParagraphResult>;
/**
@ -2363,6 +2806,15 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Get the typing text style.
*
* @returns { RichEditorTextStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getTypingStyle(): RichEditorTextStyle;
/**
@ -2373,6 +2825,15 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Set the typing text style.
*
* @param { RichEditorTextStyle } value - set the typing text style.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
setTypingStyle(value: RichEditorTextStyle): void;
/**
@ -2404,6 +2865,15 @@ declare class RichEditorController {
* @crossplatform
* @since 11
*/
/**
* Called when the content is selected.
*
* @returns { RichEditorSelection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getSelection(): RichEditorSelection;
/**
@ -2415,6 +2885,15 @@ declare class RichEditorController {
* @since 12
*/
isEditing(): boolean;
/**
* Stop editing state.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
stopEditing(): void;
}
/**
@ -2657,6 +3136,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @crossplatform
* @since 11
*/
/**
* Defines onPaste callback.
*
* @param { function } callback Executed when a paste operation is performed.
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onPaste(callback: (event?: PasteEvent) => void): RichEditorAttribute;
/**
@ -2668,6 +3157,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @crossplatform
* @since 11
*/
/**
* Enable data detector.
*
* @param { boolean } enable - Enable data detector.
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enableDataDetector(enable: boolean): RichEditorAttribute;
/**
@ -2679,6 +3178,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @crossplatform
* @since 11
*/
/**
* Data detector with config.
*
* @param { TextDataDetectorConfig } config - The config of text data detector.
* @returns { RichEditorAttribute } The attribute of the rich editor.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dataDetectorConfig(config: TextDataDetectorConfig): RichEditorAttribute;
/**
@ -2725,8 +3234,42 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
* @since 12
*/
onEditingChange(callback: Callback<boolean>): RichEditorAttribute;
/**
* Set enter key type of soft keyboard.
*
* @param { EnterKeyType } value - the enter key type of soft keyboard
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
enterKeyType(value: EnterKeyType): RichEditorAttribute;
/**
* Called when submitted.
*
* @param { SubmitCallback } callback - callback of the listened event.
* @returns { RichEditorAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onSubmit(callback: SubmitCallback): RichEditorAttribute;
}
/**
* callback of the listened enter key event.
*
* @typedef { Function } SubmitCallback
* @param { EnterKeyType } enterKey - the enter key type of soft keyboard.
* @param { SubmitEvent } event - Provides the method of keeping RichEditor editable state when submitted.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void;
/**
* Provides an interface for writing texts.
*

22
api/@internal/component/ets/scroll.d.ts vendored
View File

@ -684,6 +684,18 @@ declare class Scroller {
* @crossplatform
* @since 11
*/
/**
* Get child item size and position.
*
* @param { number } index - Index of the item.
* @returns { RectResult } Returns the size and position.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 100004 - Controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getItemRect(index: number): RectResult;
}
@ -1312,6 +1324,16 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
* @crossplatform
* @since 11
*/
/**
* Determines whether the scroll view stops on multiples of the content size when the user scrolls.
*
* @param { boolean } value - A boolean value determines whether paging is enabled for scroll.
* @returns { ScrollAttribute } the attribute of the scroll.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enablePaging(value: boolean): ScrollAttribute;
/**

128
api/@internal/component/ets/search.d.ts vendored
View File

@ -200,6 +200,15 @@ declare enum CancelButtonStyle {
* @crossplatform
* @since 11
*/
/**
* Declare the type of search input box
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SearchType {
/**
* Basic input mode.
@ -208,6 +217,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* Basic input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NORMAL = 0,
/**
@ -217,6 +234,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* Pure digital input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NUMBER = 2,
/**
@ -226,6 +251,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* Phone number entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PHONE_NUMBER = 3,
/**
@ -235,6 +268,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* E-mail address input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EMAIL = 5,
}
@ -678,6 +719,73 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
*/
cancelButton(value: { style?: CancelButtonStyle, icon?: IconOptions }): SearchAttribute;
/**
* Called when the overflow mode of the font is set.
*
* @param { TextOverflow } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textOverflow(value: TextOverflow): SearchAttribute;
/**
* Called when the baseline offset is set.
*
* @param { Dimension } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
baselineOffset(value: Dimension): SearchAttribute;
/**
* Specify the indentation of the first line in a text-block.
*
* @param { Dimension } value - The length of text indent.
* @returns { SearchAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textIndent(value: Dimension): SearchAttribute;
/**
* Called when the inputFilter of text is set.
*
* @param { ResourceStr } value
* @param { Callback<string> } error
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
inputFilter(value: ResourceStr, error?: Callback<string>): SearchAttribute;
/**
* Called when judging whether the text editing change finished.
*
* @param { Callback<boolean> } callback
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onEditChange(callback: Callback<boolean>): SearchAttribute;
/**
* Define the text selected background color of the text input.
*
* @param { ResourceColor } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
selectedBackgroundColor(value: ResourceColor): SearchAttribute;
/**
* Set the cursor style
*
@ -1025,6 +1133,16 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* crossplatform
* @since 11
*/
/**
* Called when the input of maximum text length is set.
*
* @param { number } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* crossplatform
* @atomicservice
* @since 12
*/
maxLength(value: number): SearchAttribute;
/**
@ -1192,6 +1310,16 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the search type is set.
*
* @param { SearchType } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type(value: SearchType): SearchAttribute;
/**

20
api/@internal/component/ets/select.d.ts vendored
View File

@ -685,6 +685,16 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the width of each option and set whether the option width fit the trigger.
*
* @param { Dimension | OptionWidthMode } value - The length of option width and decide option width to fit trigger or content.
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
optionWidth(value: Dimension | OptionWidthMode ): SelectAttribute;
/**
@ -696,6 +706,16 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the height of each option.
*
* @param { Dimension } value - The length of option height.
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
optionHeight(value: Dimension): SelectAttribute;
/**

56
api/@internal/component/ets/span.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Define the background style of span.
*
* @interface TextBackgroundStyle
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextBackgroundStyle {
/**
* Background color of span.
@ -35,6 +44,15 @@ declare interface TextBackgroundStyle {
* @crossplatform
* @since 11
*/
/**
* Background color of span.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
color?: ResourceColor;
/**
@ -45,6 +63,15 @@ declare interface TextBackgroundStyle {
* @crossplatform
* @since 11
*/
/**
* Background radius of span.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
radius?: Dimension | BorderRadiuses;
}
@ -56,6 +83,15 @@ declare interface TextBackgroundStyle {
* @crossplatform
* @since 11
*/
/**
* Define the BaseSpan class, contains the common methods of span.
*
* @extends CommonMethod<T>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class BaseSpan<T> extends CommonMethod<T> {
/**
* Span background style.
@ -66,6 +102,16 @@ declare class BaseSpan<T> extends CommonMethod<T> {
* @crossplatform
* @since 11
*/
/**
* Span background style.
*
* @param { TextBackgroundStyle } style - The background style of span.
* @returns { T }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textBackgroundStyle(style: TextBackgroundStyle): T;
}
@ -541,6 +587,16 @@ declare class SpanAttribute extends BaseSpan<SpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the text shadow is set.
*
* @param { ShadowOptions | Array<ShadowOptions> } value - The shadow options.
* @returns { SpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textShadow(value: ShadowOptions | Array<ShadowOptions>): SpanAttribute;
}

131
api/@internal/component/ets/swiper.d.ts vendored
View File

@ -1856,8 +1856,139 @@ declare class SwiperAttribute extends CommonMethod<SwiperAttribute> {
* @since 11
*/
nestedScroll(value: SwiperNestedScrollMode): SwiperAttribute;
/**
* Custom swiper content transition animation.
*
* @param { SwiperContentAnimatedTransition } transition - custom content transition animation.
* @returns { SwiperAttribute } the attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
customContentTransition(transition: SwiperContentAnimatedTransition): SwiperAttribute;
/**
* Called when the swiper content did scroll.
*
* @param { ContentDidScrollCallback } handler - callback of scroll,
* selectedIndex is the index value of the swiper content selected before animation start.
* index is the index value of the swiper content.
* position is the moving ratio of the swiper content from the start position of the swiper main axis.
* mainAxisLength is the swiper main axis length for calculating position.
* @returns { SwiperAttribute } the attribute of the swiper.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onContentDidScroll(handler: ContentDidScrollCallback): SwiperAttribute;
}
/**
* Defines the swiper content animated transition options.
*
* @interface SwiperContentAnimatedTransition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface SwiperContentAnimatedTransition {
/**
* Defines the timeout of custom content transition animation after the page is moved out of the swiper. The unit is ms.
* If SwiperContentTransitionProxy.finishTransition() is not invoked, use the timeout as animation end time.
*
* @type { ?number }
* @default 0 ms
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
timeout?: number;
/**
* Called when custom content transition animation start.
*
* @type { Callback<SwiperContentTransitionProxy> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
transition: Callback<SwiperContentTransitionProxy>;
}
/**
* The proxy of SwiperContentAnimatedTransition.
*
* @interface SwiperContentTransitionProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface SwiperContentTransitionProxy {
/**
* the index value of the swiper content selected before animation start.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
selectedIndex: number;
/**
* The index value of the swiper content.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: number;
/**
* the moving ratio of the swiper content from the start position of the swiper main axis.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
position: number;
/**
* the swiper main axis length for calculating position.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
mainAxisLength: number;
/**
* Notifies Swiper page the custom content transition animation is complete.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
finishTransition(): void;
}
/**
* The callback of onContentDidScroll.
*
* @typedef { Function } ContentDidScrollCallback
* @param { number } selectedIndex - the index value of the swiper content selected before animation start.
* @param { number } index - the index value of the swiper content.
* @param { number } position - the moving ratio of the swiper content from the start position of the swiper main axis.
* @param { number } mainAxisLength - the swiper main axis length for calculating position.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type ContentDidScrollCallback = (selectedIndex: number, index: number, position: number, mainAxisLength: number) => void;
/**
* Defines Swiper Component.
*

94
api/@internal/component/ets/symbol_span.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Provides an interface for SymbolSpan.
*
* @interface SymbolSpanInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SymbolSpanInterface {
/**
* Called when resource is entered in SymbolSpan.
@ -36,6 +45,16 @@ interface SymbolSpanInterface {
* @crossplatform
* @since 11
*/
/**
* Called when resource is entered in SymbolSpan.
*
* @param { Resource } value
* @returns { SymbolSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(value: Resource): SymbolSpanAttribute;
}
@ -47,6 +66,15 @@ interface SymbolSpanInterface {
* @crossplatform
* @since 11
*/
/**
* Provides attribute for SymbolSpan.
*
* @extends CommonMethod<SymbolSpanAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
/**
* Called when the SymbolSpan size is set.
@ -57,6 +85,16 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolSpan size is set.
*
* @param { number | string | Resource } value
* @returns { SymbolSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize(value: number | string | Resource): SymbolSpanAttribute;
/**
@ -68,6 +106,16 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolSpan color is set.
*
* @param { Array<ResourceColor> } value
* @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor(value: Array<ResourceColor>): SymbolSpanAttribute;
/**
@ -79,6 +127,16 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the font SymbolSpan weight is set.
*
* @param { number | FontWeight | string } value
* @returns { SymbolSpanAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight(value: number | FontWeight | string): SymbolSpanAttribute;
/**
@ -90,6 +148,16 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolSpan effect is set.
*
* @param { SymbolEffectStrategy } value
* @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
effectStrategy(value: SymbolEffectStrategy): SymbolSpanAttribute;
/**
@ -101,6 +169,16 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolSpan rendering strategy is set.
*
* @param { SymbolRenderingStrategy } value
* @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
renderingStrategy(value: SymbolRenderingStrategy): SymbolSpanAttribute;
}
@ -111,6 +189,14 @@ declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
* @crossplatform
* @since 11
*/
/**
* Defines SymbolSpan Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const SymbolSpan: SymbolSpanInterface;
/**
@ -120,4 +206,12 @@ declare const SymbolSpan: SymbolSpanInterface;
* @crossplatform
* @since 11
*/
/**
* Defines SymbolSpan Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const SymbolSpanInstance: SymbolSpanAttribute;

160
api/@internal/component/ets/symbolglyph.d.ts vendored
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Provides an interface for SymbolGlyph.
*
* @interface SymbolGlyphInterface
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SymbolGlyphInterface {
/**
* Called when resource is entered in SymbolGlyph.
@ -36,6 +45,16 @@ interface SymbolGlyphInterface {
* @crossplatform
* @since 11
*/
/**
* Called when resource is entered in SymbolGlyph.
*
* @param { Resource } value
* @returns { SymbolGlyphAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
(value: Resource): SymbolGlyphAttribute;
}
@ -47,6 +66,15 @@ interface SymbolGlyphInterface {
* @crossplatform
* @since 11
*/
/**
* The symbol rendering strategy.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SymbolRenderingStrategy {
/**
* The single rendering strategy.
@ -55,6 +83,14 @@ declare enum SymbolRenderingStrategy {
* @crossplatform
* @since 11
*/
/**
* The single rendering strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SINGLE = 0,
/**
@ -64,6 +100,14 @@ declare enum SymbolRenderingStrategy {
* @crossplatform
* @since 11
*/
/**
* The multiple color rendering strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
MULTIPLE_COLOR = 1,
/**
@ -73,6 +117,14 @@ declare enum SymbolRenderingStrategy {
* @crossplatform
* @since 11
*/
/**
* The multiple opacity rendering strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
MULTIPLE_OPACITY = 2,
}
@ -84,6 +136,15 @@ declare enum SymbolRenderingStrategy {
* @crossplatform
* @since 11
*/
/**
* The symbol effect strategy.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum SymbolEffectStrategy {
/**
* There is no effect strategy.
@ -92,6 +153,14 @@ declare enum SymbolEffectStrategy {
* @crossplatform
* @since 11
*/
/**
* There is no effect strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NONE = 0,
/**
@ -101,6 +170,14 @@ declare enum SymbolEffectStrategy {
* @crossplatform
* @since 11
*/
/**
* The scale effect strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SCALE = 1,
/**
@ -110,6 +187,14 @@ declare enum SymbolEffectStrategy {
* @crossplatform
* @since 11
*/
/**
* The hierarchical effect strategy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
HIERARCHICAL = 2,
}
@ -121,6 +206,15 @@ declare enum SymbolEffectStrategy {
* @crossplatform
* @since 11
*/
/**
* Provides attribute for SymbolGlyph.
*
* @extends CommonMethod<SymbolGlyphAttribute>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
/**
* Called when the SymbolGlyph size is set.
@ -131,6 +225,16 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolGlyph size is set.
*
* @param { number | string | Resource } value
* @returns { SymbolGlyphAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize(value: number | string | Resource): SymbolGlyphAttribute;
/**
@ -142,6 +246,16 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the SymbolGlyph color is set.
*
* @param { Array<ResourceColor> } value
* @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor(value: Array<ResourceColor>): SymbolGlyphAttribute;
/**
@ -153,6 +267,16 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the font symbolGlyph weight is set.
*
* @param { number | FontWeight | string } value
* @returns { SymbolGlyphAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight(value: number | FontWeight | string): SymbolGlyphAttribute;
/**
@ -164,6 +288,16 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the symbolGlyph effect is set.
*
* @param { SymbolEffectStrategy } value
* @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
effectStrategy(value: SymbolEffectStrategy): SymbolGlyphAttribute;
/**
@ -175,6 +309,16 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the symbolGlyph rendering strategy is set.
*
* @param { SymbolRenderingStrategy } value
* @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
renderingStrategy(value: SymbolRenderingStrategy): SymbolGlyphAttribute;
}
@ -185,6 +329,14 @@ declare class SymbolGlyphAttribute extends CommonMethod<SymbolGlyphAttribute> {
* @crossplatform
* @since 11
*/
/**
* Defines SymbolGlyph Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const SymbolGlyph: SymbolGlyphInterface;
/**
@ -194,4 +346,12 @@ declare const SymbolGlyph: SymbolGlyphInterface;
* @crossplatform
* @since 11
*/
/**
* Defines SymbolGlyph Component instance.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare const SymbolGlyphInstance: SymbolGlyphAttribute;

20
api/@internal/component/ets/tab_content.d.ts vendored
View File

@ -672,6 +672,16 @@ declare class SubTabBarStyle {
* @crossplatform
* @since 11
*/
/**
* Set an id to the sub tab bar to identify it
*
* @param { string } value - id of the sub tab bar to identify it
* @returns { SubTabBarStyle } the style of the sub tab bar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
id(value: string): SubTabBarStyle;
}
@ -865,6 +875,16 @@ declare class BottomTabBarStyle {
* @crossplatform
* @since 11
*/
/**
* Set an id to the bottom tab bar to identify it
*
* @param { string } value - id of the bottom tab bar to identify it
* @returns { BottomTabBarStyle } the style of the bottom tab bar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
id(value: string): BottomTabBarStyle;
/**

159
api/@internal/component/ets/tabs.d.ts vendored
View File

@ -470,6 +470,15 @@ interface DividerStyle {
* @crossplatform
* @since 11
*/
/**
* Provides an interface for tabs animation.
*
* @interface TabsAnimationEvent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
declare interface TabsAnimationEvent {
/**
* Offset of the current page to the start position of the tabs main axis. The unit is vp.
@ -480,6 +489,16 @@ declare interface TabsAnimationEvent {
* @crossplatform
* @since 11
*/
/**
* Offset of the current page to the start position of the tabs main axis. The unit is vp.
*
* @type { number }
* @default 0.0 vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
currentOffset: number;
/**
@ -491,6 +510,16 @@ declare interface TabsAnimationEvent {
* @crossplatform
* @since 11
*/
/**
* Offset of the target page to the start position of the tabs main axis. The unit is vp.
*
* @type { number }
* @default 0.0 vp
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
targetOffset: number;
/**
@ -502,6 +531,16 @@ declare interface TabsAnimationEvent {
* @crossplatform
* @since 11
*/
/**
* Start speed of the page-turning animation. The unit is vp/s.
*
* @type { number }
* @default 0.0 vp/s
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
velocity: number;
}
@ -1036,6 +1075,19 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the tab content flip animation start.
*
* @param { function } handler -
* "index": the index value of the tab that when animation start.
* "targetIndex": the target index value of the tab that when animation start.
* "event": the animation event callback info.
* @returns { TabsAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onAnimationStart(handler: (index: number, targetIndex: number, event: TabsAnimationEvent) => void): TabsAttribute;
/**
@ -1049,6 +1101,18 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the tab content flip animation end.
*
* @param { function } handler -
* "index": the index value of the tab that when animation start.
* "event": the animation event callback info.
* @returns { TabsAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onAnimationEnd(handler: (index: number, event: TabsAnimationEvent) => void): TabsAttribute;
/**
@ -1062,6 +1126,18 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when swiping the tab content with the gesture.
*
* @param { function } handler -
* "index": the index value of the tab that when animation start.
* "event": the animation event callback info.
* @returns { TabsAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onGestureSwipe(handler: (index: number, event: TabsAnimationEvent) => void): TabsAttribute;
/**
@ -1178,6 +1254,18 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
* @since 11
* @form
*/
/**
* Custom tab content transition animation.
* When undefined is set, this interface does not take effect.
*
* @param { function } delegate - custom content transition animation.
* @returns { TabsAttribute } the attribute of the tabs
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
customContentTransition(delegate: (from: number, to: number) => TabContentAnimatedTransition | undefined): TabsAttribute;
/**
@ -1218,6 +1306,16 @@ declare class TabsAttribute extends CommonMethod<TabsAttribute> {
* @since 11
* @form
*/
/**
* Defines the Tab Content animated transition options.
*
* @interface TabContentAnimatedTransition
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare interface TabContentAnimatedTransition {
/**
* Defines the timeout of custom content transition animation. The unit is ms.
@ -1230,6 +1328,18 @@ declare interface TabContentAnimatedTransition {
* @since 11
* @form
*/
/**
* Defines the timeout of custom content transition animation. The unit is ms.
* If TabContentTransitionProxy.finishTransition() is not invoked, use the timeout as animation end time.
*
* @type { ?number }
* @default 1000 ms
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
timeout?: number;
/**
@ -1241,6 +1351,16 @@ declare interface TabContentAnimatedTransition {
* @since 11
* @form
*/
/**
* Called when custom content transition animation start.
*
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
transition: (proxy: TabContentTransitionProxy) => void;
}
@ -1253,6 +1373,16 @@ declare interface TabContentAnimatedTransition {
* @since 11
* @form
*/
/**
* The proxy of TabContentAnimatedTransition.
*
* @interface TabContentTransitionProxy
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare interface TabContentTransitionProxy {
/**
* The index of current tab content.
@ -1263,6 +1393,16 @@ declare interface TabContentTransitionProxy {
* @since 11
* @form
*/
/**
* The index of current tab content.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
from: number;
/**
@ -1274,6 +1414,16 @@ declare interface TabContentTransitionProxy {
* @since 11
* @form
*/
/**
* The index of target tab content.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
to: number;
/**
@ -1284,6 +1434,15 @@ declare interface TabContentTransitionProxy {
* @since 11
* @form
*/
/**
* Notifies Tabs component the custom content transition animation is complete.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 112
* @form
*/
finishTransition(): void;
}

151
api/@internal/component/ets/text.d.ts vendored
View File

@ -916,6 +916,16 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the ellipsis mode.
*
* @param { EllipsisMode } value - The ellipsis mode.
* @returns { TextAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ellipsisMode(value: EllipsisMode): TextAttribute;
/**
@ -926,6 +936,15 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Enable data detector.
*
* @param { boolean } enable - Enable data detector.
* @returns { TextAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableDataDetector(enable: boolean): TextAttribute;
/**
@ -936,6 +955,15 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Data detector with config.
*
* @param { TextDataDetectorConfig } config - The config of text data detector.
* @returns { TextAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
dataDetectorConfig(config: TextDataDetectorConfig): TextAttribute;
/**
@ -950,6 +978,19 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @crossplatform
* @since 11
*/
/**
* Bind to the selection menu.
*
* @param { TextSpanType } spanType - Indicates the type of selection menu.
* @param { CustomBuilder } content - Indicates the content of selection menu.
* @param { TextResponseType } responseType - Indicates response type of selection menu.
* @param { SelectionMenuOptions } [options] - Indicates the options of selection menu.
* @returns { TextAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
bindSelectionMenu(spanType: TextSpanType, content: CustomBuilder, responseType: TextResponseType,
options?: SelectionMenuOptions): TextAttribute;
@ -962,6 +1003,16 @@ declare class TextAttribute extends CommonMethod<TextAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the text selection changes.
*
* @param { function } callback - callback of the listened event.
* @returns { TextAttribute } returns the instance of the TextAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void): TextAttribute;
/**
@ -1052,6 +1103,15 @@ declare const Text: TextInterface;
* @crossplatform
* @since 11
*/
/**
* Defines span type.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TextSpanType {
/**
* Only contains text.
@ -1060,6 +1120,14 @@ declare enum TextSpanType {
* @crossplatform
* @since 11
*/
/**
* Only contains text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TEXT = 0,
/**
@ -1069,6 +1137,14 @@ declare enum TextSpanType {
* @crossplatform
* @since 11
*/
/**
* Only contains image.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
IMAGE = 1,
/**
@ -1078,6 +1154,14 @@ declare enum TextSpanType {
* @crossplatform
* @since 11
*/
/**
* Contains both text and image.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
MIXED = 2,
}
@ -1089,6 +1173,15 @@ declare enum TextSpanType {
* @crossplatform
* @since 11
*/
/**
* ResponseType for contextMenu
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TextResponseType {
/**
* Right click.
@ -1097,6 +1190,14 @@ declare enum TextResponseType {
* @crossplatform
* @since 11
*/
/**
* Right click.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
RIGHT_CLICK = 0,
/**
@ -1106,6 +1207,14 @@ declare enum TextResponseType {
* @crossplatform
* @since 11
*/
/**
* Long press.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LONG_PRESS = 1,
/**
@ -1115,6 +1224,14 @@ declare enum TextResponseType {
* @crossplatform
* @since 11
*/
/**
* Selected by mouse.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SELECT = 2,
}
@ -1126,6 +1243,15 @@ declare enum TextResponseType {
* @crossplatform
* @since 11
*/
/**
* Defines the options of Text.
*
* @interface TextOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare interface TextOptions {
/**
* Text controller.
@ -1135,6 +1261,15 @@ declare interface TextOptions {
* @crossplatform
* @since 11
*/
/**
* Text controller.
*
* @type { TextController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
controller: TextController;
}
@ -1145,6 +1280,14 @@ declare interface TextOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the controller of Text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class TextController {
/**
* Close the select menu when menu is on.
@ -1153,5 +1296,13 @@ declare class TextController {
* @crossplatform
* @since 11
*/
/**
* Close the select menu when menu is on.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
closeSelectionMenu(): void;
}

128
api/@internal/component/ets/text_area.d.ts vendored
View File

@ -308,6 +308,15 @@ interface TextAreaInterface {
* @crossplatform
* @since 11
*/
/**
* Declare the type of input box
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TextAreaType {
/**
* Basic input mode.
@ -316,6 +325,14 @@ declare enum TextAreaType {
* @crossplatform
* @since 11
*/
/**
* Basic input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NORMAL = 0,
/**
@ -325,6 +342,14 @@ declare enum TextAreaType {
* @crossplatform
* @since 11
*/
/**
* Pure digital input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NUMBER = 2,
/**
@ -334,6 +359,14 @@ declare enum TextAreaType {
* @crossplatform
* @since 11
*/
/**
* Phone number entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PHONE_NUMBER = 3,
/**
@ -343,6 +376,14 @@ declare enum TextAreaType {
* @crossplatform
* @since 11
*/
/**
* E-mail address input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EMAIL = 5,
}
@ -438,6 +479,16 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the type of soft keyboard input button is set.
*
* @param { EnterKeyType } value: the type of soft keyboard
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enterKeyType(value: EnterKeyType): TextAreaAttribute;
/**
@ -643,6 +694,39 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
*/
fontFamily(value: ResourceStr): TextAreaAttribute;
/**
* Called when the overflow mode of the font is set.
*
* @param { TextOverflow } value
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textOverflow(value: TextOverflow): TextAreaAttribute;
/**
* Called when the baseline offset is set.
*
* @param { Dimension } value
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
baselineOffset(value: Dimension): TextAreaAttribute;
/**
* Specify the indentation of the first line in a text-block.
*
* @param { Dimension } value - The length of text indent.
* @returns { TextAreaAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textIndent(value: Dimension): TextAreaAttribute;
/**
* Called when the inputFilter of text is set.
*
@ -675,6 +759,28 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
*/
inputFilter(value: ResourceStr, error?: (value: string) => void): TextAreaAttribute;
/**
* Define the caret style of the text input
*
* @param { CaretStyle } value
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
caretStyle(value: CaretStyle): TextAreaAttribute;
/**
* Define the text selected background color of the text input.
*
* @param { ResourceColor } value
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
selectedBackgroundColor(value: ResourceColor): TextAreaAttribute;
/**
* Called when submitted.
*
@ -684,6 +790,16 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when submitted.
*
* @param { function } callback
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onSubmit(callback: (enterKey: EnterKeyType) => void): TextAreaAttribute;
/**
@ -862,7 +978,7 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* Executed when a paste operation is performed.
* { string } value - The text content to be pasted.
* { PasteEvent } event - The user-defined paste event.
* @returns { TextAreaAttribute } returns the instance of the TextInputAttribute.
* @returns { TextAreaAttribute } returns the instance of the TextAreaAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
@ -1157,6 +1273,16 @@ declare class TextAreaAttribute extends CommonMethod<TextAreaAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the input type is set.
*
* @param { TextAreaType } value
* @returns { TextAreaAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type(value: TextAreaType): TextAreaAttribute;
/**

25
api/@internal/component/ets/text_clock.d.ts vendored
View File

@ -453,6 +453,17 @@ declare class TextClockAttribute extends CommonMethod<TextClockAttribute> {
* @since 11
* @form
*/
/**
* Called when the text shadow is set.
*
* @param { ShadowOptions | Array<ShadowOptions> } value - The shadow options.
* @returns { TextClockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
textShadow(value: ShadowOptions | Array<ShadowOptions>): TextClockAttribute;
/**
@ -468,6 +479,20 @@ declare class TextClockAttribute extends CommonMethod<TextClockAttribute> {
* @since 11
* @form
*/
/**
* Called when the text fontFeature is set.
*
* @param { string } value - The fontFeature.
* normal | <feature-tag-value>,
* where <feature-tag-value> = <string> [ <integer> | on | off ], like: "ss01" 0
* number of <feature-tag-value> can be single or multiple, and separated by comma ','.
* @returns { TextClockAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
fontFeature(value: string): TextClockAttribute;
}

60
api/@internal/component/ets/text_common.d.ts vendored
View File

@ -25,12 +25,27 @@
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Defines the text data detector type.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare enum TextDataDetectorType {
/**
* Detector type phone number.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Detector type phone number.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
PHONE_NUMBER = 0,
@ -40,6 +55,13 @@ declare enum TextDataDetectorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Detector type URL.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
URL = 1,
/**
@ -48,6 +70,13 @@ declare enum TextDataDetectorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Detector type email.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
EMAIL = 2,
/**
@ -56,6 +85,13 @@ declare enum TextDataDetectorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Detector type address.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ADDRESS = 3,
}
@ -66,6 +102,14 @@ declare enum TextDataDetectorType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Text data detector config.
*
* @interface TextDataDetectorConfig
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare interface TextDataDetectorConfig {
/**
* Text data detector types.
@ -74,6 +118,14 @@ declare interface TextDataDetectorConfig {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Text data detector types.
*
* @type { TextDataDetectorType[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
types: TextDataDetectorType[]
/**
@ -83,5 +135,13 @@ declare interface TextDataDetectorConfig {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Text data detect result callback.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
onDetectResultUpdate?: (result: string) => void
}

109
api/@internal/component/ets/text_input.d.ts vendored
View File

@ -165,6 +165,14 @@ declare enum InputType {
* @crossplatform
* @since 11
*/
/**
* Number Password entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
NUMBER_PASSWORD = 8,
/**
@ -182,6 +190,13 @@ declare enum InputType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* UserName entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
USER_NAME = 10,
/**
@ -190,6 +205,13 @@ declare enum InputType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* NewPassword entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
NEW_PASSWORD = 11,
/**
@ -350,6 +372,14 @@ declare enum EnterKeyType {
* @crossplatform
* @since 11
*/
/**
* Showed as 'previous' pattern.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PREVIOUS = 7,
/**
@ -359,6 +389,14 @@ declare enum EnterKeyType {
* @crossplatform
* @since 11
*/
/**
* Showed as 'new line' pattern.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NEW_LINE = 8,
}
@ -970,6 +1008,39 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
*/
placeholderColor(value: ResourceColor): TextInputAttribute;
/**
* Called when the overflow mode of the font is set.
*
* @param { TextOverflow } value
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textOverflow(value: TextOverflow): TextInputAttribute;
/**
* Called when the baseline offset is set.
*
* @param { Dimension } value
* @returns { TextInputAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
baselineOffset(value: Dimension): TextInputAttribute;
/**
* Specify the indentation of the first line in a text-block.
*
* @param { Dimension } value - The length of text indent.
* @returns { TextInputAttribute } The attribute of the text.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
textIndent(value: Dimension): TextInputAttribute;
/**
* Called when the font property of the placeholder is set.
*
@ -1909,6 +1980,16 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @crossplatform
* @since 11
*/
/**
* Set the cancel button style
*
* @param { object } value - indicates the style of the cancel button.
* @returns { TextInputAttribute } returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cancelButton(value: { style?: CancelButtonStyle, icon?: IconOptions }): TextInputAttribute;
/**
@ -1920,6 +2001,16 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @crossplatform
* @since 11
*/
/**
* Sets selection when on focus.
*
* @param { boolean } value - Sets selection or not.
* @returns { TextInputAttribute } returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectAll(value: boolean): TextInputAttribute;
/**
@ -1963,6 +2054,15 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Sets whether enable auto fill or not.
*
* @param { boolean } value - Indicates the flag whether autofill is enabled.
* @returns { TextInputAttribute } Returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
enableAutoFill(value: boolean): TextInputAttribute;
/**
@ -2006,6 +2106,15 @@ declare class TextInputAttribute extends CommonMethod<TextInputAttribute> {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Define the password rules of the text input.
*
* @param { string } value - Indicates the password rules.
* @returns { TextInputAttribute } Returns the instance of the TextInputAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
passwordRules(value: string): TextInputAttribute;
/**

31
api/@internal/component/ets/text_picker.d.ts vendored
View File

@ -565,6 +565,17 @@ declare class TextPickerAttribute extends CommonMethod<TextPickerAttribute> {
* @since 12
*/
divider(value: DividerOptions | null): TextPickerAttribute;
/**
* Called when set the height of gradient
*
* @param { Dimension } value - The value the gradient height
* @returns { TextPickerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
gradientHeight(value: Dimension): TextPickerAttribute;
}
/**
@ -917,6 +928,16 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the textPickerDialog's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -928,6 +949,16 @@ declare interface TextPickerDialogOptions extends TextPickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the textPickerDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

10
api/@internal/component/ets/text_timer.d.ts vendored
View File

@ -574,6 +574,16 @@ declare class TextTimerAttribute extends CommonMethod<TextTimerAttribute> {
* @crossplatform
* @since 11
*/
/**
* Called when the text shadow is set.
*
* @param { ShadowOptions | Array<ShadowOptions> } value - The shadow options.
* @returns { TextTimerAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textShadow(value: ShadowOptions | Array<ShadowOptions>): TextTimerAttribute;
}

61
api/@internal/component/ets/time_picker.d.ts vendored
View File

@ -114,6 +114,14 @@ declare interface TimePickerResult {
* @crossplatform
* @since 11
*/
/**
* Type of the TimePicker that need to be displayed.
* @enum {number}
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum TimePickerFormat {
/**
* Hour and minute.
@ -121,6 +129,13 @@ declare enum TimePickerFormat {
* @crossplatform
* @since 11
*/
/**
* Hour and minute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
HOUR_MINUTE,
/**
@ -129,6 +144,13 @@ declare enum TimePickerFormat {
* @crossplatform
* @since 11
*/
/**
* Hour and minute and second
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
HOUR_MINUTE_SECOND,
}
@ -192,6 +214,16 @@ declare interface TimePickerOptions {
* @crossplatform
* @since 11
*/
/**
* Specifies the format of the TimePicker that need to be displayed.
*
* @type { ?TimePickerFormat }
* @default HOUR_MINUTE
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
format?: TimePickerFormat;
}
@ -312,6 +344,15 @@ declare class TimePickerAttribute extends CommonMethod<TimePickerAttribute> {
* @crossplatform
* @since 11
*/
/**
* Sets whether to enable the wheel mode.
* @param { boolean } value - indicates whether to enable the wheel mode.
* @returns { TimePickerAttribute } the attribute of the time picker
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
loop(value: boolean): TimePickerAttribute;
/**
@ -659,6 +700,16 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the timePickerDialog's background color
*
* @type { ?ResourceColor }
* @default Color.Transparent
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -670,6 +721,16 @@ declare interface TimePickerDialogOptions extends TimePickerOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the timePickerDialog's background blur Style
*
* @type { ?BlurStyle }
* @default BlurStyle.COMPONENT_ULTRA_THICK
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
/**

96
api/@internal/component/ets/units.d.ts vendored
View File

@ -1875,6 +1875,17 @@ declare interface Bias {
* @since 11
* @form
*/
/**
* Horizontal ratio of the Bias, it must be >= 0.
*
* @type { ?number }
* @default 0.5
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
horizontal?: number;
/**
@ -1887,6 +1898,17 @@ declare interface Bias {
* @since 11
* @form
*/
/**
* Vertical ratio of the Bias, it must be >= 0.
*
* @type { ?number }
* @default 0.5
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
vertical?: number;
}
@ -2367,6 +2389,16 @@ declare interface BorderOptions {
* @since 11
* @form
*/
/**
* Defines the options of border.
*
* @interface OutlineOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
declare interface OutlineOptions {
/**
* Defines the outline width.
@ -2377,6 +2409,16 @@ declare interface OutlineOptions {
* @since 11
* @form
*/
/**
* Defines the outline width.
*
* @type { ?(EdgeOutlineWidths | Dimension) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
width?: EdgeOutlineWidths | Dimension;
/**
@ -2388,6 +2430,16 @@ declare interface OutlineOptions {
* @since 11
* @form
*/
/**
* Defines the outline color.
*
* @type { ?(EdgeColors | ResourceColor) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
color?: EdgeColors | ResourceColor;
/**
@ -2399,6 +2451,16 @@ declare interface OutlineOptions {
* @since 11
* @form
*/
/**
* Defines the outline radius.
*
* @type { ?(OutlineRadiuses | Dimension) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
radius?: OutlineRadiuses | Dimension;
/**
@ -2410,6 +2472,16 @@ declare interface OutlineOptions {
* @since 11
* @form
*/
/**
* Defines the outline style.
*
* @type { ?(EdgeOutlineStyles | OutlineStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
style?: EdgeOutlineStyles | OutlineStyle;
}
@ -2551,6 +2623,14 @@ declare class ColorFilter {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Defines TouchPoint
*
* @interface TouchPoint
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
declare interface TouchPoint {
/**
* Define the touch point x coordinate.
@ -2559,6 +2639,14 @@ declare interface TouchPoint {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Define the touch point x coordinate.
*
* @type { Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
x: Dimension;
/**
@ -2568,6 +2656,14 @@ declare interface TouchPoint {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Define the touch point y coordinate.
*
* @type { Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
y: Dimension;
}

9
api/@internal/component/ets/water_flow.d.ts vendored
View File

@ -583,6 +583,15 @@ declare class WaterFlowAttribute extends ScrollableCommonMethod<WaterFlowAttribu
* @crossplatform
* @since 11
*/
/**
* Called to set number of flow items to be preloaded (cached) in LazyForEach.
* @param { number } value - number of flow items to be preloaded (cached).
* @returns { WaterFlowAttribute } the attribute of the water flow.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
cachedCount(value: number): WaterFlowAttribute;
/**

28
api/@internal/component/ets/xcomponent.d.ts vendored
View File

@ -134,6 +134,34 @@ declare class XComponentController {
* @since 12
*/
getXComponentSurfaceRect(): SurfaceRect;
/**
* Called after the surface is first created.
*
* @param { string } surfaceId - The id of the surface created by XComponent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
onSurfaceCreated(surfaceId: string): void;
/**
* Called after the surface rectangle information is changed.
*
* @param { string } surfaceId - The id of the surface created by XComponent.
* @param { SurfaceRect } rect - The rectangle information of the surface created by XComponent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
onSurfaceChanged(surfaceId: string, rect: SurfaceRect): void;
/**
* Called when the surface is about to be destroyed.
*
* @param { string } surfaceId - The id of the surface created by XComponent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
onSurfaceDestroyed(surfaceId: string): void;
}
/**

5
api/@internal/ets/lifecycle.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import Want from '../../@ohos.app.ability.Want';
import { ResultSet } from '../../data/rdb/resultSet';
import { AbilityInfo } from '../../bundle/abilityInfo';

138
api/@ohos.PiPWindow.d.ts vendored
View File

@ -110,6 +110,15 @@ declare namespace PiPWindow {
* @since 11
*/
contentHeight?: number;
/**
* Describes the custom controls to be displayed in PiP window control panel. If the parameter is empty, only mandatory controls are displayed.
*
* @type { ?Array<PiPControlGroup> }
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
controlGroups?: Array<PiPControlGroup>;
}
/**
@ -206,6 +215,106 @@ declare namespace PiPWindow {
ERROR = 6,
}
/**
* Describe PiP window custom controls.
*
* @typedef { VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup }
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
type PiPControlGroup = VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup;
/**
* Enum for video play PiP window custom controls.
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
enum VideoPlayControlGroup {
/**
* Previous/Next for video.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
VIDEO_PREVIOUS_NEXT = 101,
/**
* Forward/Backward for video.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
FAST_FORWARD_BACKWARD = 102,
}
/**
* Enum for video call PiP window custom controls.
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
enum VideoCallControlGroup {
/**
* Turn on/off the microphone.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
MICROPHONE_SWITCH = 201,
/**
* Hang up.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
HANG_UP_BUTTON = 202,
/**
* Turn on/off the camera
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
CAMERA_SWITCH = 203,
}
/**
* Enum for video meeting PiP window custom controls.
*
* @enum { number }.
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
enum VideoMeetingControlGroup {
/**
* Hang up.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
HANG_UP_BUTTON = 301,
/**
* Turn on/off the camera
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
CAMERA_SWITCH = 302,
/**
* Mute switch.
*
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
MUTE_SWITCH = 303,
}
/**
* Describe picture-in-picture action event type.
*
@ -217,10 +326,18 @@ declare namespace PiPWindow {
/**
* Describe picture-in-picture video template action event type.
*
* @typedef { 'playbackStateChanged' | 'nextVideo' | 'previousVideo' }
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
type PiPVideoActionEvent = 'playbackStateChanged' | 'nextVideo' | 'previousVideo';
/**
* Describe picture-in-picture video template action event type.
*
* @typedef { 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward' }
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
type PiPVideoActionEvent = 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward';
/**
* Describe picture-in-picture call template action event type.
@ -246,6 +363,15 @@ declare namespace PiPWindow {
*/
type PiPLiveActionEvent = 'playbackStateChanged';
/**
* Describe picture-in-picture control panel action event callback.
*
* @typedef {function} ControlPanelActionEventCallback
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
type ControlPanelActionEventCallback = (event: PiPActionEventType, status?: number) => void;
/**
* PiPController
*
@ -320,7 +446,15 @@ declare namespace PiPWindow {
* @syscap SystemCapability.Window.SessionManager
* @since 11
*/
on(type: 'controlPanelActionEvent', callback: (event: PiPActionEventType) => void): void;
/**
* Register picture-in-picture control event listener.
*
* @param { 'controlPanelActionEvent' } type - Registration type, user action event, 'controlPanelActionEvent'
* @param { ControlPanelActionEventCallback } callback - Used to handle {'controlPanelActionEvent'} command.
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
on(type: 'controlPanelActionEvent', callback: ControlPanelActionEventCallback): void;
/**
* Unregister picture-in-picture lifecycle event listener

1
api/@ohos.animator.d.ts vendored
View File

@ -452,6 +452,7 @@ export interface AnimatorResult {
*/
/**
* Plays the animation in reverse direction.
* Invalid when using interpolating-spring curve.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

14
api/@ohos.app.ability.wantConstant.d.ts vendored
View File

@ -277,19 +277,9 @@ declare namespace wantConstant {
FLAG_AUTH_WRITE_URI_PERMISSION = 0x00000002,
/**
* Indicates the grant for possible persisting on the URI.
* The flag only valid in PC scenarios.
* When sharing user file URI,
* if the application has PERMISSION_PROXY_AUTHORIZATION_URI permission or persistable permission to the URI,
* it can share persistable URI permission by using this flag.
* To grant persistable read permissions to URI,
* you can set flag = FLAG_AUTH_READ_URI_PERMISSION | FLAG_AUTH_PERSISTABLE_URI_PERMISSION.
* To grant persistable write permissions to URI,
* you can set flag = FLAG_AUTH_WRITE_URI_PERMISSION | FLAG_AUTH_PERSISTABLE_URI_PERMISSION.
*
* Indicates that the URI can be persisted by the callee.
* @syscap SystemCapability.Ability.AbilityBase
* @systemapi
* @since 10
* @since 12
*/
FLAG_AUTH_PERSISTABLE_URI_PERMISSION = 0x00000040,

52
api/@ohos.app.appstartup.StartupConfig.d.ts vendored Normal file
View File

@ -0,0 +1,52 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import StartupListener from './@ohos.app.appstartup.StartupListener';
/**
* @file
* @kit AbilityKit
*/
/**
* The interface of configuration for running startup tasks.
*
* @interface StartupConfig
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
export default interface StartupConfig {
/**
* Indicates timeout for executing all startup tasks. Default value is 10000 milliseconds.
*
* @type { ?number }
* @default 10000
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
timeoutMs?: number;
/**
* Indicates a listener for startup, which will be called when all tasks complete.
*
* @type { ?StartupListener }
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
startupListener?: StartupListener;
}

40
api/@ohos.app.appstartup.StartupConfigEntry.d.ts vendored Normal file
View File

@ -0,0 +1,40 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import StartupConfig from './@ohos.app.appstartup.StartupConfig';
/**
* @file
* @kit AbilityKit
*/
/**
* The configuration entry for running startup tasks.
*
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
export default class StartupConfigEntry {
/**
* Called when startup initialization to configure startup mode.
*
* @returns { StartupConfig } The developer returns a startup configuration.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
onConfig?(): StartupConfig;
}

40
api/@ohos.app.appstartup.StartupListener.d.ts vendored Normal file
View File

@ -0,0 +1,40 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import { BusinessError } from './@ohos.base';
/**
* The listener for running startup tasks, which will be called when all tasks complete.
*
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
export default class StartupListener {
/**
* Called when all startup tasks complete.
*
* @param { BusinessError<void> } error - Indicates the error during execution.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
onCompleted?(error: BusinessError<void>): void;
}

53
api/@ohos.app.appstartup.StartupTask.d.ts vendored Normal file
View File

@ -0,0 +1,53 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import AbilityStageContext from './application/AbilityStageContext';
/**
* @file
* @kit AbilityKit
*/
/**
* The base class of startup task.
*
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
export default class StartupTask {
/**
* Called when specific dependent task complete.
*
* @param { string } dependency - Indicates name of specific dependent startup task.
* @param { ESObject } result - Indicates result of specific dependent startup task.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
onDependencyCompleted?(dependency: string, result: ESObject): void;
/**
* Initializes current startup task.
* A developer could override this function to init current task and return a result for other tasks.
*
* @param { AbilityStageContext } context - Indicates ability stage context.
* @returns { Promise<ESObject> } The result of initialization.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
init(context: AbilityStageContext): Promise<ESObject>;
}

96
api/@ohos.app.appstartup.startupManager.d.ts vendored Normal file
View File

@ -0,0 +1,96 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import StartupConfig from './@ohos.app.appstartup.StartupConfig';
/**
* @file
* @kit AbilityKit
*/
/**
* Startup task manager.
*
* @namespace startupManager
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
declare namespace startupManager {
/**
* Runs startup tasks.
*
* @param { Array<string> } startupTasks - Indicates all tasks ready to run.
* @param { StartupConfig } [config] - Indicates the configuration of startup tasks.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 28800001 - Startup task or its dependency not found.
* @throws { BusinessError } 28800002 - The startup tasks have circular dependencies.
* @throws { BusinessError } 28800003 - An error occurred while running the startup tasks.
* @throws { BusinessError } 28800004 - Running startup tasks timeout.
*
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
function run(startupTasks: Array<string>, config?: StartupConfig): Promise<void>;
/**
* Removes all startup tasks result.
*
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
function removeAllStartupTaskResults(): void;
/**
* Obtains specific startup task result.
*
* @param { string } startupTask - Indicates name of specific startup task.
* @returns { Object } The result of specific startup task.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
function getStartupTaskResult(startupTask: string): Object;
/**
* Obtains whether specific startup task has already been initialized.
*
* @param { string } startupTask - Indicates name of specific startup task.
* @returns { boolean } Whether specific startup task has already been initialized.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
function isStartupTaskInitialized(startupTask: string): boolean;
/**
* Removes specific startup task result.
*
* @param { string } startupTask - Indicates name of specific startup task.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AppStartup
* @stagemodelonly
* @since 12
*/
function removeStartupTaskResult(startupTask: string): void;
}
export default startupManager;

34
api/@ohos.application.uriPermissionManager.d.ts vendored
View File

@ -34,7 +34,8 @@ declare namespace uriPermissionManager {
*
* @permission ohos.permission.PROXY_AUTHORIZATION_URI
* @param { string } uri - File URI.
* @param { wantConstant.Flags } flag - wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION or
* @param { wantConstant.Flags } flag - wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
* wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION or
* wantConstant.Flags.FLAG_AUTH_PERSISTABLE_URI_PERMISSION.
* @param { string } targetBundleName - Indicates the bundle name of authorization target.
* @param { AsyncCallback<number> } callback - the callback of grantUriPermission.
@ -61,7 +62,8 @@ declare namespace uriPermissionManager {
*
* @permission ohos.permission.PROXY_AUTHORIZATION_URI
* @param { string } uri - File URI.
* @param { wantConstant.Flags } flag - wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION or wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION or
* @param { wantConstant.Flags } flag - wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
* wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION or
* wantConstant.Flags.FLAG_AUTH_PERSISTABLE_URI_PERMISSION.
* @param { string } targetBundleName - Indicates the bundle name of authorization target.
* @returns { Promise<number> } - the promise returned by the function.
@ -94,6 +96,20 @@ declare namespace uriPermissionManager {
* @systemapi hide this for inner system use
* @since 10
*/
/**
* Revoke URI from one application
*
* @param { string } uri - File URI.
* @param { string } targetBundleName - Indicates the bundle name of authorization target.
* @param { AsyncCallback<number> } callback - the callback of revokeUriPermission.
* @throws { BusinessError } 202 - Not System App. Interface caller is not a system app.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000059 - Invalid URI type.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide this for inner system use
* @since 12
*/
function revokeUriPermission(uri: string, targetBundleName: string, callback: AsyncCallback<number>): void;
/**
@ -111,6 +127,20 @@ declare namespace uriPermissionManager {
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide this for inner system use
* @since 10
*/
/**
* Revoke URI from one application
*
* @param { string } uri - File URI.
* @param { string } targetBundleName - Indicates the bundle name of authorization target.
* @returns { Promise<number> } - the promise returned by the function.
* @throws { BusinessError } 202 - Not System App. Interface caller is not a system app.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 16000050 - Internal error.
* @throws { BusinessError } 16000059 - Invalid URI type.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide this for inner system use
* @since 12
*/
function revokeUriPermission(uri: string, targetBundleName: string): Promise<number>;
}

301
api/@ohos.arkui.UIContext.d.ts vendored
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Copyright (c) 2023-2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@ -33,6 +33,7 @@ import type observer from './@ohos.arkui.observer';
import promptAction from './@ohos.promptAction';
import router from './@ohos.router';
import type componentUtils from './@ohos.arkui.componentUtils';
import { ComponentContent } from './@ohos.arkui.node'
import type { AnimatorOptions, AnimatorResult } from './@ohos.animator';
import type { Callback, AsyncCallback } from './@ohos.base';
import type { Color, FontStyle, Nullable } from 'CommonEnums';
@ -44,6 +45,8 @@ import { TimePickerDialogOptions } from 'TimePickerDialogParam';
import { TextPickerDialogOptions } from 'textPickerDialogParam';
import type { CustomBuilder, DragItemInfo, DragEvent } from 'DragControllerParam';
import type dragController from './@ohos.arkui.dragController';
import { LocalStorage } from 'StateManagement';
import type common from './@ohos.app.ability.common';
/**
* class Font
@ -967,6 +970,14 @@ export class PromptAction {
* @crossplatform
* @since 11
*/
/**
* Register callbacks to observe ArkUI behavior.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class UIObserver {
/**
* Registers a callback function to be called when the navigation destination is updated.
@ -978,6 +989,17 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the navigation destination is updated.
*
* @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'.
* @param { object } options - The options object.
* @param { Callback<observer.NavDestinationInfo> } callback - The callback function to be called when the navigation destination is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
on(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback: Callback<observer.NavDestinationInfo>): void;
/**
@ -991,6 +1013,18 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'navDestinationUpdate' } type - The type of event to remove the listener for. Must be 'navDestinationUpdate'.
* @param { object } options - The options object.
* @param { Callback<observer.NavDestinationInfo> } callback - The callback function to remove. If not provided, all callbacks for the given event type and
* navigation ID will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
off(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback?: Callback<observer.NavDestinationInfo>): void;
/**
@ -1002,6 +1036,16 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the navigation destination is updated.
*
* @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'.
* @param { Callback<observer.NavDestinationInfo> } callback - The callback function to be called when the navigation destination is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
on(type: 'navDestinationUpdate', callback: Callback<observer.NavDestinationInfo>): void;
/**
@ -1014,6 +1058,17 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'navDestinationUpdate'} type - The type of event to remove the listener for. Must be 'navDestinationUpdate'.
* @param { Callback<observer.NavDestinationInfo> } [callback] - The callback function to remove. If not provided, all callbacks for the given event type
* will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
off(type: 'navDestinationUpdate', callback?: Callback<observer.NavDestinationInfo>): void;
/**
@ -1073,6 +1128,16 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the router page in a ui context is updated.
*
* @param { 'routerPageUpdate' } type - The type of event to listen for. Must be 'routerPageUpdate'.
* @param { Callback<observer.RouterPageInfo> } callback - The callback function to be called when the router page is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
on(type: 'routerPageUpdate', callback: Callback<observer.RouterPageInfo>): void;
/**
@ -1085,6 +1150,17 @@ export class UIObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'routerPageUpdate' } type - The type of event to remove the listener for. Must be 'routerPageUpdate'.
* @param { Callback<observer.RouterPageInfo> } [callback] - The callback function to remove. If not provided, all callbacks for the given event type
* will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
off(type: 'routerPageUpdate', callback?: Callback<observer.RouterPageInfo>): void;
/**
@ -1253,6 +1329,73 @@ export class ComponentUtils {
getRectangleById(id: string): componentUtils.ComponentInfo;
}
/**
* class OverlayManager
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
export class OverlayManager {
/**
* Add the ComponentContent to the OverlayManager.
*
* @param { ComponentContent } content - The content will be added to the OverlayManager.
* @param { number } [ index ] - The index at which to add the ComponentContent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
addComponentContent(content: ComponentContent, index?: number): void;
/**
* Remove the ComponentContent from the OverlayManager.
*
* @param { ComponentContent } content - The content will be removed from the OverlayManager.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
removeComponentContent(content: ComponentContent): void;
/**
* Show the ComponentContent.
*
* @param { ComponentContent } content - The content will be shown.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
showComponentContent(content: ComponentContent): void;
/**
* Hide the ComponentContent.
*
* @param { ComponentContent } content - The content will be hidden.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
hideComponentContent(content: ComponentContent): void;
/**
* Show all ComponentContents on the OverlayManager.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
showAllComponentContents(): void;
/**
* Hide all ComponentContents on the OverlayManager.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
hideAllComponentContents(): void;
}
/**
* interface AtomicServiceBar
* @interface AtomicServiceBar
@ -1260,6 +1403,14 @@ export class ComponentUtils {
* @crossplatform
* @since 11
*/
/**
* interface AtomicServiceBar
* @interface AtomicServiceBar
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface AtomicServiceBar {
/**
* Set the visibility of the bar, except the icon.
@ -1278,6 +1429,14 @@ export interface AtomicServiceBar {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* 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
* @atomicservice
* @since 12
*/
setBackgroundColor(color: Nullable< Color | number | string>): void;
/**
@ -1287,6 +1446,14 @@ export interface AtomicServiceBar {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Set the title of the bar.
*
* @param { string } content - the content of the bar.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
setTitleContent(content: string): void;
/**
@ -1296,6 +1463,14 @@ export interface AtomicServiceBar {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* 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
* @atomicservice
* @since 12
*/
setTitleFontStyle(font: FontStyle): void;
/**
@ -1305,6 +1480,14 @@ export interface AtomicServiceBar {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* 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
* @atomicservice
* @since 12
*/
setIconColor(color: Nullable< Color | number | string>): void;
}
@ -1313,6 +1496,12 @@ export interface AtomicServiceBar {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* class DragController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export class DragController {
/**
* Execute a drag event.
@ -1325,6 +1514,18 @@ export class DragController {
* @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.
* @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 - if the parameters checking failed.
* @throws { BusinessError } 100001 - if some internal handling failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo, callback: AsyncCallback<{
event: DragEvent, extraParams: string
}>): void;
@ -1339,6 +1540,17 @@ export class DragController {
* @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.
* @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 - if the parameters checking failed.
* @throws { BusinessError } 100001 - if some internal handling failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo): Promise<{
event: DragEvent, extraParams: string
}>;
@ -1353,6 +1565,17 @@ export class DragController {
* @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<CustomBuilder | DragItemInfo> } 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 - if the parameters checking failed.
* @throws { BusinessError } 100001 - if some internal handling failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
createDragAction(customArray: Array<CustomBuilder | DragItemInfo>, dragInfo: dragController.DragInfo): dragController.DragAction;
/**
@ -1361,6 +1584,13 @@ export class DragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Get a drag preview object.
* @returns { dragController.DragPreview } A drag preview object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getDragPreview(): dragController.DragPreview;
/**
@ -1404,6 +1634,17 @@ export class FocusController {
requestFocus(key: string): void;
}
/**
* The base context of an ability or an application. It allows access to
* application-specific resources.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @crossplatform
* @since 12
*/
export type Context = common.Context;
/**
* class UIContext
*
@ -1538,8 +1779,27 @@ export class UIContext {
* @crossplatform
* @since 11
*/
/**
* Get the UI observer.
*
* @returns { UIObserver } The UI observer.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getUIObserver(): UIObserver;
/**
* Get object OverlayManager.
*
* @returns { OverlayManager } object OverlayManager.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
getOverlayManager(): OverlayManager;
/**
* Create an animator object for custom animation.
*
@ -1735,6 +1995,13 @@ export class UIContext {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Get DragController.
* @returns { DragController } the DragController
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
getDragController(): DragController;
/**
@ -1746,6 +2013,16 @@ export class UIContext {
* @crossplatform
* @since 11
*/
/**
* Defining keyframe animation function.
*
* @param { KeyframeAnimateParam } param - overall animation parameters
* @param { Array<KeyframeState> } keyframes - all keyframe states
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
keyframeAnimateTo(param: KeyframeAnimateParam, keyframes: Array<KeyframeState>): void;
/**
@ -1766,6 +2043,28 @@ export class UIContext {
* @since 12
*/
getFocusController(): FocusController;
/**
* Get current LocalStorage shared from stage.
*
* @returns { LocalStorage | undefined }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @since 12
*/
getSharedLocalStorage(): LocalStorage | undefined;
/**
* Obtains context of the ability.
*
* @returns { Context | undefined }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform
* @since 12
*/
getHostContext(): Context | undefined;
}
/**

271
api/@ohos.arkui.advanced.Chip.d.ets
View File

@ -30,7 +30,15 @@ import { ResourceStr } from 'GlobalResource';
* @crossplatform
* @since 11
*/
/**
* Enum for ChipSize
*
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare enum ChipSize {
@ -41,6 +49,14 @@ export declare enum ChipSize {
* @crossplatform
* @since 11
*/
/**
* Normal type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NORMAL = "NORMAL",
/**
@ -50,6 +66,14 @@ export declare enum ChipSize {
* @crossplatform
* @since 11
*/
/**
* Small type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SMALL = "SMALL"
}
@ -61,6 +85,15 @@ export declare enum ChipSize {
* @crossplatform
* @since 11
*/
/**
* Defines the icon common option.
*
* @interface IconCommonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface IconCommonOptions {
/**
@ -71,6 +104,15 @@ export interface IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Image resource.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
src: ResourceStr;
/**
@ -81,6 +123,15 @@ export interface IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Image size option.
*
* @type { ?SizeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: SizeOptions;
/**
@ -91,6 +142,15 @@ export interface IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Image filled color.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fillColor?: ResourceColor;
/**
@ -113,6 +173,16 @@ export interface IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the suffix icon option.
*
* @interface SuffixIconOptions
* @extends IconCommonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface SuffixIconOptions extends IconCommonOptions {
/**
@ -123,6 +193,15 @@ export interface SuffixIconOptions extends IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Called when the suffix icon is clicked.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
action?: () => void;
}
@ -135,6 +214,16 @@ export interface SuffixIconOptions extends IconCommonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the prefix icon option.
*
* @interface PrefixIconOptions
* @extends IconCommonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PrefixIconOptions extends IconCommonOptions {}
/**
@ -145,6 +234,15 @@ export interface PrefixIconOptions extends IconCommonOptions {}
* @crossplatform
* @since 11
*/
/**
* Defines label margin.
*
* @interface LabelMarginOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface LabelMarginOptions {
/**
@ -155,6 +253,15 @@ export interface LabelMarginOptions {
* @crossplatform
* @since 11
*/
/**
* Left label margin length.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
left?: Dimension;
/**
@ -165,6 +272,15 @@ export interface LabelMarginOptions {
* @crossplatform
* @since 11
*/
/**
* Right label margin length.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
right?: Dimension;
}
@ -176,6 +292,15 @@ export interface LabelMarginOptions {
* @crossplatform
* @since 11
*/
/**
* Defines label option.
*
* @interface LabelOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface LabelOptions {
/**
@ -186,6 +311,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Text content.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: string;
/**
@ -196,6 +330,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Text font size.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize?: Dimension;
/**
@ -206,6 +349,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Text font color.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
/**
@ -226,6 +378,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Text font family.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontFamily?: string;
/**
@ -236,6 +397,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Label margin.
*
* @type { ?LabelMarginOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
labelMargin?: LabelMarginOptions;
}
@ -247,6 +417,15 @@ export interface LabelOptions {
* @crossplatform
* @since 11
*/
/**
* Defines chip options.
*
* @interface ChipOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ChipOptions {
/**
* Chip prefix icon.
@ -256,6 +435,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip prefix icon.
*
* @type { ?PrefixIconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
prefixIcon?: PrefixIconOptions;
/**
@ -266,6 +454,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip label.
*
* @type { LabelOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
label: LabelOptions;
/**
@ -276,6 +473,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip suffix icon.
*
* @type { ?SuffixIconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
suffixIcon?: SuffixIconOptions;
/**
@ -286,6 +492,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Show close icon.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
allowClose?: boolean;
/**
@ -296,6 +511,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Enable chip.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
enabled?: boolean;
/**
@ -316,6 +540,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip background color.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -336,6 +569,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip radius.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderRadius?: Dimension;
/**
@ -346,6 +588,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Chip size.
*
* @type { ?ChipSize | SizeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
size?: ChipSize | SizeOptions;
/**
@ -356,6 +607,15 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* On close action.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onClose?: () => void;
/**
@ -377,5 +637,14 @@ export interface ChipOptions {
* @crossplatform
* @since 11
*/
/**
* Build function of Chip.
*
* @param { ChipOptions } options - chip option.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Builder
export declare function Chip(options: ChipOptions): void;

355
api/@ohos.arkui.advanced.Counter.d.ets
View File

@ -26,6 +26,15 @@
* @crossplatform
* @since 11
*/
/**
* Enum for the counter type.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum CounterType {
/**
* List counter.
@ -33,6 +42,13 @@ declare enum CounterType {
* @crossplatform
* @since 11
*/
/**
* List counter.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LIST = 0,
/**
@ -41,6 +57,13 @@ declare enum CounterType {
* @crossplatform
* @since 11
*/
/**
* Compact counter.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
COMPACT = 1,
/**
@ -49,6 +72,13 @@ declare enum CounterType {
* @crossplatform
* @since 11
*/
/**
* Inline counter.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
INLINE = 2,
/**
@ -57,6 +87,13 @@ declare enum CounterType {
* @crossplatform
* @since 11
*/
/**
* Date inline counter.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
INLINE_DATE = 3
}
@ -67,6 +104,14 @@ declare enum CounterType {
* @crossplatform
* @since 11
*/
/**
* Defines the common options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class CommonOptions {
/**
* Set the focusable of the counter component.
@ -76,6 +121,15 @@ declare class CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the focusable of the counter component.
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
focusable?: boolean;
/**
@ -87,6 +141,16 @@ declare class CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the step of the couter component, ranges greater than or equal to 1
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
step?: number;
/**
@ -97,6 +161,15 @@ declare class CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a mouse hover event at the increased button.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onHoverIncrease?: (isHover: boolean) => void;
/**
@ -107,6 +180,15 @@ declare class CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a mouse hover event at the decreased button.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onHoverDecrease?: (isHover: boolean) => void;
}
@ -117,6 +199,14 @@ declare class CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the inline style options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class InlineStyleOptions extends CommonOptions {
/**
* Set initial value of the counter component, ranges from min to max.
@ -127,6 +217,16 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set initial value of the counter component, ranges from min to max.
*
* @type { ?number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
value?: number;
/**
@ -138,6 +238,16 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set minimum value of the counter component
*
* @type { ?number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
min?: number;
/**
@ -149,6 +259,16 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set maximum value of the counter component
*
* @type { ?number }
* @default 999
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
max?: number;
/**
@ -160,6 +280,16 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set text width of the counter component, ranges greater than or equal to 0
*
* @type { ?number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textWidth?: number;
/**
@ -170,6 +300,15 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the value of the counter has been changed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onChange?: (value: number) => void;
}
@ -180,6 +319,14 @@ declare class InlineStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the number style options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class NumberStyleOptions extends InlineStyleOptions {
/**
* Set the label of the counter component.
@ -189,6 +336,15 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Set the label of the counter component.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
label?: ResourceStr;
/**
@ -199,6 +355,15 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the increased button got focus.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFocusIncrease?: () => void;
/**
@ -209,6 +374,15 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the decreased button got focus.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFocusDecrease?: () => void;
/**
@ -219,6 +393,15 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the increased button lose focus.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onBlurIncrease?: () => void;
/**
@ -229,6 +412,15 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the decreased button lose focus.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onBlurDecrease?: () => void;
}
@ -239,6 +431,14 @@ declare class NumberStyleOptions extends InlineStyleOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the date data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class DateData {
/**
* The year of the DateData, ranges from 1 to 5000.
@ -248,6 +448,15 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* The year of the DateData, ranges from 1 to 5000.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
year: number;
/**
@ -258,6 +467,15 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* The month of the DateData.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
month: number;
/**
@ -268,6 +486,15 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* The day of the DateData.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
day: number;
/**
@ -280,6 +507,17 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* Constructor of the DateData.
*
* @param { number } year - set the year of the DateData.
* @param { number } month - set the month of the DateData.
* @param { number } day - set the day of the DateData.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(year: number, month: number, day: number);
/**
@ -290,6 +528,15 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* Convert the date data to string.
*
* @returns { string } date data in string form.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
}
@ -300,6 +547,14 @@ declare class DateData {
* @crossplatform
* @since 11
*/
/**
* Defines the date style options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class DateStyleOptions extends CommonOptions {
/**
* Set the year of the counter component, ranges from 1 to 5000.
@ -310,6 +565,16 @@ declare class DateStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the year of the counter component, ranges from 1 to 5000.
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
year?: number;
/**
@ -321,6 +586,16 @@ declare class DateStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the month of the counter component.
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
month?: number;
/**
@ -332,6 +607,16 @@ declare class DateStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the day of the counter component.
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
day?: number;
/**
@ -342,6 +627,15 @@ declare class DateStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Trigger a event when the date of the counter has been changed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onDateChange?: (date: DateData) => void;
}
@ -353,6 +647,14 @@ declare class DateStyleOptions extends CommonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the counter options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare class CounterOptions {
/**
* Set the type of the counter component.
@ -362,6 +664,15 @@ declare class CounterOptions {
* @crossplatform
* @since 11
*/
/**
* Set the type of the counter component.
*
* @type { CounterType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: CounterType;
/**
@ -372,6 +683,15 @@ declare class CounterOptions {
* @crossplatform
* @since 11
*/
/**
* Set the counter attribute of the LIST or COMPACT counter component.
*
* @type { ?NumberStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
numberOptions?: NumberStyleOptions;
/**
@ -382,6 +702,15 @@ declare class CounterOptions {
* @crossplatform
* @since 11
*/
/**
* Set the counter attribute of the INLINE counter component.
*
* @type { ?InlineStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
inlineOptions?: InlineStyleOptions;
/**
@ -392,6 +721,15 @@ declare class CounterOptions {
* @crossplatform
* @since 11
*/
/**
* Set the counter attribute of the INLINE_DATE counter component.
*
* @type { ?DateStyleOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dateOptions?: DateStyleOptions;
}
@ -402,6 +740,14 @@ declare class CounterOptions {
* @crossplatform
* @since 11
*/
/**
* Defines Counter Component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
declare struct CounterComponent {
/**
@ -412,6 +758,15 @@ declare struct CounterComponent {
* @crossplatform
* @since 11
*/
/**
* The options of a counter component.
*
* @type { CounterOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
options: CounterOptions;
}

117
api/@ohos.arkui.advanced.ExceptionPrompt.d.ets
View File

@ -25,6 +25,14 @@
* @crossplatform
* @since 11
*/
/**
* Control margin status of ExceptionPrompt.
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare enum MarginType {
/**
* Default margin of MarginType，Margin 1: references ohos_id_card_margin_start, margin 2: references ohos_id_card_margin_end.
@ -32,6 +40,13 @@ export declare enum MarginType {
* @crossplatform
* @since 11
*/
/**
* Default margin of MarginType，Margin 1: references ohos_id_card_margin_start, margin 2: references ohos_id_card_margin_end.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT_MARGIN = 0,
/**
@ -40,6 +55,13 @@ export declare enum MarginType {
* @crossplatform
* @since 11
*/
/**
* Margins can be adapted of MarginType，Margin 1: references ohos_id_max_padding_start, margin 2: references ohos_id_max_padding_end.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
FIT_MARGIN = 1,
}
@ -50,6 +72,14 @@ export declare enum MarginType {
* @crossplatform
* @since 11
*/
/**
* Configuration parameter of ExceptionPrompt.
* @interface PromptOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PromptOptions {
/**
* Icon of PromptOptions.
@ -58,6 +88,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Icon of PromptOptions.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: ResourceStr;
/**
@ -67,6 +105,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Tip text of PromptOptions.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
tip?: ResourceStr;
/**
@ -76,6 +122,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Margin Type of ExceptionPrompt.
* @type { MarginType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marginType: MarginType;
/**
@ -85,6 +139,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Right icon button text of PromptOptions.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
actionText?: ResourceStr;
/**
@ -94,6 +156,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Distance from the top of PromptOptions.
* @type { Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
marginTop: Dimension
/**
@ -103,6 +173,14 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Control concealment of PromptOptions.
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isShown?: boolean
}
@ -112,6 +190,13 @@ export interface PromptOptions {
* @crossplatform
* @since 11
*/
/**
* Declare struct ExceptionPrompt higher-order component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
export declare struct ExceptionPrompt {
@ -122,6 +207,14 @@ export declare struct ExceptionPrompt {
* @crossplatform
* @since 11
*/
/**
* Configuration information of ExceptionPrompt.
* @type { PromptOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop options: PromptOptions;
/**
@ -131,6 +224,14 @@ export declare struct ExceptionPrompt {
* @crossplatform
* @since 11
*/
/**
* Callback when clicking the text on the left.
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onTipClick?: () => void;
/**
@ -140,6 +241,14 @@ export declare struct ExceptionPrompt {
* @crossplatform
* @since 11
*/
/**
* Callback when click the icon button.
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onActionTextClick?: () => void;
/**
@ -149,5 +258,13 @@ export declare struct ExceptionPrompt {
* @crossplatform
* @since 11
*/
/**
* The build function is a member function that must return an ArkTS component type (Element) to represent the component to be rendered as a user interface.
* @type { function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
build(): void;
}

174
api/@ohos.arkui.advanced.GridObjectSortComponent.d.ets
View File

@ -25,6 +25,14 @@
* @crossplatform
* @since 11
*/
/**
* Controls the style types of GridObjectSortComponent.
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare enum GridObjectSortComponentType {
/**
* The GridObjectSortComponent image text type.
@ -32,6 +40,13 @@ export declare enum GridObjectSortComponentType {
* @crossplatform
* @since 11
*/
/**
* The GridObjectSortComponent image text type.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
IMAGE_TEXT = "image_text",
/**
@ -40,6 +55,13 @@ export declare enum GridObjectSortComponentType {
* @crossplatform
* @since 11
*/
/**
* The GridObjectSortComponent text type.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TEXT = "text"
}
@ -50,6 +72,14 @@ export declare enum GridObjectSortComponentType {
* @crossplatform
* @since 11
*/
/**
* Declaration of the GridObjectSortComponent item.
* @interface GridObjectSortComponentIteml
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface GridObjectSortComponentItem {
/**
* id of GridObjectSortComponent item.
@ -58,6 +88,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* id of GridObjectSortComponent item.
* @type { number | string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
id: number | string;
/**
@ -67,6 +105,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* GridObjectSortComponent item text.
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: ResourceStr;
/**
@ -76,6 +122,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* selected of GridObjectSortComponent item, true is show area, false is add area.
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selected: boolean;
/**
@ -85,6 +139,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* order of GridObjectSortComponentItem, Used for sorting dataList.
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
order: number;
/**
@ -94,6 +156,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* image resource path of the GridObjectSortComponent item.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
url?: ResourceStr;
}
@ -104,6 +174,14 @@ export interface GridObjectSortComponentItem {
* @crossplatform
* @since 11
*/
/**
* GridObjectSortComponentOptions of GridObjectSortComponent.
* @interface GridEditOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface GridObjectSortComponentOptions {
/**
* Configuration GridObjectSortComponent type.
@ -113,6 +191,15 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* Configuration GridObjectSortComponent type.
* @type { GridObjectSortComponentType }
* @default GridObjectSortComponentType.TEXT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type?: GridObjectSortComponentType;
/**
@ -122,6 +209,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* The size of the GridObjectSortComponent image.
* @type { ?number | ?Resource }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
imageSize?: number | Resource;
/**
@ -131,6 +226,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* The title displayed in the unedited state of the GridObjectSortComponent.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
normalTitle?: ResourceStr;
/**
@ -140,6 +243,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* The title displayed in the GridObjectSortComponent edit state.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
editTitle?: ResourceStr;
/**
@ -149,6 +260,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* Display Area Title, First subtitle of the GridObjectSortComponent.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showAreaTitle?: ResourceStr;
/**
@ -158,6 +277,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* Add Zone Title, second subtitle of the GridObjectSortComponent.
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
addAreaTitle?: ResourceStr;
}
@ -168,6 +295,14 @@ export interface GridObjectSortComponentOptions {
* @crossplatform
* @since 11
*/
/**
* Declare struct GridObjectSortComponent.
* @struct { GridObjectSortComponent }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
export declare struct GridObjectSortComponent {
/**
@ -177,6 +312,14 @@ export declare struct GridObjectSortComponent {
* @crossplatform
* @since 11
*/
/**
* Component types and parameters of the GridObjectSortComponent.
* @type { GridObjectSortComponentOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Prop
options: GridObjectSortComponentOptions;
@ -187,6 +330,14 @@ export declare struct GridObjectSortComponent {
* @crossplatform
* @since 11
*/
/**
* Data list of GridObjectSortComponent.
* @type { Array<GridObjectSortComponentItem> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
dataList: Array<GridObjectSortComponentItem>;
/**
@ -196,6 +347,14 @@ export declare struct GridObjectSortComponent {
* @crossplatform
* @since 11
*/
/**
* Callback when Obtain edited data.
* @type { (select: Array<GridObjectSortComponentItem>, unselect: Array<GridObjectSortComponentItem>) => void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onSave: (select: Array<GridObjectSortComponentItem>, unselect: Array<GridObjectSortComponentItem>) => void;
/**
@ -205,6 +364,14 @@ export declare struct GridObjectSortComponent {
* @crossplatform
* @since 11
*/
/**
* Cancel callback for saving data.
* @type { () => void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCancel: () => void;
/**
@ -213,5 +380,12 @@ export declare struct GridObjectSortComponent {
* @crossplatform
* @since 11
*/
/**
* Build function of GridObjectSortComponent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
build(): void;
}

195
api/@ohos.arkui.advanced.Popup.d.ets
View File

@ -24,6 +24,13 @@
* @crossplatform
* @since 11
*/
/**
* Defines the popup text options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PopupTextOptions {
@ -34,6 +41,14 @@ export interface PopupTextOptions {
* @crossplatform
* @since 11
*/
/**
* Set the text display content.
* @type { ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: ResourceStr;
/**
@ -43,6 +58,14 @@ export interface PopupTextOptions {
* @crossplatform
* @since 11
*/
/**
* Set the text font size.
* @type { ?(number | string | Resource) }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize?: number | string | Resource;
/**
@ -52,6 +75,14 @@ export interface PopupTextOptions {
* @crossplatform
* @since 11
*/
/**
* Set the text font color.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
/**
@ -61,6 +92,14 @@ export interface PopupTextOptions {
* @crossplatform
* @since 11
*/
/**
* Set the text font weight.
* @type { ?(number | FontWeight | string) }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight?: number | FontWeight | string;
}
@ -70,6 +109,13 @@ export interface PopupTextOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the popup button options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PopupButtonOptions {
/**
* Set the button display content.
@ -78,6 +124,14 @@ export interface PopupButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the button display content.
* @type { ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: ResourceStr;
/**
@ -87,6 +141,14 @@ export interface PopupButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the button callback.
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
action?: () => void;
/**
@ -96,6 +158,14 @@ export interface PopupButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the button font size.
* @type { ?(number | string | Resource) }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontSize?: number | string | Resource;
/**
@ -105,6 +175,14 @@ export interface PopupButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Set the button font color.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
}
@ -114,6 +192,13 @@ export interface PopupButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the popup icon options
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PopupIconOptions {
/**
* Set the icon image.
@ -122,6 +207,14 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Set the icon image.
* @type { ResourceStr }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
image: ResourceStr;
/**
@ -131,6 +224,14 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Set the icon width.
* @type { ?Dimension }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width?: Dimension;
/**
@ -140,6 +241,14 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Set the icon height.
* @type { ?Dimension }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height?: Dimension;
/**
@ -149,6 +258,14 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Set the icon fill color.
* @type { ?ResourceColor }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fillColor?: ResourceColor;
/**
@ -158,6 +275,14 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Set the icon border radius.
* @type { ?(Length | BorderRadiuses) }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
borderRadius?: Length | BorderRadiuses;
}
@ -167,6 +292,13 @@ export interface PopupIconOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the popup options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface PopupOptions {
/**
* The icon of Popup.
@ -176,6 +308,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of Popup.
*
* @type { ?PopupIconOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: PopupIconOptions;
/**
@ -186,6 +327,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The title of Popup.
*
* @type { ?PopupTextOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
title?: PopupTextOptions;
/**
@ -196,6 +346,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The message of Popup.
*
* @type { PopupTextOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
message: PopupTextOptions;
/**
@ -206,6 +365,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The show close of Popup.
*
* @type { ?(boolean | Resource) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showClose?: boolean | Resource;
/**
@ -216,6 +384,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The close button callback of Popup.
*
* @type { ?() => void }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onClose?: () => void;
/**
@ -226,6 +403,15 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* The buttons of Popup.
*
* @type { ?[PopupButtonOptions?, PopupButtonOptions?] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttons?: [PopupButtonOptions?, PopupButtonOptions?];
}
@ -237,5 +423,14 @@ export interface PopupOptions {
* @crossplatform
* @since 11
*/
/**
* Build function of popup.
*
* @param { PopupOptions } options - popup option.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Builder
export declare function Popup(options: PopupOptions): void;

589
api/@ohos.arkui.advanced.SegmentButton.d.ets
View File

@ -30,6 +30,15 @@ import { ResourceStr } from 'GlobalResource';
* @crossplatform
* @since 11
*/
/**
* Defines text only item of SegmentButton.
*
* @interface SegmentButtonTextItem
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SegmentButtonTextItem {
/**
@ -40,6 +49,15 @@ interface SegmentButtonTextItem {
* @crossplatform
* @since 11
*/
/**
* The text of text only item.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: ResourceStr;
}
@ -51,6 +69,15 @@ interface SegmentButtonTextItem {
* @crossplatform
* @since 11
*/
/**
* Defines icon only item of SegmentButton.
*
* @interface SegmentButtonIconItem
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SegmentButtonIconItem {
/**
* The icon of icon only item.
@ -60,6 +87,15 @@ interface SegmentButtonIconItem {
* @crossplatform
* @since 11
*/
/**
* The icon of icon only item.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon: ResourceStr;
/**
@ -70,6 +106,15 @@ interface SegmentButtonIconItem {
* @crossplatform
* @since 11
*/
/**
* The icon of icon only item in the selected state.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedIcon: ResourceStr;
}
@ -81,6 +126,15 @@ interface SegmentButtonIconItem {
* @crossplatform
* @since 11
*/
/**
* Defines icon and text item of SegmentButton.
*
* @interface SegmentButtonIconTextItem
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SegmentButtonIconTextItem {
/**
* The icon of icon and text item.
@ -90,6 +144,15 @@ interface SegmentButtonIconTextItem {
* @crossplatform
* @since 11
*/
/**
* The icon of icon and text item.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon: ResourceStr;
/**
@ -100,6 +163,15 @@ interface SegmentButtonIconTextItem {
* @crossplatform
* @since 11
*/
/**
* The icon of icon and text item in the selected state.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedIcon: ResourceStr;
/**
@ -110,6 +182,15 @@ interface SegmentButtonIconTextItem {
* @crossplatform
* @since 11
*/
/**
* The text of icon and text item.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text: ResourceStr;
}
@ -120,6 +201,14 @@ interface SegmentButtonIconTextItem {
* @crossplatform
* @since 11
*/
/**
* Defines the DimensionNoPercentage type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type DimensionNoPercentage = PX | VP | FP | LPX | Resource;
/**
@ -130,6 +219,15 @@ declare type DimensionNoPercentage = PX | VP | FP | LPX | Resource;
* @crossplatform
* @since 11
*/
/**
* Defines SegmentButton common options.
*
* @interface CommonSegmentButtonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface CommonSegmentButtonOptions {
/**
* The font color of buttons.
@ -139,6 +237,15 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font color of buttons.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontColor?: ResourceColor;
/**
@ -149,6 +256,15 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font color of selected button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedFontColor?: ResourceColor;
/**
@ -182,6 +298,16 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font weight of buttons.
*
* @type { ?FontWeight }
* @default FontWeight.Regular
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight?: FontWeight;
/**
@ -193,6 +319,16 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font weight of selected button.
*
* @type { ?FontWeight }
* @default FontWeight.Medium
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedFontWeight?: FontWeight;
/**
@ -204,6 +340,16 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The background color of SegmentButton.
*
* @type { ?ResourceColor }
* @default $r('sys.color.ohos_id_color_button_normal')
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor?: ResourceColor;
/**
@ -214,6 +360,15 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The background color of selected button.
*
* @type { ?ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor?: ResourceColor;
/**
@ -225,6 +380,16 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The image size of buttons.
*
* @type { ?SizeOptions }
* @default SizeOptions { width: 24, height: 24 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
imageSize?: SizeOptions;
/**
@ -237,6 +402,17 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The padding of buttons.
*
* @type { ?Padding | Dimension }
* @default For text only / icon only buttons Padding { top: 4, right: 8, bottom: 4, left: 8 }.
* For text & icon buttons Padding { top: 6, right: 8, bottom: 6, left: 8 }.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttonPadding?: Padding | Dimension;
/**
@ -248,6 +424,16 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The padding of text in button.
*
* @type { ?Padding | Dimension }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textPadding?: Padding | Dimension;
/**
@ -258,6 +444,15 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The blurStyle of background.
*
* @type { ?BlurStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle?: BlurStyle;
}
@ -268,6 +463,14 @@ interface CommonSegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the ItemRestriction type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type ItemRestriction<T> = [T, T, T?, T?, T?];
/**
@ -277,6 +480,14 @@ declare type ItemRestriction<T> = [T, T, T?, T?, T?];
* @crossplatform
* @since 11
*/
/**
* Defines the SegmentButtonItemTuple type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type SegmentButtonItemTuple = ItemRestriction<SegmentButtonTextItem> | ItemRestriction<SegmentButtonIconItem> | ItemRestriction<SegmentButtonIconTextItem>;
/**
@ -286,6 +497,14 @@ declare type SegmentButtonItemTuple = ItemRestriction<SegmentButtonTextItem> | I
* @crossplatform
* @since 11
*/
/**
* Defines the SegmentButtonItemArray type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare type SegmentButtonItemArray = Array<SegmentButtonTextItem> | Array<SegmentButtonIconItem> | Array<SegmentButtonIconTextItem>;
/**
@ -297,6 +516,16 @@ declare type SegmentButtonItemArray = Array<SegmentButtonTextItem> | Array<Segme
* @crossplatform
* @since 11
*/
/**
* Defines SegmentButton tab options.
*
* @interface TabSegmentButtonConstructionOptions
* @extends CommonSegmentButtonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface TabSegmentButtonConstructionOptions extends CommonSegmentButtonOptions {
/**
* The items of tab type of SegmentButton.
@ -318,6 +547,16 @@ interface TabSegmentButtonConstructionOptions extends CommonSegmentButtonOptions
* @crossplatform
* @since 11
*/
/**
* Defines SegmentButton capsule options.
*
* @interface CapsuleSegmentButtonConstructionOptions
* @extends CommonSegmentButtonOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
*/
interface CapsuleSegmentButtonConstructionOptions extends CommonSegmentButtonOptions {
/**
* The items of capsule type of SegmentButton.
@ -338,6 +577,16 @@ interface CapsuleSegmentButtonConstructionOptions extends CommonSegmentButtonOpt
* @crossplatform
* @since 11
*/
/**
* Support multiple selections flag.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
multiply?: boolean;
}
@ -350,6 +599,16 @@ interface CapsuleSegmentButtonConstructionOptions extends CommonSegmentButtonOpt
* @crossplatform
* @since 11
*/
/**
* Defines the type of SegmentButton options of tab type.
*
* @interface TabSegmentButtonOptions
* @extends TabSegmentButtonConstructionOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface TabSegmentButtonOptions extends TabSegmentButtonConstructionOptions {
/**
* The type of SegmentButton.
@ -359,6 +618,15 @@ interface TabSegmentButtonOptions extends TabSegmentButtonConstructionOptions {
* @crossplatform
* @since 11
*/
/**
* The type of SegmentButton.
*
* @type { "tab" }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: "tab";
}
@ -371,6 +639,16 @@ interface TabSegmentButtonOptions extends TabSegmentButtonConstructionOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the type of SegmentButton options of capsule type.
*
* @interface CapsuleSegmentButtonOptions
* @extends CapsuleSegmentButtonConstructionOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface CapsuleSegmentButtonOptions extends CapsuleSegmentButtonConstructionOptions {
/**
* The type of SegmentButton.
@ -380,6 +658,15 @@ interface CapsuleSegmentButtonOptions extends CapsuleSegmentButtonConstructionOp
* @crossplatform
* @since 11
*/
/**
* The type of SegmentButton.
*
* @type { "capsule" }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: "capsule";
}
@ -390,6 +677,14 @@ interface CapsuleSegmentButtonOptions extends CapsuleSegmentButtonConstructionOp
* @crossplatform
* @since 11
*/
/**
* Construct parameter types for SegmentButtonItemOptions.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface SegmentButtonItemOptionsConstructorOptions {
/**
* The icon of icon and text item.
@ -399,6 +694,15 @@ interface SegmentButtonItemOptionsConstructorOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of icon and text item.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: ResourceStr;
/**
@ -409,6 +713,15 @@ interface SegmentButtonItemOptionsConstructorOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of icon and text item in the selected state.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedIcon?: ResourceStr;
/**
@ -419,6 +732,15 @@ interface SegmentButtonItemOptionsConstructorOptions {
* @crossplatform
* @since 11
*/
/**
* The text of icon and text item.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text?: ResourceStr;
}
@ -429,6 +751,14 @@ interface SegmentButtonItemOptionsConstructorOptions {
* @crossplatform
* @since 11
*/
/**
* The options for SegmentButton items.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Observed
declare class SegmentButtonItemOptions {
/**
@ -439,6 +769,15 @@ declare class SegmentButtonItemOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of item.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon?: ResourceStr;
/**
@ -449,6 +788,15 @@ declare class SegmentButtonItemOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of selected item.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedIcon?: ResourceStr;
/**
@ -459,6 +807,15 @@ declare class SegmentButtonItemOptions {
* @crossplatform
* @since 11
*/
/**
* The text of item.
*
* @type { ?ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
text?: ResourceStr;
/**
@ -480,6 +837,15 @@ declare class SegmentButtonItemOptions {
* @crossplatform
* @since 11
*/
/**
* The class for SegmentButton item options array.
*
* @extends Array<SegmentButtonItemOptions>
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Observed
declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptions> {
/**
@ -501,6 +867,16 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* Appends new elements to the end of SegmentButtonItemOptionsArray.
*
* @param { SegmentButtonItemArray } items - New elements to add to SegmentButtonItemOptionsArray.
* @returns { number } Returns the new length of SegmentButtonItemOptionsArray.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
push(...items: SegmentButtonItemArray): number;
/**
@ -511,6 +887,15 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* Removes the last element from SegmentButtonItemOptionsArray.
*
* @returns { SegmentButtonItemOptions | undefined } Returns the removed element.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pop(): SegmentButtonItemOptions | undefined;
/**
@ -521,6 +906,15 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* Removes the first element from SegmentButtonItemOptionsArray.
*
* @returns { SegmentButtonItemOptions | undefined } Returns the removed element.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
shift(): SegmentButtonItemOptions | undefined;
/**
@ -532,6 +926,16 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* Appends new elements to the start of SegmentButtonItemOptionsArray.
*
* @param { SegmentButtonItemArray } items - New elements to add to SegmentButtonItemOptionsArray.
* @returns { number } Returns the new length of SegmentButtonItemOptionsArray.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
unshift(...items: SegmentButtonItemArray): number;
/**
@ -545,6 +949,18 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* Changes the elements of SegmentButtonItemOptionsArray by removing or replacing existing elements and/or adding new elements in place.
*
* @param { number } start - The zero-based location in the array from which to start removing elements.
* @param { number } deleteCount - The number of elements to remove.
* @param { SegmentButtonItemOptions[] } items - Elements to insert into the array in place of the deleted elements.
* @returns { SegmentButtonItemOptions[] } Returns a SegmentButtonItemOptions array containing the deleted elements.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
splice(start: number, deleteCount: number, ...items: SegmentButtonItemOptions[]): SegmentButtonItemOptions[];
/**
@ -566,6 +982,14 @@ declare class SegmentButtonItemOptionsArray extends Array<SegmentButtonItemOptio
* @crossplatform
* @since 11
*/
/**
* The class for SegmentButton options.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Observed
declare class SegmentButtonOptions {
/**
@ -576,6 +1000,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The type of SegmentButton.
*
* @type { "tab" | "capsule" }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
type: "tab" | "capsule";
/**
@ -586,6 +1019,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The support multiple selections flag of SegmentButton.
*
* @type { boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
multiply: boolean;
/**
@ -596,6 +1038,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The buttons information of SegmentButton.
*
* @type { SegmentButtonOptionsArray }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttons: SegmentButtonItemOptionsArray;
/**
@ -616,6 +1067,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font color of selected button.
*
* @type { ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedFontColor: ResourceColor;
/**
@ -646,6 +1106,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font weight of buttons.
*
* @type { FontWeight }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
fontWeight: FontWeight;
/**
@ -656,6 +1125,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The font weight of selected button.
*
* @type { FontWeight }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedFontWeight: FontWeight;
/**
@ -666,6 +1144,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The background color of SegmentButton.
*
* @type { ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundColor: ResourceColor;
/**
@ -676,6 +1163,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The background color of selected button.
*
* @type { ResourceColor }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selectedBackgroundColor: ResourceColor;
/**
@ -686,6 +1182,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The image size of buttons.
*
* @type { SizeOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
imageSize: SizeOptions;
/**
@ -696,6 +1201,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The padding of buttons.
*
* @type { Padding | Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
buttonPadding: Padding | Dimension;
/**
@ -706,6 +1220,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The padding of text in button.
*
* @type { Padding | Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textPadding: Padding | Dimension;
/**
@ -716,6 +1239,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The blurStyle of background.
*
* @type { BlurStyle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
backgroundBlurStyle: BlurStyle;
/**
@ -726,6 +1258,15 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The constructor used to create a SegmentButtonOptions object.
*
* @param { TabSegmentButtonOptions | CapsuleSegmentButtonOptions } options - The options of SegmentButton.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(options: TabSegmentButtonOptions | CapsuleSegmentButtonOptions);
/**
@ -738,6 +1279,17 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The function used to create a SegmentButtonOptions of tab type.
*
* @param { TabSegmentButtonConstructionOptions } options - The options of SegmentButton.
* @returns { SegmentButtonOptions } Returns the a new SegmentButtonOptions object of tab type.
* @static
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
static tab(options: TabSegmentButtonConstructionOptions): SegmentButtonOptions;
/**
@ -750,6 +1302,17 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* The function used to create a SegmentButtonOptions of capsule type.
*
* @param { CapsuleSegmentButtonConstructionOptions } options - The options of SegmentButton.
* @returns { SegmentButtonOptions } Returns the a new SegmentButtonOptions object of capsule type.
* @static
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
static capsule(options: CapsuleSegmentButtonConstructionOptions): SegmentButtonOptions;
}
@ -760,6 +1323,14 @@ declare class SegmentButtonOptions {
* @crossplatform
* @since 11
*/
/**
* Declare Component SegmentButton
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Component
declare struct SegmentButton {
/**
@ -770,6 +1341,15 @@ declare struct SegmentButton {
* @crossplatform
* @since 11
*/
/**
* The options of SegmentButton.
*
* @type { SegmentButtonOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@ObjectLink
options: SegmentButtonOptions;
@ -781,6 +1361,15 @@ declare struct SegmentButton {
* @crossplatform
* @since 11
*/
/**
* The selectedIndex.
*
* @type { number[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Link
selectedIndexes: number[];
}

152
api/@ohos.arkui.advanced.SelectionMenu.d.ets
View File

@ -25,6 +25,14 @@
* @crossplatform
* @since 11
*/
/**
* Construct parameter types for EditorMenuOptions.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface EditorMenuOptions {
@ -36,6 +44,15 @@ export interface EditorMenuOptions {
* @crossplatform
* @since 11
*/
/**
* The icon of icon and text item.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
icon: ResourceStr;
/**
@ -46,6 +63,15 @@ export interface EditorMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Callback function when click the icon.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
action?: () => void;
/**
@ -56,6 +82,15 @@ export interface EditorMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Callback builder when click the icon.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
builder?: () => void;
}
@ -67,6 +102,15 @@ export interface EditorMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Construct parameter types for ExpandedMenuOptions.
*
* @extends MenuItemOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface ExpandedMenuOptions extends MenuItemOptions {
/**
* Callback function when click the option.
@ -76,6 +120,15 @@ export interface ExpandedMenuOptions extends MenuItemOptions {
* @crossplatform
* @since 11
*/
/**
* Callback function when click the option.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
action?: () => void;
}
@ -87,6 +140,15 @@ export interface ExpandedMenuOptions extends MenuItemOptions {
* @crossplatform
* @since 11
*/
/**
* Defines the editor event info.
*
* @interface EditorEventInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface EditorEventInfo {
/**
* Edit information.
@ -96,6 +158,15 @@ export interface EditorEventInfo {
* @crossplatform
* @since 11
*/
/**
* Edit information.
*
* @type { ?RichEditorSelection }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
content?: RichEditorSelection;
}
@ -107,6 +178,15 @@ export interface EditorEventInfo {
* @crossplatform
* @since 11
*/
/**
* Construct parameter types for SelectionMenuOptions.
*
* @extends MenuItemOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface SelectionMenuOptions {
/**
* The options of EditorMenu.
@ -116,6 +196,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* The options of EditorMenu.
*
* @type { ?Array<EditorMenuOptions> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
editorMenuOptions?: Array<EditorMenuOptions>;
/**
@ -126,6 +215,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Expansion of SelectionMenu.
*
* @type { ?Array<ExpendMenuOptions> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
expandedMenuOptions?: Array<ExpandedMenuOptions>;
/**
@ -136,6 +234,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Expansion of SelectionMenu.
*
* @type { ?RichEditorController }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
controller?: RichEditorController;
/**
* Replace the built-in paste function.
@ -145,6 +252,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Replace the built-in paste function.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onPaste?: (event?: EditorEventInfo) => void;
/**
@ -155,6 +271,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Replace the built-in replication feature.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCopy?: (event?: EditorEventInfo) => void;
/**
@ -165,6 +290,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Replace the built-in cut function.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onCut?: (event?: EditorEventInfo) => void;
/**
@ -175,6 +309,15 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Replace the built-in select all function.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onSelectAll?: (event?: EditorEventInfo) => void;
}
@ -186,5 +329,14 @@ export interface SelectionMenuOptions {
* @crossplatform
* @since 11
*/
/**
* Declare Builder SelectionMenu.
*
* @param { SelectionMenuOptions } options - Selection menu options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
@Builder
export declare function SelectionMenu(options: SelectionMenuOptions): void;

163
api/@ohos.arkui.dragController.d.ts vendored
View File

@ -39,18 +39,38 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Defines the Drag Status.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
const enum DragStatus {
/**
* Drag has started.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Drag has started.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
STARTED = 0,
/**
* Drag has ended.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Drag has ended.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ENDED = 1,
}
@ -61,6 +81,14 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Drag and drop information
*
* @interface DragAndDropInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface DragAndDropInfo {
/**
* The drag status.
@ -68,6 +96,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The drag status.
* @type { DragStatus }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
status: DragStatus;
/**
* The information containing the drag event.
@ -75,6 +110,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The information containing the drag event.
* @type { DragEvent }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
event: DragEvent;
/**
* Additional information about the drag info.
@ -82,6 +124,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Additional information about the drag info.
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
extraParams?: string;
}
@ -92,6 +141,14 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* One drag action object for drag process
*
* @interface DragAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface DragAction {
/**
* trigger drag action
@ -101,6 +158,15 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* trigger drag action
*
* @returns { Promise<void> } A Promise can indicate the start result.
* @throws { BusinessError } 100001 - if some internal handling failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
startDrag(): Promise<void>;
/**
* Registers a callback for listening on drag status changes.
@ -111,6 +177,16 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Registers a callback for listening on drag status changes.
* This callback is triggered when the drag status change.
*
* @param { 'statusChange' } type for status changing
* @param { Callback<DragAndDropInfo> } callback with drag event and status information
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
on(type: 'statusChange', callback: Callback<DragAndDropInfo>): void;
/**
@ -122,6 +198,16 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Deregisters a callback for listening on drag status changes.
* This callback is not triggered when the drag status change.
*
* @param { 'statusChange' } type for status changing
* @param { Callback<DragAndDropInfo> } callback with drag event and status information
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
off(type: 'statusChange', callback?: Callback<DragAndDropInfo>): void;
}
@ -163,6 +249,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Touch point coordinates.
* @type { ?TouchPoint }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
touchPoint?: TouchPoint;
/**
@ -171,6 +264,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Drag preview options.
* @type { ?DragPreviewOptions }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
previewOptions?: DragPreviewOptions;
}
@ -181,6 +281,14 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Defines the animation options for drag preview.
*
* @interface AnimationOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface AnimationOptions {
/**
* Animation duration, in ms.
@ -188,6 +296,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Animation duration, in ms.
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
duration?: number;
/**
* Animation curve.
@ -195,6 +310,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Animation curve.
* @type { ?(Curve | ICurve) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
curve?: Curve | ICurve;
}
@ -203,6 +325,12 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Provides the functions of setting color or updating animation.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export class DragPreview {
/**
* change foreground color of preview
@ -210,6 +338,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* change foreground color of preview
* @param { ResourceColor } color - color value
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
setForegroundColor(color: ResourceColor): void;
/**
* update preview style with animation
@ -218,6 +353,14 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* update preview style with animation
* @param { AnimationOptions } options - animation options
* @param { function } handler - change style functions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
animate(options: AnimationOptions, handler: () =>void): void;
}
@ -261,6 +404,19 @@ declare namespace dragController {
* @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<CustomBuilder | DragItemInfo> } customArray - Objects used for prompts
* displayed when the objects are dragged.
* @param { DragInfo } dragInfo - Information about the drag event.
* @returns { DragAction } one drag action object
* @throws { BusinessError } 401 - if the parameters checking failed.
* @throws { BusinessError } 100001 - if some internal handling failed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function createDragAction(customArray: Array<CustomBuilder | DragItemInfo>, dragInfo: DragInfo): DragAction;
/**
@ -269,6 +425,13 @@ declare namespace dragController {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Get drag preview object.
* @returns { DragPreview } An drag preview object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function getDragPreview(): DragPreview;
}

50
api/@ohos.arkui.drawableDescriptor.d.ts vendored
View File

@ -146,3 +146,53 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor {
*/
static getMaskClipPath(): string;
}
/**
* Animation control options
*
* @interface AnimationOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface AnimationOptions {
/**
* The duration of animation playback once.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
duration?: number;
/**
* Animation playback times.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
iterations?: number;
}
/**
* Define the data structure for PixelMap animations.
*
* @extends DrawableDescriptor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
export class AnimatedDrawableDescriptor extends DrawableDescriptor {
/**
* Creates a new AnimatedDrawableDescriptor.
*
* @param { Array<image.PixelMap> } pixelMaps - PixelMap List.
* @param { AnimationOptions } [options] - Animation control options.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
constructor(pixelMaps: Array<image.PixelMap>, options?: AnimationOptions);
}

9
api/@ohos.arkui.modifier.d.ts vendored
View File

@ -564,3 +564,12 @@ export { VideoModifier } from './arkui/VideoModifier';
* @since 12
*/
export { WaterFlowModifier } from './arkui/WaterFlowModifier';
/**
* Export AttributeUpdater, which is used to update attributes to native side.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @crossplatform
* @since 12
*/
export { AttributeUpdater } from './arkui/AttributeUpdater';

9
api/@ohos.arkui.node.d.ts vendored
View File

@ -72,3 +72,12 @@ export { RenderNode } from './arkui/RenderNode';
* @since 11
*/
export { XComponentNode } from './arkui/XComponentNode';
/**
* Export ComponentContent.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
export { ComponentContent } from './arkui/ComponentContent';

242
api/@ohos.arkui.observer.d.ts vendored
View File

@ -30,6 +30,15 @@ import type { NavigationOperation, NavBar } from '../component/navigation';
* @crossplatform
* @since 11
*/
/**
* Register callbacks to observe ArkUI behavior.
*
* @namespace uiObserver
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare namespace uiObserver {
/**
* NavDestination state.
@ -40,6 +49,16 @@ declare namespace uiObserver {
* @since 11
* @form
*/
/**
* NavDestination state.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
export enum NavDestinationState {
/**
* When the NavDestination is shown.
@ -49,6 +68,15 @@ declare namespace uiObserver {
* @since 11
* @form
*/
/**
* When the NavDestination show.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
ON_SHOWN = 0,
/**
@ -59,6 +87,15 @@ declare namespace uiObserver {
* @since 11
* @form
*/
/**
* When the NavDestination is hidden.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
ON_HIDDEN = 1,
/**
@ -100,6 +137,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Router page state.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export enum RouterPageState {
/**
* When the router page create.
@ -108,6 +154,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* When the router page create.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ABOUT_TO_APPEAR = 0,
/**
@ -117,6 +171,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* When the router page destroy.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ABOUT_TO_DISAPPEAR = 1,
/**
@ -126,6 +188,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* When the router page show.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ON_PAGE_SHOW = 2,
/**
@ -135,6 +205,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* When the router page hide.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ON_PAGE_HIDE = 3,
/**
@ -144,6 +222,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* When back press event happened in the router page.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ON_BACK_PRESS = 4
}
@ -183,6 +269,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* NavDestination info.
*
* @interface NavDestinationInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface NavDestinationInfo {
/**
* Navigation id.
@ -192,6 +287,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Navigation id.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
navigationId: ResourceStr,
/**
@ -202,6 +306,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Changed NavDestination name.
*
* @type { ResourceStr }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
name: ResourceStr,
/**
@ -212,6 +325,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Changed NavDestination state.
*
* @type { NavDestinationState }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
state: NavDestinationState,
/**
@ -312,6 +434,14 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Router page info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class RouterPageInfo {
/**
* The context of the changed router page.
@ -321,6 +451,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* The context of the changed router page.
*
* @type { UIAbilityContext | UIContext }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
context: UIAbilityContext | UIContext;
/**
@ -331,6 +470,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* The index of the changed router page in router stack.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
index: number;
/**
@ -341,6 +489,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* The name of the changed router page.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
name: string;
/**
@ -351,6 +508,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* The path of the changed router page.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
path: string;
/**
@ -361,6 +527,15 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* The state of the changed router page.
*
* @type { RouterPageState }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
state: RouterPageState;
}
@ -473,6 +648,17 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the navigation destination is updated.
*
* @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'.
* @param { object } options - The options object.
* @param { Callback<NavDestinationInfo> } callback - The callback function to be called when the navigation destination is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function on(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback: Callback<NavDestinationInfo>): void;
/**
@ -486,6 +672,18 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'navDestinationUpdate' } type - The type of event to remove the listener for. Must be 'navDestinationUpdate'.
* @param { object } options - The options object.
* @param { Callback<NavDestinationInfo> } callback - The callback function to remove. If not provided, all callbacks for the given event type and
* navigation ID will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function off(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback?: Callback<NavDestinationInfo>): void;
/**
@ -497,6 +695,16 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the navigation destination is updated.
*
* @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'.
* @param { Callback<NavDestinationInfo> } callback - The callback function to be called when the navigation destination is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function on(type: 'navDestinationUpdate', callback: Callback<NavDestinationInfo>): void;
/**
@ -509,6 +717,17 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'navDestinationUpdate'} type - The type of event to remove the listener for. Must be 'navDestinationUpdate'.
* @param { Callback<NavDestinationInfo> } [callback] - The callback function to remove. If not provided, all callbacks for the given event type
* will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function off(type: 'navDestinationUpdate', callback?: Callback<NavDestinationInfo>): void;
/**
@ -569,6 +788,17 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Registers a callback function to be called when the router page is updated.
*
* @param { 'routerPageUpdate' } type - The type of event to listen for. Must be 'routerPageUpdate'.
* @param { UIAbilityContext | UIContext } context - The context scope of the observer.
* @param { Callback<RouterPageInfo> } callback - The callback function to be called when the router page is updated.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function on(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback: Callback<RouterPageInfo>): void;
/**
@ -582,6 +812,18 @@ declare namespace uiObserver {
* @crossplatform
* @since 11
*/
/**
* Removes a callback function that was previously registered with `on()`.
*
* @param { 'routerPageUpdate' } type - The type of event to remove the listener for. Must be 'routerPageUpdate'.
* @param { UIAbilityContext | UIContext } context - The context scope of the observer.
* @param { Callback<RouterPageInfo> } [callback] - The callback function to remove. If not provided, all callbacks for the given event type
* will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export function off(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback?: Callback<RouterPageInfo>): void;
/**

46
api/@ohos.base.d.ts vendored
View File

@ -149,6 +149,15 @@ export interface ErrorCallback<T extends Error = BusinessError> {
* @atomicservice
* @since 11
*/
/**
* Defines the basic async callback.
* @typedef AsyncCallback
* @syscap SystemCapability.Base
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export interface AsyncCallback<T, E = void> {
/**
* Defines the callback data.
@ -174,6 +183,16 @@ export interface AsyncCallback<T, E = void> {
* @atomicservice
* @since 11
*/
/**
* Defines the callback data.
* @param { BusinessError<E> } err
* @param { T } data
* @syscap SystemCapability.Base
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
(err: BusinessError<E>, data: T): void;
}
@ -198,6 +217,15 @@ export interface AsyncCallback<T, E = void> {
* @atomicservice
* @since 11
*/
/**
* Defines the error interface.
* @typedef BusinessError
* @syscap SystemCapability.Base
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
export interface BusinessError<T = void> extends Error {
/**
* Defines the basic error code.
@ -220,6 +248,15 @@ export interface BusinessError<T = void> extends Error {
* @atomicservice
* @since 11
*/
/**
* Defines the basic error code.
* @type { number } code
* @syscap SystemCapability.Base
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
code: number;
/**
* Defines the additional information for business
@ -242,5 +279,14 @@ export interface BusinessError<T = void> extends Error {
* @atomicservice
* @since 11
*/
/**
* Defines the additional information for business
* @type { ?T } data
* @syscap SystemCapability.Base
* @crossplatform
* @form
* @atomicservice
* @since 12
*/
data?: T;
}

91
api/@ohos.bluetooth.connection.d.ts vendored
View File

@ -638,6 +638,22 @@ declare namespace connection {
*/
function disconnectAllowedProfiles(deviceId: string): Promise<void>;
/**
* Modify remote device name.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @param { string } name - New device name. Max length is 64 bytes.
* @returns { Promise<void> } Returns the promise object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth switch is off.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
function setRemoteDeviceName(deviceId: string, name: string): Promise<void>;
/**
* Subscribe the event reported when a remote Bluetooth device is discovered.
*
@ -667,6 +683,37 @@ declare namespace connection {
*/
function off(type: 'bluetoothDeviceFind', callback?: Callback<Array<string>>): void;
/**
* Subscribe the event reported when a remote Bluetooth device is discovered.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.GET_BLUETOOTH_PEERS_MAC
* @param { 'discoveryResult' } type - Type of the discovering event to listen for.
* @param { Callback<Array<DiscoveryResult>> } callback - Callback used to listen for the discovering event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
function on(type: 'discoveryResult', callback: Callback<Array<DiscoveryResult>>): void;
/**
* Unsubscribe the event reported when a remote Bluetooth device is discovered.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.GET_BLUETOOTH_PEERS_MAC
* @param { 'discoveryResult' } type - Type of the discovering event to listen for.
* @param { Callback<Array<DiscoveryResult>> } callback - Callback used to listen for the discovering event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
function off(type: 'discoveryResult', callback?: Callback<Array<DiscoveryResult>>): void;
/**
* Subscribe the event reported when a remote Bluetooth device is bonded.
*
@ -995,6 +1042,48 @@ declare namespace connection {
*/
PIN_TYPE_PIN_16_DIGITS = 7
}
}
/**
* Describes the contents of the discovery results
*
* @typedef DiscoveryResult
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
interface DiscoveryResult {
/**
* Identify of the discovery device
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
deviceId: string;
/**
* RSSI of the remote device
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
rssi: number;
/**
* The local name of the device
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
deviceName: string;
/**
* The class of the device
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 12
*/
deviceClass: DeviceClass;
}
}
export default connection;

31
api/@ohos.bundle.bundleManager.d.ts vendored
View File

@ -584,6 +584,14 @@ declare namespace bundleManager {
* @since 12
*/
EMBEDDED_UI = 21,
/**
* Indicates extension info with type of insight intent UI
*
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 12
*/
INSIGHT_INTENT_UI = 22,
/**
* Indicates extension info with type of unspecified
@ -2761,7 +2769,28 @@ declare namespace bundleManager {
* @systemapi
* @since 11
*/
function getJsonProfile(profileType: ProfileType, bundleName: string, moduleName?: string): string;
/**
* Obtains the JSON profile designated by profileType, bundleName, moduleName and userId.
*
* @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
* @param { ProfileType } profileType - Indicates the type of profile to be obtained.
* @param { string } bundleName - Indicates the name of the bundle to which the profile belongs.
* @param { string } moduleName - Indicates the name of the module to which the profile belongs.
* @param { number } userId - Indicates the user ID or do not pass user ID.
* @returns { string } Returns string in json-format of the designated profile.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 17700001 - The specified bundleName is not found.
* @throws { BusinessError } 17700002 - The specified moduleName is not found.
* @throws { BusinessError } 17700004 - The specified user ID is not found.
* @throws { BusinessError } 17700024 - Failed to get the profile because the specified profile is not found in the HAP.
* @throws { BusinessError } 17700026 - The specified bundle is disabled.
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 12
*/
function getJsonProfile(profileType: ProfileType, bundleName: string, moduleName?: string, userId?: number): string;
/**
* Get extend resources.

2
api/@ohos.configPolicy.d.ts vendored
View File

@ -15,7 +15,7 @@
/**
* @file
* @kit MDMKit
* @kit BasicServicesKit
*/
import { AsyncCallback } from './@ohos.base';

9
api/@ohos.curves.d.ts vendored
View File

@ -385,8 +385,7 @@ declare namespace curves {
*/
interface ICurve {
/**
* Get curve value by fraction.params,the parameter value range is from 0 to 1.
* 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0.
* Get curve value by fraction.
*
* @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1].
* Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used.
@ -395,8 +394,7 @@ declare namespace curves {
* @since 9
*/
/**
* Get curve value by fraction,the parameter value range is from 0 to 1.
* 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0.
* Get curve value by fraction.
*
* @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1].
* Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used.
@ -406,8 +404,7 @@ declare namespace curves {
* @since 10
*/
/**
* Get curve value by fraction,the parameter value range is from 0 to 1.
* 1 is taken when the value is greater than 1 and 0 is taken when it is less than 0.
* Get curve value by fraction.
*
* @param { number } fraction -Indicates the current normalized time parameter. Value range: [0, 1].
* Note: If the value is less than 0, it will be processed as 0. If the value is greater than 1, 1 is used.

142
api/@ohos.data.dataShare.d.ts vendored
View File

@ -407,6 +407,106 @@ declare namespace dataShare {
predicates: dataSharePredicates.DataSharePredicates;
}
/**
* Enumerates the data change types.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
enum ChangeType {
/**
* Data inserted.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
INSERT = 0,
/**
* Data deleted.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
DELETE,
/**
* Data updated.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
UPDATE
}
/**
* Enumerates the subscription types.
*
* @enum { number }
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
enum SubscriptionType {
/**
* Subscribe to the change of the data with the specified URI.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
SUBSCRIPTION_TYPE_EXACT_URI = 0,
}
/**
* Struct for the data change.
*
* @interface ChangeInfo
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
interface ChangeInfo {
/**
* Type of the data change.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
type: ChangeType;
/**
* URI of the data changed.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
uri: string;
/**
* Data changed.
*
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
values: Array<ValuesBucket>;
}
/**
* DataShareHelper
*
@ -442,6 +542,35 @@ declare namespace dataShare {
* @since 9
*/
off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>): void;
/**
* Subscribes to the change of the data specified by the given URI.
*
* @param { 'dataChange' } type - Indicates the event type, which must be 'dataChange'.
* @param { SubscriptionType } type - Indicates the subscription type, which is defined in {@link SubscriptionType}.
* @param { string } uri - Indicates the path of the data to subscribe.
* @param { AsyncCallback<ChangeInfo> } callback - Indicates the callback used to return the data change.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
on(event: 'dataChange', type:SubscriptionType, uri: string, callback: AsyncCallback<ChangeInfo>): void;
/**
* Unsubscribes from the change of the data specified by the given URI.
*
* @param { 'dataChange' } type - Indicates the event type, which must be 'dataChange'.
* @param { SubscriptionType } type - Indicates the subscription type, which is defined in {@link SubscriptionType}.
* @param { string } uri - Indicates the path of the data to unsubscribe.
* @param { AsyncCallback<ChangeInfo> } callback - Indicates the callback to unsubscribe.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
off(event: 'dataChange', type:SubscriptionType, uri: string, callback?: AsyncCallback<ChangeInfo>): void;
/**
* Adds a template of {@link #on(string, Array<string>, TemplateId, AsyncCallback<ChangeNode>)}.
@ -910,6 +1039,19 @@ declare namespace dataShare {
*/
notifyChange(uri: string): Promise<void>;
/**
* Notifies the registered observers of the data change.
*
* @param { ChangeInfo } data - Indicates the data change information.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @syscap SystemCapability.DistributedDataManager.DataShare.Consumer
* @systemapi
* @stagemodelonly
* @since 12
*/
notifyChange(data: ChangeInfo): Promise<void>;
/**
* Close the connection between datashare and extension.
*

90
api/@ohos.data.relationalStore.d.ts vendored
View File

@ -197,7 +197,15 @@ declare namespace relationalStore {
* @crossplatform
* @since 10
*/
type ValueType = null | number | string | boolean | Uint8Array | Asset | Assets;
/**
* Indicates possible value types
*
* @typedef { null | number | string | boolean | Uint8Array | Asset | Assets | Float32Array }
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @crossplatform
* @since 12
*/
type ValueType = null | number | string | boolean | Uint8Array | Asset | Assets | Float32Array;
/**
* Values in buckets are stored in key-value pairs
@ -334,6 +342,16 @@ declare namespace relationalStore {
* @since 11
*/
isSearchable?: boolean;
/**
* Specifies whether the vector type is supported.
*
* @type { ?boolean }
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @systemapi
* @since 12
*/
vector?: boolean;
}
/**
@ -2208,6 +2226,23 @@ declare namespace relationalStore {
*/
getAssets(columnIndex: number): Assets;
/**
* Obtains the value of the specified column in the current row as a float array.
* The implementation class determines whether to throw an exception if the value of the specified column
* in the current row is null or the specified column is not of the float array type.
*
* @param { number } columnIndex - Indicates the specified column index, which starts from 0.
* @returns { Float32Array } The value of the specified column as a float array.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - The capability is not supported because the database is not a vector DB.
* @throws { BusinessError } 14800011 - Failed to open database by database corrupted.
* @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible.
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @systemapi
* @since 12
*/
getFloat32Array(columnIndex: number): Float32Array;
/**
* Obtains the values of all columns in the specified row.
*
@ -3124,6 +3159,22 @@ declare namespace relationalStore {
*/
execute(sql: string, args?: Array<ValueType>): Promise<ValueType>;
/**
* Executes a SQL statement that contains specified parameters and returns a value of ValueType.
*
* @param { string } sql - Indicates the SQL statement to execute.
* @param { number } txId - Indicates the transaction ID which is obtained by beginTrans or 0.
* @param { Array<ValueType> } args - Indicates the {@link ValueType} values of the parameters in the SQL statement. The values are strings.
* @returns { Promise<ValueType> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 14800011 - Failed to open database by database corrupted.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @throws { BusinessError } 14800000 - Inner error.
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @since 12
*/
execute(sql: string, txId: number, args?: Array<ValueType>): Promise<ValueType>;
/**
* BeginTransaction before execute your sql.
*
@ -3144,6 +3195,19 @@ declare namespace relationalStore {
*/
beginTransaction(): void;
/**
* Begins a transaction before executing the SQL statement.
*
* @returns { Promise<number> } Returns the transaction ID.
* @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 14800000 - Inner error.
* @throws { BusinessError } 14800011 - Failed to open database by database corrupted.
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @since 12
*/
beginTrans(): Promise<number>;
/**
* Commit the the sql you have executed.
*
@ -3161,6 +3225,18 @@ declare namespace relationalStore {
*/
commit(): void;
/**
* Commits the SQL statement executed.
*
* @param { number } txId - Indicates the transaction ID which is obtained by beginTrans.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 14800011 - Failed to open database by database corrupted.
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @since 12
*/
commit(txId : number): Promise<void>;
/**
* Roll back the sql you have already executed.
*
@ -3178,6 +3254,18 @@ declare namespace relationalStore {
*/
rollBack(): void;
/**
* Rolls back the SQL statement executed.
*
* @param { number } txId - Indicates the transaction ID which is obtained by beginTrans.
* @returns { Promise<void> } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 14800011 - Failed to open database by database corrupted.
* @syscap SystemCapability.DistributedDataManager.RelationalStore.Core
* @since 12
*/
rollback(txId : number): Promise<void>;
/**
* Backs up a database in a specified name.
*

198
api/@ohos.effectKit.d.ts vendored
View File

@ -25,6 +25,12 @@ import image from './@ohos.multimedia.image';
* @namespace effectKit
* @since 9
*/
/**
* @namespace effectKit
* @form
* @atomicservice
* @since 12
*/
declare namespace effectKit {
@ -35,6 +41,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The Filter of FilterChain.
* @typedef Filter
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
interface Filter {
/**
@ -44,6 +58,15 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* A blur effect is added to the image.
* @param { number } radius - The degree of blur, the value is measured in pixels.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
blur(radius: number): Filter;
/**
@ -53,6 +76,15 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* A Brightness effect is added to the image.
* @param { number } bright - The degree of light and darkness,the value range is 0 to 1.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
brightness(bright: number): Filter;
/**
@ -61,6 +93,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* A Grayscale effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
grayscale(): Filter;
/**
@ -79,6 +119,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 11
*/
/**
* Gets the PixelMap where all filter effects have been added to the image.
* @returns { Promise<image.PixelMap> } - returns the PixelMap generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getEffectPixelMap(): Promise<image.PixelMap>;
}
@ -88,6 +136,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The color picker of an image.
* @typedef ColorPicker
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
interface ColorPicker {
/**
@ -96,6 +152,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* get main color of an image
* @returns { Promise<Color> } returns the MainColor generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getMainColor(): Promise<Color>;
/**
@ -104,6 +168,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* get main color of an image
* @returns { Color } Main color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getMainColorSync(): Color;
/**
@ -112,6 +184,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get largest proportion color of an image
* @returns { Color } Largest proportion color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getLargestProportionColor(): Color;
/**
@ -120,6 +200,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get highest saturation color of an image
* @returns { Color } Highest saturation color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getHighestSaturationColor(): Color;
/**
@ -128,6 +216,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get average color of an image
* @returns { Color } Average color calculated in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
getAverageColor(): Color;
/**
@ -137,6 +233,15 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Determine whether the color is black or white or gray
* @param { number } color - The 32 bit ARGB color to discriminate.
* @returns { boolean } Result of judging black, white and gray.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
isBlackOrWhiteOrGrayColor(color: number): boolean;
}
@ -146,6 +251,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The color param.
* @typedef Color
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
interface Color {
/**
@ -154,6 +267,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Red
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
red: number;
/**
@ -162,6 +283,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Green
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
green: number;
/**
@ -170,6 +299,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Blue
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
blue: number;
/**
@ -178,6 +315,14 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Alpha
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
alpha: number;
}
@ -188,6 +333,15 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Create a FilterChain to add multiple effects to an image.
* @param { image.PixelMap } source - the source pixelmap.
* @returns { Filter } Returns the head node of FilterChain.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
function createEffect(source: image.PixelMap): Filter;
/**
@ -198,6 +352,16 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @returns { Promise<ColorPicker> } - returns the ColorPicker generated.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
function createColorPicker(source: image.PixelMap): Promise<ColorPicker>;
/**
@ -210,6 +374,18 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { Array<number> } region - contains 4 elements, represents the region's left, top, right, bottom coordinates,
* default is [0, 0, 1, 1], represents the region of color picker is the whole pixelMap.
* @returns { Promise<ColorPicker> } - returns the ColorPicker generated.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
function createColorPicker(source: image.PixelMap, region: Array<number>): Promise<ColorPicker>;
/**
@ -220,6 +396,16 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { AsyncCallback<ColorPicker> } callback - the callback of createColorPicker.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
function createColorPicker(source: image.PixelMap, callback: AsyncCallback<ColorPicker>): void;
/**
@ -232,6 +418,18 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { Array<number> } region - contains 4 elements, represents the region's left, top, right, bottom coordinates,
* default is [0, 0, 1, 1], represents the region of color picker is the whole pixelMap.
* @param { AsyncCallback<ColorPicker> } callback - the callback of createColorPicker.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
function createColorPicker(source: image.PixelMap, region: Array<number>, callback: AsyncCallback<ColorPicker>): void;
}

19
api/@ohos.enterprise.securityManager.d.ts vendored
View File

@ -25,7 +25,6 @@ import type Want from './@ohos.app.ability.Want';
*
* @namespace securityManager
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @systemapi
* @stagemodelonly
* @since 11
*/
@ -88,6 +87,24 @@ declare namespace securityManager {
* @since 11
*/
function getDeviceEncryptionStatus(admin: Want): DeviceEncryptionStatus;
/**
* Gets device security policy of the specific type.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SECURITY
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } item - item indicates the specific type of security policy.
* @returns { string } security policy of the specific type.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - the application does not have permission to call this function.
* @throws { BusinessError } 401 - invalid input parameter.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 12
*/
function getSecurityStatus(admin: Want, item: string): string;
}
export default securityManager;

30
api/@ohos.file.photoAccessHelper.d.ts vendored
View File

@ -3060,6 +3060,36 @@ declare namespace photoAccessHelper {
* @since 11
*/
recommendationType?: RecommendationType;
/**
* The textContextInfo to recommend images.
*
* @type { ?TextContextInfo }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 12
*/
textContextInfo?: TextContextInfo;
}
/**
* Defines the text context info.
*
* @interface TextContextInfo
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 12
*/
interface TextContextInfo {
/**
* The Simplified Chinese(UTF-8) text within 250 to recommend images.
*
* @type { ?string }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 12
*/
text?: string;
}
/**

144
api/@ohos.font.d.ts vendored
View File

@ -281,6 +281,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontConfig
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontConfig {
/**
* The paths of system font files.
@ -288,6 +294,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The paths of system font files.
* @type { Array<string> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
fontDir: Array<string>;
/**
@ -296,6 +309,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The generic font info.
* @type { Array<UIFontGenericInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
generic: Array<UIFontGenericInfo>;
/**
@ -304,6 +324,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The fallback font info.
* @type { Array<UIFontFallbackGroupInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
fallbackGroups: Array<UIFontFallbackGroupInfo>;
}
@ -312,6 +339,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontGenericInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontGenericInfo {
/**
* Name of the font set.
@ -319,6 +352,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Name of the font set.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
family: string;
/**
@ -327,6 +367,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Alias info of the font set.
* @type { Array<UIFontAliasInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
alias: Array<UIFontAliasInfo>;
/**
@ -335,6 +382,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Adjust info of the font set.
* @type { Array<UIFontAdjustInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
adjust: Array<UIFontAdjustInfo>;
}
@ -343,6 +397,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontAliasInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontAliasInfo {
/**
* Font set name.
@ -350,6 +410,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Font set name.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
name: string;
/**
@ -359,6 +426,14 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Weight the font set contains only fonts with, if weight = 0,
* this font set can contain fonts with any weight.
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
weight: number;
}
@ -367,6 +442,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontAdjustInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontAdjustInfo {
/**
* Original weight of the font
@ -374,6 +455,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Original weight of the font
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
weight: number;
/**
* Font weight displayed in the app
@ -381,6 +469,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Font weight displayed in the app
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
to: number;
}
@ -389,6 +484,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontFallbackGroupInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontFallbackGroupInfo {
/**
* Indicates which font set uses following list for fallback font
@ -397,6 +498,14 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Indicates which font set uses following list for fallback font
* if the font set name is "", it means that the following list can be fallback font for all font sets.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
fontSetName: string;
/**
@ -405,6 +514,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Fallback font list related.
* @type { Array<UIFontFallbackInfo> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
fallback: Array<UIFontFallbackInfo>;
}
@ -413,6 +529,12 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* @typedef UIFontFallbackInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
interface UIFontFallbackInfo {
/**
* Language that font set support.
@ -420,6 +542,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Language that font set support.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
language: string;
/**
@ -428,6 +557,13 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Font name related.
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
family: string;
}
@ -491,6 +627,14 @@ declare namespace font {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Get font details according to the font name.
*
* @returns { UIFontConfig } Returns the ui font config
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
function getUIFontConfig(): UIFontConfig;
}

18
api/@ohos.measure.d.ts vendored
View File

@ -170,6 +170,15 @@ export interface MeasureOptions {
* @crossplatform
* @since 11
*/
/**
* Specify the indentation of the first line in a text-block.
*
* @type { ?(number | string) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
textIndent?: number | string;
/**
@ -180,6 +189,15 @@ export interface MeasureOptions {
* @crossplatform
* @since 11
*/
/**
* Set the word break type.
*
* @type { ?WordBreak }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
wordBreak?: WordBreak;
}

62
api/@ohos.multimedia.audio.d.ts vendored
View File

@ -3165,6 +3165,30 @@ declare namespace audio {
* @since 11
*/
updateSpatialDeviceState(spatialDeviceState: AudioSpatialDeviceState): void;
/**
* Set spatialization rendering scene type.
* @permission ohos.permission.MANAGE_SYSTEM_AUDIO_EFFECTS
* @param { AudioSpatializationSceneType } spatializationSceneType - Spatialization scene type.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 401 - Input parameter type or number mismatch.
* @throws { BusinessError } 6800101 - Invalid parameter error.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
setSpatializationSceneType(spatializationSceneType: AudioSpatializationSceneType): void;
/**
* Get spatialization rendering scene type.
* @returns { AudioSpatializationSceneType } Current spatialization rendering scene type.
* @throws { BusinessError } 202 - Not system App.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
getSpatializationSceneType(): AudioSpatializationSceneType;
}
/**
@ -5237,6 +5261,44 @@ declare namespace audio {
SPATIAL_DEVICE_TYPE_OTHERS = 5,
}
/**
* Describes a spatialization scene type group.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
enum AudioSpatializationSceneType {
/**
* Audio Spatialization Scene Type Default.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
DEFAULT = 0,
/**
* Audio Spatialization Scene Type Music.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
MUSIC = 1,
/**
* Audio Spatialization Scene Type Movie.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
MOVIE = 2,
/**
* Audio Spatialization Scene Type Audio Book.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @systemapi
* @since 12
*/
AUDIOBOOK = 3,
}
/**
* Audio AudioChannel Layout
* A 64-bit integer indicates that the appearance and order of the speakers for recording or playback.

1056
api/@ohos.multimedia.image.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

70
api/@ohos.multimedia.media.d.ts vendored
View File

@ -107,6 +107,18 @@ declare namespace media {
*/
function createAudioRecorder(): AudioRecorder;
/**
* Create MediaSource from url.
* @param { string } url : The location for the media source.
* @param { Record<string, string> } headers : Headers attached to network request while player request data.
* @returns { MediaSource } MediaSource instance if the operation is successful; returns null otherwise.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 5400101 - No memory.
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
function createMediaSourceWithUrl(url: string, headers?: Record<string, string>): MediaSource;
/**
* Creates an VideoPlayer instance.
* @param { AsyncCallback<VideoPlayer> } callback - used to return AudioPlayer instance if the operation is successful; returns null otherwise.
@ -1181,6 +1193,18 @@ declare namespace media {
*/
getTrackDescription(): Promise<Array<MediaDescription>>;
/**
* Set MediaSource to AVPlayer, this interface is exclusive with fd/url/dataSrc assign.
* @param { MediaSource } src : MediaSource instance to be set to the avplayer instance.
* @param { PlaybackStrategy } strategy : Play strategy of the media source.
* @returns { Promise<void> } A Promise instance used to return when setMediaSource completed.
* @throws { BusinessError } 401 - The parameter check failed. Return by promise.
* @throws { BusinessError } 5400102 - Operation not allowed. Return by promise.
* @syscap SystemCapability.Multimedia.Media.AVPlayer
* @since 12
*/
setMediaSource(src: MediaSource, strategy?: PlaybackStrategy): Promise<void>;
/**
* Media URI. Mainstream media formats are supported.
* Network:http://xxx
@ -1825,6 +1849,52 @@ declare namespace media {
CACHED_DURATION = 4,
}
/**
* Media source descriptor. User can set media data information
* @typedef MediaSource
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
interface MediaSource {
}
/**
* Provides preferred playback settings for player.
*
* @typedef PlaybackStrategy
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
interface PlaybackStrategy {
/**
* Choose a stream with width close to it.
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
preferredWidth?: number;
/**
* Choose a stream with height close to it.
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
preferredHeight?: number;
/**
* Choose a preferred buffer duration.
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
preferredBufferDuration?: number;
/**
* If true, the player should choose HDR stream if exist.
* @syscap SystemCapability.Multimedia.Media.Core
* @since 12
*/
preferredHdr?: boolean;
}
/**
* Media file descriptor. The caller needs to ensure that the fd is valid and
* the offset and length are correct.

146
api/@ohos.promptAction.d.ts vendored
View File

@ -154,6 +154,15 @@ declare namespace promptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Determine the show mode of the toast.
*
* @type { ?ToastShowMode }
* @default ToastShowMode.DEFAULT
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
showMode?: ToastShowMode;
/**
* Defines the toast alignment of the screen.
@ -182,6 +191,14 @@ declare namespace promptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Enum for the toast showMode.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
export enum ToastShowMode {
/**
* Toast shows in app.
@ -189,6 +206,13 @@ declare namespace promptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Toast shows in app.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
DEFAULT = 0,
/**
@ -197,6 +221,13 @@ declare namespace promptAction {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Toast shows at the top.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
TOP_MOST = 1
}
@ -491,6 +522,16 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showInSubWindow?: boolean;
/**
@ -501,6 +542,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
}
@ -512,6 +562,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Dialog base options
*
* @typedef BaseDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface BaseDialogOptions {
/**
* Mask Region of dialog. The size can't exceed the main window.
@ -521,6 +580,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Mask Region of dialog. The size can't exceed the main window.
*
* @type { ?Rectangle }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
maskRect?: Rectangle;
/**
@ -531,6 +599,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Defines the dialog alignment of the screen.
*
* @type { ?DialogAlignment }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
alignment?: DialogAlignment;
/**
@ -541,6 +618,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Defines the dialog offset.
*
* @type { ?Offset }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
offset?: Offset;
/**
@ -552,6 +638,16 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether to display in the sub window.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
showInSubWindow?: boolean;
/**
@ -562,6 +658,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
/**
@ -583,6 +688,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Dialog's custom content options
*
* @interface CustomDialogOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface CustomDialogOptions extends BaseDialogOptions {
/**
* Allow developer custom dialog's content.
@ -592,6 +706,15 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Allow developer custom dialog's content.
*
* @type { CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
builder: CustomBuilder;
/**
@ -930,6 +1053,18 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Open the custom dialog.
*
* @param { CustomDialogOptions } options - Options.
* @returns { Promise<number> } return the dialog id that will be used by closeCustomDialog.
* @throws { BusinessError } 401 - if the number of parameters is not 1 or the type of parameters is incorrect.
* @throws { BusinessError } 100001 - if UI execution context not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function openCustomDialog(options: CustomDialogOptions): Promise<number>;
/**
@ -942,6 +1077,17 @@ declare namespace promptAction {
* @crossplatform
* @since 11
*/
/**
* Close the custom dialog.
*
* @param { number } dialogId - the dialog id that returned by openCustomDialog.
* @throws { BusinessError } 401 - if the number of parameters is not 1 or the type of parameters is incorrect.
* @throws { BusinessError } 100001 - if UI execution context not found.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
function closeCustomDialog(dialogId: number): void;
/**

14
api/@ohos.resourceManager.d.ts vendored
View File

@ -4447,6 +4447,20 @@ declare namespace resourceManager {
* @since 11
*/
getSymbolByName(resName: string) : number;
/**
* Whether the rawfile resource is a directory or not.
*
* @param { string } path - Indicates the rawfile resource relative path.
* @returns { boolean } True means the file path is directory, else false.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001005 - If the resource not found by path.
* @syscap SystemCapability.Global.ResourceManager
* @crossplatform
* @atomicservice
* @since 12
*/
isRawDir(path: string): boolean;
}
/**

113
api/@ohos.usbManager.d.ts vendored
View File

@ -180,6 +180,119 @@ declare namespace usbManager {
*/
function setPortRoles(portId: number, powerRole: PowerRoleType, dataRole: DataRoleType): Promise<void>;
/**
* Add USB device access right.
* The system application has access to the device by default, and calling this interface will not have any impact.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { string } tokenId - refers to application that require access permissions.
* @param { string } deviceName - device name defined by USBDevice.name.
* @returns { boolean } value to indicate whether the permission is granted.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function addDeviceAccessRight(tokenId: string, deviceName: string): boolean;
/**
* Converts the string descriptor of a given USB function list to a numeric mask combination.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { string } funcs - descriptor of the supported function list.
* @returns { number } the numeric mask combination of the function list.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function getFunctionsFromString(funcs: string): number;
/**
* Converts the numeric mask combination of a given USB function list to a string descriptor.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { FunctionType } funcs - numeric mask combination of the function list.
* @returns { string } - descriptor of the supported function list.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function getStringFromFunctions(funcs: FunctionType): string;
/**
* Sets the current USB function list in Device mode.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { FunctionType } funcs - numeric mask combination of the supported function list.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function setDeviceFunctions(funcs: FunctionType): Promise<void>;
/**
* Obtains the numeric mask combination for the current USB function list in Device mode.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @returns { FunctionType } the numeric mask combination for the current USB function list in FunctionType.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function getDeviceFunctions(): FunctionType;
/* usb port functions begin */
/**
* Obtains the USBPort list.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @returns { Array<USBPort> } the USBPort list.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function getPortList(): Array<USBPort>;
/**
* Gets the mask combination for the supported mode list of the specified USBPort.
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { number } portId
* @returns { PortModeType } the mask combination for the supported mode list in PortModeType.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function getPortSupportModes(portId: number): PortModeType;
/**
* Sets the role types supported by the specified USBPort, which can be powerRole (for charging) and dataRole (for data transfer).
*
* @permission ohos.permission.MANAGE_USB_CONFIG
* @param { number } portId - unique ID of the port.
* @param { PowerRoleType } powerRole - charging role.
* @param { DataRoleType } dataRole - data role.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - The parameter types do not match or parameter is not specified.
* @throws { BusinessError } 202 - Permission denied.
* @syscap SystemCapability.USB.USBManager
* @systemapi
* @since 12
*/
function setPortRoleTypes(portId: number, powerRole: PowerRoleType, dataRole: DataRoleType): Promise<void>;
/* usb pipe functions begin */
/**
* Claims a USB interface.

46
api/@ohos.userIAM.userAuth.d.ts vendored
View File

@ -929,6 +929,22 @@ declare namespace userAuth {
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 9
*/
/**
* Check whether the authentication capability is available.
*
* @permission ohos.permission.ACCESS_BIOMETRIC
* @param { UserAuthType } authType - Credential type for authentication.
* @param { AuthTrustLevel } authTrustLevel - Trust level of authentication result.
* @throws { BusinessError } 201 - Permission verification failed.
* @throws { BusinessError } 401 - Incorrect parameters.
* @throws { BusinessError } 12500002 - General operation error.
* @throws { BusinessError } 12500005 - The authentication type is not supported.
* @throws { BusinessError } 12500006 - The authentication trust level is not supported.
* @throws { BusinessError } 12500010 - The type of credential has not been enrolled.
* @throws { BusinessError } 12500013 - Indicates that current operation failed because of PIN expired.
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 12
*/
function getAvailableStatus(authType: UserAuthType, authTrustLevel: AuthTrustLevel): void;
/**
@ -1273,6 +1289,26 @@ declare namespace userAuth {
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 10
*/
/**
* Start this authentication, an instance can only perform authentication once.
*
* @permission ohos.permission.ACCESS_BIOMETRIC
* @throws { BusinessError } 201 - Permission verification failed.
* @throws { BusinessError } 401 - Incorrect parameters.
* @throws { BusinessError } 12500001 - Authentication failed.
* @throws { BusinessError } 12500002 - General operation error.
* @throws { BusinessError } 12500003 - The operation is canceled.
* @throws { BusinessError } 12500004 - The operation is time-out.
* @throws { BusinessError } 12500005 - The authentication type is not supported.
* @throws { BusinessError } 12500006 - The authentication trust level is not supported.
* @throws { BusinessError } 12500007 - The authentication task is busy.
* @throws { BusinessError } 12500009 - The authenticator is locked.
* @throws { BusinessError } 12500010 - The type of credential has not been enrolled.
* @throws { BusinessError } 12500011 - The authentication is canceled from widget's navigation button.
* @throws { BusinessError } 12500013 - Indicates that current authentication failed because of PIN expired.
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 12
*/
start(): void;
/**
@ -1432,7 +1468,15 @@ declare namespace userAuth {
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 10
*/
CANCELED_FROM_WIDGET = 12500011
CANCELED_FROM_WIDGET = 12500011,
/**
* Indicates that current operation failed because of PIN expired.
*
* @syscap SystemCapability.UserIAM.UserAuth.Core
* @since 12
*/
PIN_EXPIRED = 12500013
}
/**

45
api/@ohos.util.d.ts vendored
View File

@ -3447,5 +3447,50 @@ declare namespace util {
*/
static replace(targetClass: Object, methodName: string, isStatic: boolean, instead: Function) : void;
}
/**
* Provide the ability to decode binary streams into strings. The supported encoding types include: utf-8, iso-8859-2,
* koi8-r, macintosh, windows-1250, windows-1251, gbk, gb18030, big5, utf-16be, utf-16 le, etc.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class StringDecoder {
/**
* The StringDecoder constructor.
*
* @param { string } [encoding] - Encoding type of the input data.Default: utf8.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
*/
constructor(encoding?: string);
/**
* Returns a decoded string, ensuring that any incomplete multiple byte characters at the end of the Uint8Array are
* omitted from the returned string and stored in an internal buffer.
*
* @param { string | Uint8Array } chunk - The bytes to decode.
* @returns { string } Returns a decoded string.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
*/
write(chunk: string | Uint8Array): string;
/**
* Returns any remaining input stored in the internal buffer as a string. After end() is called,
* this object can be reused for new input.
*
* @param { string | Uint8Array } [chunk] - The bytes to decode.
* @returns { string } Returns any remaining input stored in the internal buffer as a string.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 12
*/
end(chunk?: string | Uint8Array): string;
}
}
export default util;

50
api/@ohos.web.webview.d.ts vendored
View File

@ -2423,6 +2423,35 @@ declare namespace webview {
getArray(): Array<string | number | boolean>;
}
/**
* Defines the render process mode.
*
* @enum {number}
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
enum RenderProcessMode {
/**
* Indicates the ArkWeb operates in single render process mode, which is the default value for
* mobile devices.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
SINGLE = 0,
/**
* Indicates the ArkWeb operates in multiple render process mode.
*
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
MULTIPLE,
}
/**
* Provides methods for controlling the web controller.
* @syscap SystemCapability.Web.Webview.Core
@ -4419,6 +4448,27 @@ declare namespace webview {
* @since 12
*/
static clearPrefetchedResource(cacheKeyList: Array<string>): void;
/**
* Set render process mode of the ArkWeb.
*
* @param { RenderProcessMode } mode - The render process mode for the ArkWeb.
* @throws { BusinessError } 401 - Invalid input parameter.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
static setRenderProcessMode(mode: RenderProcessMode): void;
/**
* Get render process mode of the ArkWeb.
*
* @returns { RenderProcessMode } mode - The render process mode of the ArkWeb.
* @syscap SystemCapability.Web.Webview.Core
* @atomicservice
* @since 12
*/
static getRenderProcessMode(): RenderProcessMode;
}
/**

233
api/@ohos.window.d.ts vendored
View File

@ -245,7 +245,16 @@ declare namespace window {
* @StageModelOnly
* @since 11
*/
TYPE_GLOBAL_SEARCH
TYPE_GLOBAL_SEARCH,
/**
* Handwrite.
*
* @syscap SystemCapability.Window.SessionManager
* @systemapi Hide this for inner system use.
* @StageModelOnly
* @since 12
*/
TYPE_HANDWRITE
}
/**
@ -1501,6 +1510,109 @@ declare namespace window {
height: number;
}
/**
* Rect change options
*
* @interface RectChangeOptions
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
interface RectChangeOptions {
/**
* Rect
*
* @type { Rect }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
rect: Rect,
/**
* Rect change reason
*
* @type { RectChangeReason }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
reason: RectChangeReason
}
/**
* Window rect change reason.
*
* @enum { number }
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
enum RectChangeReason {
/**
* Default RectChangeReason.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
UNDEFINED = 0,
/**
* Window maximize.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MAXIMIZE,
/**
* Window recover.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
RECOVER,
/**
* Window move.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
MOVE,
/**
* Window drag.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
DRAG,
/**
* Window drag start.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
DRAG_START,
/**
* Window drag end.
*
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
DRAG_END,
}
/**
* Create a window with a specific configuration
*
@ -1894,6 +2006,21 @@ declare namespace window {
*/
function shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise<void>;
/**
* gets snapshot of window
*
* @param { number } windowId - Indicates target window id.
* @returns { Promise<image.PixelMap> } - Promise that returns no value.
* @throws {BusinessError} 801 - Capability not supported on this device.
* @throws {BusinessError} 1300002 - This window state is abnormal.
* @throws {BusinessError} 1300003 - This window manager service work abnormally.
* @throws {BusinessError} 1300004 - This operation is not access.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @systemapi Hide this for inner system use.
* @since 12
*/
function getSnapshot(windowId: number): Promise<image.PixelMap>;
/**
* Register the callback of systemBarTintChange
*
@ -4428,6 +4555,19 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Sets whether is private mode or not.
*
* @permission ohos.permission.PRIVACY_WINDOW
* @param { boolean } isPrivacyMode in private mode if true, or not if false.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 201 - Permission verification failed.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
setWindowPrivacyMode(isPrivacyMode: boolean): Promise<void>;
/**
@ -4442,6 +4582,19 @@ declare namespace window {
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @since 9
*/
/**
* Sets whether is private mode or not.
*
* @permission ohos.permission.PRIVACY_WINDOW
* @param { boolean } isPrivacyMode in private mode if true, or not if false.
* @param { AsyncCallback<void> } callback Callback used to return the result.
* @throws { BusinessError } 201 - Permission verification failed.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @syscap SystemCapability.WindowManager.WindowManager.Core
* @atomicservice
* @since 12
*/
setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void;
/**
@ -4506,6 +4659,22 @@ declare namespace window {
*/
setWindowTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void;
/**
* Set handwrite flag on the window. This flag means only response handwrite event.
*
* @param { boolean } enable - Add handwrite flag to window if true, or remove flag if false.
* @returns { Promise<void> } - The promise returned by the function.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported on this device.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @systemapi Hide this for inner system use.
* @since 12
*/
setHandwritingFlag(enable: boolean): Promise<void>;
/**
* Sets the flag of the window is forbidden to move in split screen mode
*
@ -5127,6 +5296,23 @@ declare namespace window {
*/
getTitleButtonRect(): TitleButtonRect;
/**
* Set whether to display the maximize, minimize, split buttons of main window.
*
* @param { boolean } isMaximizeVisible - Display maximize button if true, or hide maximize button if false.
* @param { boolean } isMinimizeVisible - Display minimize button if true, or hide minimize button if false.
* @param { boolean } isSplitVisible - Display split button if true, or hide split button if false.
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported on this device.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300004 - Unauthorized operation.
* @syscap SystemCapability.Window.SessionManager
* @systemapi Hide this for inner system use.
* @since 12
*/
setTitleButtonVisible(isMaximizeVisible: boolean, isMinimizeVisible: boolean, isSplitVisible: boolean): void;
/**
* Enable landscape multiWindow
*
@ -5176,7 +5362,52 @@ declare namespace window {
* @since 11
*/
off(type: 'windowTitleButtonRectChange', callback?: Callback<TitleButtonRect>): void;
/**
* Set the window mask of window
*
* @param { Array<Array<number>> } windowMask - The mask of window. The value of the array is 0 and 1, the other number is illegal value.
* @returns { Promise<void> } Promise that returns no value.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported on this device.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @since 12
*/
setWindowMask(windowMask: Array<Array<number>>): Promise<void>;
/**
* Register the callback of windowRectChange
*
* @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event.
* @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
on(type: 'windowRectChange', callback: Callback<RectChangeOptions>): void;
/**
* Unregister the callback of windowRectChange
*
* @param { 'windowRectChange' } type - The value is fixed at 'windowRectChange', indicating the window rect change event.
* @param { Callback<RectChangeOptions> } callback - Callback used to return the RectChangeOptions.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 1300002 - This window state is abnormal.
* @throws { BusinessError } 1300003 - This window manager service works abnormally.
* @syscap SystemCapability.Window.SessionManager
* @atomicservice
* @since 12
*/
off(type: 'windowRectChange', callback?: Callback<RectChangeOptions>): void;
}
/**
* Window stage callback event type
*

61
api/arkui/AttributeUpdater.d.ts vendored Normal file
View File

@ -0,0 +1,61 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/// <reference path="../../component/common.d.ts" />
/**
* Defines a modifier which can update attributes to native side.
*
* @implements AttributeModifier
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @crossplatform
* @since 12
*/
export declare class AttributeUpdater<T> implements AttributeModifier<T> {
/**
* Defines the normal update attribute function.
*
* @param { T } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @crossplatform
* @since 12
*/
applyNormalAttribute?(instance: T): void;
/**
* Defines a function for initialization.
*
* @param { T } instance
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @crossplatform
* @since 12
*/
initializeModifier(instance: T): void;
/**
* Get attribute of the modifier.
*
* @returns { T | undefined } The attribute of the modifier.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @crossplatform
* @since 12
*/
get attribute(): T | undefined;
}

112
api/arkui/BuilderNode.d.ts vendored
View File

@ -33,6 +33,16 @@ import { Size } from './Graphics';
* @crossplatform
* @since 11
*/
/**
* Render type of the node using for indicating that
* if the node will be shown on the display or rendered to a texture
*
* @enum { number } Render type
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
declare enum NodeRenderType {
/**
* Display type.The node will be shown on the display.
@ -41,6 +51,14 @@ declare enum NodeRenderType {
* @crossplatform
* @since 11
*/
/**
* Display type.The node will be shown on the display.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
RENDER_TYPE_DISPLAY = 0,
/**
@ -49,6 +67,13 @@ declare enum NodeRenderType {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Exporting texture type.The node will be render to a texture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
RENDER_TYPE_TEXTURE = 1,
}
@ -60,6 +85,15 @@ declare enum NodeRenderType {
* @crossplatform
* @since 11
*/
/**
* RenderOptions info.
*
* @interface RenderOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface RenderOptions {
/**
* The ideal size of the node.
@ -68,6 +102,14 @@ export interface RenderOptions {
* @crossplatform
* @since 11
*/
/**
* The ideal size of the node.
* @type { ?Size } selfIdealSize - The ideal size of the node
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
selfIdealSize?: Size;
/**
@ -76,6 +118,13 @@ export interface RenderOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Render type of the node.
* @type { ?NodeRenderType } type - Render type of the node
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
type?: NodeRenderType;
/**
@ -84,6 +133,13 @@ export interface RenderOptions {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* The surfaceId of a texture consumer
* @type { ?string } surfaceId - surfaceId of a consumer who can receive the texture of the Node
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
surfaceId?: string;
}
@ -94,6 +150,14 @@ export interface RenderOptions {
* @crossplatform
* @since 11
*/
/**
* Defines BuilderNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class BuilderNode<Args extends Object[]> {
/**
* Constructor.
@ -104,6 +168,16 @@ export class BuilderNode<Args extends Object[]> {
* @crossplatform
* @since 11
*/
/**
* Constructor.
*
* @param { UIContext } uiContext - uiContext used to create the BuilderNode
* @param { RenderOptions } options - Render options of the Builder Node
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(uiContext: UIContext, options?: RenderOptions);
/**
@ -115,6 +189,16 @@ export class BuilderNode<Args extends Object[]> {
* @crossplatform
* @since 11
*/
/**
* Build the BuilderNode with the builder.
*
* @param { WrappedBuilder<Args> } builder - Defined the builder will be called to build the node.
* @param { Object } arg - Defined the args will be used in the builder.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
build(builder: WrappedBuilder<Args>, arg?: Object): void;
/**
@ -125,6 +209,15 @@ export class BuilderNode<Args extends Object[]> {
* @crossplatform
* @since 11
*/
/**
* Update the BuilderNode based on the provided parameters.
*
* @param { Object } arg - Parameters used to update the BuilderNode, which must match the types required by the builder bound to the BuilderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
update(arg: Object): void;
/**
@ -135,6 +228,15 @@ export class BuilderNode<Args extends Object[]> {
* @crossplatform
* @since 11
*/
/**
* Get the FrameNode in BuilderNode.
*
* @returns { FrameNode | null } - Returns a FrameNode inside the BuilderNode, or null if not contained.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getFrameNode(): FrameNode | null;
/**
@ -146,6 +248,16 @@ export class BuilderNode<Args extends Object[]> {
* @crossplatform
* @since 11
*/
/**
* Dispatch touchEvent to targetNode.
*
* @param { TouchEvent } event - The touchEvent which will be sent to the targetNode.
* @returns { boolean } - Returns true if the TouchEvent has been successfully posted to the targetNode, false otherwise.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
postTouchEvent(event: TouchEvent): boolean;
/**

64
api/arkui/ComponentContent.d.ts vendored Normal file
View File

@ -0,0 +1,64 @@
/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
import { UIContext } from '../@ohos.arkui.UIContext';
import { WrappedBuilder } from 'wrappedBuilderObject';
/**
* Defines ComponentContent.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
export class ComponentContent<T extends Object> {
/**
* Constructor.
*
* @param { UIContext } uiContext - uiContext used to create the ComponentContent
* @param { WrappedBuilder<[]> } builder - Defined the builder will be called to build ComponentContent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
constructor(uiContext: UIContext, builder: WrappedBuilder<[]>);
/**
* Constructor.
*
* @param { UIContext } uiContext - uiContext used to create the ComponentContent
* @param { WrappedBuilder<[T]> } builder - Defined the builder will be called to build ComponentContent.
* @param { T } args - Parameters used to update the ComponentContent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
constructor(uiContext: UIContext, builder: WrappedBuilder<[T]>, args: T);
/**
* Update the ComponentContent based on the provided parameters.
*
* @param { T } args - Parameters used to update the ComponentContent, which must match the types required by the builder bound to the ComponentContent.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
update(args: T): void;
}

26
api/arkui/FrameNode.d.ts vendored
View File

@ -30,6 +30,14 @@ import { CommonAttribute } from 'commonAttribute';
* @crossplatform
* @since 11
*/
/**
* Defines FrameNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class FrameNode {
/**
* Constructor.
@ -39,6 +47,15 @@ export class FrameNode {
* @crossplatform
* @since 11
*/
/**
* Constructor.
*
* @param { UIContext } uiContext - uiContext used to create the FrameNode
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(uiContext: UIContext);
/**
@ -49,6 +66,15 @@ export class FrameNode {
* @crossplatform
* @since 11
*/
/**
* Get the RenderNode in FrameNode.
*
* @returns { RenderNode | null } - Returns a RenderNode inside the FrameNode, or null if not contained.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getRenderNode(): RenderNode | null;
/**

203
api/arkui/Graphics.d.ts vendored
View File

@ -30,6 +30,15 @@ import { BorderStyle } from 'borderStyle'
* @crossplatform
* @since 11
*/
/**
* Size info.
*
* @interface Size
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export interface Size {
/**
* Get the width of the Size.
@ -39,6 +48,15 @@ export interface Size {
* @crossplatform
* @since 11
*/
/**
* Get the width of the Size.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width: number;
/**
@ -49,6 +67,15 @@ export interface Size {
* @crossplatform
* @since 11
*/
/**
* Get the height of the Size.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height: number;
}
@ -59,6 +86,14 @@ export interface Size {
* @crossplatform
* @since 11
*/
/**
* Defines DrawContext.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class DrawContext {
/**
@ -69,6 +104,15 @@ export class DrawContext {
* @crossplatform
* @since 11
*/
/**
* Get size of the DrawContext.
*
* @returns { Size } The size of the DrawContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get size(): Size;
/**
@ -79,6 +123,15 @@ export class DrawContext {
* @crossplatform
* @since 11
*/
/**
* Get canvas of the DrawContext.
*
* @returns { drawing.Canvas } The canvas of the DrawContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get canvas(): drawing.Canvas;
}
@ -90,6 +143,15 @@ export class DrawContext {
* @crossplatform
* @since 11
*/
/**
* Defined a vector with two values.
*
* @interface Vector2
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
interface Vector2 {
/**
* Value for x-axis of the vector.
@ -99,6 +161,15 @@ interface Vector2 {
* @crossplatform
* @since 11
*/
/**
* Value for x-axis of the vector.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
x: number
/**
@ -109,6 +180,15 @@ interface Vector2 {
* @crossplatform
* @since 11
*/
/**
* Value for y-axis of the vector.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
y: number
}
@ -129,6 +209,15 @@ interface Vector3 {
* @crossplatform
* @since 11
*/
/**
* Value for x-axis of the vector.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
x: number;
/**
@ -139,6 +228,15 @@ interface Vector3 {
* @crossplatform
* @since 11
*/
/**
* Value for y-axis of the vector.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
y: number;
/**
@ -149,6 +247,15 @@ interface Vector3 {
* @crossplatform
* @since 11
*/
/**
* Value for z-axis of the vector.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
z: number;
}
@ -159,6 +266,14 @@ interface Vector3 {
* @crossplatform
* @since 11
*/
/**
* It's a 4x4 matrix, represent by number[].
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Matrix4 = [
number,
number,
@ -185,6 +300,14 @@ export type Matrix4 = [
* @crossplatform
* @since 11
*/
/**
* Offset info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Offset = Vector2;
/**
@ -203,6 +326,14 @@ export type Position = Vector2;
* @crossplatform
* @since 11
*/
/**
* Pivot info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Pivot = Vector2;
/**
@ -212,6 +343,14 @@ export type Pivot = Vector2;
* @crossplatform
* @since 11
*/
/**
* Scale info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Scale = Vector2;
/**
@ -221,6 +360,14 @@ export type Scale = Vector2;
* @crossplatform
* @since 11
*/
/**
* Translation info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Translation = Vector2;
/**
@ -230,6 +377,14 @@ export type Translation = Vector2;
* @crossplatform
* @since 11
*/
/**
* Rotation info.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export type Rotation = Vector3;
/**
@ -240,6 +395,15 @@ export type Rotation = Vector3;
* @crossplatform
* @since 11
*/
/**
* Frame info, include the position info and size info.
*
* @interface Frame
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export declare interface Frame {
/**
* Position value for x-axis of the frame info.
@ -249,6 +413,15 @@ export declare interface Frame {
* @crossplatform
* @since 11
*/
/**
* Position value for x-axis of the frame info.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
x: number;
/**
@ -259,6 +432,15 @@ export declare interface Frame {
* @crossplatform
* @since 11
*/
/**
* Position value for y-axis of the frame info.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
y: number;
/**
@ -269,6 +451,15 @@ export declare interface Frame {
* @crossplatform
* @since 11
*/
/**
* Size value for width of the frame info.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
width: number;
/**
@ -279,6 +470,15 @@ export declare interface Frame {
* @crossplatform
* @since 11
*/
/**
* Size value for height of the frame info.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
height: number;
}
@ -570,6 +770,7 @@ export declare class ShapeMask {
* The fill color of the ShapeMask.
*
* @type { number }
* @default 0XFF000000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
@ -580,6 +781,7 @@ export declare class ShapeMask {
* The stroke color of the ShapeMask.
*
* @type { number }
* @default 0XFF000000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
@ -590,6 +792,7 @@ export declare class ShapeMask {
* The stroke width of the ShapeMask.
*
* @type { number }
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12

63
api/arkui/NodeController.d.ts vendored
View File

@ -31,6 +31,15 @@ import { Size } from './Graphics';
* @crossplatform
* @since 11
*/
/**
* Defined the controller of node container.Provides lifecycle callbacks for the associated NodeContainer
* and methods to control the child node of the NodeContainer.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export abstract class NodeController {
/**
* MakeNode Method. Used to build a node tree and return the a FrameNode or null, and
@ -43,6 +52,18 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* MakeNode Method. Used to build a node tree and return the a FrameNode or null, and
* attach the return result to the associated NodeContainer.
* Executed when the associated NodeContainer is created or the rebuild function is called.
*
* @param { UIContext } uiContext - uiContext used to makeNode
* @returns { FrameNode | null } - Returns a FrameNode or null.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
abstract makeNode(uiContext: UIContext): FrameNode | null;
/**
@ -53,6 +74,15 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* AboutToResize Method. Executed when the associated NodeContainer performs the measure method.
*
* @param { Size } size - size used to resize
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
aboutToResize?(size: Size): void;
/**
@ -62,6 +92,14 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* AboutToAppear Method. Executed when the associated NodeContainer is aboutToAppear.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
aboutToAppear?(): void;
/**
@ -71,6 +109,14 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* AboutToDisappear Method. Executed when the associated NodeContainer is aboutToDisappear.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
aboutToDisappear?(): void;
/**
@ -80,6 +126,14 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* Rebuild Method. Used to re invoke the makeNode method.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
rebuild(): void;
/**
@ -90,5 +144,14 @@ export abstract class NodeController {
* @crossplatform
* @since 11
*/
/**
* OnTouchEvent Method. Executed when associated NodeContainer is touched.
*
* @param { TouchEvent } event - The TouchEvent when associated NodeContainer is touched.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onTouchEvent?(event: TouchEvent): void;
}

407
api/arkui/RenderNode.d.ts vendored
View File

@ -27,6 +27,14 @@ import { DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4
* @crossplatform
* @since 11
*/
/**
* Defines RenderNode. Contains node tree operations and render property operations on node.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
export class RenderNode {
/**
* Constructor.
@ -35,6 +43,14 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Constructor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
/**
@ -45,6 +61,15 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Add child to the end of the RenderNode's children.
*
* @param { RenderNode } node - The node will be added.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
appendChild(node: RenderNode): void;
/**
@ -56,6 +81,16 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Add child to the current RenderNode.
*
* @param { RenderNode } child - The node will be added.
* @param { RenderNode | null } sibling - The new node is added after this node. When sibling is null, insert node as the first children of the node.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
insertChildAfter(child: RenderNode, sibling: RenderNode | null): void;
/**
@ -66,6 +101,15 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Remove child from the current RenderNode.
*
* @param { RenderNode } node - The node will be removed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
removeChild(node: RenderNode): void;
/**
@ -75,6 +119,14 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Clear children of the current RenderNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
clearChildren(): void;
/**
@ -86,6 +138,16 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Get a child of the current RenderNode by index.
*
* @param { number } index - The index of the desired node in the children of RenderNode.
* @returns { RenderNode | null } - Returns a RenderNode. When the required node does not exist, returns null.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getChild(index: number): RenderNode | null;
/**
@ -97,6 +159,16 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Get the first child of the current RenderNode.
*
* @returns { RenderNode | null } - Returns a RenderNode, which is first child of the current RenderNode.
* If current RenderNode does not have child node, returns null.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getFirstChild(): RenderNode | null;
/**
@ -107,15 +179,33 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Get the next sibling node of the current RenderNode.
*
* @returns { RenderNode | null } - Returns a RenderNode. If current RenderNode does not have next sibling node, returns null.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
getNextSibling(): RenderNode | null;
/**
* Get the previous sibling node of the current RenderNode. If current RenderNode does not have previous sibling node, returns null.
*
* @returns { RenderNode | null } - Returns a RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get the previous sibling node of the current RenderNode.
*
* @returns { RenderNode | null } - Returns a RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
* @atomicservice
* @since 12
*/
getPreviousSibling(): RenderNode | null;
@ -127,16 +217,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set the background color of the RenderNode.
*
* @param { number } color - The background color. Colors are defined as ARGB format represented by number.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set backgroundColor(color: number);
/**
* Get the background color of the RenderNode.
*
* @returns { number } - Returns a background color. Colors are defined as ARGB format represented by number.
* @default 0X00000000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get the background color of the RenderNode.
*
* @returns { number } - Returns a background color. Colors are defined as ARGB format represented by number.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get backgroundColor(): number;
/**
@ -147,16 +256,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set whether the RenderNode clip to frame.
*
* @param { boolean } useClip - Whether the RenderNode clip to frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set clipToFrame(useClip: boolean);
/**
* Get whether the RenderNode clip to frame.
*
* @returns { boolean } - Returns whether the RenderNode clip to frame.
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get whether the RenderNode clip to frame.
*
* @returns { boolean } - Returns whether the RenderNode clip to frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get clipToFrame(): boolean;
/**
@ -167,16 +295,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set opacity of the RenderNode.
*
* @param { number } value - The opacity of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set opacity(value: number);
/**
* Get opacity of the RenderNode.
*
* @returns { number } Returns the opacity of the RenderNode.
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get opacity of the RenderNode.
*
* @returns { number } Returns the opacity of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get opacity(): number;
/**
@ -187,16 +334,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set frame size of the RenderNode.
*
* @param { Size } size - The size of the RenderNode frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set size(size: Size);
/**
* Get frame size of the RenderNode.
*
* @returns { Size } The size of the RenderNode frame.
* @default Size { width: 0, height: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get frame size of the RenderNode.
*
* @returns { Size } The size of the RenderNode frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get size(): Size;
/**
@ -213,10 +379,20 @@ export class RenderNode {
* Get frame position of the RenderNode.
*
* @returns { Position } - The position of the RenderNode frame.
* @default Position { x: 0, y: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get frame position of the RenderNode.
*
* @returns { Position } - The position of the RenderNode frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get position(): Position;
/**
@ -227,16 +403,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set frame info of the RenderNode.
*
* @param { Frame } frame - The frame info of the RenderNode frame.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set frame(frame: Frame);
/**
* Get frame info of the RenderNode.
*
* @returns { Frame } - Returns frame info of the RenderNode.
* @default Frame { x: 0, y: 0, width: 0, height: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get frame info of the RenderNode.
*
* @returns { Frame } - Returns frame info of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get frame(): Frame;
/**
@ -247,16 +442,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set pivot of the RenderNode.
*
* @param { Pivot } pivot - The pivot of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set pivot(pivot: Pivot);
/**
* Get pivot vector of the RenderNode.
*
* @returns { Pivot } - Returns pivot vector of the RenderNode.
* @default Pivot { x: 0.5, y: 0.5 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get pivot vector of the RenderNode.
*
* @returns { Pivot } - Returns pivot vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get pivot(): Pivot;
/**
@ -267,16 +481,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set scale of the RenderNode.
*
* @param { Scale } scale - The scale of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set scale(scale: Scale);
/**
* Get scale vector of the RenderNode.
*
* @returns { Scale } - Returns scale vector of the RenderNode.
* @default Scale { x: 1, y: 1 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get scale vector of the RenderNode.
*
* @returns { Scale } - Returns scale vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get scale(): Scale;
/**
@ -287,16 +520,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set translation of the RenderNode.
*
* @param { Translation } translation - the translate vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set translation(translation: Translation);
/**
* Get translation vector of the RenderNode.
*
* @returns { Translation } - Returns translation vector of the RenderNode.
* @default Translation { x: 0, y: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get translation vector of the RenderNode.
*
* @returns { Translation } - Returns translation vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get translation(): Translation;
/**
@ -307,16 +559,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set rotation vector of the RenderNode.
*
* @param { Rotation } rotation - The rotation vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set rotation(rotation: Rotation);
/**
* Get rotation vector of the RenderNode.
*
* @returns { Rotation } - Returns rotation vector of the RenderNode.
* @default Rotation { x: 0, y: 0, z: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get rotation vector of the RenderNode.
*
* @returns { Rotation } - Returns rotation vector of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get rotation(): Rotation;
/**
@ -327,16 +598,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set transform info of the RenderNode.
*
* @param { Matrix4 } transform - the transform info of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set transform(transform: Matrix4);
/**
* Get transform info of the RenderNode.
*
* @returns {Matrix4 } - Returns transform info of the RenderNode.
* @default Matrix4 [ 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 ]
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get transform info of the RenderNode.
*
* @returns {Matrix4 } - Returns transform info of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get transform(): Matrix4;
/**
@ -347,16 +637,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set shadow color of the RenderNode.
*
* @param { number } color - the shadow color of the RenderNode. Colors are defined as ARGB format represented by number.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set shadowColor(color: number);
/**
* Get shadow color of the RenderNode.
*
* @returns { number } - Returns the shadow color of the RenderNode. Colors are defined as ARGB format represented by number.
* @default 0X00000000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get shadow color of the RenderNode.
*
* @returns { number } - Returns the shadow color of the RenderNode. Colors are defined as ARGB format represented by number.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get shadowColor(): number;
/**
@ -367,16 +676,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set shadow offset of the RenderNode.
*
* @param { Offset } offset - the shadow offset of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set shadowOffset(offset: Offset);
/**
* Get shadow offset of the RenderNode.
*
* @returns { Offset } - Returns the shadow offset of the RenderNode.
* @default Offset { x: 0, y: 0 }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get shadow offset of the RenderNode.
*
* @returns { Offset } - Returns the shadow offset of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get shadowOffset(): Offset;
/**
@ -387,16 +715,35 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set shadow alpha of the RenderNode.
*
* @param { number } alpha - the shadow alpha of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set shadowAlpha(alpha: number);
/**
* Get shadow alpha of the RenderNode.
*
* @returns { number } - Returns the shadow alpha of the RenderNode.
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get shadow alpha of the RenderNode.
*
* @returns { number } - Returns the shadow alpha of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get shadowAlpha(): number;
/**
@ -407,26 +754,55 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Set shadow elevation of the RenderNode.
*
* @param { number } elevation - the shadow elevation of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set shadowElevation(elevation: number);
/**
* Get shadow elevation of the RenderNode.
*
* @returns { number } - Returns the shadow elevation of the RenderNode.
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Get shadow elevation of the RenderNode.
*
* @returns { number } - Returns the shadow elevation of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get shadowElevation(): number;
/**
* Set shadow radius of the RenderNode.
*
* @param { number } radius - the shadow radius of the RenderNode.
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 11
*/
/**
* Set shadow radius of the RenderNode.
*
* @param { number } radius - the shadow radius of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
set shadowRadius(radius: number);
/**
@ -437,6 +813,15 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Get shadow radius of the RenderNode.
*
* @returns { number } - Returns the shadow radius of the RenderNode.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
get shadowRadius(): number;
/**
@ -473,6 +858,7 @@ export class RenderNode {
* Get border width of the RenderNode.
*
* @returns { Edges<number> } - Returns the border width of the RenderNode.
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
@ -493,6 +879,7 @@ export class RenderNode {
* Get border color of the RenderNode.
*
* @returns { Edges<number> } - Returns the border color of the RenderNode.
* @default 0XFF000000
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
@ -513,6 +900,7 @@ export class RenderNode {
* Get border radius of the RenderNode.
*
* @returns { BorderRadiuses } - Returns the border radius of the RenderNode.
* @default 0
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
@ -547,6 +935,15 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Draw Method. Executed when the associated RenderNode is onDraw.
*
* @param { DrawContext } context - The DrawContext will be used when executed draw method.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
draw(context: DrawContext): void;
/**
@ -556,6 +953,14 @@ export class RenderNode {
* @crossplatform
* @since 11
*/
/**
* Invalidate the RenderNode, which will cause a re-render of the RenderNode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
invalidate(): void;
/**

3
api/device-define/default.json
View File

@ -213,6 +213,7 @@
"SystemCapability.Graphic.Graphic2D.NativeImage",
"SystemCapability.Graphic.Graphic2D.NativeVsync",
"SystemCapability.Graphic.Vulkan",
"SystemCapability.Multimedia.Image.ImageCreator"
"SystemCapability.Multimedia.Image.ImageCreator",
"SystemCapability.Ability.AppStartup"
]
}

3
api/device-define/tablet.json
View File

@ -205,6 +205,7 @@
"SystemCapability.Graphic.Graphic2D.NativeVsync",
"SystemCapability.Graphic.Vulkan",
"SystemCapability.Multimedia.Image.ImageCreator",
"SystemCapability.Graphic.Graphic2D.WebGL2"
"SystemCapability.Graphic.Graphic2D.WebGL2",
"SystemCapability.Ability.AppStartup"
]
}

Some files were not shown because too many files have changed in this diff Show More