UNPKG

@vonage/vivid-react

Version:

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

62 lines (60 loc) 3.75 kB
import React, { ReactNode, SyntheticEvent } from 'react'; /** VwcColorPicker * For more info on this Vivid element please visit https://vivid.deno.dev/components/color-picker * @param {string} placeholder - Sets the placeholder value of the element, generally used to provide a hint to the user. **attribute** `placeholder` * @param {string | undefined} savedColorsKey - Sets the localStorage saved colors key explicitly. **attribute** `saved-colors-key` * @param {boolean} disableSavedColors - Disables the saving colors functionality **attribute** `disable-saved-colors` * @param {number} maxSwatches - Limits number of swatches that can be saved. **attribute** `max-swatches` * @param {string | undefined} helperText - Provides additional information to help the user enter the correct information. To add HTML to the helper text, use the helper-text slot instead. **attribute** `helper-text` * @param {string | undefined} errorText - Provides a custom error message. Any current error state will be overridden. **attribute** `error-text` * @param validate * @param {string | undefined} successText - Provides a custom success message. Any current error state will be overridden. **attribute** `success-text` * @param {'delegate'} _vividAriaBehaviour * @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 VwcColorPicker: { (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; placeholder?: string | undefined; savedColorsKey?: string | undefined; disableSavedColors?: boolean | undefined; maxSwatches?: number | undefined; helperText?: string | undefined; errorText?: string | undefined; validate?: any; successText?: string | undefined; _vividAriaBehaviour?: 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 VwcColorPicker;