Git Product home page Git Product logo

onkey's Introduction

onKey.js Build Status

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 window
key.down(function(e) {
    alert("key down!");
});

key.up(function(e) {
    alert("key up!")
});

// Bind keyup to a specific selector (will also take a DOM or jQuery object)
key('#input').down(function() {
    alert('input keydown');
});

// Bind hot-keys
key.down({
    'ctrl+alt+tab': function() {
        console.log('ctr+alt+tab pressed!');
    },
    'cmd+a': function() {
        console.log('cmd & ctrl are normalized so that hot-keys work consistently across operating systems');
    }
});

// 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 = key('#input').down(function() {
    alert('boom!');
});

keyEvent.off();
// keyEvent won't fire

keyEvent.on();
// keyEvent will fire

keyEvent.up({
    'ctrl+a': function() {
        alert('Another binding to the same input!');
    }
});

// Chaining
key
    .down(callback)
    .up(callback)
    .on()
    .off()
    .destroy(); //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

onkey's People

Contributors

drochetti avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.