choo-kanye

choo-kanye

easily add kanye keyboard shortcuts to your choo app

Install

npm install --save choo-kanye

Usage

API

This module implements the kanye API using choo events.

Any kanye events received before the DOM is loaded are buffered until they can be registered.

Events choo-kanye listens to:

• kanye:on args: combo, options?, listener
  • see 'kanye.on'
• kanye:off args: combo, options?, listener
  • see 'kanye.off'
• kanye.clear args: context?
  • see 'kanye.clear'

Example

var app = require('choo')

choo.use(require('choo-kanye'))

choo.use(function(state, bus) {
  var sayhi = function () {
    console.log('hi!')
  }
  // run sayhi when the user presses ctrl+shift+a while element with id 'main' is the target
  bus.emit('kanye:on', 'ctrl+shift+a', { filter: '#main' }, sayhi))
})

License

To the extent possible by law, we transfer any rights we have in this code to the public domain. Specifically, we do so using the CC0 1.0 Universal Public Domain Dedication.

You can do whatever you want with this code. No need to credit us, link to us, include any license, or anything else. But if you want to do those things, you're free to do that too.