onKey.js
A key event controller w/ hot-keys.
Installation
npm install onKey
In addition jQuery-like selector library is required:
- jQuery 1.4.3+
- Zepto
Usage
// Bind a keydown & keyup event to the windowkey; key; // Bind keyup to a specific selector (will also take a DOM or jQuery object); // Bind hot-keyskey; // An Event object is returned whenever key(), key.down() or key.up() is called.// This object can be turned on and off and more key events can be bound to it.// This is useful for apps where key events are only relevant in certain views.var keyEvent = ; keyEvent;// keyEvent won't fire keyEvent;// keyEvent will fire keyEvent; // Chainingkey ; //Completely unbinds the key events in an event object
Note: Since version 0.1.0 you can't use -
as hotkey separator since it can be used as a valid key combination, such as cmd -
. It's recommended to use spaces or +
.
Development
To Build: grunt build
To Develop: grunt watch
To Test: npm test