TouchSweep

Super tiny vanilla JS module to detect swipe direction and trigger custom events accordingly.

Visitor stats

Code stats

Install

1npm i touchsweep

or

1yarn add touchsweep

Usage

1import TouchSweep from 'touchsweep';
2
3const area = document.getElementById('swipe-area');
4const data = {
5	value: 1
6};
7const touchThreshold = 20;
8
9const touchSwipeInstance = new TouchSweep(area, data, touchThreshold);
10
11// Then listen for custom swipe events and do your magic:
12
13area.addEventListener('swipeleft', event => {
14	// You have swiped left
15	// Custom event data is located in event.detail
16});
17
18area.addEventListener('swiperight', event => {
19	// You have swiped right
20	// Custom event data is located in event.detail
21});
22
23area.addEventListener('swipedown', event => {
24	// You have swiped down
25	// Custom event data is located in event.detail
26});
27
28area.addEventListener('swipeup', event => {
29	// You have swiped up
30	// Custom event data is located in event.detail
31});
32
33area.addEventListener('tap', event => {
34	// You have tapped
35	// Custom event data is located in event.detail
36});

Options and default settings

The module constructor accepts three (3) arguments:

• element: A HTML Element. Default is document.body
• eventData: A plain JS object. Default is {}
• threshold: How many pixels to count until an event is fired. Default is 40

API

TouchSweep provides a minimal API for you to use.

The TouchSwipe instance exposes two public methods which allow you to add or to remove all event listeners responsible for the module functionality.

This is useful in cases where you want to remove the TouchSwipe container/area from the DOM and prevent possible memory leaks by removing all event listeners related to this DOM element.

In order to remove all previously attached event listeners:

1touchSwipeInstance.unbind();

In order to add all previously removed event listeners:

1touchSwipeInstance.bind();

Supported Browsers

Currently all evergreen browsers are supported.

Demo

There is a simple demo illustrating how the TouchSweep library works.

Check it out here

LICENSE

MIT

                     

Support and sponsor my work: