Interface PointerHandlerOptions

interface PointerHandlerOptions {
    consumeTouch?: boolean;
    onPointerDown: ((event, modifiers) => boolean | void);
    onPointerMoveOrWait?: ((event, modifiers, originalEvent) => void);
    onPointerUp?: ((event, modifiers, originalEvent) => void);
    processTouch?: boolean;
    timerContinuous?: number;
    timerInitial?: number;
}

Properties

consumeTouch? onPointerDown onPointerMoveOrWait? onPointerUp? processTouch? timerContinuous? timerInitial?

Properties

Optional consumeTouch

consumeTouch?: boolean

If true the touch events will be consumed and not propagated.

Default

true

onPointerDown

onPointerDown: ((event, modifiers) => boolean | void)

If returns false then other events will not be fired

Type declaration

    • (event, modifiers): boolean | void

    • Parameters

      Returns boolean | void

Optional onPointerMoveOrWait

onPointerMoveOrWait?: ((event, modifiers, originalEvent) => void)

If the Pointer has moved or it the Pointer was held for a period of timerContinuous.

Type declaration

    • (event, modifiers, originalEvent): void

    • Parameters

      • event: PointerEvent
      • modifiers: PointerModifiers
      • originalEvent: PointerEvent<Element>

      Returns void

Optional onPointerUp

onPointerUp?: ((event, modifiers, originalEvent) => void)

Called when Pointer is released. This is different than the regular Pointer up in that it will be called even if the Pointer is released when outside the component.

Type declaration

    • (event, modifiers, originalEvent): void

    • Parameters

      • event: PointerEvent
      • modifiers: PointerModifiers
      • originalEvent: PointerEvent<Element>

      Returns void

Optional processTouch

processTouch?: boolean

If this is being used for a touch device then this should be true. This will prevent the default touch events from being fired (by calling defaultPrevent during the capture phase).

Default

false

Optional timerContinuous

timerContinuous?: number

Optional timerInitial

timerInitial?: number

Settings

Member Visibility

Theme

On This Page

consumeTouchonPointerDownonPointerMoveOrWaitonPointerUpprocessTouchtimerContinuoustimerInitial