JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q34521F
  • License ISC

React swipeable component

Package Exports

  • @sustainhawaii/react-swipy

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sustainhawaii/react-swipy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Swipy (react-swipy)

Build Status Coverage Status

A simple Tinder-like swipeable React component

Installation

# NPM
npm install --save react-swipy
# Yarn
yarn add react-swipy

Why

I didn't like the lack of control on mose deck-based swipeable components out there

How

See in CodeSandbox

import React, {Component} from "react";
import Swipeable from "react-swipy"

import Card from "./components/Card";
import Button from "./components/Button";

const wrapperStyles = {position: "relative", width: "250px", height: "250px"};
const actionsStyles = {
  display: "flex",
  justifyContent: "space-between",
  marginTop: 12,
};

class App extends Component {
  state = {
    cards: ["First", "Second", "Third"],
  };

  remove = () =>
    this.setState(({cards}) => ({
      cards: cards.slice(1, cards.length),
    }));

  render() {
    const {cards} = this.state;

    return (
      <div>
        <div style={wrapperStyles}>
          {cards.length > 0 ? (
            <div style={wrapperStyles}>
              <Swipeable
                buttons={({left, right}) => (
                  <div style={actionsStyles}>
                    <Button onClick={left}>Reject</Button>
                    <Button onClick={right}>Accept</Button>
                  </div>
                )}
                onAfterSwipe={this.remove}
              >
                <Card>{cards[0]}</Card>
              </Swipeable>
              {cards.length > 1 && <Card zIndex={-1}>{cards[1]}</Card>}
            </div>
          ) : (
            <Card zIndex={-2}>No more cards</Card>
          )}
        </div>
      </div>
    );
  }
}

export default App;

Props

limit

Number

Offset in px swiped to consider as swipe

min

Number

Offset when opacity fade should start

onBeforeSwipe

Function

Callback executed before swiping, it receives 3 parameters:

  • A function that, when called, executes the swipe ('left' or 'right' can be passed to force direction)
  • A function that will cancel the swipe
  • The direction of the swipe

onSwipe

Function

Callback executed right after swipe, it receives 'left' or 'right' as first parameter

onAfterSwipe

Function

Callback executed when animation ends

children

Node

Content of the card

buttons

Function

Function that returns a left and right function that will force a swipe