Specify that bindings react only to press events

cjquines · Jun 9, 2021 · 629a724 · 629a724
1 parent 868b4d5
commit 629a724
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/lib/keyboard.ts b/src/lib/keyboard.ts
@@ -119,7 +119,8 @@ export default class KeyboardHandler {
 
   /**
    * Creates a keyboard.js binding from the key combination {@param key} to the action {@param action},
-   * writing to `localStorage` if {@param save}
+   * writing to `localStorage` if {@param save}.
+   * The binding reacts only to the `press` event and not the `release` event.
    */
   bind = (key: string, action: Action, save = true): void => {
     this.keyMap[key] = action;