Skip to content

ColorPicker Color Selector

Rules

Basic Example

js
const rule = {
    type: "ColorPicker",
    field: "color",
    title: "Color",
    value: '#ff7271',
}

Props Configuration Examples

Support Alpha Channel

js
const rule = {
    type: "ColorPicker",
    field: "bgColor",
    title: "Background Color",
    value: '#ff7271',
    props: {
        showAlpha: true,
        colorFormat: 'rgba',
    },
}

Predefined Colors

js
const rule = {
    type: "ColorPicker",
    field: "themeColor",
    title: "Theme Color",
    value: '#409EFF',
    props: {
        predefine: [
            '#ff4500',
            '#ff8c00',
            '#ffd700',
            '#90ee90',
            '#00ced1',
            '#1e90ff',
            '#c71585',
        ],
    },
}

Different Sizes

js
const rule = {
    type: "ColorPicker",
    field: "color",
    title: "Color",
    value: '#409EFF',
    props: {
        size: "large",
    },
}

Events Examples

Listen to Color Changes

js
const rule = {
    type: "ColorPicker",
    field: "color",
    title: "Theme Color",
    value: '#409EFF',
    on: {
        change: (value) => {
            console.log('Color changed:', value);
        },
        'active-change': (value) => {
            console.log('Currently displayed color:', value);
        },
        focus: (event) => {
            console.log('Gained focus:', event);
        },
        blur: (event) => {
            console.log('Lost focus:', event);
        },
    },
}

Update Preview After Color Change

js
const rule = [
    {
        type: "ColorPicker",
        field: "color",
        title: "Theme Color",
        value: '#409EFF',
        inject: true,
        on: {
            change: ($inject, value) => {
                // Update color preview
                $inject.api.setValue('colorPreview', value);
            },
        },
    },
    {
        type: "input",
        field: "colorPreview",
        title: "Color Value",
        props: {
            disabled: true,
        },
    },
]

Full configuration: Element_ColorPicker

value :String

Props

Attribute NameDescriptionTypeDefault Value
disabledWhether to disablebooleanfalse
sizeSizeenum
showAlphaWhether to support alpha channel selectionbooleanfalse
colorFormatFormat of color written to v-modelenum
popperClassClass name for ColorPicker dropdownstring
predefinePredefined colorsobject
validateEventWhether to trigger form validation on inputbooleantrue
tabindexTabindex of ColorPickerstring / number0
ariaLabelAria-label of ColorPickerstring
idId of ColorPickerstring
teleportedWhether to render popover dropdown list to bodybooleantrue

Events

Event NameDescriptionType
changeTriggered when bound value changesFunction
active-changeTriggered when currently displayed color in panel changesFunction
focusTriggered when gaining focusFunction
blurTriggered when losing focusFunction

FormCreate is an open-source project released under the MIT License. Free for personal and commercial use.