Handle the Value Change Event
By default, the ColorBox applies value after an end user clicks the "Apply" button. To change this behavior, assign 'instantly' to the applyValueMode property. In this case, the UI component applies the value immediately after an end user chooses a color in the drop-down editor.
jQuery
$(function() { $("#colorBoxContainer").dxColorBox({ value: "#FF0000", applyValueMode: 'instantly' }); });
Angular
<dx-color-box [(value)]="color" applyValueMode="instantly"> </dx-color-box>
import { DxColorBoxModule } from "devextreme-angular"; // ... export class AppComponent { color: string = "#FF0000" } @NgModule({ imports: [ // ... DxColorBoxModule ], // ... })
Vue
<template> <DxColorBox v-model:value="color" apply-value-mode="instantly" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data() { return { color: "#FF0000" }; } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ColorBox from 'devextreme-react/color-box'; class App extends React.Component { constructor(props) { super(props); this.state = { color: "#FF0000" }; this.handleValueChange = this.handleValueChange.bind(this); } handleValueChange(e) { this.setState({ color: e.value }); } render() { return ( <ColorBox value={this.state.color} applyValueMode="instantly" onValueChanged={this.handleValueChange} /> ); } } export default App;
To process a new ColorBox value, you need to handle the value change event. If the handling function is not going to be changed during the lifetime of the UI component, assign it to the onValueChanged property when you configure the UI component.
jQuery
$(function() { $("#colorBoxContainer").dxColorBox({ onValueChanged: function (e) { const previousValue = e.previousValue; const newValue = e.value; // Event handling commands go here } }); });
Angular
<dx-color-box ... [(value)]="color" (onValueChanged)="handleValueChange($event)"> </dx-color-box>
import { DxColorBoxModule } from "devextreme-angular"; // ... export class AppComponent { color: string = "#FF0000"; handleValueChange (e) { const previousValue = e.previousValue; const newValue = e.value; // Event handling commands go here } } @NgModule({ imports: [ // ... DxColorBoxModule ], // ... })
Vue
<template> <DxColorBox v-model:value="color" @value-changed="handleValueChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data() { return { color: "#FF0000" }; }, methods: { handleValueChange: function (e) { const previousValue = e.previousValue; const newValue = e.value; // Event handling commands go here } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ColorBox from 'devextreme-react/color-box'; class App extends React.Component { constructor(props) { super(props); this.state = { color: "#FF0000" }; this.handleValueChange = this.handleValueChange.bind(this); } handleValueChange(e) { const previousValue = e.previousValue; const newValue = e.value; // Event handling commands go here this.setState({ color: newValue }); } render() { return ( <ColorBox value={this.state.color} onValueChanged={this.handleValueChange} /> ); } } export default App;
If you are going to change event handlers at runtime, or if you need to attach several handlers to the value change event, subscribe to this event using the on(eventName, eventHandler) method. This approach is more typical of jQuery.
const valueChangedHandler1 = function (e) { const previousValue = e.previousValue; const newValue = e.value; // First handler of the "valueChanged" event }; const valueChangedHandler2 = function (e) { const previousValue = e.previousValue; const newValue = e.value; // Second handler of the "valueChanged" event }; $("#colorBoxContainer").dxColorBox("instance") .on("valueChanged", valueChangedHandler1) .on("valueChanged", valueChangedHandler2);
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout
- ColorBox - Support Alpha Channel
- ColorBox Demos
- ColorBox API Reference
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.