Gesture options

🖐 React UseGesture offers different options to configure the gestures.

Some options are generic to the way 👍 React UseGesture behaves while some other options can be configured per gesture.

Structure of the config object

Depending on whether you use gesture-specific hooks or if you use the useGesture hook, you'll need to structure the config option object differently.

// when you use a gesture-specific hook
useDrag(state => doSomethingWith(state), { ...genericOptions, ...dragOptions })
// when you use the useGesture hook
useGesture(state => doSomethingWith(state), {
  // global options such as `domTarget`
  ...genericOptions,
  // gesture specific options
  drag:   dragOptions,
  wheel:  wheelOptions,
  pinch:  pinchOptions,
  scroll: scrollOptions,
  wheel:  wheelOptions,
  hover:  hoverOptions,
})

Generic options

Generic options deal with how 👍 React UseGesture will set event listeners.

Gesture options

Here are all options that can be applied to gestures.

All options are not available to all gestures. In the table below xy designates coordinates-based gestures: drag, move, wheel and scroll.

Options explained

domTarget

✊ React UseGesture also supports adding handlers to dom nodes directly (or the window or document objects). In that case, you shouldn't spread the bind() object returned by the hooks as a prop. Cleaning is handled automatically.

function ScrollExample() {
  const [{ width }, set] = useSpring(() => ({ width: '0%' }))
  const height = document.documentElement.scrollHeight
  useScroll(({ xy: [, y] }) => set({ width: (y / height) * 100 + '%' }), { domTarget: window })
  return <animated.div style={{ width }} />
}

The code above binds the scroll gesture to the document window, and acts as a scroll indicator. Try scrolling the page and you'll see the blue bar progress.

You can also directly pass a ref to domTarget. This is actually usefull when you want your events not to be passive.

const myRef = React.useRef(null)
// This will add a scroll listener the div
useScroll(({ event }) => event.preventDefault(), {
  domTarget: myRef,
  eventOptions: { passive: false },
})
return <div ref={myRef} />

eventOptions

When eventOptions.capture is set to true, events will be captured.

eventOptions.passive sets whether events are passive. Note that if you want events not to be passive, you will need to attach events directly to a node using domTarget because of the way React handles events.

window

Lets you specify which window element the gesture should bind events to (only relevant for the drag gesture).

enabled

Whether the gesture is enabled.

initial

Everytime a gesture starts, the movement state attribute is set to [0,0]. But in some cases, you might want to calculate movement from an initial position that is external to your logic¹.

Let's take a tangible example: say that a draggable component turns back to its initial position slowly. In the meantime, the draggable component should still be interruptible at any moment. In that case, you can use initial to set the position of the component at the moment the user drags it to the value of the spring.

Drag the blue square and before it goes back to its origin drag it again. If you've unticked the checkbox, you'll notice that the square goes back to its origin instead of moving from where you've dragged it: that's because movement is by default reset to [0,0].

The code below shows how the example works:

function InitialExample() {
  const [{ x }, set] = useSpring(() => ({ x: 0 }))
  const bind = useDrag(
    ({ down, movement: [mx] }) => set({ x: down ? mx : 0, immediate: down, config: { duration: 3000 } }),
    { initial: () => [x.get(), 0] }
  )
  return <animated.div {...bind()} style={{ x }} />
}

Unless your initial position is static or depends on state, make sure you use a function rather than a static array.

threshold

By default, your gesture handler will be triggered as soon as an event is fired. However, there are situations where you want to make sure the user action is intentional: that's where threshold comes into play.

threshold is the minimum displacement the gesture movement needs to travel before your handler is fired.

In this example, we've set the threshold to 100² and made visible when that threshold is exceeded: when you start dragging the blue square, you'll see a ghost square showing how many pixels are left until the blue square starts moving per axis³.

function ThresholdExample() {
  const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))
  const bind = useDrag(({ offset: [x, y] }) => set({ x, y }), {
    threshold: 10,
  })
  return <animated.div {...bind()} style={{ x, y }} />
}

If you still want your handler to be triggered for non intentional displacement, this is where the triggerAllEvents config option and the intentional state attribute become useful.

triggerAllEvents

Forces the handler to fire even for non intentional displacement (ignores the threshold). In that case, the intentional attribute from state will remain false until the threshold is reached.

bounds

If you want to set contraints to the user gesture, then you should use the bounds option. In that case, both the gesture movement and offset will be clamped to the specified bounds. bounds will be defaulted to Infinity when not set.

function BoundsExample() {
  const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))
  const bind = useDrag(({ down, offset: [ox, oy] }) => set({ x: ox, y: oy, immediate: down }), {
    bounds: { left: -100, right: 100, top: -50, bottom: 50 },
  })
  return <animated.div {...bind()} style={{ x, y }} />
}

distanceBounds and angleBounds serve the same purpose as bounds for the pinch gesture, in a {min,max} format.

distanceBounds

angleBounds

rubberband

In some cases, you may want to simulate resistance when the user drags a component, for example when the end of a content is reached⁴.

You can set rubberband to true to use the default elasticity coeffecient of 0.15, or specify your own. The rubberband option also accepts a vector if you want to set different elasticity coeffecients per axis.

function RubberbandExample() {
  const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))
  const bind = useDrag(({ down, offset: [ox, oy] }) => set({ x: ox, y: oy, immediate: down }), {
    bounds: { left: -100, right: 100, top: -50, bottom: 50 },
    rubberband: true,
  })
  return <animated.div {...bind()} style={{ x, y }} />
}

Note that you have to set bounds for rubberbanding to take effect.

If you stop your gesture while being off-bounds, the offset or movement for the last event will be reverted to the closest bounds.

axis (xy gestures only)

axis makes it easy to constraint the user gesture to a specific axis.

function AxisExample() {
  const [{ x }, set] = useSpring(() => ({ x: 0 }))
  const bind = useDrag(({ down, movement: [mx] }) => set({ x: down ? mx : 0 }), { axis: 'x' })
  return <animated.div {...bind()} style={{ x }} />
}

From the code below it isn't obvious to understand why axis might be useful, since in any case the y movement isn't part of the logic.

But in reality axis does slightly more than just locking the gesture direction: if it detects that the user intent is to move the component in a different direction, it will stop firing the gesture handler. Here is an example to show the difference.

The component above can only move along the x axis. But try dragging the component on the vertically. Without the axis option, you should notice the component movement will slightly jiggle horizontally because you're movement won't be perfectly vertical.

lockDirection (xy gestures only)

lockDirection allows you to lock the movement of the gesture once a direction has been detected. In other words, if the user starts moving horizontally, the gesture will be locked on the x axis.

function LockDirectionExample() {
  const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))
  const bind = useDrag(
    ({ down, movement: [mx, my] }) => {
      set({ x: down ? mx : 0, y: down ? my : 0, immediate: down })
    },
    { lockDirection: true }
  )
  return <animated.div {...bind()} style={{ x, y }} />
}

filterTaps (drag only)

Making a draggable component tappable or clickable can be tricky: differenciating a click from a drag is not always trivial. When you set filterTaps to true, the tap state attribute will be true on release if the total displacement is inferior to 3 pixels while down will remain false all along.

function FilterTapsExample() {
  const [{ x, y }, set] = useSpring(() => ({ x: 0, y: 0 }))
  const bind = useDrag(
    ({ down, movement: [mx, my], tap }) => {
      if (tap) alert('tap!')
      set({ x: down ? mx : 0, y: down ? my : 0 })
    },
    { filterTaps: true }
  )
  return <animated.div {...bind()} style={{ x, y }} />
}

If you still want your handler to be triggered for non intentional displacement, this is where the triggerAllEvents config option and the intentional state attribute become useful.

delay (drag only)

delay delays the drag gesture for the amount of milliseconds you specify. This might be useful if you don't want your logic to fire right away. The below example has a delay set to 1000. Try clicking on the square without moving your mouse.

Note that if the the pointer is moved by the user, the drag gesture will fire immediately without waiting for the delay.

function DelayExample() {
  const [{ x, y, scale }, set] = useSpring(() => ({ x: 0, y: 0, scale: 1 }))
  const bind = useDrag(
    ({ down, movement: [mx, my] }) => set({ x: down ? mx : 0, y: down ? my : 0, scale: down ? 1.2 : 1 }),
    { delay: 1000 }
  )
  return <animated.div {...bind()} style={{ x, y, scale }} />
}

Note that delay and threshold don't play well together: without moving your pointer, your handler will never get triggered.

swipeDistance

swipeVelocity