@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
45 lines (44 loc) • 1.79 kB
TypeScript
import '@ui5/webcomponents-fiori/dist/ShellBarItem.js';
import type { ShellBarItemClickEventDetail } from '@ui5/webcomponents-fiori/dist/ShellBarItem.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js';
interface ShellBarItemAttributes {
/**
* Defines the count displayed in the top-right corner.
* @default undefined
*/
count?: string | undefined;
/**
* Defines the name of 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 pressed.
*
* **Note:** Call `event.preventDefault()` inside the handler of this event to prevent its default action/s.
*/
onClick?: (event: Ui5CustomEvent<ShellBarItemDomRef, ShellBarItemClickEventDetail>) => void;
}
/**
* The `ShellBarItem` represents a custom item, that
* might be added to the `ShellBar`.
*
*
*
* __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
* @abstract
*/
declare const ShellBarItem: import("react").ForwardRefExoticComponent<ShellBarItemPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<ShellBarItemDomRef>>;
export { ShellBarItem };
export type { ShellBarItemDomRef, ShellBarItemPropTypes };