keyboard-shortcut-manager
A modern library for managing keyboard shortcuts in a Vaadin application.
Note! For the latest version numbers, check https://www.npmjs.com/package/@vaadin-component-factory/keyboard-shortcut-manager
VCF Keyboard Shortcut Manager
A modern library for managing keyboard shortcuts in a Vaadin application (or any framework).
- Dispatch custom events from keyboard shortcuts.
- Bind multiple keyboard commands to a single event listener.
- Easily create simple keyboard shortcut help dialog/popup.
- Compatible with web components and Shadow DOM.
- Implemented in TypeScript.
This is a wrapper for the Tinykeys library.
Install
npm i @vaadin-component-factory/vcf-keyboard-chortcut-manager
Usage
Create an array of KeyboardShortcut
definitions:
const shortcuts: KeyboardShortcut = [
{
keyBinding: 'Control+Shift+?',
handler: 'help-dialog',
description: 'Opens the help dialog.'
}
];
Then create a KeyboardShortcutManager
instance and subscribe
your shortcuts to activate them:
const ksm = new KeyboardShortcutManager({ shortcuts, helpDialog: true });
ksm.subscribe();
Keybinding Syntax
Refer to the following links for more information on the keybinding syntax:
License
Apache-2.0 License
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- @vaadin-component-factory/vcf-enhanced-dialog#23.0.0
- @vaadin/grid#23.0.10
- query-selector-shadow-dom#^1.0.0
- tinykeys#^1.4.0
- Released
- 2022-05-17
- Maturity
- IMPORTED
- License
- MIT License
Compatibility
- Framework
- Vaadin 10+
- Browser
- Browser Independent