Repository files navigation

#AboutjQuery Hotkeys is a plug-in that lets you easily add and remove handlers for keyboard events anywhere in your code supporting almost any key combination.

This plugin is based off of the plugin by Tzury Bar Yochay:jQuery.hotkeys

The syntax is as follows:

$(expression).bind(types,keys,handler);$(expression).unbind(types,handler);$(document).bind('keydown','ctrl+a',fn);// e.g. replace '$' sign with 'EUR'$('input.foo').bind('keyup','$',function(){this.value=this.value.replace('$','EUR');});

Syntax when wanting to use jQuery'son()/off methods:

$(expression).on(types,null,keys,handler);$(expression).off(types,handler);$(document).on('keydown',null,'ctrl+a',fn);// e.g. replace '$' sign with 'EUR'$('input.foo').on('keyup',null,'$',function(){this.value=this.value.replace('$','EUR');});

Example

Supported types are'keydown','keyup' and'keypress'

Works with jQuery 1.4.2 and newer.

It is known to be working with all the major browsers on all available platforms (Win/Mac/Linux)

• IE 6/7/8+
• FF 1.5/2/3+
• Opera-9+
• Safari-3+
• Chrome-0.2+

If you want to include this module in a Browserified project, just add it to node_modules and require it.

require('jquery.javascript');

This will work if jQuery is global (ex. served from a CDN). If it's not, you need toshim it:

{"browserify-shim":{"jquery":"global:jQuery"}}

Modifiers are not case sensitive (Ctrl ==ctrl ==cTRL)

If you want to use more than one modifier (e.g.alt+ctrl+z) you should define them by an alphabetical order e.g. alt+ctrl+shift

Hotkeys aren't tracked if you're inside of an input element (unless you explicitly bind the hotkey directly to the input). This helps to avoid conflict with normal user typing.

You can use namespacing by adding a suffix to the event type (e.g.keyup.toggle)

Hotkeys aren't tracked if the user is focused within an input element or any element that hascontenteditable="true" unless you bind the hotkey directly to the element. This helps to avoid conflict with normal user typing.If you don't want this, you can change the booleans of the following to suit:

• jQuery.hotkeys.options.filterInputAcceptingElements
• jQuery.hotkeys.options.filterContentEditable
• jQuery.hotkeys.options.filterTextInputs (deprecated, will be removed in a later version)

Meta and hyper keys don't register onkeyup in any browser tested.

Meta key registers onkeydown event.Hyper key registers onkeydown event.

Meta key registers onkeydown andkeypress events.Hyper key registers onkeydown andkeypress events.

Meta key doesn't register at all :(Hyper key registers onkeydown andkeypress events.

Bind tokeydown event for meta and hyper keys, but meta key does not work in Opera ;)

Firefox is the most liberal one in the manner of letting you capture all short-cuts even those that are built-in in the browser such asCtrl-t for new tab, orCtrl-a for selecting all text. You can always bubble them up to the browser by returningtrue in your handler.

Others, (IE) either let you handle built-in short-cuts, but will add their functionality after your code has executed. Or (Opera/Safari) willnot pass those events to the DOM at all.

So, if you bindCtrl-Q orAlt-F4 and your Safari/Opera window is closed don't be surprised.