Vue UseGesture

Vue UseGesture is a hook 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 vue-use-spring, though you can most certainly use any other.

Installation

#Yarn
yarn add vue-use-gesture

#NPM
npm install vue-use-gesture

Full documentation website

• Available Hooks
• Gesture State
• Gesture Options
• Utilities
• FAQ

Simple example

<template>
  <!-- Bind it to a component -->
  <div v-bind="bind()" :style="style" class="box"></div>
</template>

<script>
  import { useDrag } from 'vue-use-gesture'
  import { useSpring } from 'vue-use-spring'
  import { defineComponent, computed } from 'vue'

  export default defineComponent({
    setup() {
      const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))

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

      const style = computed(() => ({ transform: `translate3d(${x.value}px,${y.value}px,0)`, touchAction: 'none' }))

      return { bind, style }
    },
  })
</script>

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 on a draggable element to prevent glitches with the browser native scrolling on touch devices.

Available hooks

vue-use-gesture exports several hooks that can handle different gestures:

| Hook | Description | | ------------ | ------------------------------------------ | | useDrag | Handles the drag gesture | | useMove | Handles mouse move events | | useHover | Handles mouse enter and mouse leave events | | useScroll | Handles scroll events | | useWheel | Handles wheel events | | usePinch | Handles the pinch gesture | | useGesture | Handles multiple gestures in one hook |

More on the full documentation website...

Thanks

This library is a port of React UseGesture. Thanks Polmandres 🙏

License

MIT