KeyboardJS
KeyboardJS is a library for use in the browser (node.js compatible). It Allows
developers to easily setup key bindings. Use key combos to setup complex
bindings. KeyboardJS also provides contexts. Contexts are great for single page
applications. They allow you to scope your bindings to various parts of your
application. Out of the box keyboardJS uses a US keyboard locale. If you need
support for a different type of keyboard KeyboardJS provides custom locale
support so you can create with a locale that better matches your needs.
KeyboardJS is available as a NPM module for use with
browserify (or in node.js). If you don't use
browserify you can simply include
keyboard.js
or
keyboard.min.js
from the dist folder in this repo. These files are
UMD wrapped so they can be used with or without
a module loader such as requireJS.
npm install keyboardjs
Note that all key names can be found in ./locales/us.js.
If you're looking for the previous v1.x.x release of KeyboardJS you can find it
here.
Setting up bindings is easy
keyboardJS.bind('a', function(e) {
console.log('a is pressed');
});
keyboardJS.bind('a + b', function(e) {
console.log('a and b is pressed');
});
keyboardJS.bind('a + b > c', function(e) {
console.log('a and b then c is pressed');
});
keyboardJS.bind(['a + b > c', 'z + y > z'], function(e) {
console.log('a and b then c or z and y then z is pressed');
});
keyboardJS.bind('', function(e) {
console.log('any key was pressed');
});
//alt, shift, ctrl, etc must be lowercase
keyboardJS.bind('alt+shift+a', function(e) {
console.log('alt, shift and a is pressed');
});
// keyboardJS.bind === keyboardJS.on === keyboardJS.addListener
keydown vs a keyup
keyboardJS.bind('a', function(e) {
console.log('a is pressed');
}, function(e) {
console.log('a is released');
});
keyboardJS.bind('a', null, function(e) {
console.log('a is released');
});
Prevent keydown repeat
keyboardJS.bind('a', function(e) {
// this function will once run once even if a is held
e.preventRepeat();
console.log('a is pressed');
});
Unbind things
keyboardJS.unbind('a', previouslyBoundHandler);
// keyboardJS.unbind === keyboardJS.off === keyboardJS.removeListener
Using contexts
// these will execute in all contexts
keyboardJS.bind('a', function(e) {});
keyboardJS.bind('b', function(e) {});
keyboardJS.bind('c', function(e) {});
// these will execute in the index context
keyboardJS.setContext('index');
keyboardJS.bind('1', function(e) {});
keyboardJS.bind('2', function(e) {});
keyboardJS.bind('3', function(e) {});
// these will execute in the foo context
keyboardJS.setContext('foo');
keyboardJS.bind('x', function(e) {});
keyboardJS.bind('y', function(e) {});
keyboardJS.bind('z', function(e) {});
// if we have a router we can activate these contexts when appropriate
myRouter.on('GET /', function(e) {
keyboardJS.setContext('index');
});
myRouter.on('GET /foo', function(e) {
keyboardJS.setContext('foo');
});
// you can always figure out your context too
var contextName = keyboardJS.getContext();
// you can also set up handlers for a context without losing the current context
keyboardJS.withContext('bar', function() {
// these will execute in the bar context
keyboardJS.bind('7', function(e) {});
keyboardJS.bind('8', function(e) {});
keyboardJS.bind('9', function(e) {});
});
pause, resume, and reset
// the keyboard will no longer trigger bindings
keyboardJS.pause();
// the keyboard will once again trigger bindings
keyboardJS.resume();
// all active bindings will released and unbound,
// pressed keys will be cleared
keyboardJS.reset();
pressKey, releaseKey, and releaseAllKeys
// pressKey
keyboardJS.pressKey('a');
// or
keyboardJS.pressKey(65);
// releaseKey
keyboardJS.releaseKey('a');
// or
keyboardJS.releaseKey(65);
// releaseAllKeys
keyboardJS.releaseAllKeys();
watch and stop
// bind to the window and document in the current window
keyboardJS.watch();
// or pass your own window and document
keyboardJS.watch(myDoc);
keyboardJS.watch(myWin, myDoc);
// or scope to a specific element
keyboardJS.watch(myForm);
keyboardJS.watch(myWin, myForm);
// detach KeyboardJS from the window and document/element
keyboardJS.stop();