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

  • <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>
See Also