DevExtreme React - 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