react-native-gesture-handler 2.27.1 → 2.28.0

package/lib/typescript/handlers/gestures/gestureComposition.js

@@ -1,78 +0,0 @@
-import { BaseGesture, Gesture } from './gesture';
-function extendRelation(currentRelation, extendWith) {
-    if (currentRelation === undefined) {
-        return [...extendWith];
-    }
-    else {
-        return [...currentRelation, ...extendWith];
-    }
-}
-export class ComposedGesture extends Gesture {
-    gestures = [];
-    simultaneousGestures = [];
-    requireGesturesToFail = [];
-    constructor(...gestures) {
-        super();
-        this.gestures = gestures;
-    }
-    prepareSingleGesture(gesture, simultaneousGestures, requireGesturesToFail) {
-        if (gesture instanceof BaseGesture) {
-            const newConfig = { ...gesture.config };
-            // No need to extend `blocksHandlers` here, because it's not changed in composition.
-            // The same effect is achieved by reversing the order of 2 gestures in `Exclusive`
-            newConfig.simultaneousWith = extendRelation(newConfig.simultaneousWith, simultaneousGestures);
-            newConfig.requireToFail = extendRelation(newConfig.requireToFail, requireGesturesToFail);
-            gesture.config = newConfig;
-        }
-        else if (gesture instanceof ComposedGesture) {
-            gesture.simultaneousGestures = simultaneousGestures;
-            gesture.requireGesturesToFail = requireGesturesToFail;
-            gesture.prepare();
-        }
-    }
-    prepare() {
-        for (const gesture of this.gestures) {
-            this.prepareSingleGesture(gesture, this.simultaneousGestures, this.requireGesturesToFail);
-        }
-    }
-    initialize() {
-        for (const gesture of this.gestures) {
-            gesture.initialize();
-        }
-    }
-    toGestureArray() {
-        return this.gestures.flatMap((gesture) => gesture.toGestureArray());
-    }
-}
-export class SimultaneousGesture extends ComposedGesture {
-    prepare() {
-        // This piece of magic works something like this:
-        // for every gesture in the array
-        const simultaneousArrays = this.gestures.map((gesture) => 
-        // we take the array it's in
-        this.gestures
-            // and make a copy without it
-            .filter((x) => x !== gesture)
-            // then we flatmap the result to get list of raw (not composed) gestures
-            // this way we don't make the gestures simultaneous with themselves, which is
-            // important when the gesture is `ExclusiveGesture` - we don't want to make
-            // exclusive gestures simultaneous
-            .flatMap((x) => x.toGestureArray()));
-        for (let i = 0; i < this.gestures.length; i++) {
-            this.prepareSingleGesture(this.gestures[i], simultaneousArrays[i], this.requireGesturesToFail);
-        }
-    }
-}
-export class ExclusiveGesture extends ComposedGesture {
-    prepare() {
-        // Transforms the array of gestures into array of grouped raw (not composed) gestures
-        // i.e. [gesture1, gesture2, ComposedGesture(gesture3, gesture4)] -> [[gesture1], [gesture2], [gesture3, gesture4]]
-        const gestureArrays = this.gestures.map((gesture) => gesture.toGestureArray());
-        let requireToFail = [];
-        for (let i = 0; i < this.gestures.length; i++) {
-            this.prepareSingleGesture(this.gestures[i], this.simultaneousGestures, this.requireGesturesToFail.concat(requireToFail));
-            // Every group gets to wait for all groups before it
-            requireToFail = requireToFail.concat(gestureArrays[i]);
-        }
-    }
-}

package/lib/typescript/handlers/gestures/gestureObjects.js

