React DateBox - Keyboard Support

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

Value Picker Key Action
All Alt + ↓ / Alt + ↑ Opens/closes the value picker.
Esc Closes the date/time picker.
Calendar ← → ↑ ↓ Moves focus to the day nearby.
Page Up or Ctrl + ← Displays the previous month.
Page Down or Ctrl + → Displays the next month.
Enter Selects the focused day.
Alt + ↑ / Alt + ↓ Opens/closes the drop-down editor.
Esc Closes the drop-down editor.
List ↑ / ↓ Moves focus to the previous/next time value.
Enter Selects the focused time value.
Page Up / Page Down Moves focus to the first/last value.

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

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

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

import DxDateBox from 'devextreme-vue/date-box';

const myDateBoxRef = 'my-date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            myDateBoxRef
        }
    },
    computed: {
        dateBox: function() {
            return this.$refs[myDateBoxRef].instance;
        }
    },
    mounted: function() {
        this.dateBox.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.dateBox.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 { DateBox } from 'devextreme-react/date-box';

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

        this.dateBoxRef = React.createRef();
    }

    render() {
        return (
            <DateBox ref={this.dateBoxRef} />
        );
    }

    get dateBox() {
        return this.dateBoxRef.current.instance;
    }

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

export default App;
See Also