Long press hook
  • Introduction
  • Installation
  • Basics
  • Advanced
    • Definition
    • Callback
    • Options
      • Configuration
        • Events detection
        • Long press threshold
      • React events
        • Persisting event
        • Filtering events
      • Callbacks
        • Press started
        • On move
        • Press finished
        • Long press cancelled
      • Cancellation
        • Cancel outside element
        • Cancel on movement
    • Hook result / Bind function
      • Context
      • Handlers
  • Examples
    • Advanced usage example
    • Live examples
      • Version 3
      • Version 2 (deprecated)
      • Version 1 (deprecated)
  • Migration
    • V1 to V2
    • V2 to V3
    • ⚠️V3.1+
    • Change log
  • Contributions
    • ❤️Donations
    • Pull requests policy
  • Architectural Decisions
    • V1 and V2 deprecation
    • Moving to new repository
Powered by GitBook
On this page

Was this helpful?

  1. Advanced
  2. Options
  3. React events

Filtering events

Skip triggering long press for undesired events

PreviousPersisting eventNextCallbacks

Last updated 1 year ago

Was this helpful?

Name

filterEvents

Type

Javascript
(event) => boolean
TypeScript
(event: LongPressReactEvents<Target>) => boolean

Default value

undefined

Description

If provided, it gives you the ability to ignore long press detection on specified conditions (e.g. on right mouse click). When function returns false, it will prevent ANY callbacks from triggering (including and ) as well as .

onStart
onCancel
persisting event