ColorPicker

ColorPicker is an input component to select a color.


import { ColorPicker } from 'primereact/colorpicker';
         

ColorPicker is used as a controlled input with value and onChange properties.


<ColorPicker value={color} onChange={(e) => setColor(e.value)} />

         

ColorPicker is displayed as a popup by default, add inline property to customize this behavior.


<ColorPicker value={color} onChange={(e) => setColor(e.value)} inline />
         

Default color format to use in value binding is hex and other possible values can be rgb and hsb using the format property.

6466f1
{"r":100,"g":102,"b":241}
{"h":239,"s":59,"b":95}

<ColorPicker format="hex" value={colorHEX} onChange={(e) => setColorHEX(e.value)} />
<ColorPicker format="rgb" value={colorRGB} onChange={(e) => setColorRGB(e.value)} />
<ColorPicker format="hsb" value={colorHSB} onChange={(e) => setColorHSB(e.value)} />
         

When disabled is present, the element cannot be edited and focused.


<ColorPicker disabled />
         
Compatibility with popular React form libraries.

Formik is a popular library for handling forms in React.

 

<Toast ref={toast} />
<ColorPicker
    id="color"
    name="color"
    value={formik.values.color}
    className={classNames({ 'p-invalid': isFormFieldInvalid('item') })}
    onChange={(e) => {
        formik.setFieldValue('color', e.value);
    }}
/>
{getFormErrorMessage('color')}
<Button type="submit" label="Submit" />
         

React Hook Form is another popular React library to handle forms.

 

<Toast ref={toast} />
<Controller
name="color"
control={control}
    rules={{ required: 'Color is required.' }}
    render={({ field, fieldState }) => <ColorPicker name="color" control={control} value={field.value} className={classNames({ 'p-invalid': fieldState.error })} onChange={(e) => field.onChange(e.value)} />}
    />
    {getFormErrorMessage('color')}
<Button type="submit" label="Submit" />
         

Following is the list of structural style classes

NameElement
p-colorpickerContainer element.
p-colorpicker-overlayContainer element in overlay mode.
p-colorpicker-preview Preview input in overlay mode.
p-colorpicker-panelPanel element of the colorpicker.
p-colorpicker-contentWrapper that contains color and hue sections.
p-colorpicker-color-selectorColor selector container.
p-colorpicker-colorColor element.
p-colorpicker-color-handleHandle of the color element.
p-colorpicker-hueHue slider.
p-colorpicker-hue-handleHandle of the hue slider.
Accessibility guide documents the specification of this component based on WCAG guidelines, the implementation is in progress.

Screen Reader

Specification does not cover a color picker yet and using a semantic native color picker is not consistent across browsers so currently component is not compatible with screen readers. In the upcoming versions, text fields will be introduced below the slider section to be able to pick a color using accessible text boxes in hsl, rgba and hex formats.

Closed State Keyboard Support of Popup ColorPicker

KeyFunction
tabMoves focus to the color picker button.
spaceOpens the popup and moves focus to the color slider.

Popup Keyboard Support

KeyFunction
enterSelects the color and closes the popup.
spaceSelects the color and closes the popup.
escapeCloses the popup, moves focus to the input.

Color Picker Slider

KeyFunction
arrow keysChanges color.

Hue Slider

KeyFunction
up arrowdown arrowChanges hue.
Visit the API documentation for detailed information about all the properties, events and methods of the component.