Swipe - a lightweight jQuery plugin

This is a lightweight jQuery plugin that allows you to handle user swipes.

Getting started

Prerequisites

This plugin requires the latest version of jQuery

Usage

Include above </body> tag, but below jQuery include script tags.

<script src="js/swipe.js"></script>

Hook to the element which you wish to observe like so:

$(element).onSwipe();

.onSwipe() accepts a few parameters in the following order:

onSwipe(function(result), timeTreshold, tresholdX, tresholdY);

function(result) - Required! A function that will handle results of swiping

timeTreshold - A treshold below which swipes will not register. (ms) Not required, default 100ms

tresholdX - A treshold below which swipes will not register on the horizontal axis. (px) Not required, default 30px.

tresholdY - A treshold below which swipes will not register on the vertical axis. (px) Not required, default 30px.

Results are returned in the following object:

{
	up:true or false,
	right:true or false,
	down:true or false,
	left:true or false,
}

Author

This project was developed by Gvozden Despotovski.

License

This project is licensed under the MIT License - see the LICENSE.md file for details