Ever wanted to add keyboard shortcuts to your website? but couldnt justify the time to develop it?
Shortcut.js gives you easy access to add shortcuts to your already existing functions.
- Chainable
- noConflict mode
- Global and Individual pause/resume functions
- Cross OS Key Bindings ('mod' key)
- CrossBrowser (IE8+, Chrome, FF, Safari Tested)
- AMD compatibility
bower install shortcut
function uppercaseInput(e){...}
function validateInput(e){...}
shortcut('mod =', 'input#uppercase').bindsTo(uppercaseInput).bindsTo(validateInput);
Here, when a user presses the the modifier key with the equals key, we run an uppercaseInput function, and then a validateInput function.
If you want to return the global shortcut namespace to its previous use, follow this:
var s = shortcut.noConflict();
s('shift = ', 'input#uppercase').bindsTo(uppercaseInput);
console.log(shortcut);
// outputs whatever window.shortcut was before the shortcut.js library was loaded
-
String shortcutKeys:A space delimited set of keys to press. For special keys, use the following mappings:shift, meta, optn, ctrl, space, down, right, up, left, tab, rtn -
String selector:a css selector used to specify if the shortcut should be bound to an element. For example, if you wanted a user to be able to press shift+g together in an input box to run a function to uppercase the entire input value, simply do something like:shortcut('shift =', 'input#uppercase').bindsTo(uppercaseInput). When the selector argument is not supplied, the shortcut will get called on the window, meaning at any time the shortcut is pressed the functions will run.
This function globally pauses all shortcut function dispatching. Keyboard shortcuts pressed after this function will not fire their associated functions.
Useage:
shortcut.pause();
This function globally resumes all shortcut function dispatching. Keyboard shortcuts pressed after this function WILL fire their associated functions.
Useage:
shortcut.resume();
function fn:A function which gets ran when the shortcutKeys are pressed in the appropriate selector.
A function that prevents default on the current shortcut. Usage:
shortcut('meta a', 'input').bindsTo(uppercaseInput).preventDefault()
This usage would cause cmd + a to not hightlight the input, but rather call the uppercaseInput functions.
A function to trigger the functions associated to a shortcut. Usage:
shortcut('meta a', 'input').bindsTo(function(e){console.log('triggerMe!');}).trigger();
// Triggers the bindsTo function and outputs:
// "triggerMe!"
A function used to remove bindings to keyboard shortcuts.
Usage:
shortcut('meta a', 'input').unbind();
Now when a user presses meta a in an input, it will not touch shortcut and run its normal native events.
Pauses event dispatching for the associated shortcut.
Usage:
shortcut('meta a', 'input').pause();
When a user presss meta a in an input, it will not fire associated functions. Once -resume() is called they will fire.
Resumes event dispatching for the associated shortcut.
Usage:
shortcut('meta a', 'input').pause();
// pressing meta a in an input does nothing
shortcut('meta a', 'input').resume();
// pressing meta a dispatches the functions again
When a user presss meta a in an input, it will not fire associated functions. Once -resume() is called they will fire.
Licensed under the MIT license. Copyright 2014 Blaine Kasten