jQuery CheckBox Options

An object defining configuration properties for the CheckBox UI component.

accessKey

Specifies the shortcut key that sets focus on the UI component.

Type:

String

Default Value: undefined

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.

Type:

Boolean

Default Value: true

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.

Type:

Boolean

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#checkBoxContainer").dxCheckBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-check-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-check-box>
import { DxCheckBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxCheckBoxModule
    ],
    // ...
})
Vue
App.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
App.js
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.

Type:

Boolean

Default Value: false

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

View Demo

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Boolean

Default Value: true (desktop)

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

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 (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

NOTE
The property affects only the size of the UI component container. Use the iconSize property to specify the size of a check box icon.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

iconSize

Specifies the check box icon's width and height.

Type:

Number

|

String

Default Value: undefined

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.

Type:

Boolean

Default Value: false

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

jQuery
index.js
$(() => {
    const checkBox = $('#checkBox').dxCheckBox({
        // ...
        value: 'John Smith'
    }).dxCheckBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (checkBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});
Angular
app.component.ts
app.component.html
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
    value="John Smith"
>
</dx-check-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>
Vue
App.vue
<template>
    <DxCheckBox ...
        :ref="checkBoxRef"
        value="John Smith"
    >
    </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
App.js
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}
            value="John Smith"
        >
        </CheckBox>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;
See Also

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Boolean

Default Value: true

NOTE
When you use async rules, isValid is true if the status is "pending" or "valid".
See Also

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

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.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

CheckBox

The UI component's instance.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

CheckBox

The UI component's instance.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

CheckBox

The UI component's instance.

Default Value: null

Angular
app.component.html
app.component.ts
<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
App.vue (Options API)
App.vue (Composition API)
<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
App.js
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
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

fullName

String

The path to the modified property that includes all parent properties.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

CheckBox

The UI component's instance.

Default Value: null

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

jQuery
index.js
$(function() {
    $("#checkBoxContainer").dxCheckBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<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
App.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
App.js
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.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value

Object

The UI component's new value.

previousValue

Object

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

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

CheckBox

The UI component's instance.

Default Value: null

readOnly

Specifies whether the editor is read-only.

Type:

Boolean

Default Value: false

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

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

text

Specifies the text displayed by the check box.

Type:

String

Default Value: ''

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type: any
Default Value: null

See Also

validationErrors

An array of the validation rules that failed.

Type:

Array<any>

Default Value: null

validationMessageMode

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

Default Value: 'auto'

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.

Type:

Position

Default Value: 'bottom'

The following example positions a validation message at the component's right:

jQuery
index.js
$(function() {
    $("#checkBoxContainer").dxCheckBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});
Angular
app.component.html
<dx-check-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-check-box>
Vue
App.vue
<template>
    <DxCheckBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxCheckBox>
</template>

<script>
    // ...
</script>
React
App.js
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.

Default Value: 'valid'

The following table illustrates the validation status indicators:

validationStatus Indicator
"pending" DevExtreme editor validation status: pending
"valid" DevExtreme editor validation status: valid
"invalid" DevExtreme editor validation status: invalid

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

jQuery
index.js
$(function() {
    const checkBox = $("#checkBoxContainer").dxCheckBox({
        // ...
    }).dxCheckBox("instance");

    function setInvalidStatus(message) {
        checkBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});
Angular
app.component.html
app.component.ts
<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
App.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
App.js
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.

Type:

Boolean

| null | undefined
Default Value: false
Raised Events: onValueChanged

The CheckBox can be in one of the following states depending on the value property's value.

  • checked
    value is true

  • unchecked
    value is false

  • indeterminate
    value is undefined or null

Users can press the Space key to change the value.

View Demo

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

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

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

NOTE
The property affects only the size of the UI component container. Use the iconSize property to specify the size of a check box icon.