useSwipe
function useSwipe(element): void;Defined in: packages/react/src/hooks/useSwipe.ts:32
Note. This feature is experimental and may change or be removed based on developer feedback and real-world usage. Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes.
Parameters
| Parameter | Type |
|---|---|
element | RefObject<HTMLElement> |
Returns
void
Example
// Basic — register swipe handling on one element.
const swipeRef = React.useRef<HTMLDivElement>(null);
useSwipe(swipeRef);
return <div ref={swipeRef} />;
// Advanced — combine swipe navigation with a track grid.
function SwipeableStage() {
const swipeRef = React.useRef<HTMLDivElement>(null);
const tracks = useTracks([{ source: Track.Source.Camera, withPlaceholder: true }]);
useSwipe(swipeRef);
return (
<div ref={swipeRef}>
<GridLayout tracks={tracks}>
<ParticipantTile />
</GridLayout>
</div>
);
}