A newer version of this page is available. Switch to the current version.

Keyboard Support

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

Key Action
Space Changes the widget value.

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

jQuery
JavaScript
function registerKeyHandlers () {
    let 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
    ],
    // ...
})
See Also