keyboard-handler v3.0.7

keyboard-handler

Single handler for all browser keyboard events.

Appends a single listener for keyboard events, using the document.addEventListener function. See the API section for available helper functions, when key(s) are pressed and released.

Install

$ npm install --save keyboard-handler

or

$ pnpm add keyboard-handler

Usage

import * as keyboard from 'keyboard-handler'
keyboard.keyPressed(e => {
	console.log(e.key)
})
// => 'Enter'

API

keysAreDown(keys, cb)

Calls cb if all keys are held down.

keys

Type: array

cb

Type: function

keyIsDown(key, cb)

Calls cb when a certain key key is pressed.

key

Type: string

cb

Type: function

keyPressed(cb)

Calls cb when any key is pressed.

cb

Type: function

keyReleased(cb)

Calls cb when any key is released.

cb

Type: function

License

MIT © Emil Johansson