@@ -1,125 +0,0 @@
-import { FlingGesture } from './flingGesture';
-import { ForceTouchGesture } from './forceTouchGesture';
-import { ComposedGesture, ExclusiveGesture, SimultaneousGesture, } from './gestureComposition';
-import { LongPressGesture } from './longPressGesture';
-import { PanGesture } from './panGesture';
-import { PinchGesture } from './pinchGesture';
-import { RotationGesture } from './rotationGesture';
-import { TapGesture } from './tapGesture';
-import { NativeGesture } from './nativeGesture';
-import { ManualGesture } from './manualGesture';
-import { HoverGesture } from './hoverGesture';
-/**
- * `Gesture` is the object that allows you to create and compose gestures.
- *
- * ### Remarks
- * - Consider wrapping your gesture configurations with `useMemo`, as it will reduce the amount of work Gesture Handler has to do under the hood when updating gestures.
- *
- * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture
- */
-export const GestureObjects = {
-    /**
-     * A discrete gesture that recognizes one or many taps.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/tap-gesture
-     */
-    Tap: () => {
-        return new TapGesture();
-    },
-    /**
-     * A continuous gesture that can recognize a panning (dragging) gesture and track its movement.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture
-     */
-    Pan: () => {
-        return new PanGesture();
-    },
-    /**
-     * A continuous gesture that recognizes pinch gesture. It allows for tracking the distance between two fingers and use that information to scale or zoom your content.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pinch-gesture
-     */
-    Pinch: () => {
-        return new PinchGesture();
-    },
-    /**
-     * A continuous gesture that can recognize rotation and track its movement.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/rotation-gesture
-     */
-    Rotation: () => {
-        return new RotationGesture();
-    },
-    /**
-     * A discrete gesture that activates when the movement is sufficiently fast.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture
-     */
-    Fling: () => {
-        return new FlingGesture();
-    },
-    /**
-     * A discrete gesture that activates when the corresponding view is pressed for a sufficiently long time.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/long-press-gesture
-     */
-    LongPress: () => {
-        return new LongPressGesture();
-    },
-    /**
-     * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
-     *
-     *  #### iOS only
-     * A continuous gesture that recognizes force of a touch. It allows for tracking pressure of touch on some iOS devices.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/force-touch-gesture
-     */
-    ForceTouch: () => {
-        return new ForceTouchGesture();
-    },
-    /**
-     * A gesture that allows other touch handling components to participate in RNGH's gesture system.
-     * When used, the other component should be the direct child of a `GestureDetector`.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/native-gesture
-     */
-    Native: () => {
-        return new NativeGesture();
-    },
-    /**
-     * A plain gesture that has no specific activation criteria nor event data set.
-     * Its state has to be controlled manually using a state manager.
-     * It will not fail when all the pointers are lifted from the screen.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/manual-gesture
-     */
-    Manual: () => {
-        return new ManualGesture();
-    },
-    /**
-     * A continuous gesture that can recognize hovering above the view it's attached to.
-     * The hover effect may be activated by moving a mouse or a stylus over the view.
-     *
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/hover-gesture
-     */
-    Hover: () => {
-        return new HoverGesture();
-    },
-    /**
-     * Builds a composed gesture consisting of gestures provided as parameters.
-     * The first one that becomes active cancels the rest of gestures.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#race
-     */
-    Race: (...gestures) => {
-        return new ComposedGesture(...gestures);
-    },
-    /**
-     * Builds a composed gesture that allows all base gestures to run simultaneously.
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneous
-     */
-    Simultaneous(...gestures) {
-        return new SimultaneousGesture(...gestures);
-    },
-    /**
-     * Builds a composed gesture where only one of the provided gestures can become active.
-     * Priority is decided through the order of gestures: the first one has higher priority
-     * than the second one, second one has higher priority than the third one, and so on.
-     * For example, to make a gesture that recognizes both single and double tap you need
-     * to call Exclusive(doubleTap, singleTap).
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#exclusive
-     */
-    Exclusive(...gestures) {
-        return new ExclusiveGesture(...gestures);
-    },
-};

package/lib/typescript/handlers/gestures/gestureStateManager.js

@@ -1,60 +0,0 @@
-import { Reanimated } from './reanimatedWrapper';
-import { State } from '../../State';
-import { tagMessage } from '../../utils';
-const warningMessage = tagMessage('react-native-reanimated is required in order to use synchronous state management');
-// Check if reanimated module is available, but look for useSharedValue as conditional
-// require of reanimated can sometimes return content of `utils.ts` file (?)
-const REANIMATED_AVAILABLE = Reanimated?.useSharedValue !== undefined;
-const setGestureState = Reanimated?.setGestureState;
-function create(handlerTag) {
-    'worklet';
-    return {
-        begin: () => {
-            'worklet';
-            if (REANIMATED_AVAILABLE) {
-                // When Reanimated is available, setGestureState should be defined
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                setGestureState(handlerTag, State.BEGAN);
-            }
-            else {
-                console.warn(warningMessage);
-            }
-        },
-        activate: () => {
-            'worklet';
-            if (REANIMATED_AVAILABLE) {
-                // When Reanimated is available, setGestureState should be defined
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                setGestureState(handlerTag, State.ACTIVE);
-            }
-            else {
-                console.warn(warningMessage);
-            }
-        },
-        fail: () => {
-            'worklet';
-            if (REANIMATED_AVAILABLE) {
-                // When Reanimated is available, setGestureState should be defined
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                setGestureState(handlerTag, State.FAILED);
-            }
-            else {
-                console.warn(warningMessage);
-            }
-        },
-        end: () => {
-            'worklet';
-            if (REANIMATED_AVAILABLE) {
-                // When Reanimated is available, setGestureState should be defined
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                setGestureState(handlerTag, State.END);
-            }
-            else {
-                console.warn(warningMessage);
-            }
-        },
-    };
-}
-export const GestureStateManager = {
-    create,
-};

