angular2-hotkeys
Angular 9 and Ivy Compatible. Older versions might work but isn't officially tested.
Installation
To install this library, run:
$ npm install angular2-hotkeys --save
Examples
First, import the HotkeyModule into your root AppModule
;
Then, add HotkeyModule.forRoot() to your AppModule's import array
If you have any sub/feature modules that also use hotkeys, import the HotkeyModule (but NOT .forRoot())
Then inject the service into your constructor and add a new hotkey
constructorprivate _hotkeysService: HotkeysService
It also handles passing an array of hotkey combinations for a single callback
this._hotkeysService.addnew Hotkey,;
Your callback must return either a boolean or an "ExtendedKeyboardEvent".
For more information on what hotkeys can be used, check out https://craig.is/killing/mice
This library is a work in progress and any issues/pull-requests are welcomed! Based off of the angular-hotkeys library
Cheat Sheet
To enable the cheat sheet, simply add <hotkeys-cheatsheet></hotkeys-cheatsheet>
to your top level component template.
The HotkeysService
will automatically register the ?
key combo to toggle the cheat sheet.
NB! Only hotkeys that have a description will apear on the cheat sheet. The Hotkey constructor takes a description as an optional fourth parameter as a string or optionally as a function for dynamic descriptions.
this._hotkeysService.addnew Hotkey'meta+shift+g',, undefined, 'Send a secret message to the console.';
The third parameter, given as undefined
, can be used to allow the Hotkey to fire in INPUT, SELECT or TEXTAREA tags.
Cheat Sheet Customization
- You can now pass in custom options in
HotkeyModule.forRoot(options: IHotkeyOptions)
.
;
- You can also customize the title of the cheat sheet component.
<!-- Default: 'Keyboard Shortcuts:' -->
TODO
- Create unit and E2E tests
Development
To generate all * }.js
, *.js.map
and *.d.ts
files:
$ npm run tsc
License
MIT © Nick Richardson