JavaScript/jQuery ColorBox Options
An object defining configuration properties for the ColorBox UI component.
See Also
acceptCustomValue
Specifies whether or not the UI component allows an end user to enter a custom value.
accessKey
Specifies the shortcut key that sets focus on the UI component.
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
Specifies whether the UI component changes its visual state as a result of user interaction.
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
applyButtonText
Specifies the text displayed on the button that applies changes and closes the drop-down editor.
applyValueMode
Specifies the way an end user applies the selected value.
The property accepts the following values.
"useButtons"
Enables an end user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively."instantly"
Applies the selected value immediately after a user clicks the required value in the drop-down menu. To cancel the selection, click outside the drop-down menu.
buttons[]
Allows you to add custom buttons to the input text field.
Array<DropDownPredefinedButton | TextEditorButton>
Built-in buttons should also be declared in this array. You can find an example in the following demo:
cancelButtonText
Specifies the text displayed on the button that cancels changes and closes the drop-down editor.
deferRendering
Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.
disabled
Specifies whether the UI component responds to user interaction.
dropDownButtonTemplate
Specifies a custom template for the drop-down button.
dropDownOptions
Configures the drop-down field which holds the content.
See Popup Configuration for properties that you can specify in this object.
Angular
Vue
editAlphaChannel
Specifies whether or not the UI component value includes the alpha channel component.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#colorBoxContainer").dxColorBox({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-color-box ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-color-box>
import { DxColorBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxColorBoxModule ], // ... })
Vue
<template> <DxColorBox ... :element-attr="colorBoxAttributes"> </DxColorBox> </template> <script> import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data() { return { colorBoxAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import ColorBox from 'devextreme-react/color-box'; class App extends React.Component { colorBoxAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <ColorBox ... elementAttr={this.colorBoxAttributes}> </ColorBox> ); } } export default App;
fieldTemplate
Specifies a custom template for the input field. Must contain the TextBox UI component.
See Also
focusStateEnabled
Specifies whether the UI component can be focused using keyboard navigation.
height
Specifies the UI component's height.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.
hint
Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled
Specifies whether the UI component changes its state when a user pauses on it.
inputAttr
Specifies the attributes to be passed on to the underlying HTML element.
jQuery
$(function(){ $("#colorBoxContainer").dxColorBox({ // ... inputAttr: { id: "inputId" } }); });
Angular
<dx-color-box ... [inputAttr]="{ id: 'inputId' }"> </dx-color-box>
import { DxColorBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxColorBoxModule ], // ... })
Vue
<template> <DxColorBox :input-attr="inputAttr" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data() { return { inputAttr: { id: 'inputId' } } } } </script>
React
import 'devextreme/dist/css/dx.light.css'; import ColorBox from 'devextreme-react/color-box'; const inputAttr = { id: 'inputId' }; export default function App() { return ( <ColorBox inputAttr={inputAttr} /> ); }
ASP.NET MVC Controls
@(Html.DevExtreme().ColorBox() .InputAttr("id", "inputId") // ===== or ===== .InputAttr(new { @id = "inputId" }) // ===== or ===== .InputAttr(new Dictionary<string, object>() { { "id", "inputId" } }) )
@(Html.DevExtreme().ColorBox() _ .InputAttr("id", "inputId") ' ===== or ===== .InputAttr(New With { .id = "inputId" }) ' ===== or ===== .InputAttr(New Dictionary(Of String, Object) From { { "id", "inputId" } }) )
To improve accessibility, use this property to specify aria-label for the component.
jQuery
$(function(){ $("#colorBoxContainer").dxColorBox({ // ... inputAttr: { 'aria-label': 'your-label', }, }); });
Angular
<dx-color-box ... [inputAttr]="{ 'aria-label': 'your-label' }"> </dx-color-box>
Vue
<template> <DxColorBox :input-attr="inputAttr" /> </template> <script> import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data() { return { inputAttr: { 'aria-label': 'your-label' } } } } </script>
React
import ColorBox from 'devextreme-react/color-box'; const inputAttr = { 'aria-label': 'your-label' }; export default function App() { return ( <ColorBox inputAttr={inputAttr} /> ); }
You do not need to specify aria-label
if you use label.
isDirty
Specifies whether the component's current value differs from the initial value.
This property is a read-only flag. You can use it to check if the editor value changed.
jQuery
$(() => { const colorBox = $('#colorBox').dxColorBox({ // ... }).dxColorBox('instance'); $('#button').dxButton({ // ... onClick () { if (colorBox.option('isDirty')) { DevExpress.ui.notify("Do not forget to save changes", "warning", 500); } } }); });
Angular
import { Component, ViewChild } from '@angular/core'; import { DxColorBoxComponent, DxButtonModule } from 'devextreme-angular'; import notify from 'devextreme/ui/notify'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('colorBoxRef', { static: false }) colorBox: DxColorBoxComponent; onClick () { if (this.colorBox.instance.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }
<dx-color-box ... #colorBoxRef > </dx-color-box> <dx-button ... (onClick)="onClick($event)" > </dx-button>
Vue
<template> <DxColorBox ... :ref="colorBoxRef" > </DxColorBox> <DxButton ... @click="onClick" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; import DxButton from 'devextreme-vue/button'; import notify from 'devextreme/ui/notify'; export default { components: { DxColorBox, DxButton }, data() { return { colorBoxRef } }, methods: { onClick () { if (this.colorBox.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }, computed: { colorBox: function() { return this.$refs[colorBoxRef].instance; } } } </script>
React
import React, { useRef } from 'react'; import ColorBox from 'devextreme-react/color-box'; import Button from 'devextreme-react/button'; import 'devextreme/dist/css/dx.light.css'; const App = () => { const colorBoxRef = useRef(null); const onClick = () => { if (this.colorBoxRef.current.instance().option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } }; return ( <ColorBox ... ref={colorBoxRef} > </ColorBox> <Button ... onClick={onClick} /> ); }; export default App;
See Also
isValid
Specifies or indicates whether the editor's value is valid.
See Also
keyStep
Specifies the size of a step by which a handle is moved using a keyboard shortcut.
labelMode
Specifies the label's display mode.
This property can have one of the following values:
labelMode | Description | Illustration |
---|---|---|
"static" | The label is displayed above the input field. | |
"floating" | The label is used as a placeholder, but when the editor gets focus, the label moves to the position above the input field. |
|
"hidden" | The label is hidden. | |
"outside" | The label is outside. |
If autofill is enabled in the browser, we do not recommend that you use "floating" mode. The autofill values will overlap the label when it is displayed as a placeholder. Use "static" mode instead.
name
The value to be assigned to the name
attribute of the underlying HTML element.
Specify this property if the UI component lies within an HTML form that will be submitted.
onChange
A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onClosed
A function that is executed once the drop-down editor is closed.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onCopy
A function that is executed when the UI component's input has been copied.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onCut
A function that is executed when the UI component's input has been cut.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onEnterKey
A function that is executed when the Enter key has been pressed while the UI component is focused.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onFocusIn
A function that is executed when the UI component gets focus.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onFocusOut
A function that is executed when the UI component loses focus.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
Angular
<dx-color-box ... (onInitialized)="saveInstance($event)"> </dx-color-box>
import { Component } from "@angular/core"; import ColorBox from "devextreme/ui/data_grid"; // ... export class AppComponent { colorBoxInstance: ColorBox; saveInstance (e) { this.colorBoxInstance = e.component; } }
Vue
<template> <div> <DxColorBox ... @initialized="saveInstance"> </DxColorBox> </div> </template> <script> import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, data: function() { return { colorBoxInstance: null }; }, methods: { saveInstance: function(e) { this.colorBoxInstance = e.component; } } }; </script>
<template> <div> <DxColorBox ... @initialized="saveInstance"> </DxColorBox> </div> </template> <script setup> import DxColorBox from 'devextreme-vue/color-box'; let colorBoxInstance = null; const saveInstance = (e) => { colorBoxInstance = e.component; } </script>
React
import ColorBox from 'devextreme-react/color-box'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.colorBoxInstance = e.component; } render() { return ( <div> <ColorBox onInitialized={this.saveInstance} /> </div> ); } }
See Also
onInput
A function that is executed each time the UI component's input is changed while the UI component is focused.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onKeyDown
A function that is executed when a user is pressing a key on the keyboard.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onKeyUp
A function that is executed when a user releases a key on the keyboard.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onOpened
A function that is executed once the drop-down editor is opened.
Information about the event.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#colorBoxContainer").dxColorBox({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-color-box ... (onOptionChanged)="handlePropertyChange($event)"> </dx-color-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxColorBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxColorBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxColorBox ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; export default { components: { DxColorBox }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ColorBox from 'devextreme-react/color-box'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <ColorBox ... onOptionChanged={handlePropertyChange} /> ); }
onPaste
A function that is executed when the UI component's input has been pasted.
Information about the event.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onValueChanged
A function that is executed after the UI component's value is changed.
Information about the event.
Name | Type | Description |
---|---|---|
value |
The UI component's new value. |
|
previousValue |
The UI component's previous value. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
openOnFieldClick
Specifies whether a user can open the drop-down list by clicking a text field.
See Also
placeholder
Specifies a text string displayed when the editor's value is empty.
See Also
readOnly
Specifies whether the editor is read-only.
When this property is set to true, the following applies:
- The editor's value cannot be changed using the UI.
- Built-in action buttons are invisible.
Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:
jQuery
index.js$(function() { $("#colorBoxContainer").dxColorBox({ // ... buttons: [{ name: "myCustomButton", location: "after", options: { onClick: function(e) { // ... }, disabled: false } }] }); });
Angular
app.component.htmlapp.component.tsapp.module.ts<dx-color-box ... > <dxi-button name="myCustomButton" location="after" [options]="myCustomButtonConfig"> </dxi-button> </dx-color-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { myCustomButtonConfig = { onClick: (e) => { // ... }, disabled: false }; }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxColorBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxColorBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxColorBox ... > <DxColorBoxButton name="myCustomButton" location="after" :options="myCustomButtonConfig" /> </DxColorBox> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox, { DxButton as DxColorBoxButton } from 'devextreme-vue/color-box'; export default { components: { DxColorBox, DxColorBoxButton }, data() { return { myCustomButtonConfig: { onClick: (e) => { // ... }, disabled: false } } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ColorBox, { Button as ColorBoxButton } from 'devextreme-react/color-box'; class App extends React.Component { myCustomButtonConfig = { onClick: (e) => { // ... }, disabled: false }; render() { return ( <ColorBox> <ColorBoxButton name="myCustomButton" location="after" options={this.myCustomButtonConfig} /> </ColorBox> ); } } export default App;
You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:
jQuery
index.js$(function() { $("#colorBoxContainer").dxColorBox({ // ... buttons: [{ name: "myCustomButton", // ... }], onOptionChanged: function(e) { if(e.name == "readOnly") { const myButton = e.component.getButton("myCustomButton"); myButton.option("visible", !e.value); // Hide the button when readOnly: true } } }); });
Angular
app.component.htmlapp.component.tsapp.module.ts<dx-color-box ... (onOptionChanged)="changeButtonState"> <dxi-button name="myCustomButton" ... ></dxi-button> </dx-color-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxColorBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxColorBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxColorBox ... @option-changed="changeButtonState"> <DxColorBoxButton name="myCustomButton" ... /> </DxColorBox> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox, { DxButton as DxColorBoxButton } from 'devextreme-vue/color-box'; export default { components: { DxColorBox, DxColorBoxButton }, data() { return { // ... } }, methods: { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ColorBox, { Button as ColorBoxButton } from 'devextreme-react/color-box'; class App extends React.Component { changeButtonState(e) { if(e.name == 'readOnly') { let myButton = e.component.getButton('myCustomButton'); myButton.option('visible', !e.value); // Hide the button when readOnly: true } } render() { return ( <ColorBox ... onOptionChanged={this.changeButtonState}> <ColorBoxButton name="myCustomButton" ... /> </ColorBox> ); } } export default App;
rtlEnabled
Switches the UI component to a right-to-left representation.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
showClearButton
Specifies whether to display the Clear button in the UI component.
The Clear button calls the reset method.
showDropDownButton
Specifies whether the drop-down button is visible.
See Also
stylingMode
Specifies how the UI component's text field is styled.
The following styles are available:
You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
text
The read-only property that holds the text displayed by the UI component input element.
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
See Also
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
The following property values are possible:
- auto
The tooltip with the message is displayed when the editor is in focus. - always
The tooltip with the message is not hidden when the editor loses focus.
validationMessagePosition
Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
If you set this property to auto
, the component specifies the validation message position automatically.
The following example positions a validation message at the component's right:
jQuery
$(function() { $("#colorBoxContainer").dxColorBox({ // ... validationMessagePosition: 'right' }).dxValidator({ validationRules: [{ type: 'required', message: 'Required', }], }); });
Angular
<dx-color-box ... validationMessagePosition="right"> <dx-validator> <dxi-validation-rule type="required" message="Required" > </dxi-validation-rule> </dx-validator> </dx-color-box>
Vue
<template> <DxColorBox ... validation-message-position="right" > <DxValidator> <DxRequiredRule message="Required" /> </DxValidator> </DxColorBox> </template> <script> // ... </script>
React
import React from 'react'; // ... function App() { return ( <ColorBox ... validationMessagePosition="right" > <Validator> <RequiredRule message="Required" /> </Validator> </ColorBox> ); }; export default App;
validationStatus
Indicates or specifies the current validation status.
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
![]() |
"valid" |
![]() |
"invalid" |
![]() |
When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:
jQuery
$(function() { const colorBox = $("#colorBoxContainer").dxColorBox({ // ... }).dxColorBox("instance"); function setInvalidStatus(message) { colorBox.option({ validationStatus: "invalid", validationErrors: [{ message: message }] }); } });
Angular
<dx-color-box [validationStatus]="validationStatus" [validationErrors]="validationErrors"> </dx-color-box>
// ... export class AppComponent { validationStatus: string = "valid"; validationErrors: any; // ... setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } }
Vue
<template> <DxColorBox ... :validation-status="validationStatus" :validation-errors="validationErrors" /> </template> <script> // ... export default { // ... data() { return { validationStatus: "valid", validationErrors: [] } }, methods: { setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } } } </script>
React
import React, { useState } from 'react'; // ... function App() { const [validationStatus, setValidationStatus] = useState("valid"); const [validationErrors, setValidationErrors] = useState([]); const setInvalidStatus = message => { setValidationStatus("invalid"); setValidationErrors([{ message: message }]); } return ( <ColorBox validationStatus={validationStatus} validationErrors={validationErrors} /> ); }; export default App;
width
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.