Angular 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.

Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.

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
  • ],
  • // ...
  • })
See Also