UNPKG

@ui5/webcomponents-react

Version:

React Wrapper for UI5 Web Components and additional components

52 lines (51 loc) 2.16 kB
import '@ui5/webcomponents/dist/OptionCustom.js'; import type { ReactNode } from 'react'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface OptionCustomAttributes { /** * Defines the text, displayed inside the `Select` input filed * when the option gets selected. * @default undefined */ displayText?: string | undefined; /** * Defines the selected state of the component. * @default false */ selected?: boolean; /** * Defines the tooltip of the option. * @default undefined */ tooltip?: string | undefined; /** * Defines the value of the `Select` inside an HTML Form element when this component is selected. * For more information on HTML Form support, see the `name` property of `Select`. * @default undefined */ value?: string | undefined; } interface OptionCustomDomRef extends Required<OptionCustomAttributes>, Ui5DomRef { } interface OptionCustomPropTypes extends OptionCustomAttributes, Omit<CommonProps, keyof OptionCustomAttributes | 'children'> { /** * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. */ children?: ReactNode | ReactNode[]; } /** * The `OptionCustom` component defines a custom content of an option in the `Select`. * A component to be the same way as the standard `Option`. * The component accepts arbitrary HTML content to allow full customization. * * * * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/) * * @since [2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ declare const OptionCustom: import("react").ForwardRefExoticComponent<OptionCustomPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<OptionCustomDomRef>>; export { OptionCustom }; export type { OptionCustomDomRef, OptionCustomPropTypes };