JavaScript/jQuery ColorBox Options

See Also

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

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.

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.

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

View Demo

See Also

• Custom Templates

See Popup Configuration for properties that you can specify in this object.

See Also

• Custom Templates

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".

$(function(){
    $("#colorBoxContainer").dxColorBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

<dx-color-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-color-box>

import { DxColorBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxColorBoxModule
    ],
    // ...
})

<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>

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}
        />
    );
}

@(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.

$(function(){
    $("#colorBoxContainer").dxColorBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

<dx-color-box ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-color-box>

<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>

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.

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const colorBox = $('#colorBox').dxColorBox({
        // ...
    }).dxColorBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (colorBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

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>

<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>

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

• reset

See Also

• validationErrors

See Also

• labelMode
• placeholder

This property can have one of the following values:

Specify this property if the UI component lies within an HTML form that will be submitted.

<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;
    }
}

<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>

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

The following example shows how to subscribe to component property changes:

$(function() {
    $("#colorBoxContainer").dxColorBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<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 { }  

<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> 

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}
        />        
    ); 
} 

See Also

• showDropDownButton

See Also

• label

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.html

  app.component.ts

  app.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.js

  import 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.html

  app.component.ts

  app.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.js

  import 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;

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
});

DataGrid Demo Navigation UI Demo Editors Demo

The Clear button calls the reset method.

See Also

• dropDownButtonTemplate

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.

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

See Also

• isValid

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.

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:

$(function() {
    $("#colorBoxContainer").dxColorBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-color-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-color-box>

<template>
    <DxColorBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxColorBox>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <ColorBox ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </ColorBox>
    ); 

};
export default App;

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:

$(function() {
    const colorBox = $("#colorBoxContainer").dxColorBox({
        // ...
    }).dxColorBox("instance");

    function setInvalidStatus(message) {
        colorBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<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 }];
    }
}

<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>

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;

See Also

• label

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".