useLongPress

Category

Sensors

Hook that defines the logic when long pressing an element

import { useLongPress } from '@siberiacancode/reactuse';

Usage

const longPressing = useLongPress(ref, () => console.log('callback'));

Demo

source

Api

Parameters

Name	Type	Default	Note
target	Target	-	The target element to be long pressed
callback	(event: Event) => void	-	The callback function to be invoked on long press
options.threshold?	number	400	The threshold time in milliseconds
options.onStart?	(event: Event) => void	-	The callback function to be invoked on long press start
options.onFinish?	(event: Event) => void	-	The callback function to be invoked on long press finish
options.onCancel?	(event: Event) => void	-	The callback function to be invoked on long press cancel

Returns

void

Parameters

Name	Type	Default	Note
target	Target	-	The target element to be long pressed
callback	(event: Event) => void	-	The callback function to be invoked on long press
options.threshold?	number	400	The threshold time in milliseconds
options.onStart?	(event: Event) => void	-	The callback function to be invoked on long press start
options.onFinish?	(event: Event) => void	-	The callback function to be invoked on long press finish
options.onCancel?	(event: Event) => void	-	The callback function to be invoked on long press cancel

Returns

UseLongPressReturn<Target>

Contributors

Source • Demo