From 76940abb7f9207457d7d6afc2389f1bebd58a76b Mon Sep 17 00:00:00 2001 From: Jossef Harush Date: Thu, 30 Jun 2016 14:04:07 +0300 Subject: [PATCH] added "supported keys" (from mousetrap docs) --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 4160ebd..8debd1d 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,14 @@ Example of how directive-based hotkeys works: ``` +#### Supported Keys + +For modifier keys you can use `shift`, `ctrl`, `alt`, or `meta`. + +Other special keys are `backspace`, `tab`, `enter`, `return`, `capslock`, `esc`, `escape`, `space`, `pageup`, `pagedown`, `end`, `home`, `left`, `up`, `right`, `down`, `ins`, `del`, and `plus`. + +Any other key you should be able to reference by name like `a`, `/`, `$`, `*`, or `=`. + #### Cheatsheet A cheatsheet is created automatically for you, showing which hotkeys are available for the current route, along with a description as to what it does. The default binding to show the cheatsheet is `?`. Be sure to include the `build/hotkeys.css` stylesheet. [Cheatsheet demo](http://chieffancypants.github.io/angular-hotkeys/#features)