24.0.1 • Published 23 days ago
@vaadin-component-factory/keyboard-shortcut-manager v24.0.1
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/keyboard-shortcut-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:
Publish the component to NPM
npm login
git commit -a -m "v${version}"
npm version ${version}
npm publish --registry https://registry.npmjs.org/
git reset HEAD~2
git commit -a -m "v${version}"
git push
git push origin v${version}
License
Apache-2.0 License
24.0.1
23 days ago
24.0.0
23 days ago
23.3.1
1 year ago
23.3.0
1 year ago
23.2.1
2 years ago
23.2.0
2 years ago
23.1.7
2 years ago
23.1.6
2 years ago
23.1.9
2 years ago
23.1.8
2 years ago
23.1.11
2 years ago
23.1.12
2 years ago
23.1.10
2 years ago
23.1.3
2 years ago
23.1.2
2 years ago
23.1.5
2 years ago
23.1.4
2 years ago
23.1.1
2 years ago
23.1.0
2 years ago
23.0.4
2 years ago
23.0.3
2 years ago
23.0.0
2 years ago
23.0.2
2 years ago
23.0.1
2 years ago
1.0.7-legacy-1
2 years ago
1.0.7
2 years ago
1.0.7-legacy
2 years ago
1.0.6
2 years ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago