react-native-gesture-handler 2.27.0 → 2.27.1

package/lib/typescript/web/handlers/FlingGestureHandler.js

@@ -0,0 +1,133 @@
+import { State } from '../../State';
+import { DiagonalDirections, Directions } from '../../Directions';
+import GestureHandler from './GestureHandler';
+import Vector from '../tools/Vector';
+import { coneToDeviation } from '../utils';
+const DEFAULT_MAX_DURATION_MS = 800;
+const DEFAULT_MIN_VELOCITY = 700;
+const DEFAULT_ALIGNMENT_CONE = 30;
+const DEFAULT_DIRECTION = Directions.RIGHT;
+const DEFAULT_NUMBER_OF_TOUCHES_REQUIRED = 1;
+const AXIAL_DEVIATION_COSINE = coneToDeviation(DEFAULT_ALIGNMENT_CONE);
+const DIAGONAL_DEVIATION_COSINE = coneToDeviation(90 - DEFAULT_ALIGNMENT_CONE);
+export default class FlingGestureHandler extends GestureHandler {
+    numberOfPointersRequired = DEFAULT_NUMBER_OF_TOUCHES_REQUIRED;
+    direction = DEFAULT_DIRECTION;
+    maxDurationMs = DEFAULT_MAX_DURATION_MS;
+    minVelocity = DEFAULT_MIN_VELOCITY;
+    delayTimeout;
+    maxNumberOfPointersSimultaneously = 0;
+    keyPointer = NaN;
+    updateGestureConfig({ enabled = true, ...props }) {
+        super.updateGestureConfig({ enabled: enabled, ...props });
+        if (this.config.direction) {
+            this.direction = this.config.direction;
+        }
+        if (this.config.numberOfPointers) {
+            this.numberOfPointersRequired = this.config.numberOfPointers;
+        }
+    }
+    startFling() {
+        this.begin();
+        this.maxNumberOfPointersSimultaneously = 1;
+        this.delayTimeout = setTimeout(() => this.fail(), this.maxDurationMs);
+    }
+    tryEndFling() {
+        const velocityVector = Vector.fromVelocity(this.tracker, this.keyPointer);
+        if (!velocityVector) {
+            return false;
+        }
+        const getAlignment = (direction, minimalAlignmentCosine) => {
+            return ((direction & this.direction) === direction &&
+                velocityVector.isSimilar(Vector.fromDirection(direction), minimalAlignmentCosine));
+        };
+        const axialDirectionsList = Object.values(Directions);
+        const diagonalDirectionsList = Object.values(DiagonalDirections);
+        // List of alignments to all activated directions
+        const axialAlignmentList = axialDirectionsList.map((direction) => getAlignment(direction, AXIAL_DEVIATION_COSINE));
+        const diagonalAlignmentList = diagonalDirectionsList.map((direction) => getAlignment(direction, DIAGONAL_DEVIATION_COSINE));
+        const isAligned = axialAlignmentList.some(Boolean) || diagonalAlignmentList.some(Boolean);
+        const isFast = velocityVector.magnitude > this.minVelocity;
+        if (this.maxNumberOfPointersSimultaneously ===
+            this.numberOfPointersRequired &&
+            isAligned &&
+            isFast) {
+            clearTimeout(this.delayTimeout);
+            this.activate();
+            return true;
+        }
+        return false;
+    }
+    endFling() {
+        if (!this.tryEndFling()) {
+            this.fail();
+        }
+    }
+    onPointerDown(event) {
+        if (!this.isButtonInConfig(event.button)) {
+            return;
+        }
+        this.tracker.addToTracker(event);
+        this.keyPointer = event.pointerId;
+        super.onPointerDown(event);
+        this.newPointerAction();
+        this.tryToSendTouchEvent(event);
+    }
+    onPointerAdd(event) {
+        this.tracker.addToTracker(event);
+        super.onPointerAdd(event);
+        this.newPointerAction();
+    }
+    newPointerAction() {
+        if (this.state === State.UNDETERMINED) {
+            this.startFling();
+        }
+        if (this.state !== State.BEGAN) {
+            return;
+        }
+        this.tryEndFling();
+        if (this.tracker.trackedPointersCount > this.maxNumberOfPointersSimultaneously) {
+            this.maxNumberOfPointersSimultaneously =
+                this.tracker.trackedPointersCount;
+        }
+    }
+    pointerMoveAction(event) {
+        this.tracker.track(event);
+        if (this.state !== State.BEGAN) {
+            return;
+        }
+        this.tryEndFling();
+    }
+    onPointerMove(event) {
+        this.pointerMoveAction(event);
+        super.onPointerMove(event);
+    }
+    onPointerOutOfBounds(event) {
+        this.pointerMoveAction(event);
+        super.onPointerOutOfBounds(event);
+    }
+    onPointerUp(event) {
+        super.onPointerUp(event);
+        this.onUp(event);
+        this.keyPointer = NaN;
+    }
+    onPointerRemove(event) {
+        super.onPointerRemove(event);
+        this.onUp(event);
+    }
+    onUp(event) {
+        if (this.state === State.BEGAN) {
+            this.endFling();
+        }
+        this.tracker.removeFromTracker(event.pointerId);
+    }
+    activate(force) {
+        super.activate(force);
+        this.end();
+    }
+    resetConfig() {
+        super.resetConfig();
+        this.numberOfPointersRequired = DEFAULT_NUMBER_OF_TOUCHES_REQUIRED;
+        this.direction = DEFAULT_DIRECTION;
+    }
+}

