1.1.3 • Published 3 years ago

react-native-swipe-gestures-plus v1.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-native-swipe-gestures-plus

React Native component for handling swipe gestures in up, down, left and right direction with Press and Long Press Events.

npm npm

Installation

npm i react-native-swipe-gestures-plus

License

This is an updated version by arunahuja94. Original author glepur,

Usage

'use strict';

import React, {Component} from 'react';
import {View, Text} from 'react-native';
import GestureRecognizer, {swipeDirections} from 'react-native-swipe-gestures-plus';

export default function App() {
  const [myText, setMyText] = React.useState("I'm ready to get swiped!");
  const [gestureName, setGestureName] = React.useState('none');
  const [backgroundColor, setBackgroundColor] = React.useState('#fff');

  const onSwipeUp = (gestureState) => {
    setMyText('You swiped up!');
  };

  const onSwipeDown = (gestureState) => {
    setMyText('You swiped down!');
  };

  const onSwipeLeft = (gestureState) => {
    setMyText('You swiped left!');
  };

  const onSwipeRight = (gestureState) => {
    setMyText('You swiped right!');
  };

  const onPress = (gestureState) => {
    setMyText('You Clicked!');
  };

  const onLongPress = (gestureState) => {
    setMyText('You Long Pressed!');
  };

  const onLongPressRelease = (gestureState) => {
    setMyText('You Long Pressed Released!');
  };

  const onSwipe = (gestureName, gestureState) => {
    const {
      SWIPE_UP,
      SWIPE_DOWN,
      SWIPE_LEFT,
      SWIPE_RIGHT,
      ON_PRESS,
      ON_LONGPRESS,
      ON_LONGPRESS_RELEASE,
    } = swipeDirections;
    setGestureName(gestureName);
    switch (gestureName) {
      case SWIPE_UP:
        setBackgroundColor('red');
        break;
      case SWIPE_DOWN:
        setBackgroundColor('green');
        break;
      case SWIPE_LEFT:
        setBackgroundColor('blue');
        break;
      case SWIPE_RIGHT:
        setBackgroundColor('yellow');
        break;
      case ON_PRESS:
        setBackgroundColor('black');
        break;
      case ON_LONGPRESS:
        setBackgroundColor('pink');
        break;
      case ON_LONGPRESS_RELEASE:
        setBackgroundColor('pink');
        break;
    }
  };

  const config = {
    velocityThreshold: 0.3,
    directionalOffsetThreshold: 80,
    swipeEnabled: true,
    longpressDelay: 700,
  };

  return (
    <GestureRecognizer
      onSwipe={(direction, state) => onSwipe(direction, state)}
      onSwipeUp={(state) => onSwipeUp(state)}
      onSwipeDown={(state) => onSwipeDown(state)}
      onSwipeLeft={(state) => onSwipeLeft(state)}
      onSwipeRight={(state) => onSwipeRight(state)}
      onPress={(state) => onPress(state)}
      onLongPress={(state) => onLongPress(state)}
      onLongPressRelease={(state) => onLongPressRelease(state)}
      config={config}
      gestureStyle={{
        width: '100%',
        height: '100%',
        justifyContent: 'center',
        alignItems: 'center',
        flex: 1,
        backgroundColor: backgroundColor,
      }}
      style={{
        flex: 1,
        backgroundColor: backgroundColor,
      }}>
      <Text>{myText}</Text>
      <Text>callback received gesture: {gestureName}</Text>
    </GestureRecognizer>
  );
}

Config

Can be passed within optional config property.

ParamsTypeDefaultDescription
velocityThresholdNumber0.3Velocity that has to be breached in order for swipe to be triggered (vx and vy properties of gestureState)
directionalOffsetThresholdNumber80Absolute offset that shouldn't be breached for swipe to be triggered (dy for horizontal swipe, dx for vertical swipe)
gestureIsClickThresholdNumber5Absolute distance that should be breached for the gesture to not be considered a click (dx or dy properties of gestureState)

Methods

onSwipe(gestureName, gestureState)

ParamsTypeDescription
gestureNameStringName of the gesture (look example above)
gestureStateObjectgestureState received from PanResponder

onSwipeUp(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onSwipeDown(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onSwipeLeft(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onSwipeRight(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onPress(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onLongPress(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder

onLongPressRelease(gestureState)

ParamsTypeDescription
gestureStateObjectgestureState received from PanResponder