All docs
V20.2
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
22.2
22.1
21.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
A newer version of this page is available. Switch to the current version.

jQuery Calendar - Keyboard Support

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

Key Action
← → ↑ ↓ 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.
Ctrl + ↑ Increases zoomLevel.
Ctrl + ↓ Decreases zoomLevel.
Home Moves focus to the first date in the view.
End Moves focus to the last date in the view.

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

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

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

import DxCalendar from 'devextreme-vue/calendar';

const myCalendarRef = 'my-calendar';

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

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

        this.calendarRef = React.createRef();
    }

    render() {
        return (
            <Calendar ref={this.calendarRef} />
        );
    }

    get calendar() {
        return this.calendarRef.current.instance;
    }

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

export default App;
See Also