react-swipe-to-dismiss

2.0.3 • Public • Published

react-swipe-to-dismiss

npm version npm downloads npm size

Swipe to dismiss hook for notifications

Demo

Install via npm

npm install react-swipe-to-dismiss

or

yarn add react-swipe-to-dismiss

Features

  • Left and right direction
  • Touch support (Desktop and Mobile)

Usage

import { useSwipeToDismiss } from 'react-swipe-to-dismiss';

const MessageItem = () => {
  const ref = useRef();
  useSwipeToDismiss(ref, onDismiss, false, 50, 'right');

  return (
    <div className="Message" ref={ref}>
      Your changes has been saved.
    </div>
  );
}

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

Package Sidebar

Install

npm i react-swipe-to-dismiss

Weekly Downloads

54

Version

2.0.3

License

Apache-2.0

Unpacked Size

29.2 kB

Total Files

11

Last publish

Collaborators

  • hosembafer