VCF Keyboard Shortcut Manager Flow
A modern library for managing keyboard shortcuts in a Vaadin application.
keyboard-shortcut-manager is A modern library for managing keyboard shortcuts in a Vaadin application.
Basic Usage
KeyboardShortcutManager keyboardShortcutManager = new KeyboardShortcutManager(this);
KeyboardShortcut[] shortcuts = new KeyboardShortcut[] {
new KeyboardShortcut("", KeyboardShortcut.Actions.helpDialog, Key.CONTROL, Key.SHIFT, Key.SLASH),
new KeyboardShortcut("", KeyboardShortcut.Actions.focusNextInvalidField, Key.ALT, Key.F8),
new KeyboardShortcut("", KeyboardShortcut.Actions.focusPreviousInvalidField, Key.ALT, Key.SHIFT, Key.F8),
new KeyboardShortcut("scope-element-1", KeyboardShortcut.Actions.clearAllFields, Key.CONTROL, Key.KEY_K),
new KeyboardShortcut("focus-element", "scope-element-2", KeyboardShortcut.Actions.focusElement, Key.CONTROL, Key.KEY_F)
};
keyboardShortcutManager.addShortcut(shortcuts);
keyboardShortcutManager.subscribe();
How to run the demo?
mvn jetty:run -pl keyboard-shortcut-manager-flow-demo
After server startup, you'll be able find the demo at http://localhost:8080
License & Author
This Add-on is distributed under Apache 2. For license terms, see LICENSE.txt.
Component Factory Keyboard Shortcut Manager is written by Vaadin Ltd.
Setting up for development:
Clone the project in GitHub (or fork it if you plan on contributing):
git clone git@github.com:vaadin-component-factory/keyboard-shortcut-manager-flow.git
To install project to your maven repository run:
mvn install
Sponsored development
Major pieces of development of this add-on has been sponsored by customers of Vaadin. Read more about Expert on Demand at: Support and Pricing
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
Added a new API to offer a hint for the focusNextElement / focusPreviousElement searches which may not work consistently with all components without the extra help.
- Released
- 2023-07-11
- Maturity
- TESTED
- License
- Apache License 2.0
Compatibility
- Framework
- Vaadin 23+
- Vaadin 20+ in 23.1.6
- Vaadin 14 in 1.0.0
- Browser
- N/A