UNPKG

@ui5/webcomponents-react

Version:

React Wrapper for UI5 Web Components and additional components

67 lines (66 loc) 2.88 kB
import '@ui5/webcomponents-fiori/dist/ShellBarItem.js'; import type { ShellBarItemAccessibilityAttributes, ShellBarItemClickEventDetail } from '@ui5/webcomponents-fiori/dist/ShellBarItem.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '@ui5/webcomponents-react-base'; interface ShellBarItemAttributes { /** * Defines additional accessibility attributes on Shellbar Items. * * The accessibility attributes support the following values: * * - **expanded**: Indicates whether the button, or another grouping element it controls, * is currently expanded or collapsed. * Accepts the following string values: `true` or `false`. * * - **hasPopup**: Indicates the availability and type of interactive popup element, * such as menu or dialog, that can be triggered by the button. * * - **controls**: Identifies the element (or elements) whose contents * or presence are controlled by the component. * Accepts a lowercase string value, referencing the ID of the element it controls. * * **Note:** Available since [v2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of **@ui5/webcomponents-fiori**. * @default {} */ accessibilityAttributes?: ShellBarItemAccessibilityAttributes; /** * Defines the count displayed in badge. * @default undefined */ count?: string | undefined; /** * Defines the item's icon. * @default undefined */ icon?: string | undefined; /** * Defines the item text. * * **Note:** The text is only displayed inside the overflow popover list view. * @default undefined */ text?: string | undefined; } interface ShellBarItemDomRef extends Required<ShellBarItemAttributes>, Ui5DomRef { } interface ShellBarItemPropTypes extends ShellBarItemAttributes, Omit<CommonProps, keyof ShellBarItemAttributes | 'onClick'> { /** * Fired when the item is clicked. * * **Note:** Call `event.preventDefault()` inside the handler of this event to prevent its default action/s. * * | cancelable | bubbles | * | :--------: | :-----: | * | ✅|✅| */ onClick?: (event: Ui5CustomEvent<ShellBarItemDomRef, ShellBarItemClickEventDetail>) => void; } /** * The `ShellBarItem` represents a custom item for `ShellBar`. * * * * __Note:__ This is a UI5 Web Component! [ShellBarItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBarItem) | [Repository](https://github.com/UI5/webcomponents) */ declare const ShellBarItem: import("react").ForwardRefExoticComponent<ShellBarItemPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<ShellBarItemDomRef>>; export { ShellBarItem }; export type { ShellBarItemDomRef, ShellBarItemPropTypes };