@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
50 lines (49 loc) • 2.01 kB
TypeScript
import '@ui5/webcomponents/dist/ColorPicker.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '../../types/index.js';
interface ColorPickerAttributes {
/**
* Determines the name by which the component will be identified upon submission in an HTML form.
*
* **Note:** This property is only applicable within the context of an HTML Form element.
*
* **Note:** Available since [v2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**.
* @default undefined
*/
name?: string | undefined;
/**
* Defines the currently selected color of the component.
*
* **Note**: use HEX, RGB, RGBA, HSV formats or a CSS color name when modifying this property.
* @default "rgba(255,255,255,1)"
*/
value?: string;
}
interface ColorPickerDomRef extends Required<ColorPickerAttributes>, Ui5DomRef {
}
interface ColorPickerPropTypes extends ColorPickerAttributes, Omit<CommonProps, keyof ColorPickerAttributes | 'onChange'> {
/**
* Fired when the the selected color is changed
*/
onChange?: (event: Ui5CustomEvent<ColorPickerDomRef>) => void;
}
/**
* The `ColorPicker` allows users to choose any color and provides different input options for selecting colors.
*
* ### Usage
*
* #### When to use
* Use the color picker if:
*
* - users need to select any color freely.
*
* #### When not to use
*
* - Users need to select one color from a predefined set of colors. Use the ColorPalette component instead.
*
*
*
* __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
*/
declare const ColorPicker: import("react").ForwardRefExoticComponent<ColorPickerPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<ColorPickerDomRef>>;
export { ColorPicker };
export type { ColorPickerDomRef, ColorPickerPropTypes };