Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
react-swipeable
Advanced tools
Readme
React swipe event handler hook
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.
{
onSwiped, // After any swipe (SwipeEventData) => void
onSwipedLeft, // After LEFT swipe (SwipeEventData) => void
onSwipedRight, // After RIGHT swipe (SwipeEventData) => void
onSwipedUp, // After UP swipe (SwipeEventData) => void
onSwipedDown, // After DOWN swipe (SwipeEventData) => void
onSwipeStart, // Start of swipe (SwipeEventData) => void *see details*
onSwiping, // During swiping (SwipeEventData) => void
onTap, // After a tap ({ event }) => void
// Pass through callbacks, event provided: ({ event }) => void
onTouchStartOrOnMouseDown, // Called for `touchstart` and `mousedown`
onTouchEndOrOnMouseUp, // Called for `touchend` and `mouseup`
}
onSwipeStart
- called only once per swipe at the start and before the first onSwiping
callback
first
property of the SwipeEventData
will be true
{
delta: 10, // min distance(px) before a swipe starts. *See Notes*
preventScrollOnSwipe: false, // prevents scroll during swipe (*See Details*)
trackTouch: true, // track touch input
trackMouse: false, // track mouse input
rotationAngle: 0, // set a rotation angle
swipeDuration: Infinity, // allowable duration of a swipe (ms). *See Notes*
touchEventOptions: { passive: true }, // options for touch listeners (*See Details*)
}
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 } // up and down ">= 20", left and right default to ">= 10"
}
A swipe lasting more than swipeDuration
, in milliseconds, will not be considered a swipe.
Infinity
for backwards compatibility, a sensible duration could be something like 250
use-gesture
swipe.duration{
swipeDuration: 250 // only swipes under 250ms will trigger callbacks
}
Allows the user to set the options for the touch event listeners( currently only passive
option ).
touchstart
, touchmove
, and touchend
event listeners{ passive: true }
preventScrollOnSwipe
option supersedes touchEventOptions.passive
for touchmove
event listener
preventScrollOnSwipe
for more detailsAll Event Handlers are called with the below event data, SwipeEventData
.
{
event, // source event
initial, // initial swipe [x,y]
first, // true for the first event of a tracked swipe
deltaX, // x offset (current.x - initial.x)
deltaY, // y offset (current.y - initial.y)
absX, // absolute deltaX
absY, // absolute deltaY
velocity, // √(absX^2 + absY^2) / time - "absolute velocity" (speed)
vxvy, // [ deltaX/time, deltaY/time] - velocity per axis
dir, // direction of swipe (Left|Right|Up|Down)
}
None of the props/config options are required.
handlers
are currently ref
and onMouseDown
handlers
as the props contained in it could change as react changes event listening capabilitiespreventScrollOnSwipe
detailsThis 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 }
thene.preventDefault()
will be called, but if the user was swiping left thene.preventDefault()
would not be called.
e.preventDefault()
is only called when:
preventScrollOnSwipe: true
trackTouch: true
onSwiping
or onSwiped
handler/propPlease experiment with the example app to test preventScrollOnSwipe
.
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.
If upgrading from v6 refer to the release notes and the migration doc.
document
?Example by @merrywhether #180
https://codesandbox.io/s/react-swipeable-document-swipe-example-1yvr2v
const { ref } = useSwipeable({
...
}) as { ref: RefCallback<Document> };
useEffect(() => {
ref(document);
// Clean up swipeable event listeners
return () => ref({});
});
Note: Issues can arise if you forget to clean up listeners - #332
ref
from useSwipeable
?Example ref passthrough, more details #189:
const MyComponent = () => {
const handlers = useSwipeable({ onSwiped: () => console.log('swiped') })
// setup ref for your usage
const myRef = React.useRef();
const refPassthrough = (el) => {
// call useSwipeable ref prop with el
handlers.ref(el);
// set myRef el so you can access it yourself
myRef.current = el;
}
return (<div {...handlers} ref={refPassthrough} />
}
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.
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.
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.
Please see our contributions guide.
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.
FAQs
React Swipe event handler hook
The npm package react-swipeable receives a total of 358,542 weekly downloads. As such, react-swipeable popularity was classified as popular.
We found that react-swipeable demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 22 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.