Giter Club home page Giter Club logo

hkmljs's Introduction

HKML.JS

Hot Key Markup Language.

Demo

This library will help u make a quick map for hot keys. Just like 1-2-3-Fibonacci.

Hkml.js is firstly language. So need to understand how it work.

Hkml support next expressions and it combinations:

KEY1+KEY2 - trigger when user pressed KEY1 and KEY2 at the same time KEY1>>KEY2 - trigger when user pressed first KEY1 then KEY2 KEY1>N>KEY2 - trigger when user pressed first KEY1 then KEY2, and between presses less N ms.

Get it?

okay...

JS API

so when u understand how hkml works, we can start understanding of JS API.

//Creating handler for dom object. By default this is document
var hotKeyHandler = hkml([dom target]);

//Listen hot key(markup instanceOf String), callback is function(markup, status){/* status == true when hotkey is triggered*/}
hotKeyHandler.on(markup, callback);

//triggering some callback by markup string
hotKeyHandler.trigger(markup)

//removing listener by markup string
hotKeyHandler.remove(markup);

Some examples u can see at example/js/app.js.

Example of hkml markup


A+B>>Z
A+B+C>>D+F
A>100>B>100>C

hkmljs's People

Contributors

pavel-shirobok avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.