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

Merge remote-tracking branch 'upstream/master'

Browse Source
This commit is contained in:
王海龙 2024-04-06 11:17:24 +08:00
commit fd9865909e
753 changed files with 112379 additions and 75864 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
BUILD.gn
View File

@ -50,6 +50,13 @@ ohos_copy("bundle_kits") {
module_install_name = ""
}
ohos_copy("bundle_arkts") {
sources = [ "//interface/sdk-js/arkts" ]
outputs = [ target_out_dir + "/$target_name" ]
module_source_dir = target_out_dir + "/$target_name"
module_install_name = ""
}
ohos_copy_internal("ets_internal_api") {
iv_input = "//interface/sdk-js/api/@internal/ets"
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provide an interface for the ability component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The information of sheet.
*
@ -118,23 +123,23 @@ interface SheetInfo {
}
/**
* Component dialog dismiss
* Component dialog dismiss action.
*
* @interface DismissDialog
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface DismissDialog {
declare interface DismissDialogAction {
/**
* Defines dialog dismiss function.
*
* @type { function }
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
dismiss: () => void;
dismiss: Callback<void>;
/**
* Dismiss reason type.
@ -535,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;
/**
@ -545,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;
/**
@ -556,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;
/**
@ -567,17 +601,107 @@ 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;
/**
* Callback function when the actionSheet interactive dismiss
*
* @type { ?function }
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onWillDismiss?: (dismissDialog: DismissDialog) => void;
onWillDismiss?: Callback<DismissDialogAction>;
/**
* Transition parameters of opening/closing ActionSheet.
*
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
transition?: TransitionEffect;
/**
* Defines the actionSheet's corner radius.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
cornerRadius?: Dimension | BorderRadiuses;
/**
* Defines the actionSheet's width.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
width?: Dimension;
/**
* Defines the actionSheet's height.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
height?: Dimension;
/**
* Defines the actionSheet's border width.
*
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderWidth?: Dimension | EdgeWidths;
/**
* Defines the actionSheet's border color.
*
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderColor?: ResourceColor | EdgeColors;
/**
* Defines the actionSheet's border style.
*
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
/**
* Defines the actionSheet's shadow.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The alignment of dialog,
*
@ -749,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;
/**
@ -759,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;
/**
@ -770,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;
/**
@ -781,17 +815,107 @@ 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;
/**
* Callback function when the dialog interactive dismiss
*
* @type { ?function }
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onWillDismiss?: (dismissDialog: DismissDialog) => void;
onWillDismiss?: Callback<DismissDialogAction>;
/**
* Transition parameters of opening/closing AlertDialog.
*
* @type { ?TransitionEffect }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
transition?: TransitionEffect;
/**
* Defines the alertDialog's corner radius.
*
* @type { ?(Dimension | BorderRadiuses) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
cornerRadius?: Dimension | BorderRadiuses;
/**
* Defines the alertDialog's width.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
width?: Dimension;
/**
* Defines the alertDialog's height.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
height?: Dimension;
/**
* Defines the alertDialog's border width.
*
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderWidth?: Dimension | EdgeWidths;
/**
* Defines the alertDialog's border color.
*
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderColor?: ResourceColor | EdgeColors;
/**
* Defines the alertDialog's border style.
*
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
/**
* Defines the alertDialog's shadow.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
}
/**
@ -1008,23 +1132,23 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam {
}
/**
* Component dialog dismiss
* Component dialog dismiss action.
*
* @interface DismissDialog
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface DismissDialog {
declare interface DismissDialogAction {
/**
* Defines dialog dismiss function.
*
* @type { function }
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
dismiss: () => void;
dismiss: Callback<void>;
/**
* Dismiss reason type.

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* indexer align property.
*
@ -753,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;
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Customize spring properties.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the badge position property.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Create Blank.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides a button component.
*
@ -154,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).
@ -163,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,
/**
@ -173,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,
/**
@ -183,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,
}
@ -226,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.
@ -235,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',
/**
@ -245,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',
}
@ -365,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;
/**
@ -377,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;
/**
@ -806,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;
/**
@ -818,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;
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides a monthly view component to display information such as date, shift break, and schedule.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The type of alignment between entry and calendar.
* @enum {number}
@ -312,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;
/**
@ -323,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;
/**

116
api/@internal/component/ets/canvas.d.ts vendored
View File

@ -13,6 +13,20 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Import the drawing canvas type object for Canvas.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Canvas;
/**
* Filling style algorithm, which determines whether a point is within or outside the path. The following
* two configurations are supported:
@ -5060,6 +5074,25 @@ declare class CanvasRenderingContext2D extends CanvasRenderer {
*/
toDataURL(type?: string, quality?: any): string;
/**
* Start image analyzer.
*
* @param { ImageAnalyzerConfig } config - Image analyzer config.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 110001 - Image analysis feature is not supported.
* @throws { BusinessError } 110002 - Image analysis is currently being executed.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
startImageAnalyzer(config: ImageAnalyzerConfig): Promise<void>;
/**
* Stop image analyzer.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
stopImageAnalyzer(): void;
/**
* Constructor of the canvas drawing context object, which is used to create a drawing context object.
*
@ -5469,6 +5502,66 @@ declare class OffscreenCanvas {
constructor(width: number, height: number);
}
/**
* Size info.
*
* @interface Size
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface Size {
/**
* Defines the width property.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
width: number;
/**
* Defines the height property.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
height: number;
}
/**
* Defines DrawingRenderingContext.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare class DrawingRenderingContext {
/**
* Get size of the DrawingRenderingContext.
*
* @returns { Size } The size of the DrawingRenderingContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
get size(): Size;
/**
* Get canvas of the DrawingRenderingContext.
*
* @returns { DrawingCanvas } The canvas of the DrawingRenderingContext.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
get canvas(): DrawingCanvas;
}
/**
*TextTimer component, which provides the text timer capability.
*
@ -5542,7 +5635,18 @@ interface CanvasInterface {
* @since 11
* @form
*/
(context?: CanvasRenderingContext2D): CanvasAttribute;
/**
* Construct a canvas component.
*
* @param { CanvasRenderingContext2D | DrawingRenderingContext } context - Canvas context object.
* @returns { CanvasAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
(context?: CanvasRenderingContext2D | DrawingRenderingContext): CanvasAttribute;
}
/**
@ -5619,6 +5723,16 @@ declare class CanvasAttribute extends CommonMethod<CanvasAttribute> {
* @form
*/
onReady(event: () => void): CanvasAttribute;
/**
* Enable image analyzer for Canvas.
*
* @param { boolean } enable
* @returns { CanvasAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
enableAnalyzer(enable: boolean): CanvasAttribute;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the options of Checkbox.
*
@ -119,6 +124,16 @@ declare interface CheckboxOptions {
* @form
*/
group?: string;
/**
* Custom builder function.
*
* @type { ?CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
indicatorBuilder?: CustomBuilder;
}
/**
@ -326,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;
/**

17
api/@internal/component/ets/checkboxgroup.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* CheckboxGroup SelectStatus
*
@ -594,6 +599,18 @@ declare class CheckboxGroupAttribute extends CommonMethod<CheckboxGroupAttribute
* @form
*/
onChange(callback: (event: CheckboxGroupResult) => void): CheckboxGroupAttribute;
/**
* Setting the shape of checkbox group.
*
* @param { CheckBoxShape } value - The configuration of checkbox group shape.
* @returns { CheckboxGroupAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
checkboxShape(value: CheckBoxShape): CheckboxGroupAttribute;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines circle options for Circle component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the Column Component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the ColumnSplit component.
*

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

File diff suppressed because it is too large Load Diff

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* AppStorage singleton is sub-class of see LocalStorage for
* UI state of app-wide access and same life cycle as the app.

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The enum of model type
* @enum { number }

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Span container interface.
*
@ -21,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.
@ -30,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;
}
@ -40,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.
@ -50,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;
}
@ -60,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;
/**
@ -69,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;

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines Close contextMenu.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Counter component, which provides corresponding increment or decrement counting operations.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the options of CustomDialogController.
*
@ -334,7 +339,7 @@ declare interface CustomDialogControllerOptions {
* @since 11
*/
backgroundColor?: ResourceColor;
/**
* Corner radius of dialog.
*
@ -362,38 +367,107 @@ declare interface CustomDialogControllerOptions {
* @crossplatform
* @since 11
*/
isModal?: boolean;
/**
* Whether it is a modal dialog
* @type { ?boolean }
* @default true
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
isModal?: boolean;
/**
* Callback function when the CustomDialog interactive dismiss.
*
* @type { ?function }
* @type { ?Callback<DismissDialogAction> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onWillDismiss?: (dismissDialog: DismissDialog) => void;
onWillDismiss?: Callback<DismissDialogAction>;
/**
* Defines the custom dialog's width.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
width?: Dimension;
/**
* Defines the custom dialog's height.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
height?: Dimension;
/**
* Defines the custom dialog's border width.
*
* @type { ?(Dimension | EdgeWidths) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderWidth?: Dimension | EdgeWidths;
/**
* Defines the custom dialog's border color.
*
* @type { ?(ResourceColor | EdgeColors) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderColor?: ResourceColor | EdgeColors;
/**
* Defines the custom dialog's border style.
*
* @type { ?(BorderStyle | EdgeStyles) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
borderStyle?: BorderStyle | EdgeStyles;
/**
* Defines the custom dialog's shadow.
*
* @type { ?(ShadowOptions | ShadowStyle) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
shadow?: ShadowOptions | ShadowStyle;
}
/**
* Component dialog dismiss
* Component dialog dismiss action.
*
* @interface DismissDialog
* @interface DismissDialogAction
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface DismissDialog {
declare interface DismissDialogAction {
/**
* Defines dialog dismiss function
*
* @type { function }
* @type { Callback<void> }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
dismiss: () => void;
dismiss: Callback<void>;
/**
* Dismiss reason type.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* DataPanelType enum
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the struct of DatePickerResult.
*
@ -744,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;
/**
@ -755,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;
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides a divider component to separate different content blocks/content elements.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides an Effect Component, which is invisible, but setting properties on this component defines an effect template
* that child components can apply by setting useEffect(true).

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Ellipse drawing.
*

6
api/@internal/component/ets/embedded_component.d.ts vendored
View File

@ -12,6 +12,12 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/// <reference path="../../../../api/@internal/component/ets/common.d.ts" />
/// <reference path="../../../../api/@internal/component/ets/enums.d.ts" />

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* common enum of the checkbox shape
*
@ -22,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.
@ -31,6 +46,15 @@ declare enum CheckBoxShape {
* @since 11
* @form
*/
/**
* Circle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
CIRCLE = 0,
/**
@ -41,6 +65,15 @@ declare enum CheckBoxShape {
* @since 11
* @form
*/
/**
* Rounded Square.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
ROUNDED_SQUARE = 1,
}
@ -500,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',
/**
@ -509,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',
}
@ -7338,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
@ -7346,6 +7404,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target start position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
START = 'Start',
/**
@ -7355,6 +7421,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target center position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CENTER = 'Center',
/**
@ -7364,6 +7438,14 @@ declare enum ArrowPointPosition {
* @crossplatform
* @since 11
*/
/**
* Target end position
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
END = 'End',
}
@ -7481,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,
}
@ -8815,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.
@ -8823,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,
/**
@ -8832,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,
/**
@ -8841,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,
}
@ -8851,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' {
@ -8868,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.
@ -8876,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',
/**
@ -8885,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',
}
@ -8955,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.
@ -8963,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.
@ -8971,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.
@ -8979,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.
@ -8987,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,
}
@ -9049,6 +9247,34 @@ declare enum EmbeddedType {
EMBEDDED_UI_EXTENSION = 0,
}
/**
* Marquee scrolling strategy after text update
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare enum MarqueeUpdateStrategy {
/**
* Reset scroll position and restart scroll.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
DEFAULT = 0,
/**
* Preserve scroll position, just change to new text
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
PRESERVE_POSITION = 1
}
declare module 'borderStyle' {
module 'borderStyle' {
// @ts-ignore

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the options of Flex.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Mesh container for static fixed-size layout scenarios.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Import the WindowMode type object for onHoverStatusChange.
*
@ -29,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 {
/**
@ -40,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;
}
@ -50,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.
@ -60,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;
/**
@ -70,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: {
/**
@ -103,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;
/**
@ -114,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;
}
@ -168,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;
/**
@ -177,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;

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* looping function.
*

188
api/@internal/component/ets/form_component.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the FormDimension enum.
*
@ -76,6 +81,15 @@ declare enum FormDimension {
* @since 11
*/
DIMENSION_1_1 = 6,
/**
* 6 x 4 cards
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
DIMENSION_6_4,
}
/**
@ -107,6 +121,106 @@ declare enum FormRenderingMode {
SINGLE_COLOR,
}
/**
* Defines the FormInfo.
*
* @interface FormInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
declare interface FormInfo {
/**
* The id the form.
*
* @type { number | string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
id: number | string;
/**
* The name of the form.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
name: string;
/**
* The bundle of the form.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
bundle: string;
/**
* The ability of the form.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
ability: string;
/**
* The module of the form.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
module: string;
/**
* The dimension of the form.
*
* @type { ?FormDimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
dimension?: FormDimension;
/**
* Whether the form is temporary.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
temporary?: boolean;
/**
* The want of the form.
*
* @type { ?import('../api/@ohos.app.ability.Want').default }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
want?: import('../api/@ohos.app.ability.Want').default;
/**
* The renderingMode of the form.
*
* @type { ?FormRenderingMode }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
renderingMode?: FormRenderingMode;
}
/**
* Defines the FormComponent.
*
@ -152,17 +266,46 @@ interface FormComponentInterface {
* @systemapi
* @since 11
*/
(value: {
id: number;
name: string;
bundle: string;
ability: string;
module: string;
dimension?: FormDimension;
temporary?: boolean;
want?: import('../api/@ohos.app.ability.Want').default;
renderingMode?: FormRenderingMode;
}): FormComponentAttribute;
/**
* Set a new value of form info.
*
* @param { FormInfo } value
* @returns { FormComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
(value: FormInfo): FormComponentAttribute;
}
/**
* Defines the FormCallbackInfo.
*
* @interface FormCallbackInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
interface FormCallbackInfo {
/**
* The id of the form.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
id: number;
/**
* The string id of the form.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
idString: string;
}
/**
@ -237,7 +380,17 @@ declare class FormComponentAttribute extends CommonMethod<FormComponentAttribute
* @systemapi
* @since 7
*/
onAcquired(callback: (info: { id: number }) => void): FormComponentAttribute;
/**
* This function is triggered after card information is obtained.
* For details about the form information, see the definition of the original capability subsystem.
*
* @param { Callback<FormCallbackInfo> } callback
* @returns { FormComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
onAcquired(callback: Callback<FormCallbackInfo>): FormComponentAttribute;
/**
* Card loading error.
@ -270,7 +423,16 @@ declare class FormComponentAttribute extends CommonMethod<FormComponentAttribute
* @systemapi
* @since 7
*/
onUninstall(callback: (info: { id: number }) => void): FormComponentAttribute;
/**
* Uninstall Card.
*
* @param { Callback<FormCallbackInfo> } callback
* @returns { FormComponentAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @since 12
*/
onUninstall(callback: Callback<FormCallbackInfo>): FormComponentAttribute;
/**
* Card to be loaded.

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the FormLink options.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the Gauge component.
*
@ -105,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 {}
/**
@ -115,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 {
/**
@ -126,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;
/**
@ -137,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;
}
@ -376,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;
/**
@ -387,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;
/**
@ -398,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;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Creating an Object
*
@ -516,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.
@ -524,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,
/**
@ -533,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,
}
@ -553,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.
@ -561,6 +600,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* TapGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
TAP_GESTURE = 0,
/**
@ -570,6 +617,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* LongPressGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
LONG_PRESS_GESTURE = 1,
/**
@ -579,6 +634,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* PanGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PAN_GESTURE = 2,
/**
@ -588,6 +651,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* PinchGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PINCH_GESTURE = 3,
/**
@ -597,6 +668,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* SwipeGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
SWIPE_GESTURE = 4,
/**
@ -606,6 +685,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* RotationGesture.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
ROTATION_GESTURE = 5,
/**
@ -615,6 +702,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* Drag.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
DRAG = 6,
/**
@ -624,6 +719,14 @@ declare namespace GestureControl {
* @crossplatform
* @since 11
*/
/**
* Click.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
CLICK = 7,
}
}
@ -636,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.
@ -645,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;
/**
@ -655,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;
/**
@ -665,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;
}
@ -822,6 +961,28 @@ interface FingerInfo {
* @since 11
*/
localY: number;
/**
* X coordinate of the touch point relative to the left edge of the device screen.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
displayX: number;
/**
* Y coordinate of the touch point relative to the upper edge of the device screen.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
displayY: number;
}
/**
@ -862,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.
@ -871,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[];
}
@ -882,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 {
}
@ -893,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.
@ -902,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;
}
@ -913,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.
@ -923,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;
/**
@ -934,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;
/**
@ -943,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;
/**
@ -952,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;
/**
@ -961,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;
}
@ -972,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.
@ -981,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;
/**
@ -992,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;
/**
@ -1003,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;
}
@ -1014,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.
@ -1024,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;
}
@ -1035,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.
@ -1045,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;
/**
@ -1056,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;
}
@ -1436,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;
}
/**
@ -2650,4 +3006,3 @@ declare const RotationGesture: RotationGestureInterface;
* @since 11
*/
declare const GestureGroup: GestureGroupInterface;

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The options to help grid layout
*
@ -101,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]
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the grid item style.
*
@ -21,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.
@ -29,6 +43,14 @@ declare enum GridItemStyle {
* @crossplatform
* @since 11
*/
/**
* Show none style.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NONE = 0,
/**
@ -38,6 +60,14 @@ declare enum GridItemStyle {
* @crossplatform
* @since 11
*/
/**
* Show plain style.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
PLAIN = 1,
}
@ -49,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.
@ -58,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;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the option in number unit of grid-container child component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the size type.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the option in length unit of grid-row component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the hyperlink interface.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Use the DrawableDescriptor class to get drawable image.
*
@ -28,6 +33,17 @@
*/
declare type DrawableDescriptor = import ('../api/@ohos.arkui.drawableDescriptor').DrawableDescriptor;
/**
* Import the DrawingColorFilter type object for image color filter setting.
*
* @typedef DrawingColorFilter
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').default.ColorFilter;
/**
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
@ -849,7 +865,18 @@ declare class ImageAttribute extends CommonMethod<ImageAttribute> {
* @since 11
* @form
*/
colorFilter(value: ColorFilter): ImageAttribute;
/**
* Sets the color filter effect on the image.
*
* @param { ColorFilter | DrawingColorFilter } value ColorFilter object.
* @returns { ImageAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
* @form
*/
colorFilter(value: ColorFilter | DrawingColorFilter): ImageAttribute;
/**
* Allow replication.
@ -1325,6 +1352,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;
/**
@ -1347,6 +1383,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;
}
@ -1546,6 +1592,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.
@ -1555,5 +1610,14 @@ declare interface ResizableOptions {
* @crossplatform
* @since 11
*/
/**
* Image slice widths.
*
* @type { ?EdgeWidths }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
slice?: EdgeWidths;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the ImageAnimator Interface.
*
@ -129,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
*

38
api/@internal/component/ets/image_common.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the image analyze type.
*
@ -21,6 +26,13 @@
* @systemapi
* @since 11
*/
/**
* Defines the image analyze type.
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
declare enum ImageAnalyzerType {
/**
* Image analyze type subject.
@ -29,6 +41,12 @@ declare enum ImageAnalyzerType {
* @systemapi
* @since 11
*/
/**
* Image analyze type subject.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
SUBJECT = 0,
/**
@ -38,6 +56,12 @@ declare enum ImageAnalyzerType {
* @systemapi
* @since 11
*/
/**
* Image analyze type text.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
TEXT,
}
@ -49,6 +73,13 @@ declare enum ImageAnalyzerType {
* @systemapi
* @since 11
*/
/**
* Image analyzer config.
*
* @interface ImageAnalyzerConfig
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
declare interface ImageAnalyzerConfig {
/**
* Image analyze types.
@ -58,5 +89,12 @@ declare interface ImageAnalyzerConfig {
* @systemapi
* @since 11
*/
/**
* Image analyze types.
*
* @type { ImageAnalyzerType[] }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 12
*/
types: ImageAnalyzerType[];
}

