All docs
V21.1
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 List - Keyboard Support

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

Key Action
↑ / ↓ Moves focus to the previous/next item.
Page Up / Page Down Moves focus to the item located a screen above/below the current one.
Home / End Moves focus to the first/last item.
Enter or Space Selects the focused item.
Shift + ↑ / ↓ Shifts the focused item one item up/down. Active if the allowItemReordering property is set to true.
Delete Removes the focused item. Active if the allowItemDeleting property is set to true.

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

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

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

import DxList from 'devextreme-vue/list';

const myListRef = 'my-list';

export default {
    components: {
        DxList
    },
    data() {
        return {
            myListRef
        }
    },
    computed: {
        list: function() {
            return this.$refs[myListRef].instance;
        }
    },
    mounted: function() {
        this.list.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.list.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
</script>
React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import { List } from 'devextreme-react/list';

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

        this.listRef = React.createRef();
    }

    render() {
        return (
            <List ref={this.listRef} />
        );
    }

    get list() {
        return this.listRef.current.instance;
    }

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

export default App;
See Also