# key-event-plus

> Improved key up and key down listener

Latest version **1.0.1** (published 2020-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install key-event-plus
pnpm add key-event-plus
yarn add key-event-plus
bun add key-event-plus
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-06-15 |
| First published | 2020-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jean Ribeiro |
| Maintainers | jeeanribeiro |
| Keywords | key, event, eventlistener, keypress, keydown, keyup |

## Links

- npm: https://www.npmjs.com/package/key-event-plus
- Repository: https://github.com/jeeanribeiro/key-event-plus
- Homepage: https://github.com/jeeanribeiro/key-event-plus#readme
- Issues: https://github.com/jeeanribeiro/key-event-plus/issues
- npm.io page: https://npm.io/package/key-event-plus

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-06-15
- 1.0.0 — 2020-06-15

## README

# keyEvent+
<p>
  <img src="https://img.shields.io/npm/v/key-event-plus.svg?orange=blue" />
  <a href="https://github.com/jeeanribeiro/key-event-plus/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/jeeanribeiro/key-event-plus" />
  </a>
  <a href="https://twitter.com/jeeanribeiro" target="_blank">
    <img alt="Twitter: jeeanribeiro" src="https://img.shields.io/twitter/follow/jeeanribeiro.svg?style=social" />
  </a>
</p>

Key listener that returns all keys, including special characters, solves international keyboards compatibility in some scenarios.

## How to use

### Installing
```
npm install key-event-plus
```

### Function
`keyEventListener(ms, callback)`

*ms* is the millisseconds between each update

*callback* is the callback function

### Using
```
var keyEventListener = require('key-event-plus');

window.onload = function() {
	keyEventListener(20, key => console.log(key));
}
```

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