0.3.8 • Published 3 years ago

@getcabal/react-swipe-to-dismiss v0.3.8

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 years ago

react-swipe-to-dismiss

Swipe to dismiss Component for notifications

Install

React-swipe-to-dismiss is available via npm.

npm install --save react-swipe-to-dismiss

Usage

react-swipe-to-dismiss decorate your component, not wrapping, so you can use it on layouts too. When your component become swiped more than it's width, it will be removed and onDismiss callback will be fired.

Example

You may see an example here.

// Import
import SwipeToDismiss from 'react-swipe-to-dismiss';

// Use
<SwipeToDismiss
  onDismiss={() => this.props.remove()}
>
  <div className="Message">
    Your changes has been saved.
  </div>
</SwipeToDismiss>

Props

  • onDismiss - function. If a component swiped more than its width then it will be called.
  • distanceBeforeDismiss - number. Distance in pixels from where lib will trigger onDismiss
  • removeDOM - boolean. Remove from DOM when element reaches distanceBeforeDismiss
  • direction - enum(left, right). In which direction user can swipe the element