JavaScript/jQuery CheckBox Options
An object defining configuration properties for the CheckBox UI component.
See Also
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.
disabled
Specifies whether the UI component responds to user interaction.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#checkBoxContainer").dxCheckBox({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-check-box ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-check-box>
import { DxCheckBoxModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxCheckBoxModule ], // ... })
Vue
<template> <DxCheckBox ... :element-attr="checkBoxAttributes"> </DxCheckBox> </template> <script> import DxCheckBox from 'devextreme-vue/check-box'; export default { components: { DxCheckBox }, data() { return { checkBoxAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import CheckBox from 'devextreme-react/check-box'; class App extends React.Component { checkBoxAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <CheckBox ... elementAttr={this.checkBoxAttributes}> </CheckBox> ); } } export default App;
enableThreeStateBehavior
Specifies whether users can set the CheckBox state to indeterminate.
The CheckBox component supports three states: checked, unchecked, and indeterminate. The following table specifies the relation between the editor's state and its value:
Value | State |
---|---|
null or undefined |
Indeterminate |
true |
Checked |
false |
Unchecked |
If you set enableThreeStateBehavior to true
, users can cycle through CheckBox states in the following order:
Indeterminate → Checked → Unchecked → Indeterminate → ...
If you set enableThreeStateBehavior property to false
, users can only cycle between the checked and unchecked states. Note that the CheckBox can initially appear in the indeterminate state, if you haven't set the value to either true
or false
.
Indeterminate → Checked → Unchecked → Checked → Unchecked → ...
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.
iconSize
Specifies the check box icon's width and height.
This property accepts a value of one of the following types:
Number
The width and height in pixels.String
A CSS-accepted measurement of width and height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.
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 checkBox = $('#checkBox').dxCheckBox({ // ... }).dxCheckBox('instance'); $('#button').dxButton({ // ... onClick () { if (checkBox.option('isDirty')) { DevExpress.ui.notify("Do not forget to save changes", "warning", 500); } } }); });
Angular
import { Component, ViewChild } from '@angular/core'; import { DxCheckBoxComponent, 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('checkBoxRef', { static: false }) checkBox: DxCheckBoxComponent; onClick () { if (this.checkBox.instance.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }
<dx-check-box ... #checkBoxRef > </dx-check-box> <dx-button ... (onClick)="onClick($event)" > </dx-button>
Vue
<template> <DxCheckBox ... :ref="checkBoxRef" > </DxCheckBox> <DxButton ... @click="onClick" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxCheckBox from 'devextreme-vue/check-box'; import DxButton from 'devextreme-vue/button'; import notify from 'devextreme/ui/notify'; export default { components: { DxCheckBox, DxButton }, data() { return { checkBoxRef } }, methods: { onClick () { if (this.checkBox.option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } } }, computed: { checkBox: function() { return this.$refs[checkBoxRef].instance; } } } </script>
React
import React, { useRef } from 'react'; import CheckBox from 'devextreme-react/check-box'; import Button from 'devextreme-react/button'; import 'devextreme/dist/css/dx.light.css'; const App = () => { const checkBoxRef = useRef(null); const onClick = () => { if (this.checkBoxRef.current.instance().option('isDirty')) { notify("Do not forget to save changes", "warning", 500); } }; return ( <CheckBox ... ref={checkBoxRef} > </CheckBox> <Button ... onClick={onClick} /> ); }; export default App;
See Also
isValid
Specifies or indicates whether the editor's value is valid.
See Also
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.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
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. |
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. |
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-check-box ... (onInitialized)="saveInstance($event)"> </dx-check-box>
import { Component } from "@angular/core"; import CheckBox from "devextreme/ui/data_grid"; // ... export class AppComponent { checkBoxInstance: CheckBox; saveInstance (e) { this.checkBoxInstance = e.component; } }
Vue
<template> <div> <DxCheckBox ... @initialized="saveInstance"> </DxCheckBox> </div> </template> <script> import DxCheckBox from 'devextreme-vue/check-box'; export default { components: { DxCheckBox }, data: function() { return { checkBoxInstance: null }; }, methods: { saveInstance: function(e) { this.checkBoxInstance = e.component; } } }; </script>
<template> <div> <DxCheckBox ... @initialized="saveInstance"> </DxCheckBox> </div> </template> <script setup> import DxCheckBox from 'devextreme-vue/check-box'; let checkBoxInstance = null; const saveInstance = (e) => { checkBoxInstance = e.component; } </script>
React
import CheckBox from 'devextreme-react/check-box'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.checkBoxInstance = e.component; } render() { return ( <div> <CheckBox onInitialized={this.saveInstance} /> </div> ); } }
See Also
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() { $("#checkBoxContainer").dxCheckBox({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-check-box ... (onOptionChanged)="handlePropertyChange($event)"> </dx-check-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 { DxCheckBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxCheckBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxCheckBox ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxCheckBox from 'devextreme-vue/check-box'; export default { components: { DxCheckBox }, // ... 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 CheckBox from 'devextreme-react/check-box'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <CheckBox ... onOptionChanged={handlePropertyChange} /> ); }
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. |
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 });
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.
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
See Also
validationErrors
An array of validation errors.
Array<any>
CheckBox updates this property automatically as it validates values. You can also update validationErrors manually to display custom errors and implement custom validation logic. The following code snippet demonstrates how to define items in this array:
jQuery
$('#check-box').dxCheckBox({ isValid: false, validationErrors: [{ message: "Custom validation error" }], })
Angular
<dx-check-box [isValid]="false" [validationErrors]="validationErrors" ></dx-check-box>
import { DxCheckBoxComponent } from 'devextreme-angular/ui/check-box' export class AppComponent { validationErrors = [ { message: 'Custom validation error' } ]; }
Vue
<script setup lang="ts"> import { DxCheckBox } from 'devextreme-vue/check-box'; const validationErrors = [ { message: 'Custom validation error' } ]; </script> <template> <DxCheckBox :is-valid="false" :validation-errors="validationErrors" /> </template>
React
import { CheckBox } from 'devextreme-react/check-box'; const validationErrors = [ { message: 'Custom validation error' } ]; function App(): JSX.Element { return ( <CheckBox isValid={false} validationErrors={validationErrors} /> ) }
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.
The following example positions a validation message at the component's right:
jQuery
$(function() { $("#checkBoxContainer").dxCheckBox({ // ... validationMessagePosition: 'right' }).dxValidator({ validationRules: [{ type: 'required', message: 'Required', }], }); });
Angular
<dx-check-box ... validationMessagePosition="right"> <dx-validator> <dxi-validation-rule type="required" message="Required" > </dxi-validation-rule> </dx-validator> </dx-check-box>
Vue
<template> <DxCheckBox ... validation-message-position="right" > <DxValidator> <DxRequiredRule message="Required" /> </DxValidator> </DxCheckBox> </template> <script> // ... </script>
React
import React from 'react'; // ... function App() { return ( <CheckBox ... validationMessagePosition="right" > <Validator> <RequiredRule message="Required" /> </Validator> </CheckBox> ); }; 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 checkBox = $("#checkBoxContainer").dxCheckBox({ // ... }).dxCheckBox("instance"); function setInvalidStatus(message) { checkBox.option({ validationStatus: "invalid", validationErrors: [{ message: message }] }); } });
Angular
<dx-check-box [validationStatus]="validationStatus" [validationErrors]="validationErrors"> </dx-check-box>
// ... export class AppComponent { validationStatus: string = "valid"; validationErrors: any; // ... setInvalidStatus(message) { this.validationStatus = "invalid"; this.validationErrors = [{ message: message }]; } }
Vue
<template> <DxCheckBox ... :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 ( <CheckBox validationStatus={validationStatus} validationErrors={validationErrors} /> ); }; export default App;
value
Specifies the UI component state.
The CheckBox can be in one of the following states depending on the value property's value.
checked
value istrue
unchecked
value isfalse
indeterminate
value isundefined
ornull
Users can press the Space key to change the value.
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"
.