134
api/@internal/component/ets/image_span.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provide image decoration in the text component.
*
@ -112,6 +117,30 @@ declare class ImageSpanAttribute extends BaseSpan<ImageSpanAttribute> {
* @since 11
*/
objectFit(value: ImageFit): ImageSpanAttribute;
/**
* Sets a callback which is triggered when the image is successfully loaded.
* The size of the image source that is successfully loaded is returned, in pixels.
*
* @param { ImageCompleteCallback } callback - Triggered when the image is successfully loaded.
* @returns { ImageSpanAttribute } The attribute of the image span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onComplete(callback: ImageCompleteCallback): ImageSpanAttribute;
/**
* Sets a callback which is triggered when an exception occurs during image loading.
* The field of "message" returned in the callback carries the detailed information of failed image loading.
*
* @param { ImageErrorCallback } callback - Triggered when an exception occurs during image loading.
* @returns { ImageSpanAttribute } The attribute of the image span.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onError(callback: ImageErrorCallback): ImageSpanAttribute;
}
/**
@ -147,3 +176,108 @@ declare const ImageSpan: ImageSpanInterface;
* @since 11
*/
declare const ImageSpanInstance: ImageSpanAttribute;
/**
* Callback function triggered when the image is successfully loaded.
*
* @typedef { function } ImageCompleteCallback
* @param { ImageLoadResult } result - the information about the successfully loaded image.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type ImageCompleteCallback = (result: ImageLoadResult) => void;
/**
* The information about the successfully loaded image.
*
* @interface ImageLoadResult
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface ImageLoadResult {
/**
* The width of the image source.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
width: number;
/**
* The height of the image source.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
height: number;
/**
* The width of the component source.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
componentWidth: number;
/**
* The height of the component source.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
componentHeight: number;
/**
* The value of the status of the image being loaded successfully.
* If the returned status value is 0, the image data is successfully loaded.
* If the returned status value is 1, the image is successfully decoded.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
loadingStatus: number;
/**
* The width of the picture that is actually drawn.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
contentWidth: number;
/**
* The height of the picture that is actually drawn.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
contentHeight: number;
/**
* The offset between image content and image component on the X-axis.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
contentOffsetX: number;
/**
* The offset between image content and image component on the Y-axis.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
contentOffsetY: number;
}

6
api/@internal/component/ets/index-full.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/// <reference path="./action_sheet.d.ts" />
/// <reference path="./alert_dialog.d.ts" />
/// <reference path="./alphabet_indexer.d.ts" />
@ -137,3 +142,4 @@
/// <reference path="./component3d.d.ts" />
/// <reference path="./container_span.d.ts" />
/// <reference path="./embedded_component.d.ts" />
/// <reference path="./styled_string.d.ts" />

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Get inspector node infos.
*

410
api/@internal/component/ets/lazy_for_each.d.ts vendored
View File

@ -13,6 +13,406 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines type to operation data source.
*
* @enum { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare enum DataOperationType {
/**
* Add data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
ADD = 'add',
/**
* Delete data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
DELETE = 'delete',
/**
* Exchange data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
EXCHANGE = 'exchange',
/**
* Move data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
MOVE = 'move',
/**
* Change data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
CHANGE = 'change',
/**
* Reload data.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
RELOAD = 'reload'
}
/**
* Defines add operation.
*
* @interface DataAddOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataAddOperation {
/**
* How to operate added data.
*
* @type { DataOperationType.ADD }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.ADD,
/**
* Index of added data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: number,
/**
* Count of added data in one operation
* Only validate for ADD and DELETE.
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
count?: number,
/**
* Key of added data.
*
* @type { ?(string | Array<string>) }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
key?: string | Array<string>
}
/**
* Defines delete operation.
*
* @interface DataDeleteOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataDeleteOperation {
/**
* How to operate deleted data.
*
* @type { DataOperationType.DELETE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.DELETE,
/**
* Index of deleted data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: number,
/**
* Count of deleted data in one operation
* Only validate for ADD and DELETE.
*
* @type { ?number }
* @default 1
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
count?: number
}
/**
* Defines change operation.
*
* @interface DataChangeOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataChangeOperation {
/**
* How to operate changed data.
*
* @type { DataOperationType.CHANGE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.CHANGE,
/**
* Index of changed data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: number,
/**
* Key of changed data.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
key?: string
}
/**
* Defines position of moved data.
*
* @interface MoveIndex
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface MoveIndex {
/**
* Index of moved data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
from: number;
/**
* Destination of moved data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
to: number;
}
/**
* Defines position of exchange data.
*
* @interface ExchangeIndex
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface ExchangeIndex {
/**
* Index of the first exchange data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
start: number;
/**
* Index of the second exchange data.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
end: number;
}
/**
* Defines new key of exchange data.
*
* @interface ExchangeKey
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface ExchangeKey {
/**
* Key of the first exchange data.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
start: string;
/**
* Key of the second exchange data.
*
* @type { string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
end: string;
}
/**
* Defines move&exchange operation.
*
* @interface DataMoveOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataMoveOperation {
/**
* How to operate moved data.
*
* @type { DataOperationType.MOVE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.MOVE,
/**
* Index of moved data.
*
* @type { MoveIndex }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: MoveIndex,
/**
* Key of moved data.
*
* @type { ?string }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
key?: string
}
/**
* Defines exchange operation.
*
* @interface DataExchangeOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataExchangeOperation {
/**
* How to operate exchange data.
*
* @type { DataOperationType.EXCHANGE }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.EXCHANGE,
/**
* Index of exchange data.
*
* @type { ExchangeIndex }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: ExchangeIndex,
/**
* Key of exchange data.
*
* @type { ?ExchangeKey }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
key?: ExchangeKey
}
/**
* Defines reload operation.
*
* @interface DataReloadOperation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
interface DataReloadOperation {
/**
* How to operate reload data.
*
* @type { DataOperationType.RELOAD }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
type: DataOperationType.RELOAD
}
/**
* All data operation type
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type DataOperation =
DataAddOperation | DataDeleteOperation | DataChangeOperation | DataMoveOperation | DataExchangeOperation | DataReloadOperation
/**
* Data Change Listener.
*
@ -212,6 +612,16 @@ declare interface DataChangeListener {
* @since 11
*/
onDataChange(index: number): void;
/**
* Call when multiple data change.
*
* @param { DataOperation[] } dataOperations
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onDatasetChange(dataOperations: DataOperation[]): void;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Line drawing component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Declare scroll status
*
@ -252,6 +257,52 @@ declare enum ListItemAlign {
End,
}
/**
* Declare list item group area
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare enum ListItemGroupArea {
/**
* List item group area is none
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
NONE = 0,
/**
* List item group area is list item
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
IN_LIST_ITEM_AREA = 1,
/**
* List item group area is header
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
IN_HEADER_AREA = 2,
/**
* List item group area is footer
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
IN_FOOTER_AREA = 3,
}
/**
* Declare item group sticky style.
*
@ -565,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.
@ -574,15 +634,81 @@ declare interface CloseSwipeActionOptions {
* @crossplatform
* @since 11
*/
/**
* Called after collapse animation completed.
*
* @type { ?function }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
onFinish?: ()=>void
}
/**
* Defines the visible list content info.
*
* @interface VisibleListContentInfo
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface VisibleListContentInfo {
/**
* Index number of a child in the list.
*
* @type { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
index: number
/**
* Area of the ListItemGroup.
*
* @type { ?ListItemGroupArea }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
itemGroupArea?: ListItemGroupArea
/**
* Index number of a ListItem in ListItemGroup.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
itemIndexInGroup?: number
}
/**
* Callback of scroll visible content, using in onScrollVisibleContentChange.
*
* @typedef {function} OnScrollVisibleContentChangeCallback
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare type OnScrollVisibleContentChangeCallback = (start: VisibleListContentInfo, end: VisibleListContentInfo) => void;
/**
* @extends Scroller
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @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.
@ -596,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;
/**
@ -611,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;
/**
@ -623,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;
}
@ -924,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;
/**
@ -934,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;
/**
@ -1321,6 +1503,17 @@ declare class ListAttribute extends ScrollableCommonMethod<ListAttribute> {
*/
onScrollIndex(event: (start: number, end: number, center: number) => void): ListAttribute;
/**
* Called when the list visible content changes.
*
* @param { OnScrollVisibleContentChangeCallback } handler - Callback of Scroll Visible.
* @returns { ListAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
onScrollVisibleContentChange(handler: OnScrollVisibleContentChangeCallback): ListAttribute;
/**
* Called when the list begins to arrive.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Declare item ceiling attribute.
*
@ -168,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.
@ -175,6 +189,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Collapsed type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
COLLAPSED,
/**
@ -183,6 +204,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* EXPANDED type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
EXPANDED,
/**
@ -191,6 +219,13 @@ declare enum SwipeActionState {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 11
*/
/**
* Action type.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @atomicservice
* @since 12
*/
ACTIONING,
}
@ -313,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;
}
@ -433,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;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the list item group style.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Load style of progress bar.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Enumerates the icon styles.
*

