react-native-gesture-handler 2.26.0 → 2.27.1

package/lib/typescript/handlers/gestures/GestureDetector/utils.js

@@ -0,0 +1,140 @@
+import { Platform } from 'react-native';
+import { isTestEnv, tagMessage } from '../../../utils';
+import { BaseGesture } from '../gesture';
+import { flingGestureHandlerProps } from '../../FlingGestureHandler';
+import { forceTouchGestureHandlerProps } from '../../ForceTouchGestureHandler';
+import { longPressGestureHandlerProps } from '../../LongPressGestureHandler';
+import { panGestureHandlerProps, panGestureHandlerCustomNativeProps, } from '../../PanGestureHandler';
+import { tapGestureHandlerProps } from '../../TapGestureHandler';
+import { hoverGestureHandlerProps } from '../hoverGesture';
+import { nativeViewGestureHandlerProps } from '../../NativeViewGestureHandler';
+import { baseGestureHandlerWithDetectorProps, } from '../../gestureHandlerCommon';
+import { isNewWebImplementationEnabled } from '../../../EnableNewWebImplementation';
+import { RNRenderer } from '../../../RNRenderer';
+import { useCallback, useRef, useState } from 'react';
+import { Reanimated } from '../reanimatedWrapper';
+import { onGestureHandlerEvent } from '../eventReceiver';
+export const ALLOWED_PROPS = [
+    ...baseGestureHandlerWithDetectorProps,
+    ...tapGestureHandlerProps,
+    ...panGestureHandlerProps,
+    ...panGestureHandlerCustomNativeProps,
+    ...longPressGestureHandlerProps,
+    ...forceTouchGestureHandlerProps,
+    ...flingGestureHandlerProps,
+    ...hoverGestureHandlerProps,
+    ...nativeViewGestureHandlerProps,
+];
+function convertToHandlerTag(ref) {
+    if (typeof ref === 'number') {
+        return ref;
+    }
+    else if (ref instanceof BaseGesture) {
+        return ref.handlerTag;
+    }
+    else {
+        // @ts-ignore in this case it should be a ref either to gesture object or
+        // a gesture handler component, in both cases handlerTag property exists
+        return ref.current?.handlerTag ?? -1;
+    }
+}
+function extractValidHandlerTags(interactionGroup) {
+    return (interactionGroup?.map(convertToHandlerTag)?.filter((tag) => tag > 0) ?? []);
+}
+export function extractGestureRelations(gesture) {
+    const requireToFail = extractValidHandlerTags(gesture.config.requireToFail);
+    const simultaneousWith = extractValidHandlerTags(gesture.config.simultaneousWith);
+    const blocksHandlers = extractValidHandlerTags(gesture.config.blocksHandlers);
+    return {
+        waitFor: requireToFail,
+        simultaneousHandlers: simultaneousWith,
+        blocksHandlers: blocksHandlers,
+    };
+}
+export function checkGestureCallbacksForWorklets(gesture) {
+    if (!__DEV__) {
+        return;
+    }
+    // If a gesture is explicitly marked to run on the JS thread there is no need to check
+    // if callbacks are worklets as the user is aware they will be ran on the JS thread
+    if (gesture.config.runOnJS) {
+        return;
+    }
+    const areSomeNotWorklets = gesture.handlers.isWorklet.includes(false);
+    const areSomeWorklets = gesture.handlers.isWorklet.includes(true);
+    // If some of the callbacks are worklets and some are not, and the gesture is not
+    // explicitly marked with `.runOnJS(true)` show an error
+    if (areSomeNotWorklets && areSomeWorklets) {
+        console.error(tagMessage(`Some of the callbacks in the gesture are worklets and some are not. Either make sure that all calbacks are marked as 'worklet' if you wish to run them on the UI thread or use '.runOnJS(true)' modifier on the gesture explicitly to run all callbacks on the JS thread.`));
+    }
+    if (Reanimated === undefined) {
+        // If Reanimated is not available, we can't run worklets, so we shouldn't show the warning
+        return;
+    }
+    const areAllNotWorklets = !areSomeWorklets && areSomeNotWorklets;
+    // If none of the callbacks are worklets and the gesture is not explicitly marked with
+    // `.runOnJS(true)` show a warning
+    if (areAllNotWorklets && !isTestEnv()) {
+        console.warn(tagMessage(`None of the callbacks in the gesture are worklets. If you wish to run them on the JS thread use '.runOnJS(true)' modifier on the gesture to make this explicit. Otherwise, mark the callbacks as 'worklet' to run them on the UI thread.`));
+    }
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function validateDetectorChildren(ref) {
+    // Finds the first native view under the Wrap component and traverses the fiber tree upwards
+    // to check whether there is more than one native view as a pseudo-direct child of GestureDetector
+    // i.e. this is not ok:
+    //            Wrap
+    //             |
+    //            / \
+    //           /   \
+    //          /     \
+    //         /       \
+    //   NativeView  NativeView
+    //
+    // but this is fine:
+    //            Wrap
+    //             |
+    //         NativeView
+    //             |
+    //            / \
+    //           /   \
+    //          /     \
+    //         /       \
+    //   NativeView  NativeView
+    if (__DEV__ && Platform.OS !== 'web') {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const wrapType = 
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        ref._reactInternals.elementType;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        let instance = RNRenderer.findHostInstance_DEPRECATED(ref)._internalFiberInstanceHandleDEV;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        while (instance && instance.elementType !== wrapType) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            if (instance.sibling) {
+                throw new Error('GestureDetector has more than one native view as its children. This can happen if you are using a custom component that renders multiple views, like React.Fragment. You should wrap content of GestureDetector with a <View> or <Animated.View>.');
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+            instance = instance.return;
+        }
+    }
+}
+export function useForceRender() {
+    const [renderState, setRenderState] = useState(false);
+    const forceRender = useCallback(() => {
+        setRenderState(!renderState);
+    }, [renderState, setRenderState]);
+    return forceRender;
+}
+export function useWebEventHandlers() {
+    return useRef({
+        onGestureHandlerEvent: (e) => {
+            onGestureHandlerEvent(e.nativeEvent);
+        },
+        onGestureHandlerStateChange: isNewWebImplementationEnabled()
+            ? (e) => {
+                onGestureHandlerEvent(e.nativeEvent);
+            }
+            : undefined,
+    });
+}

package/lib/typescript/handlers/gestures/eventReceiver.d.ts

@@ -2,4 +2,3 @@ import { GestureTouchEvent, GestureUpdateEvent, GestureStateChangeEvent } from '
 export declare function onGestureHandlerEvent(event: GestureUpdateEvent | GestureStateChangeEvent | GestureTouchEvent): void;
 export declare function startListening(): void;
 export declare function stopListening(): void;
-//# sourceMappingURL=eventReceiver.d.ts.map

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

@@ -0,0 +1,105 @@
+import { DeviceEventEmitter } from 'react-native';
+import { State } from '../../State';
+import { TouchEventType } from '../../TouchEventType';
+import { findHandler, findOldGestureHandler } from '../handlersRegistry';
+import { GestureStateManager, } from './gestureStateManager';
+let gestureHandlerEventSubscription = null;
+let gestureHandlerStateChangeEventSubscription = null;
+const gestureStateManagers = new Map();
+const lastUpdateEvent = [];
+function isStateChangeEvent(event) {
+    // @ts-ignore oldState doesn't exist on GestureTouchEvent and that's the point
+    return event.oldState != null;
+}
+function isTouchEvent(event) {
+    return event.eventType != null;
+}
+export function onGestureHandlerEvent(event) {
+    const handler = findHandler(event.handlerTag);
+    if (handler) {
+        if (isStateChangeEvent(event)) {
+            if (event.oldState === State.UNDETERMINED &&
+                event.state === State.BEGAN) {
+                handler.handlers.onBegin?.(event);
+            }
+            else if ((event.oldState === State.BEGAN ||
+                event.oldState === State.UNDETERMINED) &&
+                event.state === State.ACTIVE) {
+                handler.handlers.onStart?.(event);
+                lastUpdateEvent[handler.handlers.handlerTag] = event;
+            }
+            else if (event.oldState !== event.state && event.state === State.END) {
+                if (event.oldState === State.ACTIVE) {
+                    handler.handlers.onEnd?.(event, true);
+                }
+                handler.handlers.onFinalize?.(event, true);
+                lastUpdateEvent[handler.handlers.handlerTag] = undefined;
+            }
+            else if ((event.state === State.FAILED || event.state === State.CANCELLED) &&
+                event.oldState !== event.state) {
+                if (event.oldState === State.ACTIVE) {
+                    handler.handlers.onEnd?.(event, false);
+                }
+                handler.handlers.onFinalize?.(event, false);
+                gestureStateManagers.delete(event.handlerTag);
+                lastUpdateEvent[handler.handlers.handlerTag] = undefined;
+            }
+        }
+        else if (isTouchEvent(event)) {
+            if (!gestureStateManagers.has(event.handlerTag)) {
+                gestureStateManagers.set(event.handlerTag, GestureStateManager.create(event.handlerTag));
+            }
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const manager = gestureStateManagers.get(event.handlerTag);
+            switch (event.eventType) {
+                case TouchEventType.TOUCHES_DOWN:
+                    handler.handlers?.onTouchesDown?.(event, manager);
+                    break;
+                case TouchEventType.TOUCHES_MOVE:
+                    handler.handlers?.onTouchesMove?.(event, manager);
+                    break;
+                case TouchEventType.TOUCHES_UP:
+                    handler.handlers?.onTouchesUp?.(event, manager);
+                    break;
+                case TouchEventType.TOUCHES_CANCELLED:
+                    handler.handlers?.onTouchesCancelled?.(event, manager);
+                    break;
+            }
+        }
+        else {
+            handler.handlers.onUpdate?.(event);
+            if (handler.handlers.onChange && handler.handlers.changeEventCalculator) {
+                handler.handlers.onChange?.(handler.handlers.changeEventCalculator?.(event, lastUpdateEvent[handler.handlers.handlerTag]));
+                lastUpdateEvent[handler.handlers.handlerTag] = event;
+            }
+        }
+    }
+    else {
+        const oldHandler = findOldGestureHandler(event.handlerTag);
+        if (oldHandler) {
+            const nativeEvent = { nativeEvent: event };
+            if (isStateChangeEvent(event)) {
+                oldHandler.onGestureStateChange(nativeEvent);
+            }
+            else {
+                oldHandler.onGestureEvent(nativeEvent);
+            }
+            return;
+        }
+    }
+}
+export function startListening() {
+    stopListening();
+    gestureHandlerEventSubscription = DeviceEventEmitter.addListener('onGestureHandlerEvent', onGestureHandlerEvent);
+    gestureHandlerStateChangeEventSubscription = DeviceEventEmitter.addListener('onGestureHandlerStateChange', onGestureHandlerEvent);
+}
+export function stopListening() {
+    if (gestureHandlerEventSubscription) {
+        gestureHandlerEventSubscription.remove();
+        gestureHandlerEventSubscription = null;
+    }
+    if (gestureHandlerStateChangeEventSubscription) {
+        gestureHandlerStateChangeEventSubscription.remove();
+        gestureHandlerStateChangeEventSubscription = null;
+    }
+}

package/lib/typescript/handlers/gestures/flingGesture.d.ts

@@ -19,4 +19,3 @@ export declare class FlingGesture extends BaseGesture<FlingGestureHandlerEventPa
     direction(direction: number): this;
 }
 export type FlingGestureType = InstanceType<typeof FlingGesture>;
-//# sourceMappingURL=flingGesture.d.ts.map

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

@@ -0,0 +1,27 @@
+import { BaseGesture } from './gesture';
+export class FlingGesture extends BaseGesture {
+    config = {};
+    constructor() {
+        super();
+        this.handlerName = 'FlingGestureHandler';
+    }
+    /**
+     * Determine exact number of points required to handle the fling gesture.
+     * @param pointers
+     */
+    numberOfPointers(pointers) {
+        this.config.numberOfPointers = pointers;
+        return this;
+    }
+    /**
+     * Expressed allowed direction of movement.
+     * Expected values are exported as constants in the Directions object.
+     * Arguments can be combined using `|` operator. Default value is set to `MouseButton.LEFT`.
+     * @param direction
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture/#directionvalue-directions
+     */
+    direction(direction) {
+        this.config.direction = direction;
+        return this;
+    }
+}

package/lib/typescript/handlers/gestures/forceTouchGesture.d.ts

@@ -2,9 +2,15 @@ import { BaseGestureConfig, ContinousBaseGesture } from './gesture';
 import { ForceTouchGestureConfig } from '../ForceTouchGestureHandler';
 import type { ForceTouchGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
 import { GestureUpdateEvent } from '../gestureHandlerCommon';
+/**
+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ */
 export type ForceTouchGestureChangeEventPayload = {
     forceChange: number;
 };
+/**
+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ */
 export declare class ForceTouchGesture extends ContinousBaseGesture<ForceTouchGestureHandlerEventPayload, ForceTouchGestureChangeEventPayload> {
     config: BaseGestureConfig & ForceTouchGestureConfig;
     constructor();
@@ -27,5 +33,7 @@ export declare class ForceTouchGesture extends ContinousBaseGesture<ForceTouchGe
     feedbackOnActivation(value: boolean): this;
     onChange(callback: (event: GestureUpdateEvent<GestureUpdateEvent<ForceTouchGestureHandlerEventPayload & ForceTouchGestureChangeEventPayload>>) => void): this;
 }
+/**
+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ */
 export type ForceTouchGestureType = InstanceType<typeof ForceTouchGesture>;
-//# sourceMappingURL=forceTouchGesture.d.ts.map

package/lib/typescript/handlers/gestures/forceTouchGesture.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forceTouchGesture.d.ts","sourceRoot":"","sources":["../../../../src/handlers/gestures/forceTouchGesture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,+BAA+B,CAAC;AAC1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,MAAM,MAAM,mCAAmC,GAAG;IAChD,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAqBF,qBAAa,iBAAkB,SAAQ,oBAAoB,CACzD,oCAAoC,EACpC,mCAAmC,CACpC;IACQ,MAAM,EAAE,iBAAiB,GAAG,uBAAuB,CAAM;;IAQhE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKtB;;;OAGG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAKnC,QAAQ,CACN,QAAQ,EAAE,CACR,KAAK,EAAE,kBAAkB,CACvB,kBAAkB,CAChB,oCAAoC,GAClC,mCAAmC,CACtC,CACF,KACE,IAAI;CAMZ;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,iBAAiB,CAAC,CAAC"}
+{"version":3,"file":"forceTouchGesture.d.ts","sourceRoot":"","sources":["../../../../src/handlers/gestures/forceTouchGesture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,+BAA+B,CAAC;AAC1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAqBF;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,oBAAoB,CACzD,oCAAoC,EACpC,mCAAmC,CACpC;IACQ,MAAM,EAAE,iBAAiB,GAAG,uBAAuB,CAAM;;IAQhE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKtB;;;OAGG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAKnC,QAAQ,CACN,QAAQ,EAAE,CACR,KAAK,EAAE,kBAAkB,CACvB,kBAAkB,CAChB,oCAAoC,GAClC,mCAAmC,CACtC,CACF,KACE,IAAI;CAMZ;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

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

@@ -0,0 +1,57 @@
+import { ContinousBaseGesture } from './gesture';
+function changeEventCalculator(current, previous) {
+    'worklet';
+    let changePayload;
+    if (previous === undefined) {
+        changePayload = {
+            forceChange: current.force,
+        };
+    }
+    else {
+        changePayload = {
+            forceChange: current.force - previous.force,
+        };
+    }
+    return { ...current, ...changePayload };
+}
+/**
+ * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ */
+export class ForceTouchGesture extends ContinousBaseGesture {
+    config = {};
+    constructor() {
+        super();
+        this.handlerName = 'ForceTouchGestureHandler';
+    }
+    /**
+     * A minimal pressure that is required before gesture can activate.
+     * Should be a value from range [0.0, 1.0]. Default is 0.2.
+     * @param force
+     */
+    minForce(force) {
+        this.config.minForce = force;
+        return this;
+    }
+    /**
+     * A maximal pressure that could be applied for gesture.
+     * If the pressure is greater, gesture fails. Should be a value from range [0.0, 1.0].
+     * @param force
+     */
+    maxForce(force) {
+        this.config.maxForce = force;
+        return this;
+    }
+    /**
+     * Value defining if haptic feedback has to be performed on activation.
+     * @param value
+     */
+    feedbackOnActivation(value) {
+        this.config.feedbackOnActivation = value;
+        return this;
+    }
+    onChange(callback) {
+        // @ts-ignore TS being overprotective, ForceTouchGestureHandlerEventPayload is Record
+        this.handlers.changeEventCalculator = changeEventCalculator;
+        return super.onChange(callback);
+    }
+}

package/lib/typescript/handlers/gestures/gesture.d.ts

@@ -215,4 +215,3 @@ export declare abstract class ContinousBaseGesture<EventPayloadT extends Record<
     manualActivation(manualActivation: boolean): this;
 }
 export {};
-//# sourceMappingURL=gesture.d.ts.map