diff --git a/api/@ohos.arkui.advanced.EditableTitleBar.static.d.ets b/api/@ohos.arkui.advanced.EditableTitleBar.static.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..e5fbfb48081fe648715e28c8bf158a39ad18042d --- /dev/null +++ b/api/@ohos.arkui.advanced.EditableTitleBar.static.d.ets @@ -0,0 +1,297 @@ +'use static' +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the 'License'); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an 'AS IS' BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { ResourceStr, ResourceColor, LocalizedMargin } from './arkui/component/units'; +import { SafeAreaType, SafeAreaEdge, BlurStyle } from './arkui/component/common'; +import { Component } from './arkui/component/customComponent'; +import { SymbolGlyphModifier } from './arkui/SymbolGlyphModifier'; +import { PropRef } from './arkui/stateManagement/decorator'; +import { Builder } from './arkui/component/builder'; +/** + * Declaration of the menu item on the right side. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare class EditableTitleBarMenuItem { + /** + * Icon resource for this menu item. + * + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + value: ResourceStr; + /** + * Symbol style for this menu item. + * + * @type { ?SymbolGlyphModifier }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + symbolStyle?: SymbolGlyphModifier; + /** + * Icon label for this menu item. + * + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + label?: ResourceStr; + /** + * Whether to enable this menu item. + * + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + isEnabled?: boolean; + /** + * Callback function when click on this menu item. + * + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + action?: () => void; + /** + * The accessibilityText of this menu item. + * + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityText?: ResourceStr; + /** + * The accessibilityDescription of this menu item. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityDescription?: ResourceStr; + /** + * The accessibilityLevel of this menu item. + * + * @type { ?string } + * @default "auto" + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + accessibilityLevel?: string; + /** + * Set the default focus state of this menu item. + * + * @type { ?boolean }. + * @default { false }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + defaultFocus?: boolean; +} +/** + * Declaration of the image item . + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export type EditableTitleBarItem = EditableTitleBarMenuItem; +/** + * Declaration of the left icon type. + * + * @enum { EditableLeftIconType }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum EditableLeftIconType { + /** + * The back type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + Back = 0, + /** + * The cancel type. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + Cancel = 1 +} +/** + * Indicates the options of the editable title bar. + * + * @interface EditableTitleBarOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare interface EditableTitleBarOptions { + /** + * Background color. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + backgroundColor?: ResourceColor; + /** + * Background blur style. + * + * @type { ?BlurStyle } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + backgroundBlurStyle?: BlurStyle; + /** + * Indicates the types of the safe area. + * + * @type { ?Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + safeAreaTypes?: Array; + /** + * Indicates the edges of the safe area. + * + * @type { ?Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + safeAreaEdges?: Array; +} +/** + * Declaration of the editable title bar. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +@Component +export declare struct EditableTitleBar { + /** + * Style of the left icon. + * + * @type { EditableLeftIconType }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + leftIconStyle: EditableLeftIconType; + /** + * Image item between the left icon and the title. + * + * @type { ?EditableTitleBarItem } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + imageItem?: EditableTitleBarItem; + /** + * Title of this title bar. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + title: ResourceStr; + /** + * Sub-Title of this title bar. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + subtitle?: ResourceStr; + /** + * Whether to required the save icon. + * + * @type { boolean } + * @default true + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + isSaveIconRequired: boolean; + /** + * Menu items on the right side. + * + * @type { ?Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + menuItems?: Array; + /** + * Callback function when click on the save icon at the right side. + * + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onSave?: () => void; + /** + * Callback function when click on the cancel icon at the left side. + * + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onCancel?: () => void; + /** + * Indicates the options of titlebar. + * + * @type { EditableTitleBarOptions } + * @default {expandSafeAreaTypes: SafeAreaType.SYSTEM, expandSafeAreaEdges: SafeAreaEdge.TOP} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + options: EditableTitleBarOptions; + /** + * Sets the content margin. + * + * @type { ?LocalizedMargin } + * @default {start: LengthMetrics.resource($r('sys.float.margin_left')), + *
end: LengthMetrics.resource($r('sys.float.margin_right'))} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + @PropRef contentMargin?: LocalizedMargin; + /** + * Sets the default focus state of left icon. + * + * @type { ?boolean } + * @default { false } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + leftIconDefaultFocus?: boolean; + /** + * Sets the default focus state of save icon. + * + * @type { ?boolean } + * @default { false } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + saveIconDefaultFocus?: boolean; + /** + * The method to build component. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + @Builder build(): void; +} diff --git a/api/@ohos.arkui.advanced.ExceptionPrompt.static.d.ets b/api/@ohos.arkui.advanced.ExceptionPrompt.static.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..284f26ebe781a437a64ae86d9eec802bc015127a --- /dev/null +++ b/api/@ohos.arkui.advanced.ExceptionPrompt.static.d.ets @@ -0,0 +1,156 @@ +'use static' +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the 'License'); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an 'AS IS' BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * @file + * @kit ArkUI + * @arkts 1.2 + */ +import { ResourceStr, Dimension } from './arkui/component/units'; +import { PropRef } from './arkui/stateManagement/decorator'; +import { Component } from './arkui/component/customComponent'; +import { SymbolGlyphModifier } from './arkui/SymbolGlyphModifier'; +import { Builder } from './arkui/component/builder'; +/** + * Control margin status of ExceptionPrompt. + * + * @enum { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export declare enum MarginType { + /** + * Default margin of MarginType,Margin 1: references ohos_id_card_margin_start, + * margin 2: references ohos_id_card_margin_end. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * + * @since 20 + */ + DEFAULT_MARGIN = 0, + /** + * Margins can be adapted of MarginType,Margin 1: references ohos_id_max_padding_start, + * margin 2: references ohos_id_max_padding_end. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + FIT_MARGIN = 1, +} +/** + * Configuration parameter of ExceptionPrompt. + * + * @interface PromptOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +export interface PromptOptions { + /** + * Icon of PromptOptions. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + icon?: ResourceStr; + /** + * SymbolGlyphModifier of PromptOptions. + * + * @type { ?SymbolGlyphModifier } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + symbolStyle?: SymbolGlyphModifier; + /** + * Tip text of PromptOptions. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + tip?: ResourceStr; + /** + * Margin Type of ExceptionPrompt. + * + * @type { MarginType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + marginType: MarginType; + /** + * Right icon button text of PromptOptions. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + actionText?: ResourceStr; + /** + * Distance from the top of PromptOptions. + * + * @type { Dimension } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + marginTop: Dimension + /** + * Control concealment of PromptOptions. + * + * @type { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + isShown?: boolean +} +/** + * Declare struct ExceptionPrompt higher-order component. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +@Component +export declare struct ExceptionPrompt { + /** + * Configuration information of ExceptionPrompt. + * + * @type { PromptOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + @PropRef options: PromptOptions; + /** + * Callback when clicking the text on the left. + * + * @type { ?function } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onTipClick?: () => void; + /** + * Callback when click the icon button. + * + * @type { ?function } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + onActionTextClick?: () => void; + /** + * The method to build component. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + @Builder build(): void; +} \ No newline at end of file