@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
38 lines (37 loc) • 1.95 kB
TypeScript
import '@ui5/webcomponents/dist/CalendarLegendItem.js';
import type CalendarLegendItemType from '@ui5/webcomponents/dist/types/CalendarLegendItemType.js';
import type { CommonProps, Ui5DomRef } from '@ui5/webcomponents-react-base';
interface CalendarLegendItemAttributes {
/**
* Defines the text content of the Calendar Legend Item.
* @default undefined
*/
text?: string | undefined;
/**
* Defines the type of the Calendar Legend Item.
* @default "None"
*/
type?: CalendarLegendItemType | keyof typeof CalendarLegendItemType;
}
interface CalendarLegendItemDomRef extends Required<CalendarLegendItemAttributes>, Ui5DomRef {
}
interface CalendarLegendItemPropTypes extends CalendarLegendItemAttributes, Omit<CommonProps, keyof CalendarLegendItemAttributes> {
}
/**
* Each `CalendarLegendItem` represents a legend item, displaying a color with a label.
* The color is determined by the `type` property and the label by the `text` property.
* If a `SpecialCalendarDate` is used within the `Calendar` and a type is set, clicking on a `CalendarLegendItem`
* with the same type will emphasize the respective date(s) in the calendar.
*
* ### Usage
* The `CalendarLegendItem` is intended to be used within the `CalendarLegend` component.
*
*
*
* __Note:__ This is a UI5 Web Component! [CalendarLegendItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/CalendarLegendItem) | [Repository](https://github.com/UI5/webcomponents)
*
* @since [1.23.0](https://github.com/UI5/webcomponents/releases/tag/v1.23.0) of __@ui5/webcomponents__.
*/
declare const CalendarLegendItem: import("react").ForwardRefExoticComponent<CalendarLegendItemPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<CalendarLegendItemDomRef>>;
export { CalendarLegendItem };
export type { CalendarLegendItemDomRef, CalendarLegendItemPropTypes };