Interface IPointersCallbacksMap

Maps event names to their callback payload types.

Extend this interface to map event names to payload types. Use undefined for events without a payload.

interface IPointersCallbacksMap {
    destroy: undefined;
    end: undefined;
    move: IPointersMove;
    pointerdown: { event: PointerEvent; pointer: IPointersItem };
    pointermove: { event: PointerEvent; pointer: IPointersItem };
    pointerup: { pointer: IPointersItem };
    props: Partial<IPointersMutableProps>;
    start: undefined;
}

Properties

destroy: undefined

Triggered when the module is destroyed.

end: undefined

Fired when the gesture ends: active pointers drop below minPointers, or on pointercancel / window blur.

Fired once per microtask when any pointer moves after start.

pointerdown: { event: PointerEvent; pointer: IPointersItem }

Fired when a pointer is added.

pointermove: { event: PointerEvent; pointer: IPointersItem }

Fired when a pointer moves.

pointerup: { pointer: IPointersItem }

Fired when a pointer is removed.

Triggered when the module's properties are updated. Receives the diff (changed keys and new values) as the first argument.

start: undefined

Fired when the required number of pointers is reached.