Skip to content

Commit

Permalink
add example reference
Browse files Browse the repository at this point in the history
  • Loading branch information
fermads committed Mar 17, 2015
1 parent a20a4aa commit a12020e
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions README.md
@@ -1,9 +1,10 @@
# visualKeys

VisualKeys is a jQuery plugin that give users an alternative way to control
your web application without (necessarily) using a mouse. It's best on web
interfaces where users have to execute repetitive tasks giving them a faster
way to do the job.
VisualKeys is a jQuery plugin to configure shortcuts to users most used actions.
It's best on web interfaces where users have to execute repetitive tasks giving
them a faster way to do the job.

![Menu](/example/visualkeys.png)

## Install

Expand All @@ -20,12 +21,6 @@ way to do the job.

$.visualkeys(options);

1. Hit `ctrl+space`. A menu will appear at the bottom of the page.
2. Hit `v` to execute the "view source code" shortcut and see the code bellow.
3. That's it! You can configure any action to any key. You can also alt+shift+v as a faster shortcut.


## Options

`options` is an object with the following properties:
```js
Expand All @@ -38,19 +33,20 @@ way to do the job.
}
```

hide option is used as a context. To show, for example, a shortcut that
exists on one page but not on the other, one could do $
The `hide` option can be used as a context. To show, for example, a shortcut that
exists on one page but not on the other:

```js
hide : function() { return ('page.selecor').length > 0; }
hide : function() { return ('page.selector').length > 0; }
```

## Also...
## Other options
- change the appearence of the menu by editing visualkeys.css
- bind esc to a exec:function(). It'll be executed right away, not showing the menu.
- the hide:value can be used to turn a shortcut visible/hidden based on a context. What? How?
- open the menu and mouse click a shortcut. It'll be executed.
- as an alternative to ctrl+space you can use f9 or shift+space to open the menu.
- unbind and remove visualkeys with $.visualkeys('remove').
- bind esc to a exec:function(). It'll be executed right away, not showing the menu
- open the menu and mouse click a shortcut. It'll be executed
- F9 can be used as an alternative to ctrl+space to open the menu
- unbind and remove visualkeys with $.visualkeys('remove')

## Demo
There is a demo at `demo/index.html`

## Example

0 comments on commit a12020e

Please sign in to comment.