DevExtreme React - Keyboard Support

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

Key Action
← / → Decreases/increases the value of the focused handle by a step.
Page Up / Page Down Decreases/increases the value of the focused handle by a keyStep.
Home / End Sets the focused handle to the minimum/maximum value or to the value of the other handle.

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

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

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

import DxSlider from 'devextreme-vue/slider';

const mySliderRef = 'my-slider';

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

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

        this.sliderRef = React.createRef();
    }

    render() {
        return (
            <Slider ref={this.sliderRef} />
        );
    }

    get slider() {
        return this.sliderRef.current.instance;
    }

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

export default App;
See Also