DevExtreme Angular - Keyboard Support

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

Key Action
Shift + Mouse Wheel Scrolls the content left/right if the scrollDirection option is "horizontal" or "both".
↑ / ↓ Moves focus to the previous/next node.
Home / End Moves focus to the first/last node.
Expands the node.
Collapses the node.
Asterisk Sign (*) Expands all nodes. Available only if expandAllEnabled is set to true.
Minus Sign (-) Collapses all nodes. Available only if expandAllEnabled is set to true.
Enter or Space Selects the node.
Shift + ↑ / Shift + ↓ Extends selection up/down by one node.
Shift + Home Extends selection up to the first node.
Shift + End Extends selection down to the last node.

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

TypeScript
  • import { ..., ViewChild, AfterViewInit } from "@angular/core";
  • import { DxTreeViewModule, DxTreeViewComponent } from "devextreme-angular";
  • // ...
  • export class AppComponent implements AfterViewInit {
  • @ViewChild(DxTreeViewComponent, { static: false }) treeView: DxTreeViewComponent
  • // Prior to Angular 8
  • // @ViewChild(DxTreeViewComponent) treeView: DxTreeViewComponent
  • ngAfterViewInit () {
  • this.treeView.instance.registerKeyHandler("backspace", function (e) {
  • // The argument "e" contains information on the event
  • });
  • this.treeView.instance.registerKeyHandler("space", function (e) {
  • // ...
  • });
  • }
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxTreeViewModule
  • ],
  • // ...
  • })
See Also