Skip to content

Commit

Permalink
clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
jhchen committed Sep 15, 2016
1 parent 6313d2b commit 30702ff
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/docs/modules/keyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ The Keyboard module enables custom behavior for keyboard events in particular co

### Key Bindings

Keyboard handlers are bound to a particular key and key modifiers: `metaKey`, `ctrlKey`, `shiftKey` and `altKey`. In addition, `shortKey` is a platform specific modifier equivalent to `metaKey` on a Mac and `ctrlKey` on Linux and Windows.
Keyboard handlers are bound to a particular key and key modifiers. The `key` is the JavaScript event key code, but string shorthands are allowed for alphanumeric keys and some common keys.

Key modifiers include: `metaKey`, `ctrlKey`, `shiftKey` and `altKey`. In addition, `shortKey` is a platform specific modifier equivalent to `metaKey` on a Mac and `ctrlKey` on Linux and Windows.

Handlers will called with `this` bound to the keyboard instance and be passed the current selection range.

Expand Down

0 comments on commit 30702ff

Please sign in to comment.