React hook for detecting click (or tap) and hold event. Easy to use, highly customizable options, thoroughly tested.

useLongPress

Function to call when long press event is detected (click or tap lasts for threshold amount of time or longer)

callback

<ul> <li>threshold - Period of time that must elapse after detecting click or tap in order to trigger callback</li> <li>captureEvent - If React Event will be supplied as first argument to all callbacks</li> <li>detect - Which type of events should be detected ('mouse' | 'touch' | 'both' ) <li>cancelOnMovement - If long press should be canceled on mouse / touch move. You can use this option to turn it on / off or set specific move tolerance as follows: <ol><li>true or false (by default) - when set to true tolerance value will default to 25px <li>number - set a specific tolerance value (square size inside which movement won't cancel long press)</li></ol> </li> <li>onStart - Called right after detecting click / tap event (e.g. onMouseDown or onTouchStart) <li>onFinish - Called (if long press was triggered) on releasing click or tap (e.g. onMouseUp, onMouseLeave or onTouchEnd) <li>onCancel - Called (if long press was not triggered) on releasing click or tap (e.g. onMouseUp, onMouseLeave or onTouchEnd) </ul>

Name	Types	Description
callback		Function to call when long press event is detected (click or tap lasts for threshold amount of time or longer)
options		threshold - Period of time that must elapse after detecting click or tap in order to trigger callback captureEvent - If React Event will be supplied as first argument to all callbacks detect - Which type of events should be detected ('mouse'

use-long-press (master)

# useLongPress(callback, options)

Parameters