GestureKit Helper

A GestureKit plugin to show the gesture drawing to the user at runtime.

Usage

Add the dependency into your HTML file.

You should download the dependency and reference the JavaScript file using a <script> tag somewhere on your HTML pages.

<script src="gesturekit.min.js"></script>

Add gesturekit.helper.css into your HTML file.

You should download the library and reference the CSS file on your HTML pages.

<link rel="stylesheet" href="gesturekit.helper.min.css">

Add gesturekit.helper.js into your HTML file.

You should download the library and reference the JavaScript file using a <script> tag somewhere on your HTML pages.

<script src="gesturekit.helper.min.js"></script>

Initialize Helper.

Initializes a new instance of Helper.

var helper = gesturekit.helper();

API

gesturekit.helper([options])

Initialize an instance of Helper. You could customize a Helper instance using the following options, and shown is their default value.

• options: A given options to customize an instance.
  • size: A given number indicating the size of the helper in px. Default: 60.
  • container: An HTMLElement to use as helper's container. Default: document.body.
  • drag: Enable or disable if you want to drag the helper. Default: true.
  • snap: Enable or disable if you want to snap helper to the container. Default: true.
  • title: The title of the available gestures. Default: Gestures.

var helper = gesturekit.helper({
    'size': 120,
    'drag': true,
    'snap': false,
    'title': 'Gestures'
});

gesturekit.helper#show()

Shows the helper visor.

helper.show();

gesturekit.helper#hide()

Hides the helper visor.

helper.hide();

gesturekit.helper#showGestures()

Shows the available gestures.

helper.showGestures();

gesturekit.helper#hideGestures()

Hides the available gestures.

helper.hideGestures();

gesturekit.helper#loadGestures([gid])

Loads the available gestures from a given gid.

helper.loadGestures('xxx-xxx-xxx-xxx');

Maintained by

• Guille Paz (Front-end developer | Web standards lover)
• E-mail: guille87paz@gmail.com
• Twitter: @pazguille
• Web: http://pazguille.me

Credits

RoamTouch

GestureKit

License

Licensed under Apache v2 License.

Copyright (c) 2014 RoamTouch.