Keyboard Support

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

Key Action
Switches the widget to the previous view.
Switches the widget to the next view.

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

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

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

import DxTabPanel from 'devextreme-vue/tab-panel';

const myTabPanelRef = 'my-tab-panel';

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

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

        this.tabPanelRef = React.createRef();
    }

    render() {
        return (
            <TabPanel ref={this.tabPanelRef} />
        );
    }

    get tabPanel() {
        return this.tabPanelRef.current.instance;
    }

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

export default App;
See Also