Question 1

How do I set up a key sequence like 'a + b > c' in KeyboardJS?

Accepted Answer

Use the bind method with the sequence syntax: keyboardJS.bind('a + b > c', handler). This allows intuitive definition of complex combos, as shown in the README examples for handling multi-step shortcuts.

Question 2

Does KeyboardJS work with non-US keyboard layouts?

Accepted Answer

Yes, it supports custom locales. You can create or modify locales based on the provided US layout file to handle international keyboards, making it adaptable for global users without relying on browser defaults.

Question 3

KeyboardJS vs Keystrokes: which should I choose?

Accepted Answer

The author recommends Keystrokes for new projects as it's more refined and optimized for modern browsers. KeyboardJS is stable but legacy; choose Keystrokes for better performance and updated features, or KeyboardJS if you need a proven solution with existing code.

Question 4

How can I scope shortcuts to different pages in a single-page app?

Accepted Answer

Use the context system: set contexts with keyboardJS.setContext('contextName') and bind shortcuts within them. Activate contexts based on routes, as demonstrated in the README with router integration for clean scoping.

Question 5

Can I prevent a key from repeating when held down?

Accepted Answer

Yes, within the keydown handler, call e.preventRepeat() to ensure the binding triggers only once per key press, even if the key is held. This is useful for avoiding unintended repeated actions in games or tools.

Question 6

How do I remove or unbind a keyboard shortcut in KeyboardJS?

Accepted Answer

Use the unbind method with the key combo and the original handler: keyboardJS.unbind('a', handler). This is essential for cleaning up bindings dynamically and preventing memory leaks in long-running apps.

KeyboardJS

What is KeyboardJS?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions