react-native-gesture-handler 2.27.0 → 2.27.1

package/lib/typescript/handlers/PanGestureHandler.js

@@ -0,0 +1,128 @@
+import createHandler from './createHandler';
+import { baseGestureHandlerProps, } from './gestureHandlerCommon';
+export const panGestureHandlerProps = [
+    'activeOffsetY',
+    'activeOffsetX',
+    'failOffsetY',
+    'failOffsetX',
+    'minDist',
+    'minVelocity',
+    'minVelocityX',
+    'minVelocityY',
+    'minPointers',
+    'maxPointers',
+    'avgTouches',
+    'enableTrackpadTwoFingerGesture',
+    'activateAfterLongPress',
+];
+export const panGestureHandlerCustomNativeProps = [
+    'activeOffsetYStart',
+    'activeOffsetYEnd',
+    'activeOffsetXStart',
+    'activeOffsetXEnd',
+    'failOffsetYStart',
+    'failOffsetYEnd',
+    'failOffsetXStart',
+    'failOffsetXEnd',
+];
+export const panHandlerName = 'PanGestureHandler';
+/**
+ * @deprecated PanGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Pan()` instead.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
+export const PanGestureHandler = createHandler({
+    name: panHandlerName,
+    allowedProps: [
+        ...baseGestureHandlerProps,
+        ...panGestureHandlerProps,
+    ],
+    config: {},
+    transformProps: managePanProps,
+    customNativeProps: panGestureHandlerCustomNativeProps,
+});
+function validatePanGestureHandlerProps(props) {
+    if (Array.isArray(props.activeOffsetX) &&
+        (props.activeOffsetX[0] > 0 || props.activeOffsetX[1] < 0)) {
+        throw new Error(`First element of activeOffsetX should be negative, a the second one should be positive`);
+    }
+    if (Array.isArray(props.activeOffsetY) &&
+        (props.activeOffsetY[0] > 0 || props.activeOffsetY[1] < 0)) {
+        throw new Error(`First element of activeOffsetY should be negative, a the second one should be positive`);
+    }
+    if (Array.isArray(props.failOffsetX) &&
+        (props.failOffsetX[0] > 0 || props.failOffsetX[1] < 0)) {
+        throw new Error(`First element of failOffsetX should be negative, a the second one should be positive`);
+    }
+    if (Array.isArray(props.failOffsetY) &&
+        (props.failOffsetY[0] > 0 || props.failOffsetY[1] < 0)) {
+        throw new Error(`First element of failOffsetY should be negative, a the second one should be positive`);
+    }
+    if (props.minDist && (props.failOffsetX || props.failOffsetY)) {
+        throw new Error(`It is not supported to use minDist with failOffsetX or failOffsetY, use activeOffsetX and activeOffsetY instead`);
+    }
+    if (props.minDist && (props.activeOffsetX || props.activeOffsetY)) {
+        throw new Error(`It is not supported to use minDist with activeOffsetX or activeOffsetY`);
+    }
+}
+function transformPanGestureHandlerProps(props) {
+    const res = { ...props };
+    if (props.activeOffsetX !== undefined) {
+        delete res.activeOffsetX;
+        if (Array.isArray(props.activeOffsetX)) {
+            res.activeOffsetXStart = props.activeOffsetX[0];
+            res.activeOffsetXEnd = props.activeOffsetX[1];
+        }
+        else if (props.activeOffsetX < 0) {
+            res.activeOffsetXStart = props.activeOffsetX;
+        }
+        else {
+            res.activeOffsetXEnd = props.activeOffsetX;
+        }
+    }
+    if (props.activeOffsetY !== undefined) {
+        delete res.activeOffsetY;
+        if (Array.isArray(props.activeOffsetY)) {
+            res.activeOffsetYStart = props.activeOffsetY[0];
+            res.activeOffsetYEnd = props.activeOffsetY[1];
+        }
+        else if (props.activeOffsetY < 0) {
+            res.activeOffsetYStart = props.activeOffsetY;
+        }
+        else {
+            res.activeOffsetYEnd = props.activeOffsetY;
+        }
+    }
+    if (props.failOffsetX !== undefined) {
+        delete res.failOffsetX;
+        if (Array.isArray(props.failOffsetX)) {
+            res.failOffsetXStart = props.failOffsetX[0];
+            res.failOffsetXEnd = props.failOffsetX[1];
+        }
+        else if (props.failOffsetX < 0) {
+            res.failOffsetXStart = props.failOffsetX;
+        }
+        else {
+            res.failOffsetXEnd = props.failOffsetX;
+        }
+    }
+    if (props.failOffsetY !== undefined) {
+        delete res.failOffsetY;
+        if (Array.isArray(props.failOffsetY)) {
+            res.failOffsetYStart = props.failOffsetY[0];
+            res.failOffsetYEnd = props.failOffsetY[1];
+        }
+        else if (props.failOffsetY < 0) {
+            res.failOffsetYStart = props.failOffsetY;
+        }
+        else {
+            res.failOffsetYEnd = props.failOffsetY;
+        }
+    }
+    return res;
+}
+export function managePanProps(props) {
+    if (__DEV__) {
+        validatePanGestureHandlerProps(props);
+    }
+    return transformPanGestureHandlerProps(props);
+}

package/lib/typescript/handlers/PinchGestureHandler.d.ts

@@ -0,0 +1,16 @@
+import { PinchGestureHandlerEventPayload } from './GestureHandlerEventPayload';
+import { BaseGestureHandlerProps } from './gestureHandlerCommon';
+/**
+ * @deprecated PinchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Pinch()` instead.
+ */
+export interface PinchGestureHandlerProps extends BaseGestureHandlerProps<PinchGestureHandlerEventPayload> {
+}
+export declare const pinchHandlerName = "PinchGestureHandler";
+/**
+ * @deprecated PinchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Pinch()` instead.
+ */
+export type PinchGestureHandler = typeof PinchGestureHandler;
+/**
+ * @deprecated PinchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Pinch()` instead.
+ */
+export declare const PinchGestureHandler: import("react").ComponentType<PinchGestureHandlerProps & import("react").RefAttributes<any>>;

package/lib/typescript/handlers/PinchGestureHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PinchGestureHandler.d.ts","sourceRoot":"","sources":["../../../src/handlers/PinchGestureHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAE/E,OAAO,EACL,uBAAuB,EAExB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,uBAAuB,CAAC,+BAA+B,CAAC;CAAG;AAErE,eAAO,MAAM,gBAAgB,wBAAwB,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC;AAE7D;;GAEG;AAEH,eAAO,MAAM,mBAAmB,8FAO9B,CAAC"}

package/lib/typescript/handlers/PinchGestureHandler.js

@@ -0,0 +1,12 @@
+import createHandler from './createHandler';
+import { baseGestureHandlerProps, } from './gestureHandlerCommon';
+export const pinchHandlerName = 'PinchGestureHandler';
+/**
+ * @deprecated PinchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Pinch()` instead.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
+export const PinchGestureHandler = createHandler({
+    name: pinchHandlerName,
+    allowedProps: baseGestureHandlerProps,
+    config: {},
+});

package/lib/typescript/handlers/PressabilityDebugView.d.ts

@@ -0,0 +1 @@
+export { PressabilityDebugView } from 'react-native/Libraries/Pressability/PressabilityDebug';

package/lib/typescript/handlers/PressabilityDebugView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PressabilityDebugView.d.ts","sourceRoot":"","sources":["../../../src/handlers/PressabilityDebugView.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uDAAuD,CAAC"}

package/lib/typescript/handlers/PressabilityDebugView.js

@@ -0,0 +1,2 @@
+// @ts-ignore it's not exported so we need to import it from path
+export { PressabilityDebugView } from 'react-native/Libraries/Pressability/PressabilityDebug';

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

@@ -0,0 +1 @@
+export declare function PressabilityDebugView(): null;

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

@@ -0,0 +1 @@
+{"version":3,"file":"PressabilityDebugView.web.d.ts","sourceRoot":"","sources":["../../../src/handlers/PressabilityDebugView.web.tsx"],"names":[],"mappings":"AACA,wBAAgB,qBAAqB,SAEpC"}

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

@@ -0,0 +1,4 @@
+// PressabilityDebugView is not implemented in react-native-web
+export function PressabilityDebugView() {
+    return null;
+}

package/lib/typescript/handlers/RotationGestureHandler.d.ts

@@ -0,0 +1,16 @@
+import { RotationGestureHandlerEventPayload } from './GestureHandlerEventPayload';
+import { BaseGestureHandlerProps } from './gestureHandlerCommon';
+/**
+ * @deprecated RotationGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Rotation()` instead.
+ */
+export interface RotationGestureHandlerProps extends BaseGestureHandlerProps<RotationGestureHandlerEventPayload> {
+}
+export declare const rotationHandlerName = "RotationGestureHandler";
+/**
+ * @deprecated RotationGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Rotation()` instead.
+ */
+export type RotationGestureHandler = typeof RotationGestureHandler;
+/**
+ * @deprecated RotationGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Rotation()` instead.
+ */
+export declare const RotationGestureHandler: import("react").ComponentType<RotationGestureHandlerProps & import("react").RefAttributes<any>>;

package/lib/typescript/handlers/RotationGestureHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RotationGestureHandler.d.ts","sourceRoot":"","sources":["../../../src/handlers/RotationGestureHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAElF,OAAO,EACL,uBAAuB,EAExB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,uBAAuB,CAAC,kCAAkC,CAAC;CAAG;AAExE,eAAO,MAAM,mBAAmB,2BAA2B,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC;AAEnE;;GAEG;AAEH,eAAO,MAAM,sBAAsB,iGAOjC,CAAC"}

package/lib/typescript/handlers/RotationGestureHandler.js

@@ -0,0 +1,12 @@
+import createHandler from './createHandler';
+import { baseGestureHandlerProps, } from './gestureHandlerCommon';
+export const rotationHandlerName = 'RotationGestureHandler';
+/**
+ * @deprecated RotationGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Rotation()` instead.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
+export const RotationGestureHandler = createHandler({
+    name: rotationHandlerName,
+    allowedProps: baseGestureHandlerProps,
+    config: {},
+});

package/lib/typescript/handlers/TapGestureHandler.d.ts

@@ -0,0 +1,61 @@
+import type { TapGestureHandlerEventPayload } from './GestureHandlerEventPayload';
+import { BaseGestureHandlerProps } from './gestureHandlerCommon';
+export declare const tapGestureHandlerProps: readonly ["maxDurationMs", "maxDelayMs", "numberOfTaps", "maxDeltaX", "maxDeltaY", "maxDist", "minPointers"];
+export interface TapGestureConfig {
+    /**
+     * Minimum number of pointers (fingers) required to be placed before the
+     * handler activates. Should be a positive integer.
+     * The default value is 1.
+     */
+    minPointers?: number;
+    /**
+     * Maximum time, expressed in milliseconds, that defines how fast a finger
+     * must be released after a touch. The default value is 500.
+     */
+    maxDurationMs?: number;
+    /**
+     * Maximum time, expressed in milliseconds, that can pass before the next tap
+     * if many taps are required. The default value is 500.
+     */
+    maxDelayMs?: number;
+    /**
+     * Number of tap gestures required to activate the handler. The default value
+     * is 1.
+     */
+    numberOfTaps?: number;
+    /**
+     * Maximum distance, expressed in points, that defines how far the finger is
+     * allowed to travel along the X axis during a tap gesture. If the finger
+     * travels further than the defined distance along the X axis and the handler
+     * hasn't yet activated, it will fail to recognize the gesture.
+     */
+    maxDeltaX?: number;
+    /**
+     * Maximum distance, expressed in points, that defines how far the finger is
+     * allowed to travel along the Y axis during a tap gesture. If the finger
+     * travels further than the defined distance along the Y axis and the handler
+     * hasn't yet activated, it will fail to recognize the gesture.
+     */
+    maxDeltaY?: number;
+    /**
+     * Maximum distance, expressed in points, that defines how far the finger is
+     * allowed to travel during a tap gesture. If the finger travels further than
+     * the defined distance and the handler hasn't yet
+     * activated, it will fail to recognize the gesture.
+     */
+    maxDist?: number;
+}
+/**
+ * @deprecated TapGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Tap()` instead.
+ */
+export interface TapGestureHandlerProps extends BaseGestureHandlerProps<TapGestureHandlerEventPayload>, TapGestureConfig {
+}
+export declare const tapHandlerName = "TapGestureHandler";
+/**
+ * @deprecated TapGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Tap()` instead.
+ */
+export type TapGestureHandler = typeof TapGestureHandler;
+/**
+ * @deprecated TapGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Tap()` instead.
+ */
+export declare const TapGestureHandler: import("react").ComponentType<TapGestureHandlerProps & import("react").RefAttributes<any>>;

package/lib/typescript/handlers/TapGestureHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TapGestureHandler.d.ts","sourceRoot":"","sources":["../../../src/handlers/TapGestureHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAElF,OAAO,EACL,uBAAuB,EAExB,MAAM,wBAAwB,CAAC;AAEhC,eAAO,MAAM,sBAAsB,8GAQzB,CAAC;AAEX,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBACf,SAAQ,uBAAuB,CAAC,6BAA6B,CAAC,EAC5D,gBAAgB;CAAG;AAEvB,eAAO,MAAM,cAAc,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC;AAEzD;;GAEG;AAEH,eAAO,MAAM,iBAAiB,4FAY5B,CAAC"}

package/lib/typescript/handlers/TapGestureHandler.js

@@ -0,0 +1,26 @@
+import createHandler from './createHandler';
+import { baseGestureHandlerProps, } from './gestureHandlerCommon';
+export const tapGestureHandlerProps = [
+    'maxDurationMs',
+    'maxDelayMs',
+    'numberOfTaps',
+    'maxDeltaX',
+    'maxDeltaY',
+    'maxDist',
+    'minPointers',
+];
+export const tapHandlerName = 'TapGestureHandler';
+/**
+ * @deprecated TapGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Tap()` instead.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
+export const TapGestureHandler = createHandler({
+    name: tapHandlerName,
+    allowedProps: [
+        ...baseGestureHandlerProps,
+        ...tapGestureHandlerProps,
+    ],
+    config: {
+        shouldCancelWhenOutside: true,
+    },
+});

package/lib/typescript/handlers/createHandler.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { BaseGestureHandlerProps } from './gestureHandlerCommon';
+type CreateHandlerArgs<HandlerPropsT extends Record<string, unknown>> = Readonly<{
+    name: string;
+    allowedProps: Readonly<Extract<keyof HandlerPropsT, string>[]>;
+    config: Readonly<Record<string, unknown>>;
+    transformProps?: (props: HandlerPropsT) => HandlerPropsT;
+    customNativeProps?: Readonly<string[]>;
+}>;
+export default function createHandler<T extends BaseGestureHandlerProps<U>, U extends Record<string, unknown>>({ name, allowedProps, config, transformProps, customNativeProps, }: CreateHandlerArgs<T>): React.ComponentType<T & React.RefAttributes<any>>;
+export {};

package/lib/typescript/handlers/createHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHandler.d.ts","sourceRoot":"","sources":["../../../src/handlers/createHandler.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAiB/B,OAAO,EACL,uBAAuB,EAGxB,MAAM,wBAAwB,CAAC;AAyHhC,KAAK,iBAAiB,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAClE,QAAQ,CAAC;IACP,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/D,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,aAAa,CAAC;IACzD,iBAAiB,CAAC,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;CACxC,CAAC,CAAC;AAmBL,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,EACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,EACA,IAAI,EACJ,YAAiB,EACjB,MAAW,EACX,cAAc,EACd,iBAAsB,GACvB,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CA0Y1E"}