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. Cancellation

Cancel outside element

If long press should be cancelled when moved outside element

PreviousCancellationNextCancel on movement

Last updated 1 year ago

Was this helpful?

Name

cancelOutsideElement

Type

boolean

Default value

true

Description

If long press should be canceled when moving mouse / touch / pointer outside the element to which it was bound. When cancelled returns

Javascript
'cancelled-outside-element'
TypeScript
LongPressCallbackReason.CancelledOutsideElement

as a cancel reason in callback. Works for mouse and pointer events, touch events may be supported in the future.

onCancel