tap-listener's Introduction

Tap listener

Listens to taps

On mobile devices, the click event is triggered after a delay. Tap Listener listens for native touch and pointer events to trigger a callback immediately.

Used in Flickity.

var tapper = new TapListener( element );
tapper.on( 'tap', function( event ) {
  console.log('tap happened');
});

Use TapListener to extend a class.

function Widget() {
  //...
}
// inherit Tap Listener
Widget.prototype = new TapListener();
// or
_.extend( Widget.prototype, TapListener.prototype );

var widgy = new Widget( element );
widgy.on( 'tap', function() {...});

Install

Bower: bower install tap-listener --save

npm: npm install tap-listener

RequireJS

requirejs( [ 'path/to/tap-listener' ], function( TapListener ) {
  var tapper = new TapListener( element );
});

Browserify

var TapListener = require('tap-listener');
var tapper = new TapListener( element );

API

var tapper = new TapListener( element )
// element {Element} - binds tap events to element

tapper.bindTap( element )
// element {Element} - binds tap events to element

tapper.unbindTap()
// unbinds tap events

tapper.on( eventName, callback )
// eventName {String} - tap, pointerDown, pointerMove, pointerUp, pointerCancel
// callback {Function}

function callback( event, pointer ) {...}
// event {Event} - the original mouseup, touchend, or pointerup event
// pointer {Event} or {Touch} - event object with pageX and pageY

tapper.destroy()
// unbinds tap events