package/lib/typescript/handlers/gestures/gestureStateManager.web.js

@@ -1,19 +0,0 @@
-import NodeManager from '../../web/tools/NodeManager';
-export const GestureStateManager = {
-    create(handlerTag) {
-        return {
-            begin: () => {
-                NodeManager.getHandler(handlerTag).begin();
-            },
-            activate: () => {
-                NodeManager.getHandler(handlerTag).activate(true);
-            },
-            fail: () => {
-                NodeManager.getHandler(handlerTag).fail();
-            },
-            end: () => {
-                NodeManager.getHandler(handlerTag).end();
-            },
-        };
-    },
-};

package/lib/typescript/handlers/gestures/hoverGesture.js

@@ -1,45 +0,0 @@
-import { ContinousBaseGesture } from './gesture';
-export var HoverEffect;
-(function (HoverEffect) {
-    HoverEffect[HoverEffect["NONE"] = 0] = "NONE";
-    HoverEffect[HoverEffect["LIFT"] = 1] = "LIFT";
-    HoverEffect[HoverEffect["HIGHLIGHT"] = 2] = "HIGHLIGHT";
-})(HoverEffect || (HoverEffect = {}));
-export const hoverGestureHandlerProps = ['hoverEffect'];
-function changeEventCalculator(current, previous) {
-    'worklet';
-    let changePayload;
-    if (previous === undefined) {
-        changePayload = {
-            changeX: current.x,
-            changeY: current.y,
-        };
-    }
-    else {
-        changePayload = {
-            changeX: current.x - previous.x,
-            changeY: current.y - previous.y,
-        };
-    }
-    return { ...current, ...changePayload };
-}
-export class HoverGesture extends ContinousBaseGesture {
-    config = {};
-    constructor() {
-        super();
-        this.handlerName = 'HoverGestureHandler';
-    }
-    /**
-     * #### iOS only
-     * Sets the visual hover effect.
-     */
-    effect(effect) {
-        this.config.hoverEffect = effect;
-        return this;
-    }
-    onChange(callback) {
-        // @ts-ignore TS being overprotective, HoverGestureHandlerEventPayload is Record
-        this.handlers.changeEventCalculator = changeEventCalculator;
-        return super.onChange(callback);
-    }
-}

package/lib/typescript/handlers/gestures/longPressGesture.js

@@ -1,35 +0,0 @@
-import { BaseGesture } from './gesture';
-export class LongPressGesture extends BaseGesture {
-    config = {};
-    constructor() {
-        super();
-        this.handlerName = 'LongPressGestureHandler';
-        this.shouldCancelWhenOutside(true);
-    }
-    /**
-     * Minimum time, expressed in milliseconds, that a finger must remain pressed on the corresponding view.
-     * The default value is 500.
-     * @param duration
-     */
-    minDuration(duration) {
-        this.config.minDurationMs = duration;
-        return this;
-    }
-    /**
-     * Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a long press gesture.
-     * @param distance
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/long-press-gesture#maxdistancevalue-number
-     */
-    maxDistance(distance) {
-        this.config.maxDist = distance;
-        return this;
-    }
-    /**
-     * Determine exact number of points required to handle the long press gesture.
-     * @param pointers
-     */
-    numberOfPointers(pointers) {
-        this.config.numberOfPointers = pointers;
-        return this;
-    }
-}

package/lib/typescript/handlers/gestures/manualGesture.js

@@ -1,16 +0,0 @@
-import { ContinousBaseGesture } from './gesture';
-function changeEventCalculator(current, _previous) {
-    'worklet';
-    return current;
-}
-export class ManualGesture extends ContinousBaseGesture {
-    constructor() {
-        super();
-        this.handlerName = 'ManualGestureHandler';
-    }
-    onChange(callback) {
-        // @ts-ignore TS being overprotective, Record<string, never> is Record
-        this.handlers.changeEventCalculator = changeEventCalculator;
-        return super.onChange(callback);
-    }
-}

package/lib/typescript/handlers/gestures/nativeGesture.js

@@ -1,24 +0,0 @@
-import { BaseGesture } from './gesture';
-export class NativeGesture extends BaseGesture {
-    config = {};
-    constructor() {
-        super();
-        this.handlerName = 'NativeViewGestureHandler';
-    }
-    /**
-     * When true, underlying handler will activate unconditionally when in `BEGAN` or `UNDETERMINED` state.
-     * @param value
-     */
-    shouldActivateOnStart(value) {
-        this.config.shouldActivateOnStart = value;
-        return this;
-    }
-    /**
-     * When true, cancels all other gesture handlers when this `NativeViewGestureHandler` receives an `ACTIVE` state event.
-     * @param value
-     */
-    disallowInterruption(value) {
-        this.config.disallowInterruption = value;
-        return this;
-    }
-}

package/lib/typescript/handlers/gestures/panGesture.js

@@ -1,181 +0,0 @@
-import { ContinousBaseGesture } from './gesture';
-function changeEventCalculator(current, previous) {
-    'worklet';
-    let changePayload;
-    if (previous === undefined) {
-        changePayload = {
-            changeX: current.translationX,
-            changeY: current.translationY,
-        };
-    }
-    else {
-        changePayload = {
-            changeX: current.translationX - previous.translationX,
-            changeY: current.translationY - previous.translationY,
-        };
-    }
-    return { ...current, ...changePayload };
-}
-export class PanGesture extends ContinousBaseGesture {
-    config = {};
-    constructor() {
-        super();
-        this.handlerName = 'PanGestureHandler';
-    }
-    /**
-     * Range along Y axis (in points) where fingers travels without activation of gesture.
-     * @param offset
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#activeoffsetyvalue-number--number
-     */
-    activeOffsetY(offset) {
-        if (Array.isArray(offset)) {
-            this.config.activeOffsetYStart = offset[0];
-            this.config.activeOffsetYEnd = offset[1];
-        }
-        else if (offset < 0) {
-            this.config.activeOffsetYStart = offset;
-        }
-        else {
-            this.config.activeOffsetYEnd = offset;
-        }
-        return this;
-    }
-    /**
-     * Range along X axis (in points) where fingers travels without activation of gesture.
-     * @param offset
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#activeoffsetxvalue-number--number
-     */
-    activeOffsetX(offset) {
-        if (Array.isArray(offset)) {
-            this.config.activeOffsetXStart = offset[0];
-            this.config.activeOffsetXEnd = offset[1];
-        }
-        else if (offset < 0) {
-            this.config.activeOffsetXStart = offset;
-        }
-        else {
-            this.config.activeOffsetXEnd = offset;
-        }
-        return this;
-    }
-    /**
-     * When the finger moves outside this range (in points) along Y axis and gesture hasn't yet activated it will fail recognizing the gesture.
-     * @param offset
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#failoffsetyvalue-number--number
-     */
-    failOffsetY(offset) {
-        if (Array.isArray(offset)) {
-            this.config.failOffsetYStart = offset[0];
-            this.config.failOffsetYEnd = offset[1];
-        }
-        else if (offset < 0) {
-            this.config.failOffsetYStart = offset;
-        }
-        else {
-            this.config.failOffsetYEnd = offset;
-        }
-        return this;
-    }
-    /**
-     * When the finger moves outside this range (in points) along X axis and gesture hasn't yet activated it will fail recognizing the gesture.
-     * @param offset
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#failoffsetxvalue-number--number
-     */
-    failOffsetX(offset) {
-        if (Array.isArray(offset)) {
-            this.config.failOffsetXStart = offset[0];
-            this.config.failOffsetXEnd = offset[1];
-        }
-        else if (offset < 0) {
-            this.config.failOffsetXStart = offset;
-        }
-        else {
-            this.config.failOffsetXEnd = offset;
-        }
-        return this;
-    }
-    /**
-     * A number of fingers that is required to be placed before gesture can activate. Should be a higher or equal to 0 integer.
-     * @param minPointers
-     */
-    minPointers(minPointers) {
-        this.config.minPointers = minPointers;
-        return this;
-    }
-    /**
-     * When the given number of fingers is placed on the screen and gesture hasn't yet activated it will fail recognizing the gesture.
-     * Should be a higher or equal to 0 integer.
-     * @param maxPointers
-     */
-    maxPointers(maxPointers) {
-        this.config.maxPointers = maxPointers;
-        return this;
-    }
-    /**
-     * Minimum distance the finger (or multiple finger) need to travel before the gesture activates.
-     * Expressed in points.
-     * @param distance
-     */
-    minDistance(distance) {
-        this.config.minDist = distance;
-        return this;
-    }
-    /**
-     * Minimum velocity the finger has to reach in order to activate handler.
-     * @param velocity
-     */
-    minVelocity(velocity) {
-        this.config.minVelocity = velocity;
-        return this;
-    }
-    /**
-     * Minimum velocity along X axis the finger has to reach in order to activate handler.
-     * @param velocity
-     */
-    minVelocityX(velocity) {
-        this.config.minVelocityX = velocity;
-        return this;
-    }
-    /**
-     * Minimum velocity along Y axis the finger has to reach in order to activate handler.
-     * @param velocity
-     */
-    minVelocityY(velocity) {
-        this.config.minVelocityY = velocity;
-        return this;
-    }
-    /**
-     * #### Android only
-     * Android, by default, will calculate translation values based on the position of the leading pointer (the first one that was placed on the screen).
-     * This modifier allows that behavior to be changed to the one that is default on iOS - the averaged position of all active pointers will be used to calculate the translation values.
-     * @param value
-     */
-    averageTouches(value) {
-        this.config.avgTouches = value;
-        return this;
-    }
-    /**
-     * #### iOS only
-     * Enables two-finger gestures on supported devices, for example iPads with trackpads.
-     * @param value
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture/#enabletrackpadtwofingergesturevalue-boolean-ios-only
-     */
-    enableTrackpadTwoFingerGesture(value) {
-        this.config.enableTrackpadTwoFingerGesture = value;
-        return this;
-    }
-    /**
-     * Duration in milliseconds of the LongPress gesture before Pan is allowed to activate.
-     * @param duration
-     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture/#activateafterlongpressduration-number
-     */
-    activateAfterLongPress(duration) {
-        this.config.activateAfterLongPress = duration;
-        return this;
-    }
-    onChange(callback) {
-        // @ts-ignore TS being overprotective, PanGestureHandlerEventPayload is Record
-        this.handlers.changeEventCalculator = changeEventCalculator;
-        return super.onChange(callback);
-    }
-}

package/lib/typescript/handlers/gestures/pinchGesture.js

@@ -1,27 +0,0 @@
-import { ContinousBaseGesture } from './gesture';
-function changeEventCalculator(current, previous) {
-    'worklet';
-    let changePayload;
-    if (previous === undefined) {
-        changePayload = {
-            scaleChange: current.scale,
-        };
-    }
-    else {
-        changePayload = {
-            scaleChange: current.scale / previous.scale,
-        };
-    }
-    return { ...current, ...changePayload };
-}
-export class PinchGesture extends ContinousBaseGesture {
-    constructor() {
-        super();
-        this.handlerName = 'PinchGestureHandler';
-    }
-    onChange(callback) {
-        // @ts-ignore TS being overprotective, PinchGestureHandlerEventPayload is Record
-        this.handlers.changeEventCalculator = changeEventCalculator;
-        return super.onChange(callback);
-    }
-}

package/lib/typescript/handlers/gestures/reanimatedWrapper.js

@@ -1,23 +0,0 @@
-import { tagMessage } from '../../utils';
-let Reanimated;
-try {
-    Reanimated = require('react-native-reanimated');
-}
-catch (e) {
-    // When 'react-native-reanimated' is not available we want to quietly continue
-    // @ts-ignore TS demands the variable to be initialized
-    Reanimated = undefined;
-}
-if (!Reanimated?.useSharedValue) {
-    // @ts-ignore Make sure the loaded module is actually Reanimated, if it's not
-    // reset the module to undefined so we can fallback to the default implementation
-    Reanimated = undefined;
-}
-if (Reanimated !== undefined && !Reanimated.setGestureState) {
-    // The loaded module is Reanimated but it doesn't have the setGestureState defined
-    Reanimated.setGestureState = () => {
-        'worklet';
-        console.warn(tagMessage('Please use newer version of react-native-reanimated in order to control state of the gestures.'));
-    };
-}
-export { Reanimated };

package/lib/typescript/handlers/gestures/rotationGesture.js

@@ -1,27 +0,0 @@
-import { ContinousBaseGesture } from './gesture';
-function changeEventCalculator(current, previous) {
-    'worklet';
-    let changePayload;
-    if (previous === undefined) {
-        changePayload = {
-            rotationChange: current.rotation,
-        };
-    }
-    else {
-        changePayload = {
-            rotationChange: current.rotation - previous.rotation,
-        };
-    }
-    return { ...current, ...changePayload };
-}
-export class RotationGesture extends ContinousBaseGesture {
-    constructor() {
-        super();
-        this.handlerName = 'RotationGestureHandler';
-    }
-    onChange(callback) {
-        // @ts-ignore TS being overprotective, RotationGestureHandlerEventPayload is Record
-        this.handlers.changeEventCalculator = changeEventCalculator;
-        return super.onChange(callback);
-    }
-}