@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
48 lines (47 loc) • 2.5 kB
TypeScript
import '@ui5/webcomponents/dist/SuggestionItemCustom.js';
import type { ListItemBaseClickEventDetail } from '@ui5/webcomponents/dist/ListItemBase.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '@ui5/webcomponents-react-base';
import type { ReactNode } from 'react';
interface SuggestionItemCustomAttributes {
/**
* Defines the text of the `SuggestionItemCustom`.
* **Note:** The text property is considered only for autocomplete.
* @default undefined
*/
text?: string | undefined;
}
interface SuggestionItemCustomDomRef extends Required<SuggestionItemCustomAttributes>, Ui5DomRef {
}
interface SuggestionItemCustomPropTypes extends SuggestionItemCustomAttributes, Omit<CommonProps, keyof SuggestionItemCustomAttributes | 'children' | 'onClick'> {
/**
* Defines the content of the component.
*
* __Supported Node Type/s:__ `Array<Node>`
*/
children?: ReactNode | ReactNode[];
/**
* Fired when the component is activated either with a mouse/tap or by using the Enter or Space key.
*
* **Note:** The event will not be fired if the `disabled` property is set to `true`.
*
* **Note:** Available since [v2.23.0](https://github.com/UI5/webcomponents/releases/tag/v2.23.0) of **@ui5/webcomponents**.
*
* | cancelable | bubbles |
* | :--------: | :-----: |
* | ❌|✅|
*/
onClick?: (event: Ui5CustomEvent<SuggestionItemCustomDomRef, ListItemBaseClickEventDetail>) => void;
}
/**
* The `SuggestionItemCustom` is type of suggestion item,
* that can be used to place suggestion items with custom content in the input.
* The text property is considered only for autocomplete.
* In case the user needs highlighting functionality, check "@ui5/webcomponents-base/dist/util/generateHighlightedMarkup.js"
*
* __Note:__ This is a UI5 Web Component! [SuggestionItemCustom UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SuggestionItemCustom) | [Repository](https://github.com/UI5/webcomponents)
*
* @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__.
*/
declare const SuggestionItemCustom: import("react").ForwardRefExoticComponent<SuggestionItemCustomPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<SuggestionItemCustomDomRef>>;
export { SuggestionItemCustom };
export type { SuggestionItemCustomDomRef, SuggestionItemCustomPropTypes };