Tocca.js

Super lightweight script ( 1.57kB ) to detect via Javascript events like 'tap' 'dbltap' 'swipeup' 'swipedown' 'swipeleft' 'swiperight' on any kind of device.

Demo

Installation

Npm

$ npm install tocca

Bower

$ bower install Tocca.js -save

Usage

Include the script into your page:

<script src="path/to/Tocca.js"></script>

Once you have included Tocca.js you will be able to catch all the new events:

elm.addeventListener('tap',function(e){});
elm.addeventListener('dbltap',function(e){});
elm.addeventListener('swipeleft',function(e){});
elm.addeventListener('swiperight',function(e){});
elm.addeventListener('swipeup',function(e){});
elm.addeventListener('swipedown',function(e){});

It works with jQuery as well:

$(elm).on('tap',function(e,data){});
$(elm).on('dbltap',function(e,data){});
$(elm).on('swipeleft',function(e,data){});
$(elm).on('swiperight',function(e,data){});
$(elm).on('swipeup',function(e,data){});
$(elm).on('swipedown',function(e,data){});

API and Examples

Anytime you will use a Tocca.js event the callback function will receive a special event object containing the following properties

x { Int }: latest x position of pointer at the end of the event
y { Int }: latest y position of pointer at the end of the event
originalEvent { Object }: the original javascript native event that has been triggered
distance: this property is available only for the swipe events
- x { Int }: the x absolute difference between the beginning and the end of the swipe gesture
- y { Int }: the y absolute difference between the beginning and the end of the swipe gesture

Examples:

elm.addEventListener('dbltap',function (e){
	console.log(e.x);
	console.log(e.y);
});
elm.addEventListener('swipeup',function (e){
	console.log(e.x);
	console.log(e.y);
	console.log(e.distance.x);
	console.log(e.distance.y);
});

// with jQuery

$(elm).on('dbltap',function (e,data){
	console.log(data.x);
	console.log(data.y);
});
$(elm).on('swipeup',function (e,data){
	console.log(data.x);
	console.log(data.y);
	console.log(data.distance.x);
	console.log(data.distance.y);
});

Anyway you can combine Tocca.js with the default javascript touch events:

touchmove
touchstart
touchend
touchcancel

To disable the default touch behaviours (zoom on double tap, scroll on swipe...) on a certain element via javascript you can always use the following snippet:

elm.addEventListener('touchmove',function(e){e.preventDefault()});
elm.addEventListener('touchstart',function(e){e.preventDefault()});
elm.addEventListener('touchend',function(e){e.preventDefault()});

Configuration

Whenever you want to configure the plugin events settings you can do that simply specifying two constants before including Tocca.js into the page

<script>
var SWIPE_TRESHOLD = 80, // default value
	DBL_TAP_TRESHOLD || 50, // range of time in which a dbltap event could be detected
	TAP_TRESHOLD = 200, // range of time in which a tap event could be detected
	TAP_PRECISION = 60 / 2, // default value (touch events boundaries)
	JUST_ON_TOUCH_DEVICES = false; // default value ( decide whether you want to use the Tocca.js events only on the touch devices )
</script>
<script src="path/to/Tocca.js"></script>

Browser Support

Actually the script has been tested on all the modern browsers but it need a better testing phase over several platforms: Chrome 29+ Firefox 23+ Opera 12+ Safari 5+

It works on mobile/tablet browsers and on desktop browsers as well.

On the old browsers all the Tocca.js events cannot be triggered.

Changelog

0.1.2

updated: no more deferred tap events, a tap event gets triggered immediately if it's in the TAP_TRESHOLD time range
updated: a tap event will always come first a dbltap event

0.1.1

updated: better and faster tap events detection
updated: node devDependecies updated
added: DBL_TAP_TRESHOLD option

0.1.0

bugfix: optimizing the support for the microsoft hybrid devices (IE10/IE11)

0.0.8

'touchcancel' event removed to fix and android issue on page scroll

0.0.7

nothing important (just a workaround to fix the tests on the motherfucker Phantomjs)

0.0.6

bugfix: do not set the mouse event listeners on any touch device and vice versa
added: new JUST_ON_TOUCH_DEVICES option to block all the Tocca.js events on the no-touch devices

0.0.5

tap precision option included

0.0.4

dpltap renamed dbltap
new demo added demo-fun.html

0.0.3

Tests added

0.0.2

Android Bug fix

What does Tocca mean?!

'Tocca' is the second person singular of the imperative Italian verb 'Toccare' that means to touch.

rakeshrach / Tocca.js