/*
* Copyright (c) 2023-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
*/
/**
* Declaration of the menu item on the right side.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
export declare class ComposeTitleBarMenuItem {
/**
* Icon resource.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
value: ResourceStr;
/**
* Symbol icon resource, which has higher priority than **value**. This parameter is not available for the **item**
* attribute.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice
* @since 18 dynamic
*/
symbolStyle?: SymbolGlyphModifier;
/**
* Icon label.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice
* @since 13 dynamic
*/
label?: ResourceStr;
/**
* Whether to enable the item.
*
* Default value: **false**
*
* **true**: The item is enabled.
*
* **false**: The item is disabled.
*
* This property cannot be triggered by the **item** property.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
isEnabled?: boolean;
/**
* Action to perform. This parameter is not available for the **item** attribute.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
action?: () => void;
/**
* Accessibility text, that is, accessible label name. If a component does not contain text information, it will not
* be announced by the screen reader when selected. In this case, the screen reader user cannot know which component
* is selected. To solve this problem, you can set accessibility text for components without text information. When
* such a component is selected, the screen reader announces the specified accessibility text, informing the user
* which component is selected.
*
* Default value: value of the **label** property if it is set and an empty string otherwise.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice
* @since 18 dynamic
*/
accessibilityText?: ResourceStr;
/**
* Accessible description. You can provide comprehensive text explanations to help users understand the operation they
* are about to perform and its potential consequences, especially when these cannot be inferred from the component's
* attributes and accessibility text alone. If a component contains both text information and the accessible
* description, the text is announced first and then the accessible description, when the component is selected.
*
* Default value: **"Double-tap to activate"**
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice
* @since 18 dynamic
*/
accessibilityDescription?: ResourceStr;
/**
* Accessibility level. It determines whether the component can be recognized by accessibility services.
*
* The options are as follows:
*
* **"auto"**: It is treated as "yes" by the system.
*
* **"yes"**: The component can be recognized by accessibility services.
*
* **"no"**: The component cannot be recognized by accessibility services.
*
* **"no-hide-descendants"**: Neither the component nor its child components can be recognized by accessibility
* services.
*
* Default value: **"auto"**
*
* @default "auto".The options are as follows:<br/>
* "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<br/>
* for the accessibility service.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice
* @since 18 dynamic
*/
accessibilityLevel?: string;
}
/**
* **ComposeTitleBar** represents a common title bar that contains a title, subtitle (optional), and profile picture (
* optional). It can come with a Back button for switching between pages of different levels.
*
* > **NOTE**
* >
* > - This component can be used only in the stage model.
* >
* > - If the **ComposeTitleBar** component has [universal attributes]{@link ./@internal/component/ets/common} and
* > [universal events]{@link ./@internal/component/ets/common} configured, the compiler toolchain automatically
* > generates an additional **__Common__** node and mounts the universal attributes and universal events on this node
* > rather than the **ComposeTitleBar** component itself. As a result, the configured universal attributes and
* > universal events may fail to take effect or behave as intended. For this reason, avoid using universal attributes
* > and events with the **ComposeTitleBar** component.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
@Component
export declare struct ComposeTitleBar {
/**
* A single menu item for the profile picture on the left.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
item?: ComposeTitleBarMenuItem;
/**
* Title.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
title: ResourceStr;
/**
* Subtitle.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
subtitle?: ResourceStr;
/**
* List of menu items on the right.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @stagemodelonly
* @crossplatform [since 20]
* @atomicservice [since 11]
* @since 10 dynamic
*/
menuItems?: Array<ComposeTitleBarMenuItem>;
}
