All docs
V19.1
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
A newer version of this page is available. Switch to the current version.

DevExtreme jQuery - Keyboard Support

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

Key Action
Enter or Space Identical to a click.

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

jQuery
JavaScript
function registerKeyHandlers () {
    let button =  $("#buttonContainer").dxButton("instance");
    button.registerKeyHandler("backspace", function (e) {
        // The argument "e" contains information on the event
    });
    button.registerKeyHandler("space", function (e) {
        // ...
    });
}
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from "@angular/core";
import { DxButtonModule, DxButtonComponent } from "devextreme-angular";
// ...
export class AppComponent implements AfterViewInit {
    @ViewChild(DxButtonComponent, { static: false }) button: DxButtonComponent
    // Prior to Angular 8
    // @ViewChild(DxButtonComponent) button: DxButtonComponent
    ngAfterViewInit () {
        this.button.instance.registerKeyHandler("backspace", function (e) {
            // The argument "e" contains information on the event
        });
        this.button.instance.registerKeyHandler("space", function (e) {
            // ...
        });
    }
}
@NgModule({
    imports: [
        // ...
        DxButtonModule
    ],
    // ...
})
Vue
<template>
    <DxButton
        :ref="myButtonRef" />
</template>
<script>
import DxButton from "devextreme-vue/button";

const myButtonRef = "my-button";

export default {
    components: {
        DxButton
    },
    data() {
        return {
            myButtonRef
        }
    },
    computed: {
        button: function() {
            return this.$refs[myButtonRef].instance;
        }
    },
    mounted: function() {
        this.button.registerKeyHandler("backspace", function(e) {
            // The argument "e" contains information on the event
        });
        this.button.registerKeyHandler("space", function(e) {
            // ...
        });
    }
}
</script>
React
import React from 'react';
import { Button } from 'devextreme-react/button';

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

        this.buttonRef = React.createRef();
    }

    get button() {
        return this.buttonRef.current.instance;
    }

    render() {
        return (
            <Button ref={this.buttonRef} />
        );
    }

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

export default App;
See Also