@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
49 lines (47 loc) • 2.78 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcSimpleColorPicker
* For more info on this Vivid element please visit https://vivid.deno.dev/components/simple-color-picker
* @param {Placement | undefined} placement - Placement of the popup with color swatches **attribute** `placement`
* @param {number} swatchesPerRow - Number of swatches per row for grid layout **attribute** `swatches-per-row`
* @param {AnchorType | undefined} anchor - ID or direct reference to the component's anchor element. **attribute** `anchor`
* @param {boolean} open - Indicates whether the popup is open **attribute** `open`
* @param {ColorSwatch[]} swatches - List of color swatches, has to be an array of objects
### Examples
* @param {string | undefined} label - The label for the form element. **attribute** `label`
* @param {string} value - The current value of the element. **attribute** `current-value`
* @param currentValue
* @param {string} initialValue - The default value of the element. This value sets the `value` property
only when the `value` property has not been explicitly set. **attribute** `value`
* @param {boolean} disabled - Sets the element's disabled state. A disabled element will not be included during form submission. **attribute** `disabled`
* @param {string} name - The name of the element. This element's value will be surfaced during form submission under the provided name. **attribute** `name`
* @param {boolean} required - Require the field to be completed prior to form submission. **attribute** `required`
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcSimpleColorPicker: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onChange?: ((event: SyntheticEvent) => void) | undefined;
placement?: any;
swatchesPerRow?: number | undefined;
anchor?: any;
open?: boolean | undefined;
swatches?: any[] | undefined;
label?: string | undefined;
value?: string | undefined;
currentValue?: any;
initialValue?: string | undefined;
disabled?: boolean | undefined;
name?: string | undefined;
required?: boolean | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcSimpleColorPicker;