A tiny little keycode library
CoffeeScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
.npmignore
.travis.yml
Jakefile.coffee
README.md
key.min.js
package.json

README.md

Key

Key is a tiny little keycode library for your browser. It makes keybound event assertions super simple.

Build Status

Example

Here's how key can work together with a DOM query library like jQuery to navigate through a [pseudo] image gallery.

var gallery = new GalleryOfAwesome();

$(window).on('keyup', function(event) {
    if (key.is(key.code.arrow.left, event.which)) {
        gallery.navigateLeft();
    } else if (key.is(key.code.arrow.right, event.which)) {
        gallery.navigateRight();
    } else if (key.is(key.code.special.esc, event.which)) {
        gallery.close();
    }
});

You can even assert against a collection of keys, not just a specific key.

var input = $('input[type="text"]');

input.on('keydown', function (event) {
    if (key.is(key.code.punctuation, event.which)) {
        event.preventDefault();
        window.alert('No punctuation allowed!');
    }
});

Usage

var key = window.key; // In browser
var key = require('key'); // Or package manager

Installation

  • npm install key
  • <script src="path/to/key/key.min.js"></script>

License

The content of this library is released under the MIT License by Andrew Lawson.
You can find a copy of this license at http://www.opensource.org/licenses/mit