# ember-keyboard

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

Latest version **10.0.0** (published 2026-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-keyboard
pnpm add ember-keyboard
yarn add ember-keyboard
bun add ember-keyboard
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 10.0.0 |
| Published | 2026-10-09 |
| First published | 2015-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 204.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 177 |
| Maintainers | lukemelia, nullvoxpopuli, melsumner, alonbukai |
| Keywords | ember-addon |

## Links

- npm: https://www.npmjs.com/package/ember-keyboard
- Repository: https://github.com/adopted-ember-addons/ember-keyboard
- npm.io page: https://npm.io/package/ember-keyboard

## Dependencies (2)

- [decorator-transforms](https://npm.io/package/decorator-transforms.md) ^2.3.2
- [@embroider/addon-shim](https://npm.io/package/@embroider/addon-shim.md) ^1.10.2

## Recent versions

- 10.0.0 (latest) — 2026-10-09
- 8.2.1-unstable.a1e8548 (unstable) — 2024-03-09
- 7.0.0-beta.0 (beta) — 2021-11-28
- 9.0.4 — 2025-10-03
- 9.0.3 — 2025-08-22
- 9.0.2 — 2025-06-28
- 9.0.1 — 2024-08-23
- 9.0.0 — 2024-08-23
- 8.2.1-unstable.f173e2c — 2024-03-08
- 8.2.1-unstable.7f73884 — 2024-03-08
- 8.2.1-unstable.91d2907 — 2023-10-20
- 8.2.1-unstable.f6113e7 — 2023-08-16
- 8.2.1 — 2023-08-16
- 8.2.0-unstable.692ee0f — 2023-08-16
- 8.2.0-unstable.88cde23 — 2023-08-16
- … 96 more at https://npm.io/package/ember-keyboard/versions

## README

<img alt="ember-keyboard logo" src="./docs/public/ember-keyboard.svg" height=72 /> &nbsp; 
[![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 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](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

```
pnpm add ember-keyboard
```

Or with npm/yarn:

```
npm install ember-keyboard
```

---
_Source: https://npm.io/package/ember-keyboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
