React swipe event handler hook
Api
Use the hook and set your swipe(d) handlers.
const handlers = useSwipeable({
onSwiped: (eventData) => console.log("User Swiped!", eventData),
...config,
});
return <div {...handlers}> You can swipe here </div>;
Spread handlers
onto the element you wish to track swipes on.
Props / Config Options
Event handler props
{
onSwiped,
onSwipedLeft,
onSwipedRight,
onSwipedUp,
onSwipedDown,
onSwipeStart,
onSwiping,
onTap,
onTouchStartOrOnMouseDown,
onTouchEndOrOnMouseUp,
}
Details
onSwipeStart
- called only once per swipe at the start and before the first onSwiping
callback
- The
first
property of the SwipeEventData
will be true
Configuration props and default values
{
delta: 10,
preventScrollOnSwipe: false,
trackTouch: true,
trackMouse: false,
rotationAngle: 0,
swipeDuration: Infinity,
touchEventOptions: { passive: true },
}
delta
delta
can be either a number
or an object
specifying different deltas for each direction, [left
, right
, up
, down
], direction values are optional and will default to 10
;
{
delta: { up: 20, down: 20 }
}
swipeDuration
A swipe lasting more than swipeDuration
, in milliseconds, will not be considered a swipe.
- It will also not trigger any callbacks and the swipe event will stop being tracked
- Defaults to
Infinity
for backwards compatibility, a sensible duration could be something like 250
{
swipeDuration: 250
}
touchEventOptions
Allows the user to set the options for the touch event listeners( currently only passive
option ).
touchstart
, touchmove
, and touchend
event listeners- Defaults to
{ passive: true }
- this provides users full control of if/when they want to set passive
preventScrollOnSwipe
option supersedes touchEventOptions.passive
for touchmove
event listener
Swipe Event Data
All Event Handlers are called with the below event data, SwipeEventData
.
{
event,
initial,
first,
deltaX,
deltaY,
absX,
absY,
velocity,
vxvy,
dir,
}
None of the props/config options are required.
Hook details
- Hook use requires react >= 16.8.3
- The props contained in
handlers
are currently ref
and onMouseDown
- Please spread
handlers
as the props contained in it could change as react changes event listening capabilities
preventScrollOnSwipe
details
This prop prevents scroll during swipe in most cases. Use this to stop scrolling in the browser while a user swipes.
Swipeable will call e.preventDefault()
internally in an attempt to stop the browser's touchmove event default action (mostly scrolling).
NOTE: preventScrollOnSwipe
option supersedes touchEventOptions.passive
for the touchmove
event listener
Example scenario:
If a user is swiping right with props { onSwipedRight: userSwipedRight, preventScrollOnSwipe: true }
then e.preventDefault()
will be called, but if the user was swiping left then e.preventDefault()
would not be called.
e.preventDefault()
is only called when:
preventScrollOnSwipe: true
trackTouch: true
- the users current swipe has an associated
onSwiping
or onSwiped
handler/prop
Please experiment with the example app to test preventScrollOnSwipe
.
passive listener details
Swipeable adds the passive event listener option, by default, to internal uses of touch addEventListener
's. We set the passive
option to false
only when preventScrollOnSwipe
is true
and only to touchmove
. Other listeners will retain passive: true
.
When preventScrollOnSwipe
is:
true
=> el.addEventListener('touchmove', cb, { passive: false })
false
=> el.addEventListener('touchmove', cb, { passive: true })
Here is more information on react's long running passive event issue.
We previously had issues with chrome lighthouse performance deducting points for not having passive option set so it is now on by default except in the case mentioned above.
If, however, you really need all of the listeners to be passive (for performance reasons or otherwise), you can prevent all scrolling on the swipeable container by using the touch-action
css property instead, see below for an example.
Version 7 Updates and migration
If upgrading from v6 refer to the release notes and the migration doc.
FAQs
How can I add a swipe listener to the document
?
Example by @merrywhether #180
Example codesandbox with swipeable on document and nested swipe
https://codesandbox.io/s/react-swipeable-document-swipe-example-1yvr2v
const { ref } = useSwipeable({
...
}) as { ref: RefCallback<Document> };
useEffect(() => {
ref(document);
return () => ref({});
});
Note: Issues can arise if you forget to clean up listeners - #332
How to share ref
from useSwipeable
?
Example ref passthrough, more details #189:
const MyComponent = () => {
const handlers = useSwipeable({ onSwiped: () => console.log('swiped') })
const myRef = React.useRef();
const refPassthrough = (el) => {
handlers.ref(el);
myRef.current = el;
}
return (<div {...handlers} ref={refPassthrough} />
}
How to use touch-action
to prevent scrolling?
Sometimes you don't want the body
of your page to scroll along with the user manipulating or swiping an item. Or you might want all of the internal event listeners to be passive and performant.
You can prevent scrolling via preventScrollOnSwipe, which calls event.preventDefault()
during onTouchMove
. But there may be a simpler, more effective solution, which has to do with a simple CSS property.
touch-action
is a CSS property that sets how an element's region can be manipulated by a touchscreen user. See the documentation for touch-action
to determine which property value to use for your particular use case.
Static example
const handlers = useSwipeable({
onSwiped: (eventData) => console.log("User Swiped!", eventData),
...config,
});
return <div {...handlers} style={{ touchAction: 'pan-y' }}>Swipe here</div>;
This explanation and example borrowed from use-gesture
's wonderful docs.
Dynamic example
const MySwipeableComponent = props => {
const [stopScroll, setStopScroll] = useState(false);
const handlers = useSwipeable({
onSwipeStart: () => setStopScroll(true),
onSwiped: () => setStopScroll(false)
});
return <div {...handlers} style={{ touchAction: stopScroll ? 'none' : 'auto' }}>Swipe here</div>;
};
This is a somewhat contrived example as the final outcome would be similar to the static example. However, there may be cases where you want to determine when the user can scroll based on the user's swiping action along with any number of variables from state and props.
License
MIT
Contributing
Please see our contributions guide.
Maintainers
Project Maintenance
Maintenance Status
Active: Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.