react-native-gesture-handler 2.27.0 → 2.27.1

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

@@ -0,0 +1,217 @@
+import { HitSlop, CommonGestureConfig, GestureTouchEvent, GestureStateChangeEvent, GestureUpdateEvent, ActiveCursor, MouseButton } from '../gestureHandlerCommon';
+import { GestureStateManagerType } from './gestureStateManager';
+import type { FlingGestureHandlerEventPayload, ForceTouchGestureHandlerEventPayload, LongPressGestureHandlerEventPayload, PanGestureHandlerEventPayload, PinchGestureHandlerEventPayload, RotationGestureHandlerEventPayload, TapGestureHandlerEventPayload, NativeViewGestureHandlerPayload, HoverGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
+export type GestureType = BaseGesture<Record<string, unknown>> | BaseGesture<Record<string, never>> | BaseGesture<TapGestureHandlerEventPayload> | BaseGesture<PanGestureHandlerEventPayload> | BaseGesture<LongPressGestureHandlerEventPayload> | BaseGesture<RotationGestureHandlerEventPayload> | BaseGesture<PinchGestureHandlerEventPayload> | BaseGesture<FlingGestureHandlerEventPayload> | BaseGesture<ForceTouchGestureHandlerEventPayload> | BaseGesture<NativeViewGestureHandlerPayload> | BaseGesture<HoverGestureHandlerEventPayload>;
+export type GestureRef = number | GestureType | React.RefObject<GestureType | undefined> | React.RefObject<React.ComponentType | undefined>;
+export interface BaseGestureConfig extends CommonGestureConfig, Record<string, unknown> {
+    ref?: React.MutableRefObject<GestureType | undefined>;
+    requireToFail?: GestureRef[];
+    simultaneousWith?: GestureRef[];
+    blocksHandlers?: GestureRef[];
+    needsPointerData?: boolean;
+    manualActivation?: boolean;
+    runOnJS?: boolean;
+    testId?: string;
+    cancelsTouchesInView?: boolean;
+}
+type TouchEventHandlerType = (event: GestureTouchEvent, stateManager: GestureStateManagerType) => void;
+export type HandlerCallbacks<EventPayloadT extends Record<string, unknown>> = {
+    gestureId: number;
+    handlerTag: number;
+    onBegin?: (event: GestureStateChangeEvent<EventPayloadT>) => void;
+    onStart?: (event: GestureStateChangeEvent<EventPayloadT>) => void;
+    onEnd?: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void;
+    onFinalize?: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void;
+    onUpdate?: (event: GestureUpdateEvent<EventPayloadT>) => void;
+    onChange?: (event: any) => void;
+    onTouchesDown?: TouchEventHandlerType;
+    onTouchesMove?: TouchEventHandlerType;
+    onTouchesUp?: TouchEventHandlerType;
+    onTouchesCancelled?: TouchEventHandlerType;
+    changeEventCalculator?: (current: GestureUpdateEvent<Record<string, unknown>>, previous?: GestureUpdateEvent<Record<string, unknown>>) => GestureUpdateEvent<Record<string, unknown>>;
+    isWorklet: boolean[];
+};
+export declare const CALLBACK_TYPE: {
+    readonly UNDEFINED: 0;
+    readonly BEGAN: 1;
+    readonly START: 2;
+    readonly UPDATE: 3;
+    readonly CHANGE: 4;
+    readonly END: 5;
+    readonly FINALIZE: 6;
+    readonly TOUCHES_DOWN: 7;
+    readonly TOUCHES_MOVE: 8;
+    readonly TOUCHES_UP: 9;
+    readonly TOUCHES_CANCELLED: 10;
+};
+export type CALLBACK_TYPE = (typeof CALLBACK_TYPE)[keyof typeof CALLBACK_TYPE];
+export declare abstract class Gesture {
+    /**
+     * Return array of gestures, providing the same interface for creating and updating
+     * handlers, no matter which object was used to create gesture instance.
+     */
+    abstract toGestureArray(): GestureType[];
+    /**
+     * Assign handlerTag to the gesture instance and set ref.current (if a ref is set)
+     */
+    abstract initialize(): void;
+    /**
+     * Make sure that values of properties defining relations are arrays. Do any necessary
+     * preprocessing required to configure relations between handlers. Called just before
+     * updating the handler on the native side.
+     */
+    abstract prepare(): void;
+}
+export declare abstract class BaseGesture<EventPayloadT extends Record<string, unknown>> extends Gesture {
+    private gestureId;
+    handlerTag: number;
+    handlerName: string;
+    config: BaseGestureConfig;
+    handlers: HandlerCallbacks<EventPayloadT>;
+    constructor();
+    private addDependency;
+    /**
+     * Sets a `ref` to the gesture object, allowing for interoperability with the old API.
+     * @param ref
+     */
+    withRef(ref: React.MutableRefObject<GestureType | undefined>): this;
+    protected isWorklet(callback: Function): boolean;
+    /**
+     * Set the callback that is being called when given gesture handler starts receiving touches.
+     * At the moment of this callback the handler is in `BEGAN` state and we don't know yet if it will recognize the gesture at all.
+     * @param callback
+     */
+    onBegin(callback: (event: GestureStateChangeEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called when the gesture is recognized by the handler and it transitions to the `ACTIVE` state.
+     * @param callback
+     */
+    onStart(callback: (event: GestureStateChangeEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called when the gesture that was recognized by the handler finishes and handler reaches `END` state.
+     * It will be called only if the handler was previously in the `ACTIVE` state.
+     * @param callback
+     */
+    onEnd(callback: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void): this;
+    /**
+     * Set the callback that is being called when the handler finalizes handling gesture - the gesture was recognized and has finished or it failed to recognize.
+     * @param callback
+     */
+    onFinalize(callback: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void): this;
+    /**
+     * Set the `onTouchesDown` callback which is called every time a pointer is placed on the screen.
+     * @param callback
+     */
+    onTouchesDown(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesMove` callback which is called every time a pointer is moved on the screen.
+     * @param callback
+     */
+    onTouchesMove(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesUp` callback which is called every time a pointer is lifted from the screen.
+     * @param callback
+     */
+    onTouchesUp(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesCancelled` callback which is called every time a pointer stops being tracked, for example when the gesture finishes.
+     * @param callback
+     */
+    onTouchesCancelled(callback: TouchEventHandlerType): this;
+    /**
+     * Indicates whether the given handler should be analyzing stream of touch events or not.
+     * @param enabled
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#enabledvalue-boolean
+     */
+    enabled(enabled: boolean): this;
+    /**
+     * When true the handler will cancel or fail recognition (depending on its current state) whenever the finger leaves the area of the connected view.
+     * @param value
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#shouldcancelwhenoutsidevalue-boolean
+     */
+    shouldCancelWhenOutside(value: boolean): this;
+    /**
+     * This parameter enables control over what part of the connected view area can be used to begin recognizing the gesture.
+     * When a negative number is provided the bounds of the view will reduce the area by the given number of points in each of the sides evenly.
+     * @param hitSlop
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#hitslopsettings
+     */
+    hitSlop(hitSlop: HitSlop): this;
+    /**
+     * #### Web only
+     * This parameter allows to specify which `cursor` should be used when gesture activates.
+     * Supports all CSS cursor values (e.g. `"grab"`, `"zoom-in"`). Default value is set to `"auto"`.
+     * @param activeCursor
+     */
+    activeCursor(activeCursor: ActiveCursor): this;
+    /**
+     * #### Web & Android only
+     * Allows users to choose which mouse button should handler respond to.
+     * Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`.
+     * Default value is set to `MouseButton.LEFT`.
+     * @param mouseButton
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#mousebuttonvalue-mousebutton-web--android-only
+     */
+    mouseButton(mouseButton: MouseButton): this;
+    /**
+     * When `react-native-reanimated` is installed, the callbacks passed to the gestures are automatically workletized and run on the UI thread when called.
+     * This option allows for changing this behavior: when `true`, all the callbacks will be run on the JS thread instead of the UI thread, regardless of whether they are worklets or not.
+     * Defaults to `false`.
+     * @param runOnJS
+     */
+    runOnJS(runOnJS: boolean): this;
+    /**
+     * Allows gestures across different components to be recognized simultaneously.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneouswithexternalgesture
+     */
+    simultaneousWithExternalGesture(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Allows to delay activation of the handler until all handlers passed as arguments to this method fail (or don't begin at all).
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#requireexternalgesturetofail
+     */
+    requireExternalGestureToFail(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Works similarily to `requireExternalGestureToFail` but the direction of the relation is reversed - instead of being one-to-many relation, it's many-to-one.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#blocksexternalgesture
+     */
+    blocksExternalGesture(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Sets a `testID` property for gesture object, allowing for querying for it in tests.
+     * @param id
+     */
+    withTestId(id: string): this;
+    /**
+     * #### iOS only
+     * When `true`, the handler will cancel touches for native UI components (`UIButton`, `UISwitch`, etc) it's attached to when it becomes `ACTIVE`.
+     * Default value is `true`.
+     * @param value
+     */
+    cancelsTouchesInView(value: boolean): this;
+    initialize(): void;
+    toGestureArray(): GestureType[];
+    prepare(): void;
+    get shouldUseReanimated(): boolean;
+}
+export declare abstract class ContinousBaseGesture<EventPayloadT extends Record<string, unknown>, EventChangePayloadT extends Record<string, unknown>> extends BaseGesture<EventPayloadT> {
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * @param callback
+     */
+    onUpdate(callback: (event: GestureUpdateEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * This callback will receive information about change in value in relation to the last received event.
+     * @param callback
+     */
+    onChange(callback: (event: GestureUpdateEvent<EventPayloadT & EventChangePayloadT>) => void): this;
+    /**
+     * When `true` the handler will not activate by itself even if its activation criteria are met.
+     * Instead you can manipulate its state using state manager.
+     * @param manualActivation
+     */
+    manualActivation(manualActivation: boolean): this;
+}
+export {};

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

@@ -0,0 +1 @@
+{"version":3,"file":"gesture.d.ts","sourceRoot":"","sources":["../../../../src/handlers/gestures/gesture.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACZ,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EACV,+BAA+B,EAC/B,oCAAoC,EACpC,mCAAmC,EACnC,6BAA6B,EAC7B,+BAA+B,EAC/B,kCAAkC,EAClC,6BAA6B,EAC7B,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,+BAA+B,CAAC;AAGvC,MAAM,MAAM,WAAW,GACnB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GACpC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAClC,WAAW,CAAC,6BAA6B,CAAC,GAC1C,WAAW,CAAC,6BAA6B,CAAC,GAC1C,WAAW,CAAC,mCAAmC,CAAC,GAChD,WAAW,CAAC,kCAAkC,CAAC,GAC/C,WAAW,CAAC,+BAA+B,CAAC,GAC5C,WAAW,CAAC,+BAA+B,CAAC,GAC5C,WAAW,CAAC,oCAAoC,CAAC,GACjD,WAAW,CAAC,+BAA+B,CAAC,GAC5C,WAAW,CAAC,+BAA+B,CAAC,CAAC;AAEjD,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,WAAW,GACX,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,GACxC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;AACrD,MAAM,WAAW,iBACf,SAAQ,mBAAmB,EACzB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,GAAG,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IACtD,aAAa,CAAC,EAAE,UAAU,EAAE,CAAC;IAC7B,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC;IAC9B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,KAAK,qBAAqB,GAAG,CAC3B,KAAK,EAAE,iBAAiB,EACxB,YAAY,EAAE,uBAAuB,KAClC,IAAI,CAAC;AAEV,MAAM,MAAM,gBAAgB,CAAC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;IAClE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;IAClE,KAAK,CAAC,EAAE,CACN,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,EAC7C,OAAO,EAAE,OAAO,KACb,IAAI,CAAC;IACV,UAAU,CAAC,EAAE,CACX,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,EAC7C,OAAO,EAAE,OAAO,KACb,IAAI,CAAC;IACV,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;IAC9D,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAChC,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC,aAAa,CAAC,EAAE,qBAAqB,CAAC;IACtC,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,qBAAqB,CAAC,EAAE,CACtB,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACpD,QAAQ,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KACnD,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,SAAS,EAAE,OAAO,EAAE,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;CAYhB,CAAC;AAIX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,8BAAsB,OAAO;IAC3B;;;OAGG;IACH,QAAQ,CAAC,cAAc,IAAI,WAAW,EAAE;IAExC;;OAEG;IACH,QAAQ,CAAC,UAAU,IAAI,IAAI;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,IAAI,IAAI;CACzB;AAGD,8BAAsB,WAAW,CAC/B,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC7C,SAAQ,OAAO;IACf,OAAO,CAAC,SAAS,CAAM;IAChB,UAAU,SAAM;IAChB,WAAW,SAAM;IACjB,MAAM,EAAE,iBAAiB,CAAM;IAC/B,QAAQ,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAI9C;;IAcF,OAAO,CAAC,aAAa;IAUrB;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,GAAG,SAAS,CAAC;IAM5D,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ;IAKtC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,KAAK,IAAI;IAMzE;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,KAAK,IAAI;IAMzE;;;;OAIG;IACH,KAAK,CACH,QAAQ,EAAE,CACR,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,EAC7C,OAAO,EAAE,OAAO,KACb,IAAI;IAQX;;;OAGG;IACH,UAAU,CACR,QAAQ,EAAE,CACR,KAAK,EAAE,uBAAuB,CAAC,aAAa,CAAC,EAC7C,OAAO,EAAE,OAAO,KACb,IAAI;IAQX;;;OAGG;IACH,aAAa,CAAC,QAAQ,EAAE,qBAAqB;IAS7C;;;OAGG;IACH,aAAa,CAAC,QAAQ,EAAE,qBAAqB;IAS7C;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,qBAAqB;IAS3C;;;OAGG;IACH,kBAAkB,CAAC,QAAQ,EAAE,qBAAqB;IASlD;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO;IAKxB;;;;OAIG;IACH,uBAAuB,CAAC,KAAK,EAAE,OAAO;IAKtC;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO;IAKxB;;;;;OAKG;IACH,YAAY,CAAC,YAAY,EAAE,YAAY;IAKvC;;;;;;;OAOG;IACH,WAAW,CAAC,WAAW,EAAE,WAAW;IAKpC;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO;IAKxB;;;;OAIG;IACH,+BAA+B,CAAC,GAAG,QAAQ,EAAE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE;IAO1E;;;;OAIG;IACH,4BAA4B,CAAC,GAAG,QAAQ,EAAE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE;IAOvE;;;;OAIG;IACH,qBAAqB,CAAC,GAAG,QAAQ,EAAE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE;IAOhE;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM;IAKrB;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAKnC,UAAU;IAUV,cAAc,IAAI,WAAW,EAAE;IAK/B,OAAO;IAEP,IAAI,mBAAmB,IAAI,OAAO,CASjC;CACF;AAED,8BAAsB,oBAAoB,CACxC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7C,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACnD,SAAQ,WAAW,CAAC,aAAa,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,CAAC,aAAa,CAAC,KAAK,IAAI;IAMrE;;;;OAIG;IACH,QAAQ,CACN,QAAQ,EAAE,CACR,KAAK,EAAE,kBAAkB,CAAC,aAAa,GAAG,mBAAmB,CAAC,KAC3D,IAAI;IAOX;;;;OAIG;IACH,gBAAgB,CAAC,gBAAgB,EAAE,OAAO;CAI3C"}

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

@@ -0,0 +1,303 @@
+import { getNextHandlerTag } from '../getNextHandlerTag';
+import { isRemoteDebuggingEnabled } from '../../utils';
+export const CALLBACK_TYPE = {
+    UNDEFINED: 0,
+    BEGAN: 1,
+    START: 2,
+    UPDATE: 3,
+    CHANGE: 4,
+    END: 5,
+    FINALIZE: 6,
+    TOUCHES_DOWN: 7,
+    TOUCHES_MOVE: 8,
+    TOUCHES_UP: 9,
+    TOUCHES_CANCELLED: 10,
+};
+export class Gesture {
+}
+let nextGestureId = 0;
+export class BaseGesture extends Gesture {
+    gestureId = -1;
+    handlerTag = -1;
+    handlerName = '';
+    config = {};
+    handlers = {
+        gestureId: -1,
+        handlerTag: -1,
+        isWorklet: [],
+    };
+    constructor() {
+        super();
+        // Used to check whether the gesture config has been updated when wrapping it
+        // with `useMemo`. Since every config will have a unique id, when the dependencies
+        // don't change, the config won't be recreated and the id will stay the same.
+        // If the id is different, it means that the config has changed and the gesture
+        // needs to be updated.
+        this.gestureId = nextGestureId++;
+        this.handlers.gestureId = this.gestureId;
+    }
+    addDependency(key, gesture) {
+        const value = this.config[key];
+        this.config[key] = value
+            ? Array().concat(value, gesture)
+            : [gesture];
+    }
+    /**
+     * Sets a `ref` to the gesture object, allowing for interoperability with the old API.
+     * @param ref
+     */
+    withRef(ref) {
+        this.config.ref = ref;
+        return this;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    isWorklet(callback) {
+        // @ts-ignore if callback is a worklet, the property will be available, if not then the check will return false
+        return callback.__workletHash !== undefined;
+    }
+    /**
+     * Set the callback that is being called when given gesture handler starts receiving touches.
+     * At the moment of this callback the handler is in `BEGAN` state and we don't know yet if it will recognize the gesture at all.
+     * @param callback
+     */
+    onBegin(callback) {
+        this.handlers.onBegin = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.BEGAN] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the callback that is being called when the gesture is recognized by the handler and it transitions to the `ACTIVE` state.
+     * @param callback
+     */
+    onStart(callback) {
+        this.handlers.onStart = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.START] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the callback that is being called when the gesture that was recognized by the handler finishes and handler reaches `END` state.
+     * It will be called only if the handler was previously in the `ACTIVE` state.
+     * @param callback
+     */
+    onEnd(callback) {
+        this.handlers.onEnd = callback;
+        // @ts-ignore if callback is a worklet, the property will be available, if not then the check will return false
+        this.handlers.isWorklet[CALLBACK_TYPE.END] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the callback that is being called when the handler finalizes handling gesture - the gesture was recognized and has finished or it failed to recognize.
+     * @param callback
+     */
+    onFinalize(callback) {
+        this.handlers.onFinalize = callback;
+        // @ts-ignore if callback is a worklet, the property will be available, if not then the check will return false
+        this.handlers.isWorklet[CALLBACK_TYPE.FINALIZE] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the `onTouchesDown` callback which is called every time a pointer is placed on the screen.
+     * @param callback
+     */
+    onTouchesDown(callback) {
+        this.config.needsPointerData = true;
+        this.handlers.onTouchesDown = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_DOWN] =
+            this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the `onTouchesMove` callback which is called every time a pointer is moved on the screen.
+     * @param callback
+     */
+    onTouchesMove(callback) {
+        this.config.needsPointerData = true;
+        this.handlers.onTouchesMove = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_MOVE] =
+            this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the `onTouchesUp` callback which is called every time a pointer is lifted from the screen.
+     * @param callback
+     */
+    onTouchesUp(callback) {
+        this.config.needsPointerData = true;
+        this.handlers.onTouchesUp = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_UP] =
+            this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the `onTouchesCancelled` callback which is called every time a pointer stops being tracked, for example when the gesture finishes.
+     * @param callback
+     */
+    onTouchesCancelled(callback) {
+        this.config.needsPointerData = true;
+        this.handlers.onTouchesCancelled = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_CANCELLED] =
+            this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Indicates whether the given handler should be analyzing stream of touch events or not.
+     * @param enabled
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#enabledvalue-boolean
+     */
+    enabled(enabled) {
+        this.config.enabled = enabled;
+        return this;
+    }
+    /**
+     * When true the handler will cancel or fail recognition (depending on its current state) whenever the finger leaves the area of the connected view.
+     * @param value
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#shouldcancelwhenoutsidevalue-boolean
+     */
+    shouldCancelWhenOutside(value) {
+        this.config.shouldCancelWhenOutside = value;
+        return this;
+    }
+    /**
+     * This parameter enables control over what part of the connected view area can be used to begin recognizing the gesture.
+     * When a negative number is provided the bounds of the view will reduce the area by the given number of points in each of the sides evenly.
+     * @param hitSlop
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#hitslopsettings
+     */
+    hitSlop(hitSlop) {
+        this.config.hitSlop = hitSlop;
+        return this;
+    }
+    /**
+     * #### Web only
+     * This parameter allows to specify which `cursor` should be used when gesture activates.
+     * Supports all CSS cursor values (e.g. `"grab"`, `"zoom-in"`). Default value is set to `"auto"`.
+     * @param activeCursor
+     */
+    activeCursor(activeCursor) {
+        this.config.activeCursor = activeCursor;
+        return this;
+    }
+    /**
+     * #### Web & Android only
+     * Allows users to choose which mouse button should handler respond to.
+     * Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`.
+     * Default value is set to `MouseButton.LEFT`.
+     * @param mouseButton
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#mousebuttonvalue-mousebutton-web--android-only
+     */
+    mouseButton(mouseButton) {
+        this.config.mouseButton = mouseButton;
+        return this;
+    }
+    /**
+     * When `react-native-reanimated` is installed, the callbacks passed to the gestures are automatically workletized and run on the UI thread when called.
+     * This option allows for changing this behavior: when `true`, all the callbacks will be run on the JS thread instead of the UI thread, regardless of whether they are worklets or not.
+     * Defaults to `false`.
+     * @param runOnJS
+     */
+    runOnJS(runOnJS) {
+        this.config.runOnJS = runOnJS;
+        return this;
+    }
+    /**
+     * Allows gestures across different components to be recognized simultaneously.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneouswithexternalgesture
+     */
+    simultaneousWithExternalGesture(...gestures) {
+        for (const gesture of gestures) {
+            this.addDependency('simultaneousWith', gesture);
+        }
+        return this;
+    }
+    /**
+     * Allows to delay activation of the handler until all handlers passed as arguments to this method fail (or don't begin at all).
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#requireexternalgesturetofail
+     */
+    requireExternalGestureToFail(...gestures) {
+        for (const gesture of gestures) {
+            this.addDependency('requireToFail', gesture);
+        }
+        return this;
+    }
+    /**
+     * Works similarily to `requireExternalGestureToFail` but the direction of the relation is reversed - instead of being one-to-many relation, it's many-to-one.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#blocksexternalgesture
+     */
+    blocksExternalGesture(...gestures) {
+        for (const gesture of gestures) {
+            this.addDependency('blocksHandlers', gesture);
+        }
+        return this;
+    }
+    /**
+     * Sets a `testID` property for gesture object, allowing for querying for it in tests.
+     * @param id
+     */
+    withTestId(id) {
+        this.config.testId = id;
+        return this;
+    }
+    /**
+     * #### iOS only
+     * When `true`, the handler will cancel touches for native UI components (`UIButton`, `UISwitch`, etc) it's attached to when it becomes `ACTIVE`.
+     * Default value is `true`.
+     * @param value
+     */
+    cancelsTouchesInView(value) {
+        this.config.cancelsTouchesInView = value;
+        return this;
+    }
+    initialize() {
+        this.handlerTag = getNextHandlerTag();
+        this.handlers = { ...this.handlers, handlerTag: this.handlerTag };
+        if (this.config.ref) {
+            this.config.ref.current = this;
+        }
+    }
+    toGestureArray() {
+        return [this];
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    prepare() { }
+    get shouldUseReanimated() {
+        // Use Reanimated when runOnJS isn't set explicitly,
+        // all defined callbacks are worklets
+        // and remote debugging is disabled
+        return (this.config.runOnJS !== true &&
+            !this.handlers.isWorklet.includes(false) &&
+            !isRemoteDebuggingEnabled());
+    }
+}
+export class ContinousBaseGesture extends BaseGesture {
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * @param callback
+     */
+    onUpdate(callback) {
+        this.handlers.onUpdate = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.UPDATE] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * This callback will receive information about change in value in relation to the last received event.
+     * @param callback
+     */
+    onChange(callback) {
+        this.handlers.onChange = callback;
+        this.handlers.isWorklet[CALLBACK_TYPE.CHANGE] = this.isWorklet(callback);
+        return this;
+    }
+    /**
+     * When `true` the handler will not activate by itself even if its activation criteria are met.
+     * Instead you can manipulate its state using state manager.
+     * @param manualActivation
+     */
+    manualActivation(manualActivation) {
+        this.config.manualActivation = manualActivation;
+        return this;
+    }
+}

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

@@ -0,0 +1,21 @@
+import { Gesture, GestureType } from './gesture';
+export declare class ComposedGesture extends Gesture {
+    protected gestures: Gesture[];
+    protected simultaneousGestures: GestureType[];
+    protected requireGesturesToFail: GestureType[];
+    constructor(...gestures: Gesture[]);
+    protected prepareSingleGesture(gesture: Gesture, simultaneousGestures: GestureType[], requireGesturesToFail: GestureType[]): void;
+    prepare(): void;
+    initialize(): void;
+    toGestureArray(): GestureType[];
+}
+export declare class SimultaneousGesture extends ComposedGesture {
+    prepare(): void;
+}
+export declare class ExclusiveGesture extends ComposedGesture {
+    prepare(): void;
+}
+export type ComposedGestureType = InstanceType<typeof ComposedGesture>;
+export type RaceGestureType = ComposedGestureType;
+export type SimultaneousGestureType = InstanceType<typeof SimultaneousGesture>;
+export type ExclusiveGestureType = InstanceType<typeof ExclusiveGesture>;

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

@@ -0,0 +1 @@
+{"version":3,"file":"gestureComposition.d.ts","sourceRoot":"","sources":["../../../../src/handlers/gestures/gestureComposition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,OAAO,EAAc,WAAW,EAAE,MAAM,WAAW,CAAC;AAa1E,qBAAa,eAAgB,SAAQ,OAAO;IAC1C,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IACnC,SAAS,CAAC,oBAAoB,EAAE,WAAW,EAAE,CAAM;IACnD,SAAS,CAAC,qBAAqB,EAAE,WAAW,EAAE,CAAM;gBAExC,GAAG,QAAQ,EAAE,OAAO,EAAE;IAKlC,SAAS,CAAC,oBAAoB,CAC5B,OAAO,EAAE,OAAO,EAChB,oBAAoB,EAAE,WAAW,EAAE,EACnC,qBAAqB,EAAE,WAAW,EAAE;IAwBtC,OAAO;IAUP,UAAU;IAMV,cAAc,IAAI,WAAW,EAAE;CAGhC;AAED,qBAAa,mBAAoB,SAAQ,eAAe;IACtD,OAAO;CAuBR;AAED,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,OAAO;CAoBR;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,OAAO,eAAe,CAAC,CAAC;AACvE,MAAM,MAAM,eAAe,GAAG,mBAAmB,CAAC;AAClD,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAC/E,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,gBAAgB,CAAC,CAAC"}