16
api/@internal/component/ets/marquee.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides the interface for the marquee attributes.
*
@ -324,6 +329,17 @@ declare class MarqueeAttribute extends CommonMethod<MarqueeAttribute> {
*/
fontFamily(value: string | Resource): MarqueeAttribute;
/**
* Marquee scrolling strategy after text update.
*
* @param { MarqueeUpdateStrategy } value - The scrolling strategy after text update.
* @returns { MarqueeAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
marqueeUpdateStrategy(value: MarqueeUpdateStrategy): MarqueeAttribute;
/**
* Called when scrolling starts.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* 2D transformation matrix, supporting rotation, translation, and scaling of the X-axis and Y-axis
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the resource which can use ASTC.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the Menu Component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the option of MenuItem.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the option of MenuItemGroup.
*

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

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Copyright (c) 2022-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
@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the navigation destination common title.
*
@ -177,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.
@ -185,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,
/**
@ -194,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,
}
@ -249,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.
*
@ -280,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;
}
/**
@ -437,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;
/**
@ -448,7 +540,28 @@ 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;
/**
* NavDestination title bar's menus
*
* @param { Array<NavigationMenuItem> | CustomBuilder } value
* @returns { NavDestinationAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
menus(value: Array<NavigationMenuItem> | CustomBuilder): NavDestinationAttribute;
/**
* Invoked before sub-components of NavDestination are created.

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Indicates the information of the route page.
*

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

@ -1,5 +1,5 @@
/*
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Copyright (c) 2021-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
@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the navigation common title.
*
@ -512,6 +517,16 @@ declare interface NavigationMenuItem {
*/
icon?: string;
/**
* Whether to enable this menu item.
*
* @type { ?boolean }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
isEnabled?: boolean;
/**
* Trigger by navigation menu item click.
*
@ -547,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.
@ -556,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;
/**
@ -566,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;
}
@ -653,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>;
}
@ -723,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>;
/**
@ -758,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;
/**
@ -775,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>;
/**
@ -793,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>;
/**
@ -804,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;
/**
@ -816,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;
/**
@ -827,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;
/**
@ -838,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;
/**
@ -870,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;
/**
@ -905,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;
/**
@ -1120,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;
/**
@ -1348,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.
@ -1356,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,
/**
@ -1365,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,
/**
@ -1374,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,
}
@ -2099,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;
}
@ -2110,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.
@ -2119,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
/**
@ -2129,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;
/**
@ -2139,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
}
@ -2150,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.
@ -2159,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;
/**
@ -2169,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;
/**
@ -2178,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;
}
@ -2189,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.
@ -2198,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;
/**
@ -2208,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;
/**
@ -2218,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;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Route jump.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the Interface of NodeContainer. To display the node build by an associated NodeController.
*
@ -21,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
@ -31,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;
}
@ -41,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> {}
/**
@ -50,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;
/**
@ -59,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;

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Declare the jump method.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Sets the initial state of the slidable panel.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the ParticleOptions Interface.
* @interface ParticleOptions
@ -430,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;
};
/**
@ -855,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
@ -862,6 +879,7 @@ interface ParticlePropertyAnimation<T> {
/**
* Curve of the particle animation.
* @type { ?(Curve | ICurve) }
* @default Curve.Linear
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Enumerates the icon styles.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides the path drawing interface.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The challenge result based on input pattern for control pattern lock component.
* @enum { number }

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* PluginComponentTemplate
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides the polygon drawing interface.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides an interface for drawing polylines.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the option of Progress.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides an interface for generating QR codes.
*
@ -212,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;
}

64
api/@internal/component/ets/radio.d.ts vendored
View File

@ -13,6 +13,50 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the IndicatorType of Radio component
*
* @enum { number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
declare enum RadioIndicatorType {
/**
* Tick shape.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
TICK = 0,
/**
* Dot shape.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
DOT = 1,
/**
* custom shape.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
CUSTOM = 2,
}
/**
* Input parameter for creating a radio box.
*
@ -119,6 +163,26 @@ declare interface RadioOptions {
* @form
*/
value: string;
/**
* Indicator Type.
*
* @type { ?RadioIndicatorType }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
indicatorType?: RadioIndicatorType;
/**
* builder for IndicatorType.CUSTOM
*
* @type { ?CustomBuilder }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
* @form
*/
indicatorBuilder?: CustomBuilder;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides the interface for scoring bars.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides an interface for drawing rectangles.
*

29
api/@internal/component/ets/refresh.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The refresh status of the drop-down refresh.
*
@ -421,6 +426,30 @@ declare class RefreshAttribute extends CommonMethod<RefreshAttribute> {
* @since 11
*/
onRefreshing(callback: () => void): RefreshAttribute;
/**
* The pull-down offset to trigger refresh.
*
* @param { number } value
* @returns { RefreshAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
refreshOffset(value: number): RefreshAttribute;
/**
* Sets whether to trigger refresh when the pull-down distance exceeds the refreshOffset.
*
* @param { boolean } value
* @returns { RefreshAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
pullToRefresh(value: boolean): RefreshAttribute;
}
/**

41
api/@internal/component/ets/relative_container.d.ts vendored
View File

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides ports for relative containers.
*
@ -78,7 +83,7 @@ interface RelativeContainerInterface {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
declare interface GuideLinePosition {
/**
@ -88,7 +93,7 @@ declare interface GuideLinePosition {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
start? : Dimension;
@ -99,7 +104,7 @@ declare interface GuideLinePosition {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
end? : Dimension;
}
@ -111,7 +116,7 @@ declare interface GuideLinePosition {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
declare interface GuideLineStyle {
/**
@ -121,7 +126,7 @@ declare interface GuideLineStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
id : string;
@ -132,7 +137,7 @@ declare interface GuideLineStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
direction : Axis;
@ -143,7 +148,7 @@ declare interface GuideLineStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
position : GuideLinePosition;
}
@ -155,7 +160,7 @@ declare interface GuideLineStyle {
* @syscap SystemCapability.Test.UiTest
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
declare enum BarrierDirection {
/**
@ -164,7 +169,7 @@ declare enum BarrierDirection {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
LEFT,
@ -174,7 +179,7 @@ declare enum BarrierDirection {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
RIGHT,
@ -184,7 +189,7 @@ declare enum BarrierDirection {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
TOP,
@ -194,7 +199,7 @@ declare enum BarrierDirection {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
BOTTOM,
}
@ -206,7 +211,7 @@ declare enum BarrierDirection {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
declare interface BarrierStyle {
/**
@ -216,7 +221,7 @@ declare interface BarrierStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
id : string;
@ -227,7 +232,7 @@ declare interface BarrierStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
direction : BarrierDirection;
@ -238,7 +243,7 @@ declare interface BarrierStyle {
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
referencedId : Array<string>;
}
@ -273,7 +278,7 @@ declare class RelativeContainerAttribute extends CommonMethod<RelativeContainerA
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
guideLine(value: Array<GuideLineStyle>): RelativeContainerAttribute;
@ -285,7 +290,7 @@ declare class RelativeContainerAttribute extends CommonMethod<RelativeContainerA
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 11
* @since 12
*/
barrier(value: Array<BarrierStyle>): RelativeContainerAttribute;
}

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Round rect.
*

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

File diff suppressed because it is too large Load Diff

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides an interface for RichText component.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the session of RootScene.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The components are laid out horizontally
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides interfaces for layout in the vertical direction.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Enumerates the icon styles.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Defines the interface of Screen.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Content scroll direction.
*
@ -237,6 +242,26 @@ declare interface OffsetResult {
yOffset: number;
}
/**
* Define scroll edge options
*
* @interface ScrollEdgeOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface ScrollEdgeOptions {
/**
* The fasten speed of scrolling to the edge, unit is vp/s.
*
* @type { ?number }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
velocity?: number;
}
/**
* Provides custom animation parameters.
*
@ -282,6 +307,36 @@ declare interface ScrollAnimationOptions {
canOverScroll?: boolean;
}
/**
* OffsetOptions info.
*
* @interface OffsetOptions
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
declare interface OffsetOptions {
/**
* The X-axis offset.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
xOffset?: Dimension;
/**
* The y-axis offset.
*
* @type { ?Dimension }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
yOffset?: Dimension;
}
/**
* Scroller
*
@ -446,7 +501,29 @@ declare class Scroller {
* @atomicservice
* @since 11
*/
scrollEdge(value: Edge);
/**
* Called when scrolling to the edge of the container.
*
* @param { Edge } value - Edge type of the container.
* @param { ScrollEdgeOptions } [options] - Options of scrolling to edge.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
scrollEdge(value: Edge, options?: ScrollEdgeOptions);
/**
* Fling the scroll view.
*
* @param { number } velocity - initial velocity of fling, in vp/s.
* @throws { BusinessError } 401 - The parameter check failed.
* @throws { BusinessError } 100004 - Controller not bound to component.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
fling(velocity: number): void;
/**
* Called when page turning mode is set.
@ -607,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;
}
@ -1235,7 +1324,28 @@ 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;
/**
* Called to setting the initial offset
*
* @param { OffsetOptions } value - options for scroll initial offset.
* @returns { ScrollAttribute } the attribute of the scroll.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
initialOffset(value: OffsetOptions): ScrollAttribute;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Content scroll direction.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides the method of switching the cursor position.
*
@ -103,6 +108,18 @@ declare class SearchController extends TextContentControllerBase {
* @since 11
*/
stopEditing(): void;
/**
* Text selection is achieved by specifying the start and end positions of the text.
*
* @param { number } selectionStart - The start position of the selected text.
* @param { number } selectionEnd - The end position of the selected text.
* @param { SelectionOptions } [options] - Indicates the options of the text selection.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void;
}
/**
@ -183,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.
@ -191,6 +217,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* Basic input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NORMAL = 0,
/**
@ -200,6 +234,14 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* Pure digital input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
NUMBER = 2,
/**
@ -209,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,
/**
@ -218,7 +268,24 @@ declare enum SearchType {
* @crossplatform
* @since 11
*/
/**
* E-mail address input mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @atomicservice
* @since 12
*/
EMAIL = 5,
/**
* Number decimal entry mode.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
NUMBER_DECIMAL = 12,
}
/**
@ -661,6 +728,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
*
@ -769,6 +903,17 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
*/
textFont(value?: Font): SearchAttribute;
/**
* Set enter key type of soft keyboard
*
* @param { EnterKeyType } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
enterKeyType(value: EnterKeyType): SearchAttribute;
/**
* Call the function when clicked the search button
*
@ -997,6 +1142,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;
/**
@ -1070,6 +1225,28 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
*/
selectionMenuHidden(value: boolean): SearchAttribute;
/**
* Called when the minimum font size of the font is set.
*
* @param { number | string | Resource } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
minFontSize(value: number | string | Resource): SearchAttribute;
/**
* Called when the maximum font size of the font is set.
*
* @param { number | string | Resource } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
maxFontSize(value: number | string | Resource): SearchAttribute;
/**
* Define custom keyboard.
*
@ -1088,7 +1265,50 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
* @atomicservice
* @since 11
*/
customKeyboard(value: CustomBuilder): SearchAttribute;
/**
* Define custom keyboard.
*
* @param { CustomBuilder } value - Set up a custom keyboard of Search
* @param { KeyboardOptions } [options] - Indicates the custom keyboard options of Search
* @returns { SearchAttribute } returns the instance of the SearchAttribute.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
customKeyboard(value: CustomBuilder, options?: KeyboardOptions): SearchAttribute;
/**
* Called when the text decoration of the text is set.
*
* @param { TextDecorationOptions } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
decoration(value: TextDecorationOptions): SearchAttribute;
/**
* Called when the distance between text fonts is set.
*
* @param { number | string | Resource } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
letterSpacing(value: number | string | Resource): SearchAttribute;
/**
* Called when the line height of the font is set.
*
* @param { number | string | Resource } value
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
lineHeight(value: number | string | Resource): SearchAttribute;
/**
* Called when the search type is set.
@ -1099,7 +1319,32 @@ 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;
/**
* Set font feature.
*
* @param { string } value - The fontFeature.
* normal | <feature-tag-value>,
* where <feature-tag-value> = <string> [ <integer> | on | off ], like: "ss01" 0
* the values of <feature-tag-value> reference to doc of search component
* number of <feature-tag-value> can be single or multiple, and separated by comma ','.
* @returns { SearchAttribute }
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
fontFeature(value: string): SearchAttribute;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Enumerates the layout direction of the icon and text.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* The declare of selectOption.
*
@ -680,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;
/**
@ -691,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;
/**
@ -714,6 +739,17 @@ declare class SelectAttribute extends CommonMethod<SelectAttribute> {
* @since 11
*/
menuBackgroundBlurStyle(value: BlurStyle): SelectAttribute;
/**
* Sets the size for controls within Select Component.
*
* @param { ControlSize } value - control size
* @returns { SelectAttribute } the attribute of the select.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @crossplatform
* @since 12
*/
controlSize(value: ControlSize): SelectAttribute;
}
/**

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Provides interfaces for drawing components.
*

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

@ -13,6 +13,11 @@
* limitations under the License.
*/
/**
* @file
* @kit ArkUI
*/
/**
* Sets the sidebar style of showing
*

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