mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
Merge branch 'master' of gitee.com:openharmony/interface_sdk-js into ly321
Signed-off-by: luoying_ace <luoying19@huawei.com>
This commit is contained in:
commit
2575cf5e62
7
BUILD.gn
7
BUILD.gn
@ -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"
|
||||
}
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provide an interface for the ability component.
|
||||
*
|
||||
|
44
api/@internal/component/ets/action_sheet.d.ts
vendored
44
api/@internal/component/ets/action_sheet.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* The information of sheet.
|
||||
*
|
||||
@ -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,6 +601,16 @@ interface ActionSheetOptions
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the actionSheet's background blur Style
|
||||
*
|
||||
* @type { ?BlurStyle }
|
||||
* @default BlurStyle.COMPONENT_ULTRA_THICK
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
backgroundBlurStyle?: BlurStyle;
|
||||
|
||||
/**
|
||||
|
44
api/@internal/component/ets/alert_dialog.d.ts
vendored
44
api/@internal/component/ets/alert_dialog.d.ts
vendored
@ -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,6 +815,16 @@ declare interface AlertDialogParam {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the alertDialog's background blur Style
|
||||
*
|
||||
* @type { ?BlurStyle }
|
||||
* @default BlurStyle.COMPONENT_ULTRA_THICK
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
backgroundBlurStyle?: BlurStyle;
|
||||
|
||||
/**
|
||||
|
@ -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
5
api/@internal/component/ets/animator.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Customize spring properties.
|
||||
*
|
||||
|
5
api/@internal/component/ets/badge.d.ts
vendored
5
api/@internal/component/ets/badge.d.ts
vendored
@ -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
5
api/@internal/component/ets/blank.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Create Blank.
|
||||
*
|
||||
|
114
api/@internal/component/ets/button.d.ts
vendored
114
api/@internal/component/ets/button.d.ts
vendored
@ -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
5
api/@internal/component/ets/calendar.d.ts
vendored
@ -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
25
api/@internal/component/ets/calendar_picker.d.ts
vendored
@ -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;
|
||||
|
||||
/**
|
||||
|
5
api/@internal/component/ets/canvas.d.ts
vendored
5
api/@internal/component/ets/canvas.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Filling style algorithm, which determines whether a point is within or outside the path. The following
|
||||
* two configurations are supported:
|
||||
|
26
api/@internal/component/ets/checkbox.d.ts
vendored
26
api/@internal/component/ets/checkbox.d.ts
vendored
@ -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
17
api/@internal/component/ets/checkboxgroup.d.ts
vendored
@ -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
5
api/@internal/component/ets/circle.d.ts
vendored
@ -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
5
api/@internal/component/ets/column.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the Column Component.
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the ColumnSplit component.
|
||||
*
|
||||
|
1930
api/@internal/component/ets/common.d.ts
vendored
1930
api/@internal/component/ets/common.d.ts
vendored
File diff suppressed because it is too large
Load Diff
@ -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
5
api/@internal/component/ets/component3d.d.ts
vendored
@ -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
57
api/@internal/component/ets/container_span.d.ts
vendored
@ -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;
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines Close contextMenu.
|
||||
*
|
||||
|
5
api/@internal/component/ets/counter.d.ts
vendored
5
api/@internal/component/ets/counter.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Counter component, which provides corresponding increment or decrement counting operations.
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the options of CustomDialogController.
|
||||
*
|
||||
@ -362,6 +367,15 @@ declare interface CustomDialogControllerOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Whether it is a modal dialog
|
||||
* @type { ?boolean }
|
||||
* @default true
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
isModal?: boolean;
|
||||
|
||||
/**
|
||||
|
5
api/@internal/component/ets/data_panel.d.ts
vendored
5
api/@internal/component/ets/data_panel.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* DataPanelType enum
|
||||
*
|
||||
|
25
api/@internal/component/ets/date_picker.d.ts
vendored
25
api/@internal/component/ets/date_picker.d.ts
vendored
@ -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
5
api/@internal/component/ets/divider.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provides a divider component to separate different content blocks/content elements.
|
||||
*
|
||||
|
@ -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
5
api/@internal/component/ets/ellipse.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ellipse drawing.
|
||||
*
|
||||
|
@ -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" />
|
||||
|
||||
|
198
api/@internal/component/ets/enums.d.ts
vendored
198
api/@internal/component/ets/enums.d.ts
vendored
@ -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,
|
||||
}
|
||||
|
||||
|
5
api/@internal/component/ets/flex.d.ts
vendored
5
api/@internal/component/ets/flex.d.ts
vendored
@ -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
5
api/@internal/component/ets/flow_item.d.ts
vendored
@ -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
87
api/@internal/component/ets/folder_stack.d.ts
vendored
@ -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
5
api/@internal/component/ets/for_each.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* looping function.
|
||||
*
|
||||
|
179
api/@internal/component/ets/form_component.d.ts
vendored
179
api/@internal/component/ets/form_component.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the FormDimension enum.
|
||||
*
|
||||
@ -116,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.
|
||||
*
|
||||
@ -161,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;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -246,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.
|
||||
@ -279,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
5
api/@internal/component/ets/form_link.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the FormLink options.
|
||||
*
|
||||
|
73
api/@internal/component/ets/gauge.d.ts
vendored
73
api/@internal/component/ets/gauge.d.ts
vendored
@ -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
357
api/@internal/component/ets/gesture.d.ts
vendored
@ -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
15
api/@internal/component/ets/grid.d.ts
vendored
@ -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
48
api/@internal/component/ets/gridItem.d.ts
vendored
@ -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
5
api/@internal/component/ets/grid_col.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the option in number unit of grid-container child component.
|
||||
*
|
||||
|
@ -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
5
api/@internal/component/ets/grid_row.d.ts
vendored
@ -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
5
api/@internal/component/ets/hyperlink.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the hyperlink interface.
|
||||
*
|
||||
|
66
api/@internal/component/ets/image.d.ts
vendored
66
api/@internal/component/ets/image.d.ts
vendored
@ -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
17
api/@internal/component/ets/image_animator.d.ts
vendored
@ -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
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the image analyze type.
|
||||
*
|
||||
|
5
api/@internal/component/ets/image_span.d.ts
vendored
5
api/@internal/component/ets/image_span.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provide image decoration in the text component.
|
||||
*
|
||||
|
5
api/@internal/component/ets/index-full.d.ts
vendored
5
api/@internal/component/ets/index-full.d.ts
vendored
@ -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" />
|
||||
|
5
api/@internal/component/ets/inspector.d.ts
vendored
5
api/@internal/component/ets/inspector.d.ts
vendored
@ -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
410
api/@internal/component/ets/lazy_for_each.d.ts
vendored
@ -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
5
api/@internal/component/ets/line.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Line drawing component.
|
||||
*
|
||||
|
193
api/@internal/component/ets/list.d.ts
vendored
193
api/@internal/component/ets/list.d.ts
vendored
@ -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
53
api/@internal/component/ets/list_item.d.ts
vendored
@ -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;
|
||||
}
|
||||
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the list item group style.
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Load style of progress bar.
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Enumerates the icon styles.
|
||||
*
|
||||
|
5
api/@internal/component/ets/marquee.d.ts
vendored
5
api/@internal/component/ets/marquee.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provides the interface for the marquee attributes.
|
||||
*
|
||||
|
5
api/@internal/component/ets/matrix2d.d.ts
vendored
5
api/@internal/component/ets/matrix2d.d.ts
vendored
@ -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
|
||||
*
|
||||
|
@ -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
5
api/@internal/component/ets/menu.d.ts
vendored
@ -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
5
api/@internal/component/ets/menu_item.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the option of MenuItem.
|
||||
*
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the option of MenuItemGroup.
|
||||
*
|
||||
|
102
api/@internal/component/ets/nav_destination.d.ts
vendored
102
api/@internal/component/ets/nav_destination.d.ts
vendored
@ -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,6 +540,16 @@ declare class NavDestinationAttribute extends CommonMethod<NavDestinationAttribu
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Set back button icon.
|
||||
*
|
||||
* @param { ResourceStr | PixelMap } value - Indicates icon of back button.
|
||||
* @returns { NavDestinationAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
backButtonIcon(value: ResourceStr | PixelMap): NavDestinationAttribute;
|
||||
|
||||
/**
|
||||
|
5
api/@internal/component/ets/nav_router.d.ts
vendored
5
api/@internal/component/ets/nav_router.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Indicates the information of the route page.
|
||||
*
|
||||
|
324
api/@internal/component/ets/navigation.d.ts
vendored
324
api/@internal/component/ets/navigation.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the navigation common title.
|
||||
*
|
||||
@ -557,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.
|
||||
@ -566,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;
|
||||
|
||||
/**
|
||||
@ -576,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;
|
||||
}
|
||||
|
||||
@ -663,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>;
|
||||
}
|
||||
|
||||
@ -733,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>;
|
||||
|
||||
/**
|
||||
@ -768,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;
|
||||
|
||||
/**
|
||||
@ -785,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>;
|
||||
|
||||
/**
|
||||
@ -803,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>;
|
||||
|
||||
/**
|
||||
@ -814,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;
|
||||
|
||||
/**
|
||||
@ -826,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;
|
||||
|
||||
/**
|
||||
@ -837,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;
|
||||
|
||||
/**
|
||||
@ -848,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;
|
||||
|
||||
/**
|
||||
@ -880,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;
|
||||
|
||||
/**
|
||||
@ -915,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;
|
||||
|
||||
/**
|
||||
@ -1130,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;
|
||||
|
||||
/**
|
||||
@ -1358,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.
|
||||
@ -1366,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,
|
||||
|
||||
/**
|
||||
@ -1375,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,
|
||||
|
||||
/**
|
||||
@ -1384,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,
|
||||
}
|
||||
|
||||
@ -2109,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;
|
||||
}
|
||||
|
||||
@ -2120,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.
|
||||
@ -2129,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
|
||||
|
||||
/**
|
||||
@ -2139,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;
|
||||
|
||||
/**
|
||||
@ -2149,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
|
||||
}
|
||||
|
||||
@ -2160,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.
|
||||
@ -2169,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;
|
||||
|
||||
/**
|
||||
@ -2179,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;
|
||||
|
||||
/**
|
||||
@ -2188,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;
|
||||
}
|
||||
|
||||
@ -2199,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.
|
||||
@ -2208,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;
|
||||
|
||||
/**
|
||||
@ -2218,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;
|
||||
|
||||
/**
|
||||
@ -2228,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
5
api/@internal/component/ets/navigator.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Route jump.
|
||||
*
|
||||
|
48
api/@internal/component/ets/node_container.d.ts
vendored
48
api/@internal/component/ets/node_container.d.ts
vendored
@ -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;
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Declare the jump method.
|
||||
*
|
||||
|
5
api/@internal/component/ets/panel.d.ts
vendored
5
api/@internal/component/ets/panel.d.ts
vendored
@ -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
18
api/@internal/component/ets/particle.d.ts
vendored
@ -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
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Enumerates the icon styles.
|
||||
*
|
||||
|
5
api/@internal/component/ets/path.d.ts
vendored
5
api/@internal/component/ets/path.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provides the path drawing interface.
|
||||
*
|
||||
|
@ -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 }
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* PluginComponentTemplate
|
||||
*
|
||||
|
5
api/@internal/component/ets/polygon.d.ts
vendored
5
api/@internal/component/ets/polygon.d.ts
vendored
@ -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
5
api/@internal/component/ets/polyline.d.ts
vendored
@ -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
5
api/@internal/component/ets/progress.d.ts
vendored
@ -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
14
api/@internal/component/ets/qrcode.d.ts
vendored
@ -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
64
api/@internal/component/ets/radio.d.ts
vendored
@ -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
5
api/@internal/component/ets/rating.d.ts
vendored
@ -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
5
api/@internal/component/ets/rect.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Provides an interface for drawing rectangles.
|
||||
*
|
||||
|
5
api/@internal/component/ets/refresh.d.ts
vendored
5
api/@internal/component/ets/refresh.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* The refresh status of the drop-down refresh.
|
||||
*
|
||||
|
@ -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;
|
||||
}
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Round rect.
|
||||
*
|
||||
|
602
api/@internal/component/ets/rich_editor.d.ts
vendored
602
api/@internal/component/ets/rich_editor.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines delete text direction.
|
||||
*
|
||||
@ -137,6 +142,15 @@ declare enum RichEditorSpanType {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* ResponseType for contextMenu
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare enum RichEditorResponseType {
|
||||
/**
|
||||
* Right click.
|
||||
@ -145,6 +159,14 @@ declare enum RichEditorResponseType {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Right click.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
RIGHT_CLICK = 0,
|
||||
|
||||
/**
|
||||
@ -154,6 +176,14 @@ declare enum RichEditorResponseType {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Long press.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
LONG_PRESS = 1,
|
||||
|
||||
/**
|
||||
@ -163,6 +193,14 @@ declare enum RichEditorResponseType {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Selected by mouse.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
SELECT = 2,
|
||||
}
|
||||
|
||||
@ -390,6 +428,15 @@ declare interface RichEditorTextStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Text shadow
|
||||
*
|
||||
* @type { ?(ShadowOptions | Array<ShadowOptions>) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
textShadow?: ShadowOptions | Array<ShadowOptions>;
|
||||
|
||||
/**
|
||||
@ -422,6 +469,15 @@ declare interface RichEditorTextStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the leading margin placeholder of a paragraph.
|
||||
*
|
||||
* @interface LeadingMarginPlaceholder
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface LeadingMarginPlaceholder {
|
||||
/**
|
||||
* Placeholder pixelMap.
|
||||
@ -431,6 +487,15 @@ declare interface LeadingMarginPlaceholder {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Placeholder pixelMap.
|
||||
*
|
||||
* @type { PixelMap }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
pixelMap: PixelMap;
|
||||
|
||||
/**
|
||||
@ -441,6 +506,15 @@ declare interface LeadingMarginPlaceholder {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Placeholder size.
|
||||
*
|
||||
* @type { [Dimension, Dimension] }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
size: [Dimension, Dimension];
|
||||
}
|
||||
|
||||
@ -452,6 +526,15 @@ declare interface LeadingMarginPlaceholder {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the paragraph style.
|
||||
*
|
||||
* @interface RichEditorParagraphStyle
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorParagraphStyle {
|
||||
/**
|
||||
* Text alignment.
|
||||
@ -461,6 +544,15 @@ declare interface RichEditorParagraphStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Text alignment.
|
||||
*
|
||||
* @type { ?TextAlign }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
textAlign?: TextAlign;
|
||||
|
||||
/**
|
||||
@ -471,6 +563,15 @@ declare interface RichEditorParagraphStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Leading margin.
|
||||
*
|
||||
* @type { ?(Dimension | LeadingMarginPlaceholder) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
leadingMargin?: Dimension | LeadingMarginPlaceholder;
|
||||
|
||||
/**
|
||||
@ -595,6 +696,15 @@ interface RichEditorLayoutStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Outer Margin.
|
||||
*
|
||||
* @type { ?(Dimension | Margin) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
margin?: Dimension | Margin;
|
||||
|
||||
/**
|
||||
@ -605,6 +715,15 @@ interface RichEditorLayoutStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Border radius.
|
||||
*
|
||||
* @type { ?(Dimension | BorderRadiuses) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
borderRadius?: Dimension | BorderRadiuses;
|
||||
}
|
||||
|
||||
@ -687,6 +806,15 @@ declare interface RichEditorImageSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* RichEditor ImageSpan Layout Style.
|
||||
*
|
||||
* @type { ?RichEditorLayoutStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
layoutStyle?: RichEditorLayoutStyle;
|
||||
}
|
||||
|
||||
@ -698,6 +826,15 @@ declare interface RichEditorImageSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the symbol span style.
|
||||
*
|
||||
* @interface RichEditorSymbolSpanStyle
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorSymbolSpanStyle {
|
||||
/**
|
||||
* The font size.
|
||||
@ -707,6 +844,15 @@ declare interface RichEditorSymbolSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font size.
|
||||
*
|
||||
* @type { ?(number | string | Resource) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontSize?: number | string | Resource;
|
||||
|
||||
/**
|
||||
@ -717,6 +863,15 @@ declare interface RichEditorSymbolSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font color.
|
||||
*
|
||||
* @type { ?Array<ResourceColor> }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontColor?: Array<ResourceColor>;
|
||||
|
||||
/**
|
||||
@ -727,6 +882,15 @@ declare interface RichEditorSymbolSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font weight.
|
||||
*
|
||||
* @type { ?(number | FontWeight | string) }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontWeight?: number | FontWeight | string;
|
||||
|
||||
/**
|
||||
@ -737,6 +901,15 @@ declare interface RichEditorSymbolSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The symbol span effect strategy.
|
||||
*
|
||||
* @type { ?SymbolEffectStrategy }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
effectStrategy?: SymbolEffectStrategy;
|
||||
|
||||
/**
|
||||
@ -747,6 +920,15 @@ declare interface RichEditorSymbolSpanStyle {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The symbol span rendering strategy.
|
||||
*
|
||||
* @type { ?SymbolRenderingStrategy }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
renderingStrategy?: SymbolRenderingStrategy;
|
||||
}
|
||||
|
||||
@ -904,6 +1086,15 @@ declare interface RichEditorTextStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the paragraph result.
|
||||
*
|
||||
* @interface RichEditorParagraphResult
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorParagraphResult {
|
||||
/**
|
||||
* The paragraph style.
|
||||
@ -913,6 +1104,15 @@ declare interface RichEditorParagraphResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The paragraph style.
|
||||
*
|
||||
* @type { RichEditorParagraphStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
style: RichEditorParagraphStyle;
|
||||
|
||||
/**
|
||||
@ -923,6 +1123,15 @@ declare interface RichEditorParagraphResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The range of paragraph based on character indices.
|
||||
*
|
||||
* @type { [number, number] }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
range: [number, number];
|
||||
}
|
||||
|
||||
@ -934,6 +1143,15 @@ declare interface RichEditorParagraphResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the symbol span style result.
|
||||
*
|
||||
* @interface RichEditorSymbolSpanStyleResult
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorSymbolSpanStyleResult {
|
||||
/**
|
||||
* The font size.
|
||||
@ -943,6 +1161,15 @@ declare interface RichEditorSymbolSpanStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font size.
|
||||
*
|
||||
* @type { number | string | Resource }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontSize: number | string | Resource;
|
||||
|
||||
/**
|
||||
@ -953,6 +1180,15 @@ declare interface RichEditorSymbolSpanStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font color.
|
||||
*
|
||||
* @type { Array<ResourceColor> }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontColor: Array<ResourceColor>;
|
||||
|
||||
/**
|
||||
@ -963,6 +1199,15 @@ declare interface RichEditorSymbolSpanStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The font weight.
|
||||
*
|
||||
* @type { number | FontWeight | string }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
fontWeight: number | FontWeight | string;
|
||||
|
||||
/**
|
||||
@ -973,6 +1218,15 @@ declare interface RichEditorSymbolSpanStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The symbol span effect strategy.
|
||||
*
|
||||
* @type { SymbolEffectStrategy }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
effectStrategy: SymbolEffectStrategy;
|
||||
|
||||
/**
|
||||
@ -983,6 +1237,15 @@ declare interface RichEditorSymbolSpanStyleResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The symbol span rendering strategy.
|
||||
*
|
||||
* @type { SymbolRenderingStrategy }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
renderingStrategy: SymbolRenderingStrategy;
|
||||
}
|
||||
|
||||
@ -1083,6 +1346,15 @@ declare interface RichEditorTextSpanResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Symbol span style.
|
||||
*
|
||||
* @type { ?RichEditorSymbolSpanStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
symbolSpanStyle?: RichEditorSymbolSpanStyle;
|
||||
|
||||
/**
|
||||
@ -1093,6 +1365,15 @@ declare interface RichEditorTextSpanResult {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The resource string of the symbol span.
|
||||
*
|
||||
* @type { ?Resource }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
valueResource?: Resource;
|
||||
|
||||
/**
|
||||
@ -1434,6 +1715,15 @@ declare interface RichEditorRange {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the richEditor Gestures.
|
||||
*
|
||||
* @interface RichEditorGesture
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorGesture {
|
||||
/**
|
||||
* Trigger a click event when a click is clicked.
|
||||
@ -1443,6 +1733,15 @@ declare interface RichEditorGesture {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Trigger a click event when a click is clicked.
|
||||
*
|
||||
* @type { ?function }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
onClick?: (event: ClickEvent) => void;
|
||||
|
||||
/**
|
||||
@ -1453,6 +1752,15 @@ declare interface RichEditorGesture {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Trigger a gesture event when long press event is complete.
|
||||
*
|
||||
* @type { ?function }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
onLongPress?: (event: GestureEvent) => void;
|
||||
}
|
||||
|
||||
@ -1517,6 +1825,15 @@ declare interface RichEditorTextSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Paragraph style.
|
||||
*
|
||||
* @type { ?RichEditorParagraphStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
paragraphStyle?: RichEditorParagraphStyle;
|
||||
|
||||
/**
|
||||
@ -1527,9 +1844,38 @@ declare interface RichEditorTextSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* RichEditor gesture.
|
||||
*
|
||||
* @type { ?RichEditorGesture }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
gesture?: RichEditorGesture;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the Keyboard options of RichEditor.
|
||||
*
|
||||
* @interface KeyboardOptions
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
declare interface KeyboardOptions {
|
||||
/**
|
||||
* Indicates whether to support keyboard avoidance.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
supportAvoidance?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the selection options of RichEditor.
|
||||
*
|
||||
@ -1611,6 +1957,15 @@ declare interface RichEditorImageSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* RichEditor gesture.
|
||||
*
|
||||
* @type { ?RichEditorGesture }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
gesture?: RichEditorGesture;
|
||||
}
|
||||
|
||||
@ -1622,6 +1977,15 @@ declare interface RichEditorImageSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines the builder span options of RichEditor.
|
||||
*
|
||||
* @interface RichEditorBuilderSpanOptions
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorBuilderSpanOptions {
|
||||
/**
|
||||
* The offset that add custom builder span at.
|
||||
@ -1631,6 +1995,15 @@ declare interface RichEditorBuilderSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The offset that add custom builder span at.
|
||||
*
|
||||
* @type { ?number } Indicates the index where the builder will be inserted
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
offset?: number;
|
||||
}
|
||||
|
||||
@ -1692,6 +2065,15 @@ declare interface RichEditorSpanStyleOptions extends RichEditorRange { }
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines paragraph style option of RichEditor.
|
||||
*
|
||||
* @interface RichEditorParagraphStyleOptions
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
|
||||
/**
|
||||
* Paragraph style.
|
||||
@ -1701,6 +2083,15 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Paragraph style.
|
||||
*
|
||||
* @type { RichEditorParagraphStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
style: RichEditorParagraphStyle;
|
||||
}
|
||||
|
||||
@ -1784,6 +2175,15 @@ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanSt
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines symbol span style option of RichEditor.
|
||||
*
|
||||
* @interface RichEditorUpdateSymbolSpanStyleOptions
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanStyleOptions {
|
||||
/**
|
||||
* Update the symbol span style.
|
||||
@ -1793,6 +2193,15 @@ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanS
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Update the symbol span style.
|
||||
*
|
||||
* @type { RichEditorSymbolSpanStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
symbolStyle: RichEditorSymbolSpanStyle;
|
||||
}
|
||||
|
||||
@ -1813,6 +2222,15 @@ declare interface RichEditorSymbolSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The offset that add custom symbol span at.
|
||||
*
|
||||
* @type { ?number }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
offset?: number;
|
||||
|
||||
/**
|
||||
@ -1823,6 +2241,15 @@ declare interface RichEditorSymbolSpanOptions {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* The style that add custom symbol span at.
|
||||
*
|
||||
* @type { ?RichEditorSymbolSpanStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
style?: RichEditorSymbolSpanStyle;
|
||||
}
|
||||
|
||||
@ -2223,6 +2650,17 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Add a builder span.
|
||||
*
|
||||
* @param { CustomBuilder } value - Indicates the custom builder node
|
||||
* @param { RichEditorBuilderSpanOptions } [options] - span option.
|
||||
* @returns { number } span index
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
addBuilderSpan(value: CustomBuilder, options?: RichEditorBuilderSpanOptions): number;
|
||||
|
||||
/**
|
||||
@ -2235,6 +2673,17 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Add a symbol span.
|
||||
*
|
||||
* @param { Resource } value - symbol span value
|
||||
* @param { RichEditorSymbolSpanOptions } [options] - symbol span option.
|
||||
* @returns { number } symbol span index
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
addSymbolSpan(value: Resource, options?: RichEditorSymbolSpanOptions ): number;
|
||||
|
||||
/**
|
||||
@ -2263,6 +2712,15 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Modify span style.
|
||||
*
|
||||
* @param { RichEditorParagraphStyleOptions } value
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
updateParagraphStyle(value: RichEditorParagraphStyleOptions): void;
|
||||
|
||||
/**
|
||||
@ -2312,6 +2770,16 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Get span content.
|
||||
*
|
||||
* @param { RichEditorRange } [value] - range for getting span info.
|
||||
* @returns { Array<RichEditorParagraphResult> }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
getParagraphs(value?: RichEditorRange): Array<RichEditorParagraphResult>;
|
||||
|
||||
/**
|
||||
@ -2338,6 +2806,15 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Get the typing text style.
|
||||
*
|
||||
* @returns { RichEditorTextStyle }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
getTypingStyle(): RichEditorTextStyle;
|
||||
|
||||
/**
|
||||
@ -2348,6 +2825,15 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Set the typing text style.
|
||||
*
|
||||
* @param { RichEditorTextStyle } value - set the typing text style.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
setTypingStyle(value: RichEditorTextStyle): void;
|
||||
|
||||
/**
|
||||
@ -2379,7 +2865,35 @@ declare class RichEditorController {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Called when the content is selected.
|
||||
*
|
||||
* @returns { RichEditorSelection }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
getSelection(): RichEditorSelection;
|
||||
|
||||
/**
|
||||
* Judge whether is in editing state
|
||||
*
|
||||
* @returns { boolean } - true is editing state, false is non editing status
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
isEditing(): boolean;
|
||||
|
||||
/**
|
||||
* Stop editing state.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
stopEditing(): void;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -2600,7 +3114,18 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
|
||||
* @atomicservice
|
||||
* @since 11
|
||||
*/
|
||||
customKeyboard(value: CustomBuilder): RichEditorAttribute;
|
||||
/**
|
||||
* Define custom keyboard.
|
||||
*
|
||||
* @param { CustomBuilder } value - Set up a custom keyboard of RichEditor
|
||||
* @param { KeyboardOptions } [options] - Indicates the Keyboard options of RichEditor
|
||||
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
customKeyboard(value: CustomBuilder, options?: KeyboardOptions): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
* Defines onPaste callback.
|
||||
@ -2611,6 +3136,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Defines onPaste callback.
|
||||
*
|
||||
* @param { function } callback Executed when a paste operation is performed.
|
||||
* @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
onPaste(callback: (event?: PasteEvent) => void): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
@ -2622,6 +3157,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Enable data detector.
|
||||
*
|
||||
* @param { boolean } enable - Enable data detector.
|
||||
* @returns { RichEditorAttribute } The attribute of the rich editor.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
enableDataDetector(enable: boolean): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
@ -2633,6 +3178,16 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Data detector with config.
|
||||
*
|
||||
* @param { TextDataDetectorConfig } config - The config of text data detector.
|
||||
* @returns { RichEditorAttribute } The attribute of the rich editor.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
dataDetectorConfig(config: TextDataDetectorConfig): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
@ -2668,8 +3223,53 @@ declare class RichEditorAttribute extends CommonMethod<RichEditorAttribute> {
|
||||
* @since 12
|
||||
*/
|
||||
selectedBackgroundColor(value: ResourceColor): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
* Called when edit status is changed
|
||||
*
|
||||
* @param { Callback<boolean> } callback - when edit status is changed
|
||||
* @returns { RichEditorAttribute } returns The attribute of the rich editor.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onEditingChange(callback: Callback<boolean>): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
* Set enter key type of soft keyboard.
|
||||
*
|
||||
* @param { EnterKeyType } value - the enter key type of soft keyboard
|
||||
* @returns { RichEditorAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
enterKeyType(value: EnterKeyType): RichEditorAttribute;
|
||||
|
||||
/**
|
||||
* Called when submitted.
|
||||
*
|
||||
* @param { SubmitCallback } callback - callback of the listened event.
|
||||
* @returns { RichEditorAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onSubmit(callback: SubmitCallback): RichEditorAttribute;
|
||||
}
|
||||
|
||||
/**
|
||||
* callback of the listened enter key event.
|
||||
*
|
||||
* @typedef { Function } SubmitCallback
|
||||
* @param { EnterKeyType } enterKey - the enter key type of soft keyboard.
|
||||
* @param { SubmitEvent } event - Provides the method of keeping RichEditor editable state when submitted.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void;
|
||||
|
||||
/**
|
||||
* Provides an interface for writing texts.
|
||||
*
|
||||
|
5
api/@internal/component/ets/rich_text.d.ts
vendored
5
api/@internal/component/ets/rich_text.d.ts
vendored
@ -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
5
api/@internal/component/ets/root_scene.d.ts
vendored
@ -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
5
api/@internal/component/ets/row.d.ts
vendored
@ -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
5
api/@internal/component/ets/row_split.d.ts
vendored
@ -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
5
api/@internal/component/ets/save_button.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Enumerates the icon styles.
|
||||
*
|
||||
|
5
api/@internal/component/ets/screen.d.ts
vendored
5
api/@internal/component/ets/screen.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Defines the interface of Screen.
|
||||
*
|
||||
|
59
api/@internal/component/ets/scroll.d.ts
vendored
59
api/@internal/component/ets/scroll.d.ts
vendored
@ -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.
|
||||
*
|
||||
@ -476,7 +501,17 @@ 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.
|
||||
@ -649,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;
|
||||
}
|
||||
|
||||
@ -1277,6 +1324,16 @@ declare class ScrollAttribute extends ScrollableCommonMethod<ScrollAttribute> {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Determines whether the scroll view stops on multiples of the content size when the user scrolls.
|
||||
*
|
||||
* @param { boolean } value - A boolean value determines whether paging is enabled for scroll.
|
||||
* @returns { ScrollAttribute } the attribute of the scroll.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
enablePaging(value: boolean): ScrollAttribute;
|
||||
|
||||
/**
|
||||
|
5
api/@internal/component/ets/scroll_bar.d.ts
vendored
5
api/@internal/component/ets/scroll_bar.d.ts
vendored
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Content scroll direction.
|
||||
*
|
||||
|
238
api/@internal/component/ets/search.d.ts
vendored
238
api/@internal/component/ets/search.d.ts
vendored
@ -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,6 +268,14 @@ declare enum SearchType {
|
||||
* @crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* E-mail address input mode.
|
||||
*
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
EMAIL = 5,
|
||||
}
|
||||
|
||||
@ -661,6 +719,73 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
|
||||
*/
|
||||
cancelButton(value: { style?: CancelButtonStyle, icon?: IconOptions }): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Called when the overflow mode of the font is set.
|
||||
*
|
||||
* @param { TextOverflow } value
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
textOverflow(value: TextOverflow): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Called when the baseline offset is set.
|
||||
*
|
||||
* @param { Dimension } value
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
baselineOffset(value: Dimension): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Specify the indentation of the first line in a text-block.
|
||||
*
|
||||
* @param { Dimension } value - The length of text indent.
|
||||
* @returns { SearchAttribute } The attribute of the text.
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
textIndent(value: Dimension): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Called when the inputFilter of text is set.
|
||||
*
|
||||
* @param { ResourceStr } value
|
||||
* @param { Callback<string> } error
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
inputFilter(value: ResourceStr, error?: Callback<string>): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Called when judging whether the text editing change finished.
|
||||
*
|
||||
* @param { Callback<boolean> } callback
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
onEditChange(callback: Callback<boolean>): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Define the text selected background color of the text input.
|
||||
*
|
||||
* @param { ResourceColor } value
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* @crossplatform
|
||||
* @since 12
|
||||
*/
|
||||
selectedBackgroundColor(value: ResourceColor): SearchAttribute;
|
||||
|
||||
/**
|
||||
* Set the cursor style
|
||||
*
|
||||
@ -769,6 +894,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 +1133,16 @@ declare class SearchAttribute extends CommonMethod<SearchAttribute> {
|
||||
* crossplatform
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Called when the input of maximum text length is set.
|
||||
*
|
||||
* @param { number } value
|
||||
* @returns { SearchAttribute }
|
||||
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
||||
* crossplatform
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
maxLength(value: number): SearchAttribute;
|
||||
|
||||
/**
|
||||
@ -1070,6 +1216,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 +1256,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 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 +1310,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;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -13,6 +13,11 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* @kit ArkUI
|
||||
*/
|
||||
|
||||
/**
|
||||
* Enumerates the layout direction of the icon and text.
|
||||
*
|
||||
|
25
api/@internal/component/ets/select.d.ts
vendored
25
api/@internal/component/ets/select.d.ts
vendored
@ -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;
|
||||
|
||||
/**
|
||||
|
5
api/@internal/component/ets/shape.d.ts
vendored
5
api/@internal/component/ets/shape.d.ts
vendored
@ -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
5
api/@internal/component/ets/sidebar.d.ts
vendored
@ -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
Loading…
Reference in New Issue
Block a user