use-gesture

Bread n butter utility for component-tied mouse/touch gestures in React and...

ReactGesture - Touch
pmndrs/use-gestureuse-gesture.netlify.app@use-gesture/react

README

@use-gesture

npm (tag) npm bundle size NPM Discord Shield

@use-gesture is a library that lets you bind richer mouse and touch events to any component or view. With the data you receive, it becomes trivial to set up gestures, and often takes no more than a few lines of code.

You can use it stand-alone, but to make the most of it you should combine it with an animation library like react-spring, though you can most certainly use any other.

The demos are real click them!


Installation


React


  1. ``` sh
  2. #Yarn
  3. yarn add @use-gesture/react

  5. #NPM
  6. npm install @use-gesture/react
  7. ```

Vanilla javascript


  1. ``` sh
  2. #Yarn
  3. yarn add @use-gesture/vanilla

  5. #NPM
  6. npm install @use-gesture/vanilla
  7. ```

Full documentation website


- Available Gestures
- Gesture State
- Gesture Options
- FAQ

Simple example


React

  1. ``` js
  2. import { useSpring, animated } from '@react-spring/web'
  3. import { useDrag } from '@use-gesture/react'

  5. function Example() {
  6.   const [{ x, y }, api] = useSpring(() => ({ x: 0, y: 0 }))

  8.   // Set the drag hook and define component movement based on gesture data.
  9.   const bind = useDrag(({ down, movement: [mx, my] }) => {
  10.     api.start({ x: down ? mx : 0, y: down ? my : 0 })
  11.   })

  13.   // Bind it to a component.
  14.   return <animated.div {...bind()} style={{ x, y, touchAction: 'none' }} />
  15. }
  16. ```

Vanilla javascript

  1. ``` html
  3. <div id="drag" />
  4. ```

  1. ``` js
  2. // script.js
  3. const el = document.getElementById('drag')
  4. const gesture = new DragGesture(el, ({ active, movement: [mx, my] }) => {
  5.   setActive(active)
  6.   anime({
  7.     targets: el,
  8.     translateX: active ? mx : 0,
  9.     translateY: active ? my : 0,
  10.     duration: active ? 0 : 1000
  11.   })
  12. })

  14. // when you want to remove the listener
  15. gesture.destroy()
  16. ```


The example above makes a div draggable so that it follows your mouse on drag, and returns to its initial position on release.

Make sure you always set [touchAction](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) on a draggable element to prevent glitches with the browser native scrolling on touch devices.

Available hooks


@use-gesture/react exports several hooks that can handle different gestures:

HookDescription
------------------------------------------------------
`useDrag`Handles
`useMove`Handles
`useHover`Handles
`useScroll`Handles
`useWheel`Handles
`usePinch`Handles
`useGesture`Handles

More on the full documentation website...