An action to emit swipe and tap events on an element, based on react-swipeable v7.0.0. Many thanks to all the contributors of that package for their hard work!
This package provides a Svelte Action called swipeable to attach to any DOM element to react to swipe events.
Install the library
npm i @react2svelte/swipeableAnd add it to your component
<scriptlang="ts">
import {swipeable} from '@react2svelte/swipeable';
import type {SwipeEventData} from '@react2svelte/swipeable';
// ...
function handler(e: CustomEvent<SwipeEventData>) {console.log('User swiped!',e.detail);}</script><divuse:swipeable <!-- use the action -->
on:swiped={handler} <!-- set a handler for the swiped event -->
/>Add the following line to your app.d.ts file
/// <reference types="@react2svelte/swipeable" />(There should already be a line with /// <reference types="@sveltejs/kit" />)
The swipeable action emits 10 new events:
General swipe events
swipedstart- emitted once, at the beginning of a swipeswiping- emitted continuously as the user is swipingswiped- emitted once the swipe is complete
Directional swipe events. These are like swiped but for specific directions only
swipedup- User swiped up.swipeddown- User swiped down.swipedleft- User swiped left.swipedright- User swiped right.
Tap events
tap
Passthrough events
touchstartormousedowntouchendormouseup
This library is based on react-swipeable, and all the same configuration options and default values apply. Configration can be set by passing an object to use declation:
<divuse:swipeable={{delta: 10,// min distance(px) before a swipe starts. *See Notes*preventScrollOnSwipe: false,// prevents scroll during swipe (*See Details*)trackTouch: true,// track touch inputtrackMouse: false,// track mouse inputrotationAngle: 0,// set a rotation angleswipeDuration: Infinity,// allowable duration of a swipe (ms). *See Notes*touchEventOptions: {passive: true}// options for touch listeners (*See Details*)}}/>Please have a look at the react-swipeable documentation for additional information.
All Event Handlers are called with the below event data, SwipeEventData.
{event,// source eventinitial,// initial swipe [x,y]first,// true for the first event of a tracked swipedeltaX,// x offset (current.x - initial.x)deltaY,// y offset (current.y - initial.y)absX,// absolute deltaXabsY,// absolute deltaYvelocity,// √(absX^2 + absY^2) / time - "absolute velocity" (speed)vxvy,// [ deltaX/time, deltaY/time] - velocity per axisdir,// direction of swipe (Left|Right|Up|Down)}Alternative: svelte-gestures
svelte-gestures provides pinch, pan and rotate gestures besides swiping and tapping. However, there is no support for the swiping functionality of swipeable, which provides continuous updates as the user is swiping, rather than just a final event once the swipe is complete.
For the user it can be helpful to get visual feedback as they are swiping - for example and image in a gallery - and see the image move as they are swiping, not just once at the end of their swipe.
MIT