Keyboard Support

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

Key Action
Enter or Space Changes the widget value.
Changes the switch state to "On".
Changes the switch state to "Off".

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

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

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

import DxSwitch from 'devextreme-vue/switch';

const mySwitchRef = 'my-switch';

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

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

        this.switchRef = React.createRef();
    }

    render() {
        return (
            <Switch ref={this.switchRef} />
        );
    }

    get switch() {
        return this.switchRef.current.instance;
    }

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

export default App;
See Also