DevExtreme React - Keyboard Support

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

Key Action
← ↑ or PageUp Moves focus to the previous tab.
→ ↓ or PageDown Moves focus to the next tab.
Home Moves focus to the first tab.
End Moves focus to the last tab.
Enter or Space Selects the tab. Available only if selectionMode is set to 'multiple'.
Shift + Mouse Wheel Scrolls the tabs left/right if the scrollingEnabled option is true.

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

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

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

import DxTabs from 'devextreme-vue/tabs';

const myTabsRef = 'my-tabs';

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

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

        this.tabsRef = React.createRef();
    }

    render() {
        return (
            <Tabs ref={this.tabsRef} />
        );
    }

    get tabs() {
        return this.tabsRef.current.instance;
    }

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

export default App;
See Also