diff --git a/api/@ohos.arkui.advanced.ComposeTitleBarV2.d.ets b/api/@ohos.arkui.advanced.ComposeTitleBarV2.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..3d4388460daf09a7d8684d31066caf8764b1d6da --- /dev/null +++ b/api/@ohos.arkui.advanced.ComposeTitleBarV2.d.ets @@ -0,0 +1,218 @@ +/* + * Copyright (c) 2023-2023 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 + */ + + + + + +/** + * Declaration of the menu item on the right side. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +/** + * Declaration of the menu item on the right side. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ +export declare class ComposeTitleBarMenuItemV2 { + /** + * Icon resource for this menu item. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Icon resource for this menu item. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + value: ResourceStr; + + /** + * Symbol resource for this menu item. + * @type { ?SymbolGlyphModifier }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + symbolStyle?: SymbolGlyphModifier; + + /** + * Icon label for this menu item. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 13 + */ + @Param + label?: ResourceStr; + + /** + * Whether to enable this menu item. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Whether to enable this menu item. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + isEnabled?: boolean; + + /** + * Callback function when click on this menu item. + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Callback function when click on this menu item. + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + action?: () => void; + + /** + * The accessibilityText of this menu item. + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityText?: ResourceStr; + + /** + * The accessibilityDescription of this menu item. + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityDescription?: ResourceStr; + + /** + * The accessibilityLevel of this menu item. + * @type { ?string } + * @default "auto".The options are as follows:
+ * "auto":The value is converted to "yes" or "no" based on the component. + * "yes": the current component is selectable for the accessibility service. + * "no": The current component is not selectable for the accessibility service. + * "no-hide-descendants":The current component and all its child components are not selectable
+ * for the accessibility service. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityLevel?: string; +} + +/** + * Declaration of the composable title bar. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +/** + * Declaration of the composable title bar. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ +@Component +export declare struct ComposeTitleBarV2 { + /** + * Avatar resource and event callback of this title bar. + * @type { ?ComposeTitleBarMenuItemV2 }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Avatar resource and event callback of this title bar. + * @type { ?ComposeTitleBarMenuItemV2 }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + item?: ComposeTitleBarMenuItemV2; + + /** + * Title of this title bar. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Title of this title bar. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + title: ResourceStr; + + /** + * Sub-title of this title bar. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Sub-title of this title bar. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + subtitle?: ResourceStr; + + /** + * Menu items on the right side. + * @type { ?Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Menu items on the right side. + * @type { ?Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + menuItems?: Array; +} diff --git a/api/@ohos.arkui.advanced.SelectTitleBarV2.d.ets b/api/@ohos.arkui.advanced.SelectTitleBarV2.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..4db6138e7d2a03fb0d618a51a908357de695e5ee --- /dev/null +++ b/api/@ohos.arkui.advanced.SelectTitleBarV2.d.ets @@ -0,0 +1,263 @@ +/* + * Copyright (c) 2023-2023 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 + */ + + + + + +/** + * Declaration of the menu item on the right side. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +/** + * Declaration of the menu item on the right side. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ +export declare class SelectTitleBarMenuItem { + /** + * Icon resource for this menu item. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Icon resource for this menu item. + * @type { ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + value: ResourceStr; + + /** + * Symbol resource for this menu item. + * @type { ?SymbolGlyphModifier }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + symbolStyle?: SymbolGlyphModifier; + + /** + * Icon label for this menu item. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 13 + */ + @Param + label?: ResourceStr; + + /** + * Whether to enable this menu item. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Whether to enable this menu item. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + isEnabled?: boolean; + + /** + * Callback function when click on this menu item. + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Callback function when click on this menu item. + * @type { ?() => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + action?: () => void; + + /** + * The accessibilityText of this menu item. + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityText?: ResourceStr; + + /** + * The accessibilityDescription of this menu item. + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityDescription?: ResourceStr; + + /** + * The accessibilityLevel of this menu item. + * @type { ?string } + * @default "auto" + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + accessibilityLevel?: string; +} + +/** + * Declaration of the selectable title bar. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ +/** + * Declaration of the selectable title bar. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ +@ComponentV2 +export declare struct SelectTitleBar { + /** + * Selected index of the initial options in the drop-down menu. The index of the first item is 0. + * If this attribute is not set, the default value is -1. Which means, no menu item is selected. + * @type { number }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Selected index of the initial options in the drop-down menu. The index of the first item is 0. + * If this attribute is not set, the default value is -1. Which means, no menu item is selected. + * @type { number }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + selected: number; + + /** + * Options inside the drop-down list. + * @type { Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Options inside the drop-down list. + * @type { Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + options: Array; + + /** + * Menu items on the right side. + * @type { ?Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Menu items on the right side. + * @type { ?Array }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + menuItems?: Array; + + /** + * Sub-title of this title bar. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Sub-title of this title bar. + * @type { ?ResourceStr }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + subtitle?: ResourceStr; + + /** + * The number displayed in a badge. + * @type { ?number }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * The number displayed in a badge. + * @type { ?number }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + badgeValue?: number; + + /** + * Whether to hide the back arrow at the left side. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Whether to hide the back arrow at the left side. + * @type { ?boolean }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + hidesBackButton?: boolean; + + /** + * Callback function when an option is selected + * @type { ?(index: number) => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + */ + /** + * Callback function when an option is selected + * @type { ?(index: number) => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + */ + @Param + onSelected?: ((index: number) => void); +}