Keyboard Support

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

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 option is set to true.
Delete Removes the focused item. Active if the allowItemDeleting option is set to true.

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

jQuery
JavaScript
function registerKeyHandlers () {
    let 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 } from '@angular/core';
import { DxListModule, DxListComponent } from 'devextreme-angular';
// ...
export class AppComponent {
    @ViewChild(DxListComponent) list: DxListComponent
    registerKeyHandlers () {
        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
    ],
    // ...
})
See Also