All docs
V20.2
21.1 (CTP)
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

Keyboard Support

An end user can use the following keys to interact with the UI component.

Key Action
Space Changes the UI component value.

You can implement a custom handler for a key using the registerKeyHandler(key, handler) method.

jQuery
JavaScript
function registerKeyHandlers () {
    const checkBox = $("#checkBoxContainer").dxCheckBox("instance");
    checkBox.registerKeyHandler("backspace", function(e) {
        // The argument "e" contains information on the event
    });
    checkBox.registerKeyHandler("space", function(e) {
        // ...
    });
}
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxCheckBoxModule, DxCheckBoxComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
    @ViewChild(DxCheckBoxComponent, { static: false }) checkBox: DxCheckBoxComponent;
    // Prior to Angular 8
    // @ViewChild(DxCheckBoxComponent) checkBox: DxCheckBoxComponent;

    ngAfterViewInit () {
        this.checkBox.instance.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.checkBox.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
@NgModule({
    imports: [
        // ...
        DxCheckBoxModule
    ],
    // ...
})
Vue
<template>
    <DxCheckBox :ref="myCheckBoxRef" />
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxCheckBox from 'devextreme-vue/check-box';

const myCheckBoxRef = 'my-check-box';

export default {
    components: {
        DxCheckBox
    },
    data() {
        return {
            myCheckBoxRef
        }
    },
    computed: {
        checkBox: function() {
            return this.$refs[myCheckBoxRef].instance;
        }
    },
    mounted: function() {
        this.checkBox.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.checkBox.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
</script>
React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import { CheckBox } from 'devextreme-react/check-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.checkBoxRef = React.createRef();
    }

    render() {
        return (
            <CheckBox ref={this.checkBoxRef} />
        );
    }

    get checkBox() {
        return this.checkBoxRef.current.instance;
    }

    componentDidMount() {
        this.checkBox.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.checkBox.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}

export default App;
See Also