Home

##General Keymap uses jQuery to create a keymap in the given div

##Create your own keymap layout Missing a special layout. Create your own one!

##Troubleshooting Some common errors and their solutions.

##API

$().keymap([options])

jQuery

$(): jQuery element, - Div element to create keymap in

Parameters

[options]: Object, - All options as an object

[options.layout=qwerty]: (Object[]|string), - Either parsed json data of the layout or name of layout

[options.css]: Object, - Style you want to apply with js to the keys

[options.css.key]: Object, - CSS styles for the keys

[options.css.key.color]: string, - Text color of keys

[options.css.key.background]: string, - Background color of keys

[options.css.key.class]: string, - Aditional classes you want to add to the keys

jQuery

$(): jQuery element, - HTML element to control hightlighting by hovering over it

Parameters

selector: string, - Selector of the alread created keymap

keys: Object[], - Array of keys to be highlighted

[css]: Object, - Style you want apply highlighted keys

[css.class]: string, - Either a class to apply highlighted keys

[css.color]: string, - Or a color to apply

[css.background]: string, - AND background color to apply

[special]: string, - jQuery selector to select one out of several, f.e. :first, :last