ember-keyboard

An Ember addon for painlessly supporting keyboard events

Features

• Ember Octane-friendly template declarations for keyboard shortcuts
• Support for keyup and keydown, as well as the modifier keys: ctrl, alt, shift, and meta.
• Dynamic priority levels allow you to specify which components respond first to key events and under what circumstances. (Thanks to ember-key-responder for the inspiration)
• Human-readable key-mappings. (Thanks to ember-keyboard-service for the inspiration)

Documentation & Demo

You can find interactive documentation here.

Compatibility

• Ember 6.x or higher (ember-keyboard 9.x)
• Ember 4+ compatibility requires ember-keyboard 7.x or higher
• For Ember 3.8 to 3.28, you can use ember-keyboard 6.x (not compatible with Internet Explorer)
• For use with Ember 2.0 up to 3.8 or IE compatibility, use ember-keyboard 5.x.
• Node.js v18 or above
• This is a v2 addon

Accessibility Considerations

In order to avoid adding keyboard shortcuts to your application that are already in use by assistive technology, please review the existing keyboard shortcuts and gestures available today: https://dequeuniversity.com/screenreaders/.

Installation

pnpm add ember-keyboard

Or with npm/yarn:

npm install ember-keyboard