Swiperia
Web (swiperia-js)

Swiper

Compose detectors over a single element.

Swiper takes an element and a list of detector classes, instantiates each one and forwards every gesture to a single callback.

import { MouseSwiper, Swiper, TouchSwiper } from 'swiperia-js';

const swiper = new Swiper(element, [MouseSwiper, TouchSwiper], {
  threshold: 20,
});
ParameterTypeDescription
elHTMLElementThe element the gesture starts on.
detectors(new (el, config) => AbstractSwiper)[]Detector classes, not instances. Swiper constructs them.
configSwipeConfigOptional. See configuration.

Methods

listen(callback)

Instantiates each detector and subscribes callback to all of them. The callback receives a SwipeEvent.

destroy()

Destroys every detector it created and empties its internal list, so calling it twice is safe.

swiper.listen((event) => console.log(event.direction));
swiper.destroy();

Passing classes rather than instances is what lets Swiper own their lifetime — you never construct or tear down a detector yourself.

On this page