package/lib/typescript/web/handlers/GestureHandler.d.ts

@@ -0,0 +1,102 @@
+import { State } from '../../State';
+import { Config, AdaptedEvent } from '../interfaces';
+import EventManager from '../tools/EventManager';
+import PointerTracker from '../tools/PointerTracker';
+import IGestureHandler from './IGestureHandler';
+import { MouseButton } from '../../handlers/gestureHandlerCommon';
+import { PointerType } from '../../PointerType';
+import { GestureHandlerDelegate } from '../tools/GestureHandlerDelegate';
+export default abstract class GestureHandler implements IGestureHandler {
+    private lastSentState;
+    private _state;
+    private _shouldCancelWhenOutside;
+    protected hasCustomActivationCriteria: boolean;
+    private _enabled;
+    private viewRef;
+    private propsRef;
+    private _handlerTag;
+    private _config;
+    private _tracker;
+    private _activationIndex;
+    private _awaiting;
+    private _active;
+    private _shouldResetProgress;
+    private _pointerType;
+    private _delegate;
+    constructor(delegate: GestureHandlerDelegate<unknown, IGestureHandler>);
+    protected init(viewRef: number, propsRef: React.RefObject<unknown>): void;
+    attachEventManager(manager: EventManager<unknown>): void;
+    protected onCancel(): void;
+    protected onReset(): void;
+    protected resetProgress(): void;
+    reset(): void;
+    moveToState(newState: State, sendIfDisabled?: boolean): void;
+    protected onStateChange(_newState: State, _oldState: State): void;
+    begin(): void;
+    /**
+     * @param {boolean} sendIfDisabled - Used when handler becomes disabled. With this flag orchestrator will be forced to send fail event
+     */
+    fail(sendIfDisabled?: boolean): void;
+    /**
+     * @param {boolean} sendIfDisabled - Used when handler becomes disabled. With this flag orchestrator will be forced to send cancel event
+     */
+    cancel(sendIfDisabled?: boolean): void;
+    activate(force?: boolean): void;
+    end(): void;
+    getShouldResetProgress(): boolean;
+    setShouldResetProgress(value: boolean): void;
+    shouldWaitForHandlerFailure(handler: IGestureHandler): boolean;
+    shouldRequireToWaitForFailure(handler: IGestureHandler): boolean;
+    shouldRecognizeSimultaneously(handler: IGestureHandler): boolean;
+    shouldBeCancelledByOther(handler: IGestureHandler): boolean;
+    protected onPointerDown(event: AdaptedEvent): void;
+    protected onPointerAdd(event: AdaptedEvent): void;
+    protected onPointerUp(event: AdaptedEvent): void;
+    protected onPointerRemove(event: AdaptedEvent): void;
+    protected onPointerMove(event: AdaptedEvent): void;
+    protected onPointerLeave(event: AdaptedEvent): void;
+    protected onPointerEnter(event: AdaptedEvent): void;
+    protected onPointerCancel(event: AdaptedEvent): void;
+    protected onPointerOutOfBounds(event: AdaptedEvent): void;
+    protected onPointerMoveOver(_event: AdaptedEvent): void;
+    protected onPointerMoveOut(_event: AdaptedEvent): void;
+    protected onWheel(_event: AdaptedEvent): void;
+    protected tryToSendMoveEvent(out: boolean, event: AdaptedEvent): void;
+    protected tryToSendTouchEvent(event: AdaptedEvent): void;
+    sendTouchEvent(event: AdaptedEvent): void;
+    sendEvent: (newState: State, oldState: State) => void;
+    private transformEventData;
+    private transformTouchEvent;
+    private cancelTouches;
+    protected transformNativeEvent(): Record<string, unknown>;
+    updateGestureConfig({ enabled, ...props }: Config): void;
+    protected checkCustomActivationCriteria(criterias: string[]): void;
+    private validateHitSlops;
+    private checkHitSlop;
+    isButtonInConfig(mouseButton: MouseButton | undefined): number | true | undefined;
+    protected resetConfig(): void;
+    onDestroy(): void;
+    get handlerTag(): number;
+    set handlerTag(value: number);
+    get config(): Config;
+    get delegate(): GestureHandlerDelegate<unknown, IGestureHandler>;
+    get tracker(): PointerTracker;
+    get state(): State;
+    protected set state(value: State);
+    get shouldCancelWhenOutside(): boolean;
+    protected set shouldCancelWhenOutside(value: boolean);
+    get enabled(): boolean;
+    protected set enabled(value: boolean);
+    get pointerType(): PointerType;
+    protected set pointerType(value: PointerType);
+    get active(): boolean;
+    protected set active(value: boolean);
+    get awaiting(): boolean;
+    protected set awaiting(value: boolean);
+    get activationIndex(): number;
+    protected set activationIndex(value: number);
+    get shouldResetProgress(): boolean;
+    protected set shouldResetProgress(value: boolean);
+    getTrackedPointersID(): number[];
+    private isFinished;
+}

package/lib/typescript/web/handlers/GestureHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GestureHandler.d.ts","sourceRoot":"","sources":["../../../../src/web/handlers/GestureHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EACL,MAAM,EACN,YAAY,EAOb,MAAM,eAAe,CAAC;AACvB,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAGjD,OAAO,cAAkC,MAAM,yBAAyB,CAAC;AACzE,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAEzE,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,cAAe,YAAW,eAAe;IACrE,OAAO,CAAC,aAAa,CAAsB;IAE3C,OAAO,CAAC,MAAM,CAA6B;IAE3C,OAAO,CAAC,wBAAwB,CAAS;IACzC,SAAS,CAAC,2BAA2B,UAAS;IAC9C,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,OAAO,CAA8B;IAE7C,OAAO,CAAC,QAAQ,CAAwC;IAGxD,OAAO,CAAC,gBAAgB,CAAK;IAE7B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,YAAY,CAAkC;IAEtD,OAAO,CAAC,SAAS,CAAmD;gBAGlE,QAAQ,EAAE,sBAAsB,CAAC,OAAO,EAAE,eAAe,CAAC;IAS5D,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC;IAS3D,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI;IAqB/D,SAAS,CAAC,QAAQ,IAAI,IAAI;IAC1B,SAAS,CAAC,OAAO,IAAI,IAAI;IACzB,SAAS,CAAC,aAAa,IAAI,IAAI;IAExB,KAAK,IAAI,IAAI;IAYb,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,EAAE,OAAO;IA8B5D,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI;IAE1D,KAAK,IAAI,IAAI;IAUpB;;OAEG;IACI,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI;IAY3C;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI;IAetC,QAAQ,CAAC,KAAK,UAAQ;IAUtB,GAAG;IAeH,sBAAsB,IAAI,OAAO;IAGjC,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAI5C,2BAA2B,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO;IAW9D,6BAA6B,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO;IAWhE,6BAA6B,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO;IAWhE,wBAAwB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO;IAelE,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAWlD,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAGjD,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAIhD,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAGpD,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAGlD,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAenD,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAGnD,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAMpD,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAGzD,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAGvD,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAGtD,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAG7C,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;IAYrE,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAMjD,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAoBzC,SAAS,GAAI,UAAU,KAAK,EAAE,UAAU,KAAK,KAAG,IAAI,CAsBzD;IAEF,OAAO,CAAC,kBAAkB;IAkB1B,OAAO,CAAC,mBAAmB;IAmG3B,OAAO,CAAC,aAAa;IAmDrB,SAAS,CAAC,oBAAoB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAiBlD,mBAAmB,CAAC,EAAE,OAAc,EAAE,GAAG,KAAK,EAAE,EAAE,MAAM,GAAG,IAAI;IA6BtE,SAAS,CAAC,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IAQlE,OAAO,CAAC,gBAAgB;IA8CxB,OAAO,CAAC,YAAY;IAqEb,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,SAAS;IAQ5D,SAAS,CAAC,WAAW,IAAI,IAAI;IAEtB,SAAS,IAAI,IAAI;IAQxB,IAAW,UAAU,IAGQ,MAAM,CADlC;IACD,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,QAAQ,qDAElB;IAED,IAAW,OAAO,mBAEjB;IAED,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,SAAS,KAAK,KAAK,CAAC,KAAK,EAAE,KAAK,EAE/B;IAED,IAAW,uBAAuB,YAEjC;IACD,SAAS,KAAK,uBAAuB,CAAC,KAAK,SAAA,EAE1C;IAED,IAAW,OAAO,YAEjB;IACD,SAAS,KAAK,OAAO,CAAC,KAAK,SAAA,EAE1B;IAED,IAAW,WAAW,IAAI,WAAW,CAEpC;IACD,SAAS,KAAK,WAAW,CAAC,KAAK,EAAE,WAAW,EAE3C;IAED,IAAW,MAAM,YAEhB;IACD,SAAS,KAAK,MAAM,CAAC,KAAK,SAAA,EAEzB;IAED,IAAW,QAAQ,YAElB;IACD,SAAS,KAAK,QAAQ,CAAC,KAAK,SAAA,EAE3B;IAED,IAAW,eAAe,WAEzB;IACD,SAAS,KAAK,eAAe,CAAC,KAAK,QAAA,EAElC;IAED,IAAW,mBAAmB,YAE7B;IACD,SAAS,KAAK,mBAAmB,CAAC,KAAK,SAAA,EAEtC;IAEM,oBAAoB,IAAI,MAAM,EAAE;IAIvC,OAAO,CAAC,UAAU;CAOnB"}