ColorPicker

ColorPicker is an input component to select a color.

Import #


import ColorPicker from 'primevue/colorpicker';

Basic #

ColorPicker is used as a controlled input with v-model property.



<ColorPicker v-model="color" />

Inline #

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



<ColorPicker v-model="color" inline />

Format #

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

HEX

6466f1

RGB

{"r":100,"g":102,"b":241}

HSB

{"h":239,"s":59,"b":95}



<ColorPicker v-model="colorHEX" inputId="cp-hex" format="hex" class="mb-3" />
<ColorPicker v-model="colorRGB" inputId="cp-rgb" format="rgb" class="mb-3" />
<ColorPicker v-model="colorHSB" inputId="cp-hsb" format="hsb" class="mb-3" />

Disabled #

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



<ColorPicker v-model="color" disabled />

Form #

Compatibility with popular Vue form libraries.

VeeValidate #

VeeValidate is a popular library for handling forms in Vue.



<template>
    <div class="card flex justify-content-center">
        <form @submit="onSubmit" class="flex flex-column align-items-center gap-2">
            <ColorPicker v-model="value" :class="{ 'p-invalid': errorMessage }" aria-describedby="cp-error" />
            <small class="p-error" id="cp-error">{{ errorMessage || '&nbsp;' }}</small>
            <Button type="submit" label="Submit" />
        </form>
        <Toast />
    </div>
</template>

Style #

Following is the list of structural style classes, for theming classes visit theming page.

Name	Element
p-colorpicker	Container element.
p-colorpicker-overlay	Container element in overlay mode.
p-colorpicker-preview	Preview input in overlay mode.
p-colorpicker-panel	Panel element of the colorpicker.
p-colorpicker-content	Wrapper that contains color and hue sections.
p-colorpicker-color-selector	Color selector container.
p-colorpicker-color	Color element.
p-colorpicker-color-handle	Handle of the color element.
p-colorpicker-hue	Hue slider.
p-colorpicker-hue-handle	Handle of the hue slider.

Accessibility #

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

Key	Function
tab	Moves focus to the color picker button.
space	Opens the popup and moves focus to the color slider.

Popup Keyboard Support

Key	Function
enter	Selects the color and closes the popup.
space	Selects the color and closes the popup.
escape	Closes the popup, moves focus to the input.

Color Picker Slider

Key	Function
arrow keys	Changes color.

Hue Slider

Key	Function
up arrowdown arrow	Changes hue.