swipe-detect
v1.0.1
Published
A touchevent swipe detection utility for JavaScript applications.
Downloads
2,488
Maintainers
Readme
swipe-detect
A touchevent swipe detection utility for JavaScript applications.
Install
$ npm install --save swipe-detect
or
$ yarn add swipe-detect
Usage
import swipeDetect from 'swipe-detect';
swipeDetect(TARGET_DOM_NODE, YOUR_CALLBACK, THRESHOLD_FOR_SWIPE);
Where TARGET_DOM_NODE
is the element you want to listen for swipes on, YOUR_CALLBACK
is the function that should be called when a swipe occurs, and THRESHOLD_FOR_SWIPE
is an int
representing the pixels you want a swipe to gather before it is considered a swipe. Defaults to 150
.
The callback will receive either 'left'
, 'right'
, 'up'
or 'down'
.
Contributing
Create an Issue if there is not already one created. Open up a Pull Request against master
with your fix branch.
Install Dependencies
$ npm install
Run Tests
$ npm test