https://github.com/adopted-ember-addons/ember-keyboard

An Ember.js addon for the painless support of keyboard events
https://github.com/adopted-ember-addons/ember-keyboard

Last synced: 3 months ago
JSON representation

An Ember.js addon for the painless support of keyboard events

• Host: GitHub
• URL: https://github.com/adopted-ember-addons/ember-keyboard
• Owner: adopted-ember-addons
• License: other
• Created: 2015-10-21T21:13:25.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-20T02:07:49.000Z (6 months ago)
• Last Synced: 2024-05-22T11:06:28.506Z (6 months ago)
• Language: JavaScript
• Homepage: http://adopted-ember-addons.github.io/ember-keyboard/
• Size: 48.2 MB
• Stars: 174
• Watchers: 16
• Forks: 57
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ember - ember-keyboard - An Ember.js addon for the painless support of keyboard events. (Packages / a11y)

README

        
   

[![npm version](https://badge.fury.io/js/ember-keyboard.svg)](https://badge.fury.io/js/ember-keyboard)

[![Build Status](https://github.com/adopted-ember-addons/ember-keyboard/actions/workflows/ci.yml/badge.svg)](https://github.com/adopted-ember-addons/ember-keyboard/actions/workflows/ci.yml)

# 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`](https://github.com/yapplabs/ember-key-responder) for the inspiration)

* Human-readable key-mappings. (Thanks to [`ember-keyboard-service`](https://github.com/Fabriquartz/ember-keyboard-service) for the inspiration)

## Documentation & Demo

You can find interactive documentation [here](http://adopted-ember-addons.github.io/ember-keyboard/).

## Compatibility

* 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 v16 or above

* ember-auto-import v2.0.0 or above (this is [v2 addon](https://emberjs.github.io/rfcs/0507-embroider-v2-package-format.html))

## 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

`ember install ember-keyboard`