Skip to content

Latest commit

 

History

History
116 lines (68 loc) · 2.89 KB

presshandlingoptions.md

File metadata and controls

116 lines (68 loc) · 2.89 KB
Raw

Interface: PressHandlingOptions

Hierarchy

  • PressHandlingOptions

Index

Properties

Properties

Optional capturePressThresholdMs

• capturePressThresholdMs? : undefined | number

This is more of an advanced option. If set, this will be the number of milliseconds until the press is captured. Once it is captured, it won't be interpreted as a tap, long tap, or pan, and the onCapturePress* props will begin to be called.

The default is undefined (so presses won't be captured)

Optional ignorePressEntirely

• ignorePressEntirely? : undefined | false | true

Optional longTapThresholdMs

• longTapThresholdMs? : undefined | number

If a press is released after this threshold, it will be considered a long tap. The default is undefined.

Optional onCapturePressCancelled

• onCapturePressCancelled? : undefined | function

Optional onCapturePressEnd

• onCapturePressEnd? : undefined | function

Optional onCapturePressMove

• onCapturePressMove? : undefined | function

Optional onCapturePressStart

• onCapturePressStart? : undefined | function

Optional onLongTap

• onLongTap? : undefined | function

Optional onPotentialLongTap

• onPotentialLongTap? : undefined | function

Optional onPotentialTap

• onPotentialTap? : undefined | function

Optional onTap

• onTap? : undefined | function

Optional onTapAbandoned

• onTapAbandoned? : undefined | function

Optional potentialTapBounds

• potentialTapBounds? : ClientPixelUnit

The area around the initial event in which the pointer can move before the press is interpreted as just a pan. It will not be considered a tap or long tap after the pointer moves outside that area, and it can't be captured.