quay

Quay: Super Simple key binding

Quay is a super simple script that allows you to easily bind key shortcuts to functions using javascript. For instance, say you had this function:

var say_hello = function() {
	alert('Hello there!');
}

You may want that function to run when a key combination is pressed on your page. Just include Quay and add the following:

var q = new Quay(window);

q.capture({
	'ctrl_alt_a':say_hello
});

And voila! Now that function will be run whenever the user presses CTRL+ALT+A on that page. Notice how Quay takes a single argument. This is the element you want to listen for key presses on. In this case a global window will suffice.

Please note: The current key combination (so above would be ctrl_alt_a) is passed as the first argument into the callback (in this case say_hello.) The event that triggered it is also passed in as a second argument

You can also use multiple key combinations for the same callback. For example:

var q = new Quay(window);

q.capture({
    'up,down,left,right': function(key) {
        alert('You pressed the ' + key + ' arrow!');
    }
})

Version

Quay is currently on version: 2.3.2

You can check the version at any time using the Quay.VERSION object. Quay.VERSION.FULL() will return the full version and Quay.VERSION.[MAJOR/MINOR/PATCH] is set to each value respectively.

Quay uses Semantic Versioning

License

Please see LICENSE.md