1.0.3 • Published 5 years ago

rn-swipe-gestures v1.0.3

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

rn-swipe-gestures

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

Installation

npm i -S rn-swipe-gestures

Usage

'use strict';

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

class SomeComponent extends React.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 (
      <GestureRecognizerView
        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>
      </GestureRecognizerView>
    );
  }
}

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 peroperties of gestureState)
directionalOffsetThresholdNumber80Absolute offset that shouldn't be breached for swipe to be triggered (dy for horizontal swipe, dx for vertical swipe)
detectSwipeUpBooleantrueenable/disable swipe up gesture detection
detectSwipeDownBooleantrueenable/disable swipe down gesture detection
detectSwipeLeftBooleantrueenable/disable swipe left gesture detection
detectSwipeRightBooleantrueenable/disable swipe right gesture detection

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