React TreeView - Keyboard Support

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

Key Action
Shift + Mouse Wheel Scrolls the content left/right if the scrollDirection property 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.

  • <template>
  • <DxTreeView :ref="myTreeViewRef" />
  • </template>
  • <script>
  • import 'devextreme/dist/css/dx.common.css';
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import DxTreeView from 'devextreme-vue/tree-view';
  •  
  • const myTreeViewRef = 'my-tree-view';
  •  
  • export default {
  • components: {
  • DxTreeView
  • },
  • data() {
  • return {
  • myTreeViewRef
  • }
  • },
  • computed: {
  • treeView: function() {
  • return this.$refs[myTreeViewRef].instance;
  • }
  • },
  • mounted: function() {
  • this.treeView.registerKeyHandler('backspace', function(e) {
  • // The argument "e" contains information on the event
  • });
  • this.treeView.registerKeyHandler('space', function(e) {
  • // ...
  • });
  • }
  • }
  • </script>
See Also