1.0.2 • Published 1 year ago

react-native-swipe-gesture-control v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

react-native-swipe-gesture-control

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

Your Forked Package

This is a fork of react-native-swipe-gestures.

Acknowledgment

This project is based on the work of glepur.

Changes Made

  • Feature, ability to toggle the swipe gesture detection in a particular detection.

Installation

npm i react-native-swipe-gesture-control

yarn add react-native-swipe-gesture-control

Usage

'use strict';

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

class SomeComponent extends Component {

  constructor(props) {
    super(props);
    this.state = {
      myText: 'I\'m ready to get swiped!',
      gestureName: 'none',
      backgroundColor: '#fff'
    };
  }

  onSwipeUp(gestureState) {
    this.setState({myText: 'You swiped up!'});
  }

  onSwipeDown(gestureState) {
    this.setState({myText: 'You swiped down!'});
  }

  onSwipeLeft(gestureState) {
    this.setState({myText: 'You swiped left!'});
  }

  onSwipeRight(gestureState) {
    this.setState({myText: 'You swiped right!'});
  }

  onSwipe(gestureName, gestureState) {
    const {SWIPE_UP, SWIPE_DOWN, SWIPE_LEFT, SWIPE_RIGHT} = swipeDirections;
    this.setState({gestureName: gestureName});
    switch (gestureName) {
      case SWIPE_UP:
        this.setState({backgroundColor: 'red'});
        break;
      case SWIPE_DOWN:
        this.setState({backgroundColor: 'green'});
        break;
      case SWIPE_LEFT:
        this.setState({backgroundColor: 'blue'});
        break;
      case SWIPE_RIGHT:
        this.setState({backgroundColor: 'yellow'});
        break;
    }
  }

  render() {

    const config = {
      velocityThreshold: 0.3,
      directionalOffsetThreshold: 80
    };

    return (
      <GestureRecognizer
        onSwipe={(direction, state) => this.onSwipe(direction, state)}
        onSwipeUp={(state) => this.onSwipeUp(state)}
        onSwipeDown={(state) => this.onSwipeDown(state)}
        onSwipeLeft={(state) => this.onSwipeLeft(state)}
        onSwipeRight={(state) => this.onSwipeRight(state)}
        config={config}
        style={{
          flex: 1,
          backgroundColor: this.state.backgroundColor
        }}
        >
        <Text>{this.state.myText}</Text>
        <Text>onSwipe callback received gesture: {this.state.gestureName}</Text>
      </GestureRecognizer>
    );
  }
}

export default SomeComponent;

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)
detectSwipeUpbooleantrueEnables detection of swipe up gestures.
detectSwipeDownbooleantrueEnables detection of swipe down gestures.
detectSwipeLeftbooleantrueEnables detection of swipe left gestures.
detectSwipeRightbooleantrueEnables detection of swipe right gestures.

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
1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago