React-use-gesture offers different options to configure the gestures. Some options are generic to the way React-use-gesture 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.
Generic options deal with how React-use-gesture will set event listeners.
|Lets you specify a dom node or React ref you want to attach the gesture to.|
|Sets whether events are passive. Note that if you want events not to be passive, you will need to use |
|Lets you specify which window element the gesture should bind events to (only relevant for the |
|When set to |
Gesture common options
All gestures share a set of common options described below.
|Whether the gesture is enabled.|
|The initial position |
|The handler will fire only when the gesture displacement is greater than the threshold.|
|The elasticity coefficient of the gesture when going out of bounds. When set to |
xy gestures specific options
Here is the list of options for
|Your handler will only trigger if a movement is detected on the specified axis.|
|Limits the gesture |
pinch specific options
|Limits the distance |
|Limits the angle |
drag specific options
On top of the options for
xy gestures seen above,
drag has the following additional options:
|If set, the handler will be delayed for the duration of the delay (in |
|The minimum distance per axis (in |
|The minimum velocity per axis (in |
React-use-gesture also supports adding handlers to dom nodes directly (or the
document objects). In that case, you shouldn't spread the
bind() object returned by the hooks as a prop, but use the
React.useEffect hook as below.
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.
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 logic1.
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
The code below shows how the example works:
Unless your initial position is static or depends on
state, make sure you use a function rather than a static array.
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
1002 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 axis3.
If you want to set contraints to the user gesture, then you should use the
bounds option. In that case, both the gesture
offset will be clamped to the specified
bounds will be defaulted to
Infinity when not set.
angleBoundsserve the same purpose as
pinchgesture, in a
In some cases, you may want to simulate resistance when the user drags a component, for example when the end of a content is reached4.
You can set
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.
Note that you have to set
bounds for rubberbanding to take effect.
If you stop your gesture while being off-bounds, the
movementfor the last event will be reverted to the closest bounds.
xy gestures only)
axis makes it easy to constraint the user gesture to a specific axis.
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.
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
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
tap state attribute will be
true on release if the total displacement is inferior to
3 pixels while
down will remain
false all along.
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
thresholddon't play well together: without moving your pointer, your handler will never get triggered.
- If you're used to React-use-gesture, this was the most common usecase for
- This is a bit extreme in actual use cases you would be closer to
- As you might have noticed from the example above,
thresholdworks per axis: if the gesture exceeds the threshold value horizontally, you will get updates for horizontal displacement, but vertical threshold will have to be reached before vertical displacement is registered.↩
- Have a look at this article for more details about building mobile interfaces.↩