Vue Color Box

The ColorBox allows users to enter a color or select it in the drop-down editor. When you create a ColorBox, specify its value property to set the initial color. Users can change the value after they pick a shade, or after they click the OK button. To specify the mode, use the applyValueMode property.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

<template> <div class="form"> <div class="dx-fieldset"> <div class="dx-field"> <div class="dx-field-label">Default mode</div> <div class="dx-field-value"> <DxColorBox value="#f05b41" :input-attr="defaultModeLabel" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">With alpha channel editing</div> <div class="dx-field-value"> <DxColorBox :edit-alpha-channel="true" value="#f05b41" :input-attr="alphaChannelLabel" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">Custom button captions</div> <div class="dx-field-value"> <DxColorBox value="#f05b41" apply-button-text="Apply" cancel-button-text="Decline" :input-attr="customButtonCaptionsLabel" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">Read only</div> <div class="dx-field-value"> <DxColorBox :read-only="true" value="#f05b41" :input-attr="readOnlyLabel" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">Disabled</div> <div class="dx-field-value"> <DxColorBox :disabled="true" value="#f05b41" :input-attr="disabledLabel" /> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Event Handling</div> <div class="hero-block"> <div :style="{ backgroundColor: color }" class="color-block" > <div class="superhero"/> </div> <div class="hero-color-box"> <DxColorBox v-model:value="color" apply-value-mode="instantly" :input-attr="eventHandlingLabel" /> </div> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import DxColorBox from 'devextreme-vue/color-box'; const color = ref('#f05b41'); const defaultModeLabel = { 'aria-label': 'Default mode' }; const alphaChannelLabel = { 'aria-label': 'With alpha channel editing' }; const customButtonCaptionsLabel = { 'aria-label': 'Custom button captions' }; const readOnlyLabel = { 'aria-label': 'Read only' }; const disabledLabel = { 'aria-label': 'Disabled' }; const eventHandlingLabel = { 'aria-label': 'Event Handling' }; </script> <style> .form { min-height: 690px; } .form .dx-field-value { text-align: right; } .dx-fieldset-header { padding: 10px 0; } .color-block { width: 360px; height: 254px; background-color: #f05b41; position: relative; } .hero-color-box { position: absolute; right: 0; left: 400px; top: 110px; } .color-block .superhero { position: absolute; height: 100%; width: 100%; } .hero-block { position: relative; } .superhero { background-image: url("../../../../images/hero_white.png"); } .dx-color-scheme-dark .superhero { background-image: url("../../../../images/hero_black.png"); } .dx-color-scheme-darkmoon .superhero { background-image: url("../../../../images/hero_darkmoon.png"); } .dx-color-scheme-darkviolet .superhero { background-image: url("../../../../images/hero_darkviolet.png"); } .dx-color-scheme-greenmist .superhero { background-image: url("../../../../images/hero_greenmist.png"); } .dx-color-scheme-contrast .superhero { background-image: url("../../../../images/hero_contrast.png"); } .dx-color-scheme-blue-dark .superhero, .dx-color-scheme-orange-dark .superhero, .dx-color-scheme-teal-dark .superhero, .dx-color-scheme-lime-dark .superhero, .dx-color-scheme-purple-dark .superhero { background-image: url("../../../../images/hero_material_dark.png"); } </style>

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.6/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>

You can hide the editor's drop-down button to allow users to only type in a color code. To do this, disable the showDropDownButton property. Users can also edit the transparency of the selected shade if the editAlphaChannel property is set to true.

Configure the ColorBox

Use the following properties to specify the component's interactivity:

readOnly
Specifies whether the ColorBox is read-only.
disabled
Specifies whether the ColorBox responds to user interaction.

You can specify the following properties to add custom buttons into the input field, or configure the drop-down editor's buttons:

buttons
Allows you to add custom buttons to the input text field.
showClearButton
Specifies whether to display the Clear button in the ColorBox.
applyButtonText
Specifies the text for the button that applies changes and closes the drop-down editor.
cancelButtonText
Specifies the text for the button that cancels changes and closes the drop-down editor.

Handle Value Change

Implement the onValueChanged function to handle the value change when users select a color in the drop-down editor. To handle the input value change, use the onInput function.