Created
January 24, 2024 11:05
-
-
Save KristofferEriksson/098c48029874c46b5ef73d159f3c7c1a to your computer and use it in GitHub Desktop.
A simple useLongPress hook for React
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { useCallback, useEffect, useRef } from "react"; | |
export function useLongPress({ | |
delay, | |
onLongPress, | |
onClick, | |
onCancel, | |
onFinish, | |
onStart, | |
}: { | |
delay: number; | |
onLongPress: () => void; | |
onClick?: () => void; | |
onCancel?: () => void; | |
onFinish?: () => void; | |
onStart?: () => void; | |
}) { | |
const timerRef = useRef<ReturnType<typeof setTimeout>>(); | |
const pressTriggeredRef = useRef<boolean>(false); | |
const pressInitiatedRef = useRef<boolean>(false); | |
const start = useCallback( | |
(event: React.MouseEvent<any, MouseEvent> | React.TouchEvent<any>) => { | |
// Only left clicks (button 0) | |
if ("button" in event && event.button !== 0) return; | |
pressTriggeredRef.current = false; | |
pressInitiatedRef.current = true; | |
if (onStart) onStart(); | |
timerRef.current = setTimeout(() => { | |
if (pressInitiatedRef.current) { | |
onLongPress(); | |
if (onFinish) onFinish(); | |
pressTriggeredRef.current = true; | |
} | |
}, delay); | |
}, | |
[onLongPress, delay, onFinish, onStart] | |
); | |
const clear = useCallback(() => { | |
if (timerRef.current) { | |
clearTimeout(timerRef.current); | |
} | |
if (!pressTriggeredRef.current && pressInitiatedRef.current && onClick) { | |
onClick(); | |
} | |
pressInitiatedRef.current = false; | |
timerRef.current = undefined; | |
if (!pressTriggeredRef.current) { | |
if (onCancel) onCancel(); | |
} | |
}, [onClick, onCancel]); | |
useEffect(() => { | |
return () => { | |
if (timerRef.current) { | |
clearTimeout(timerRef.current); | |
} | |
}; | |
}, []); | |
return { | |
onMouseDown: start, | |
onTouchStart: start, | |
onMouseUp: clear, | |
onMouseLeave: clear, | |
onTouchEnd: clear, | |
}; | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment