https://github.com/yornaath/lavak
Javascript hotkeys.
https://github.com/yornaath/lavak
Last synced: 7 months ago
JSON representation
Javascript hotkeys.
- Host: GitHub
- URL: https://github.com/yornaath/lavak
- Owner: yornaath
- Created: 2011-10-27T08:43:30.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2014-07-08T09:42:23.000Z (over 11 years ago)
- Last Synced: 2025-01-22T07:35:45.871Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 180 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
___ __ __
/\_ \ /\ \/\ \
\//\ \ __ __ __ __ \ \ \/'/'
\ \ \ /'__`\ /\ \/\ \ /'__`\ \ \ , <
\_\ \_/\ \L\.\_\ \ \_/ |/\ \L\.\_\ \ \\`\
/\____\ \__/.\_\\ \___/ \ \__/.\_\\ \_\ \_\
\/____/\/__/\/_/ \/__/ \/__/\/_/ \/_/\/_/
```
Hotkeys(hot as lava..) for javascript with a simple api.
## Api
The spec is simple and not set in stone.
### lavaK.add(keycombo, fn)
---
Takes the keycombo(string) and a associated function to execute on triggering.
Returns a hotkey object, look further down for reference
```javascript
var findHotkey = lavaK.add('ctrl+alt+f', find);
var computeHotkey = lavaK.add('shift+c', function(){
//compute
//compute
//compute
})
```
### lavaK.remove(keycombo)
---
Takes a keycombo(string) same as add, and removes all associated functions.
```javascript
var findHotkey = lavaK.add('ctrl+alt+f', find);
var findHotkey2 = lavaK.add('ctrl+alt+f', find2);
lavaK.remove('ctrl+alt+f')
```
Be carefull as this removes ALL associated functions. If you need to add several functions to the same keycombo and enable/disable them according to a specific state; you should use the hotkey.enable() and hotkey.disable().
## hotkey
Creating a new hotkey with lavaK.add() returns a lavaK object with functions for disabling the hotkey and reenabling it. You can assign more than one function to a given key combo, and disable/enable them individually.
### hotkey.enable()
Enables the given hotkey
```javascript
var findHotkey = lavaK.add('ctrl+alt+f', find);
findHotkey.enable();
```
### hotkey.disable()
Disables the given hotkey
```javascript
var findHotkey = lavaK.add('ctrl+alt+f', find);
findHotkey.disable();
```
## Integration
You can integrate lavaK into your project in several ways.
### NPM/browserify
```bash
npm install lavaK
```
### script
```html
```
lavaK is then bound directly to the context, in this instance window. And you can access it everywhere in your code.
This is the quick and dirty way.
You can require it with and AMD module loader, for example requirejs.
Or you can include it into your ender build by using:
```bash
ender build lavaK
or
ender add lavaK
```
The lavaK API is then available at the ender global $ or can be required with enders require function.
```javascript
var lavaK = require('lavaK') //require
//or
$.lavaK
```