react-swipeable

What is react-swipeable?

The react-swipeable package is a React component that provides easy-to-use swipe event handlers for touch devices. It allows developers to add swipe functionality to their React components, making it ideal for creating touch-friendly user interfaces.

What are react-swipeable's main functionalities?

Basic Swipe Detection

This code demonstrates how to use the react-swipeable package to detect basic swipe events. The `useSwipeable` hook is used to create swipe handlers, which are then applied to a div element. When a swipe is detected, a message is logged to the console.

import React from 'react';
import { useSwipeable } from 'react-swipeable';

const SwipeComponent = () => {
  const handlers = useSwipeable({
    onSwiped: (eventData) => console.log('User Swiped!', eventData)
  });

  return (
    <div {...handlers} style={{ width: '100%', height: '100px', background: 'lightgray' }}>
      Swipe here
    </div>
  );
};

export default SwipeComponent;

Swipe Direction Detection

This code demonstrates how to detect the direction of a swipe using the react-swipeable package. The `useSwipeable` hook is configured with handlers for each swipe direction (left, right, up, down), and logs a message to the console when a swipe in that direction is detected.

import React from 'react';
import { useSwipeable } from 'react-swipeable';

const SwipeDirectionComponent = () => {
  const handlers = useSwipeable({
    onSwipedLeft: () => console.log('Swiped Left!'),
    onSwipedRight: () => console.log('Swiped Right!'),
    onSwipedUp: () => console.log('Swiped Up!'),
    onSwipedDown: () => console.log('Swiped Down!')
  });

  return (
    <div {...handlers} style={{ width: '100%', height: '100px', background: 'lightblue' }}>
      Swipe in any direction
    </div>
  );
};

export default SwipeDirectionComponent;

Swipe Threshold Configuration

This code demonstrates how to configure a swipe threshold using the react-swipeable package. The `useSwipeable` hook is configured with a `delta` value, which sets the minimum distance (in pixels) that a swipe must cover to be detected.

import React from 'react';
import { useSwipeable } from 'react-swipeable';

const SwipeThresholdComponent = () => {
  const handlers = useSwipeable({
    onSwiped: (eventData) => console.log('User Swiped!', eventData),
    delta: 50 // Minimum distance (in pixels) for a swipe to be detected
  });

  return (
    <div {...handlers} style={{ width: '100%', height: '100px', background: 'lightgreen' }}>
      Swipe with a minimum threshold
    </div>
  );
};

export default SwipeThresholdComponent;

Other packages similar to react-swipeable

react-swipe

The react-swipe package provides a React component for touch slide navigation. It is similar to react-swipeable in that it allows for swipe detection, but it is more focused on creating swipeable carousels and sliders. It offers a higher-level abstraction compared to react-swipeable.

react-use-gesture

The react-use-gesture package is a set of hooks for handling gestures in React. It supports a wide range of gestures, including swipes, pinches, and scrolls. Compared to react-swipeable, react-use-gesture offers more comprehensive gesture support and can be used for more complex interactions.

react-swipeable-views

The react-swipeable-views package is a React component for creating swipeable views, such as tabs or carousels. It is similar to react-swipeable in that it provides swipe detection, but it is specifically designed for creating swipeable view containers. It offers built-in support for animations and transitions.

README

React Swipeable

React swipe event handler hook

WIP - This is the v6.0.0 working branch

Github Pages Demo

Api

Use the hook and set your swipe(d) handlers.

const handlers = useSwipeable({
  onSwiped: (eventData) => eventHandler,
  ...config,
});
return <div {...handlers}> You can swipe here </div>;

Spread handlers onto the element you wish to track swipes inside of. Details below.

Props / Config Options

Event Handler Props

{
  onSwiped,          // Fired after any swipe
  onSwipedLeft,      // Fired after LEFT swipe
  onSwipedRight,     // Fired after RIGHT swipe
  onSwipedUp,        // Fired after UP swipe
  onSwipedDown,      // Fired after DOWN swipe
  onSwiping,         // Fired during any swipe
  onTap,             // Fired after a tap
}

Event data

All Event Handlers are called with the below event data.

{
  event,          // source event
  initial,        // initial swipe [x,y]
  first,          // true for first event
  deltaX,         // x offset (current.x - initial.x)
  deltaY,         // y offset (current.y - initial.y)
  absX,           // absolute deltaX
  absY,           // absolute deltaY
  velocity,       // √(absX^2 + absY^2) / time - "absolute velocity" (speed)
  vxvy,           // [ deltaX/time, deltaY/time] - velocity per axis
  dir,            // direction of swipe (Left|Right|Up|Down)
}

Configuration Props

{
  delta: 10,                             // min distance(px) before a swipe starts
  preventDefaultTouchmoveEvent: false,   // preventDefault on touchmove, *See Details*
  trackTouch: true,                      // track touch input
  trackMouse: false,                     // track mouse input
  rotationAngle: 0,                      // set a rotation angle
}

None of the props/config options are required.

Hook details

• Hook use requires react >= 16.8.0
• The props contained in handlers are currently ref and onMouseDown
  • Please spread handlers as the props contained in it could change as react improves event listening capabilities
    • See #127 for some more context

preventDefaultTouchmoveEvent Details

preventDefaultTouchmoveEvent prevents the browser's touchmove event. Use this to stop the browser from scrolling while a user swipes.

• e.preventDefault() is only called when:
  • preventDefaultTouchmoveEvent: true
  • trackTouch: true
  • the users current swipe has an associated onSwiping or onSwiped handler/prop

Example:

• If a user is swiping right with <Swipable onSwipedRight={this.userSwipedRight} preventDefaultTouchmoveEvent={true} > then e.preventDefault() will be called, but if the user was swiping left then e.preventDefault() would not be called.

Please experiment with the example to test preventDefaultTouchmoveEvent.

passive listener issue

At the moment, the lighthouse audit is deducting 7 points from the best practices metric for "Does not use passive listeners to improve scrolling performance".

This will not affect behavior in the application, merely the score on the lighthouse audit.

This is currently being tracked in issue 167.

Version 6 Updates and migration

v6 of react-swipeable only exports a hook now, useSwipeable. See the useSwipeable hook in action with this codesandbox.

If would like something similar to the old <Swipeable> component you can recreate it from the hook. There is an example in the migration doc.

Development

Initial set up, with node 10+ & yarn v1, run yarn.

Make changes/updates to the src/index.js file.

Please add tests if PR adds/changes functionality.

Verify updates with the examples

Build, run, and test examples locally: yarn run start:examples

After the server starts you can then view the examples page with your changes at http://localhost:3000.

You can now make updates/changes to src/index.js and webpack will rebuild, then reload the page so you can test your changes!

License

MIT