An instance class which hooks into keyup and keydown, and keeps track of all the key pressed.
npm install @jworkshop/keyboardAn instance class which hooks into keyup and keydown, and keeps track of all the key pressed.
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[npm-image]: http://img.shields.io/npm/v/@jworkshop/keyboard.svg
[npm-url]: http://npmjs.org/package/@jworkshop/keyboard
[travis-image]: https://img.shields.io/travis/JWorkshop/keyboard.svg
[travis-url]: https://travis-ci.org/JWorkshop/keyboard
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/@jworkshop/keyboard.svg
[download-url]: https://npmjs.org/package/@jworkshop/keyboard
``javascript
import Keyboard, { Keys } from "@jworkshop/keyboard";
/ Get the container for the keyboard. /
let container = document.getElementById("container");
/* Create a keyboard instance, with the element as its container.
This is to allow the keyboard to monitor all key events from the container. /
let keyboard = new Keyboard(container);
/* Append the keyboard to the a DOM element and event handlers to it. /
keyboard.attach(container);
/* Detach the keyboard from DOM element and event handlers from it. /
keyboard.detach();
/* Toggle value for keyboard prevent default on all events. /
keyboard.setPreventDefault(preventDefault);
/* Toggle value for keyboard skipping further key down events. /
keyboard.setPreventHoldDownEvent(preventHoldDownEvent);
let keyDownHandler = event => { ... };
/* Bind an event handler to the key down event. /
keyboard.onKeyDown(keyDownHandler);
/* Unbind an event handler to the key down event. /
keyboard.removeKeyDown(keyDownHandler);
/* Unbind all event handlers from the key down event. /
keyboard.clearKeyDown();
let keyUpHandler = event => { ... };
/* Bind an event handler to the key up event. /
keyboard.onKeyUp(keyUpHandler);
/* Unbind an event handler to the key up event. /
keyboard.removeKeyUp(keyUpHandler);
/* Unbind all event handlers from the key up event. /
keyboard.clearKeyUp();
/* Checks if a given keyCode has been pressed. /
keyboard.hasKeyPressed(keyCode);
/* You can use key constants as keyCodes e.g.: /
keyboard.hasKeyPressed(Keys.ENTER);
/* Get the last keyCode that has been pressed. /
keyboard.getLastKeyPressed();
``