ColorBox

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

Included in: dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/color_box
Export: default
ColorBox interactive configuration
Copy Code
Copy to Codepen
$("#colorbox").dxColorBox({
});

                    

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    JavaScript
    <div id="colorBox"></div>
    $(function () {
        $("#colorBox").dxColorBox({
            value: 'rgba(255, 144, 0, 0.3)',
            editAlphaChannel: true
        });
    });
  • Angular

    HTML
    <dx-color-box
        [value]="rgba(255, 144, 0, 0.3)"
        [editAlphaChannel]="true">
    </dx-color-box>
  • AngularJS

    HTML
    <div dx-color-box="{
        value: 'rgba(255, 144, 0, 0.3)',
        editAlphaChannel: true
    }"></div>
  • Knockout

    HTML
    <div data-bind="dxColorBox: {
        value: 'rgba(255, 144, 0, 0.3)',
        editAlphaChannel: true
    }"></div>
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().ColorBox()
        .ID("colorBox")
        .Value("rgba(255, 144, 0, 0.3)")
        .EditAlphaChannel(true)
    )
    @(Html.DevExtreme().ColorBox() _
        .ID("colorBox") _
        .Value("rgba(255, 144, 0, 0.3)") _
        .EditAlphaChannel(True)
    )

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo

See Also

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 a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying 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.

cancelButtonText

Specifies the text displayed on the button that cancels changes and closes the drop-down editor.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

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.

fieldTemplate

The template to be used for rendering the widget input field.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

inputAttr

Specifies the attributes to be passed on to the underlying HTML element.

isValid

Specifies 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 handler for the change event.

onClosed

A handler for the closed event.

onCopy

A handler for the copy event.

onCut

A handler for the cut event.

onDisposing

A handler for the disposing event.

onEnterKey

A handler for the enterKey event.

onFocusIn

A handler for the focusIn event.

onFocusOut

A handler for the focusOut event.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

onInput

A handler for the input event.

onKeyDown

A handler for the keyDown event.

onKeyPress

A handler for the keyPress event.

onKeyUp

A handler for the keyUp event.

onOpened

A handler for the opened event.

onOptionChanged

A handler for the optionChanged event.

onPaste

A handler for the paste event.

onValueChanged

A handler for the valueChanged event.

opened

Specifies whether or not the drop-down editor is displayed.

placeholder

The text displayed by the widget when the widget value is empty.

readOnly

A Boolean value specifying whether or not the widget is read-only.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

tabIndex

Specifies the widget tab index.

text

The read-only option that holds the text displayed by the widget input element.

validationError

Holds the object that defines the error that occurred during validation.

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

value

Specifies the current value displayed by the widget.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

blur()

Removes focus from the input element.

close()

Closes the drop-down editor.

content()

Returns an HTML element of the popup window content.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

field()

Returns an <input> element of the widget.

focus()

Sets focus to the input element representing the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

open()

Opens the drop-down editor.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the widget's value to null.

Events

This section describes events fired by this widget.

Name Description
change

Fires when a change within the widget's input element is committed by an end user.

closed

Fires after a drop-down list has been hidden.

copy

Fires after the widget's input has been copied.

cut

Fires after the Cut DOM event has fired.

disposing

Fires when the widget is being removed.

enterKey

Fires after the Enter key has been pressed within the widget's input element.

focusIn

Fires after the widget's input has been focused.

focusOut

Fires after the widget's input element has lost focus.

initialized

Raised only once, after the widget is initialized.

input

Fires when a value within the widget's input element is changed by an end user.

keyDown

Fires when a key is pressed down within the widget's input element.

keyPress

Fires when the keypress DOM event has been raised for the current input element.

keyUp

Fires when a key is released within the widget's input element.

opened

Fires when the drop-down editor is shown.

optionChanged

Fires after an option of the component is changed.

paste

Fires after the widget's input has been pasted.

valueChanged

Fires when the editor value changes.