A newer version of this page is available.

React ColorBox API

The ColorBox is a widget that allows an end user to enter a color or pick it out from the drop-down editor.

import ColorBox from "devextreme-react/color-box"

Type: ColorBoxTypes.default

Configuration

An object defining configuration options for the ColorBox widget.

Name	Description
acceptCustomValue	Specifies whether or not the widget allows an end-user to enter a custom value.
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
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.
buttons	Allows you to add custom buttons to the input text field.
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 widget responds to user interaction.
dropDownButtonComponent	An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
dropDownButtonRender	An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
dropDownButtonTemplate	Specifies a custom template for the drop-down button.
editAlphaChannel	Specifies whether or not the widget value includes the alpha channel component.
elementAttr	Specifies the attributes to be attached to the widget's root element.
fieldComponent	An alias for the fieldTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
fieldRender	An alias for the fieldTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
fieldTemplate	Specifies a custom template for the input field. Must contain the TextBox widget.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
inputAttr	Specifies the attributes to be passed on to the underlying HTML element.
isValid	Specifies or indicates whether the editor's value is valid.
keyStep	Specifies the size of a step by which a handle is moved using a keyboard shortcut.
name	The value to be assigned to the `name` attribute of the underlying HTML element.
onChange	A function that is executed when the widget loses focus after the text field's content was changed using the keyboard.
onClosed	A function that is executed once the drop-down editor is closed.
onCopy	A function that is executed when the widget's input has been copied.
onCut	A function that is executed when the widget's input has been cut.
onDisposing	A function that is executed before the widget is disposed of.
onEnterKey	A function that is executed when the Enter key has been pressed while the widget is focused.
onFocusIn	A function that is executed when the widget gets focus.
onFocusOut	A function that is executed when the widget loses focus.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onInput	A function that is executed each time the widget's input is changed while the widget is focused.
onKeyDown	A function that is executed when a user is pressing a key on the keyboard.
onKeyPress	A function that is executed when a user presses a key on the keyboard.
onKeyUp	A function that is executed when a user releases a key on the keyboard.
onOpened	A function that is executed once the drop-down editor is opened.
onOptionChanged	A function that is executed after a widget option is changed.
onPaste	A function that is executed when the widget's input has been pasted.
onValueChanged	A function that is executed after the widget's value is changed.
opened	Specifies whether or not the drop-down editor is displayed.
openOnFieldClick	Specifies whether a user can open the drop-down list by clicking a text field.
placeholder	The text displayed by the widget when the widget value is empty.
readOnly	Specifies whether the editor is read-only.
rtlEnabled	Switches the widget to a right-to-left representation.
showClearButton	Specifies whether to display the Clear button in the widget.
showDropDownButton	Specifies whether the drop-down button is visible.
stylingMode	Specifies how the widget's text field is styled.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
text	The read-only option that holds the text displayed by the widget input element.
validationError	Information on the broken validation rule. Contains the first item from the validationErrors array.
validationErrors	An array of the validation rules that failed.
validationMessageMode	Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
validationStatus	Indicates or specifies the current validation status.
value	Specifies the currently selected value.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
blur()	Removes focus from the input element.
close()	Closes the drop-down editor.
content()	Gets the popup window's content.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the ColorBox instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
field()	Gets the widget's `<input>` element.
focus()	Sets focus to the input element representing the widget.
getButton(name)	Gets an instance of a custom action button.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
open()	Opens the drop-down editor.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.
reset()	Resets the value option to the default value.
resetOption(optionName)	Resets an option to its default value.

Events

This section describes events that this widget raises.

Name	Description
change	Raised when the widget loses focus after the text field's content was changed using the keyboard.
closed	Raised once the drop-down editor is closed.
copy	Raised when the widget's input has been copied.
cut	Raised when the widget's input has been cut.
disposing	Raised before the widget is disposed of.
enterKey	Raised when the Enter key has been pressed while the widget is focused.
focusIn	Raised when the widget gets focus.
focusOut	Raised when the widget loses focus.
initialized	Raised only once, after the widget is initialized.
input	Raised each time the widget's input is changed while the widget is focused.
keyDown	Raised when a user is pressing a key on the keyboard.
keyPress	Raised when a user presses a key on the keyboard.
keyUp	Raised when a user releases a key on the keyboard.
opened	Raised once the drop-down editor is opened.
optionChanged	Raised after a widget option is changed.
paste	Raised when the widget's input has been pasted.
valueChanged	Raised after the widget's value is changed.

React ColorBox API

See Also

Configuration

See Also

Methods

Events

See Also