react-native-gesture-handler 3.0.0-beta.3 → 3.0.0-beta.5

package/src/components/ReanimatedSwipeable/ReanimatedSwipeable.tsx

@@ -1,5 +1,10 @@
 import type { ForwardedRef } from 'react';
-import { useCallback, useImperativeHandle, useMemo } from 'react';
+import React, {
+  useCallback,
+  useEffect,
+  useImperativeHandle,
+  useMemo,
+} from 'react';
 import type { LayoutChangeEvent } from 'react-native';
 import { I18nManager, StyleSheet, View } from 'react-native';
 import Animated, {
@@ -14,9 +19,16 @@ import Animated, {
   withSpring,
 } from 'react-native-reanimated';
 
+import { Reanimated } from '../../handlers/gestures/reanimatedWrapper';
+import { tagMessage } from '../../utils';
 import { GestureDetector } from '../../v3/detectors';
 import type { PanGestureActiveEvent } from '../../v3/hooks/gestures';
 import { usePanGesture, useTapGesture } from '../../v3/hooks/gestures';
+import {
+  maybeUnpackValue,
+  SHARED_VALUE_OFFSET,
+} from '../../v3/hooks/utils/reanimatedUtils';
+import type { SharedValueOrT } from '../../v3/types';
 import type {
   SwipeableMethods,
   SwipeableProps,
@@ -44,8 +56,8 @@ const Swipeable = (props: SwipeableProps) => {
     testID,
     children,
     enableTrackpadTwoFingerGesture = DEFAULT_ENABLE_TRACKING_TWO_FINGER_GESTURE,
-    dragOffsetFromLeftEdge = DEFAULT_DRAG_OFFSET,
-    dragOffsetFromRightEdge = DEFAULT_DRAG_OFFSET,
+    dragOffsetFromLeft = DEFAULT_DRAG_OFFSET,
+    dragOffsetFromRight = -DEFAULT_DRAG_OFFSET,
     friction = DEFAULT_FRICTION,
     overshootFriction = DEFAULT_OVERSHOOT_FRICTION,
     onSwipeableOpenStartDrag,
@@ -63,6 +75,40 @@ const Swipeable = (props: SwipeableProps) => {
     ...remainingProps
   } = props;
 
+  if (__DEV__) {
+    const checkValue = (value: SharedValueOrT<number>) => {
+      'worklet';
+      if (maybeUnpackValue<number>(value) > 0) {
+        throw new Error(
+          tagMessage('dragOffsetFromRight should be non-positive.')
+        );
+      }
+    };
+
+    checkValue(dragOffsetFromRight);
+
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+      if (!Reanimated?.isSharedValue<number>(dragOffsetFromRight)) {
+        return;
+      }
+
+      const listenerId = Math.random() + SHARED_VALUE_OFFSET;
+
+      Reanimated?.runOnUI(() => {
+        'worklet';
+        dragOffsetFromRight.addListener(listenerId, checkValue);
+      })();
+
+      return () => {
+        Reanimated?.runOnUI(() => {
+          'worklet';
+          dragOffsetFromRight.removeListener(listenerId);
+        })();
+      };
+    }, [dragOffsetFromRight, checkValue]);
+  }
+
   const shouldEnableTap = useSharedValue<boolean>(false);
   const rowState = useSharedValue<number>(0);
 
@@ -468,9 +514,9 @@ const Swipeable = (props: SwipeableProps) => {
   });
 
   const panGesture = usePanGesture({
-    enabled: enabled !== false,
+    enabled: enabled ?? true,
     enableTrackpadTwoFingerGesture: enableTrackpadTwoFingerGesture,
-    activeOffsetX: [-dragOffsetFromRightEdge, dragOffsetFromLeftEdge],
+    activeOffsetX: [dragOffsetFromRight, dragOffsetFromLeft],
     simultaneousWith,
     requireToFail,
     block,

package/src/components/ReanimatedSwipeable/ReanimatedSwipeableProps.ts

@@ -3,17 +3,14 @@ import type { StyleProp, ViewStyle } from 'react-native';
 import type { SharedValue } from 'react-native-reanimated';
 
 import type { HitSlop } from '../../handlers/gestureHandlerCommon';
-import type { AnyGesture } from '../../v3/types';
+import type { AnyGesture, WithSharedValue } from '../../v3/types';
 
 export enum SwipeDirection {
   LEFT = 'left',
   RIGHT = 'right',
 }
 
-export interface SwipeableProps {
-  /**
-   *
-   */
+export type SwipeableProps = {
   ref?: React.Ref<SwipeableMethods>;
 
   /**
@@ -23,27 +20,6 @@ export interface SwipeableProps {
 
   children?: React.ReactNode;
 
-  /**
-   * Indicates whether `ReanimatedSwipeable` should be analyzing stream of touch events or not.
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#enabledvalue-boolean
-   */
-  enabled?: boolean;
-
-  /**
-   * 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.
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#hitslopsettings
-   */
-  hitSlop?: HitSlop;
-
-  /**
-   * Enables two-finger gestures on supported devices, for example iPads with
-   * trackpads. If not enabled the gesture will require click + drag, with
-   * `enableTrackpadTwoFingerGesture` swiping with two fingers will also trigger
-   * the gesture.
-   */
-  enableTrackpadTwoFingerGesture?: boolean;
-
   /**
    * Specifies how much the visual interaction will be delayed compared to the
    * gesture distance. e.g. value of 1 will indicate that the swipeable panel
@@ -66,18 +42,6 @@ export interface SwipeableProps {
    */
   rightThreshold?: number;
 
-  /**
-   * Distance that the panel must be dragged from the left edge to be considered
-   * a swipe. The default value is 10.
-   */
-  dragOffsetFromLeftEdge?: number;
-
-  /**
-   * Distance that the panel must be dragged from the right edge to be considered
-   * a swipe. The default value is 10.
-   */
-  dragOffsetFromRightEdge?: number;
-
   /**
    * Value indicating if the swipeable panel can be pulled further than the left
    * actions panel's width. It is set to true by default as long as the left
@@ -204,7 +168,35 @@ export interface SwipeableProps {
    * used with the swipeable's gesture handler.
    */
   block?: AnyGesture | AnyGesture[];
-}
+} & WithSharedValue<{
+  /**
+   * Indicates whether `ReanimatedSwipeable` should be analyzing stream of touch events or not.
+   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#enabledvalue-boolean
+   */
+  enabled?: boolean | undefined;
+  /**
+   * 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.
+   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#hitslopsettings
+   */
+  hitSlop?: HitSlop | undefined;
+  /**
+   * Enables two-finger gestures on supported devices, for example iPads with
+   * trackpads. If not enabled the gesture will require click + drag, with
+   * `enableTrackpadTwoFingerGesture` swiping with two fingers will also trigger
+   * the gesture.
+   */
+  enableTrackpadTwoFingerGesture?: boolean | undefined;
+  /**
+   * The horizontal offset from the starting point required to trigger a right-swipe gesture. Defaults to 10.
+   */
+  dragOffsetFromLeft?: number;
+
+  /**
+   * The horizontal offset from the starting point required to trigger a left-swipe gesture. Defaults to -10.
+   */
+  dragOffsetFromRight?: number;
+}>;
 
 export interface SwipeableMethods {
   close: () => void;

package/src/components/touchables/GenericTouchable.tsx

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { Component } from 'react';
-import { Animated, Platform } from 'react-native';
+import { Animated } from 'react-native';
 
 import type {
   GestureEvent,
@@ -174,10 +174,7 @@ export default class GenericTouchable extends Component<
       // Need to handle case with external cancellation (e.g. by ScrollView)
       this.moveToState(TOUCHABLE_STATE.UNDETERMINED);
     } else if (
-      // This platform check is an implication of slightly different behavior of handlers on different platform.
-      // And Android "Active" state is achieving on first move of a finger, not on press in.
-      // On iOS event on "Began" is not delivered.
-      state === (Platform.OS !== 'android' ? State.ACTIVE : State.BEGAN) &&
+      state === State.BEGAN &&
       this.STATE === TOUCHABLE_STATE.UNDETERMINED
     ) {
       // Moving inside requires

package/src/handlers/gestures/GestureDetector/useDetectorUpdater.ts

@@ -10,7 +10,7 @@ import { dropHandlers } from './dropHandlers';
 import { needsToReattach } from './needsToReattach';
 import type { AttachedGestureState, GestureDetectorState } from './types';
 import { updateHandlers } from './updateHandlers';
-import { useForceRender, validateDetectorChildren } from './utils';
+import { useForceRender } from './utils';
 
 // Returns a function that's responsible for updating the attached gestures
 // If the view has changed, it will reattach the handlers to the new view
@@ -34,7 +34,6 @@ export function useDetectorUpdater(
         didUnderlyingViewChange ||
         needsToReattach(preparedGesture, gesturesToAttach)
       ) {
-        validateDetectorChildren(state.viewRef);
         dropHandlers(preparedGesture);
         attachHandlers({
           preparedGesture,

package/src/handlers/gestures/GestureDetector/utils.ts

@@ -1,7 +1,5 @@
 import { useCallback, useRef, useState } from 'react';
-import { Platform } from 'react-native';
 
-import { RNRenderer } from '../../../RNRenderer';
 import { isTestEnv, tagMessage } from '../../../utils';
 import type {
   GestureHandlerNativeEvent,
@@ -36,6 +34,16 @@ export const ALLOWED_PROPS = [
   ...nativeViewGestureHandlerProps,
 ];
 
+// In some environments (e.g. `Next.js`) Reanimated Babel plugin might not be used.
+// In that case we would wrongly suggest to add `runOnJS` to gesture configuration, even if the user doesn't use worklets at all.
+// To prevent this, we check whether the plugin is enabled by defining a worklet and checking if the `__workletHash` property is available.
+function emptyWorklet() {
+  'worklet';
+}
+
+// @ts-expect-error if `emptyWorklet` is a worklet, `__workletHash` will be available, if not then the check will return false.
+const wasBabelPluginEnabled = emptyWorklet.__workletHash !== undefined;
+
 function convertToHandlerTag(ref: GestureRef): number {
   if (typeof ref === 'number') {
     return ref;
@@ -105,7 +113,7 @@ export function checkGestureCallbacksForWorklets(gesture: GestureType) {
   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()) {
+  if (areAllNotWorklets && wasBabelPluginEnabled && !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.`
@@ -114,56 +122,6 @@ export function checkGestureCallbacksForWorklets(gesture: GestureType) {
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function validateDetectorChildren(ref: any) {
-  // 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(() => {

package/src/handlers/gestures/flingGesture.ts

@@ -3,6 +3,9 @@ import type { FlingGestureHandlerEventPayload } from '../GestureHandlerEventPayl
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `FlingGesture` is deprecated and will be removed in the future. Please use `useFlingGesture` instead.
+ */
 export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
   public override config: BaseGestureConfig & FlingGestureConfig = {};
 
@@ -34,4 +37,7 @@ export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
   }
 }
 
+/**
+ * @deprecated `FlingGestureType` is deprecated and will be removed in the future. Please use `FlingGesture` instead.
+ */
 export type FlingGestureType = InstanceType<typeof FlingGesture>;

package/src/handlers/gestures/forceTouchGesture.ts

@@ -5,7 +5,7 @@ import type { BaseGestureConfig } from './gesture';
 import { ContinousBaseGesture } from './gesture';
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGestureChangeEventPayload` is deprecated and will be removed in the future.
  */
 export type ForceTouchGestureChangeEventPayload = {
   forceChange: number;
@@ -31,7 +31,7 @@ function changeEventCalculator(
 }
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGesture` is deprecated and will be removed in the future.
  */
 export class ForceTouchGesture extends ContinousBaseGesture<
   ForceTouchGestureHandlerEventPayload,
@@ -91,6 +91,6 @@ export class ForceTouchGesture extends ContinousBaseGesture<
 }
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGestureType` is deprecated and will be removed in the future.
  */
 export type ForceTouchGestureType = InstanceType<typeof ForceTouchGesture>;

package/src/handlers/gestures/gesture.ts

@@ -22,6 +22,9 @@ import type {
 import { getNextHandlerTag } from '../getNextHandlerTag';
 import type { GestureStateManagerType } from './gestureStateManager';
 
+/**
+ * @deprecated `GestureType` is deprecated and will be removed in the future. Please use `SingleGesture` instead.
+ */
 export type GestureType =
   | BaseGesture<Record<string, unknown>>
   | BaseGesture<Record<string, never>>
@@ -35,6 +38,9 @@ export type GestureType =
   | BaseGesture<NativeViewGestureHandlerPayload>
   | BaseGesture<HoverGestureHandlerEventPayload>;
 
+/**
+ * @deprecated `GestureRef` is deprecated and will be removed in the future.
+ */
 export type GestureRef =
   | number
   | GestureType

package/src/handlers/gestures/gestureComposition.ts

@@ -12,6 +12,9 @@ function extendRelation(
   }
 }
 
+/**
+ * @deprecated `ComposedGesture` is deprecated and will be removed in the future. Please use `useCompetingGestures` instead.
+ */
 export class ComposedGesture extends Gesture {
   protected gestures: Gesture[] = [];
   protected simultaneousGestures: GestureType[] = [];
@@ -70,6 +73,9 @@ export class ComposedGesture extends Gesture {
   }
 }
 
+/**
+ * @deprecated `SimultaneousGesture` is deprecated and will be removed in the future. Please use `useSimultaneousGestures` instead.
+ */
 export class SimultaneousGesture extends ComposedGesture {
   override prepare() {
     // This piece of magic works something like this:
@@ -96,6 +102,9 @@ export class SimultaneousGesture extends ComposedGesture {
   }
 }
 
+/**
+ * @deprecated `ExclusiveGesture` is deprecated and will be removed in the future. Please use `useExclusiveGestures` instead.
+ */
 export class ExclusiveGesture extends ComposedGesture {
   override prepare() {
     // Transforms the array of gestures into array of grouped raw (not composed) gestures
@@ -119,7 +128,19 @@ export class ExclusiveGesture extends ComposedGesture {
   }
 }
 
+/**
+ * @deprecated `ComposedGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type ComposedGestureType = InstanceType<typeof ComposedGesture>;
+/**
+ * @deprecated `RaceGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type RaceGestureType = ComposedGestureType;
+/**
+ * @deprecated `SimultaneousGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type SimultaneousGestureType = InstanceType<typeof SimultaneousGesture>;
+/**
+ * @deprecated `ExclusiveGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type ExclusiveGestureType = InstanceType<typeof ExclusiveGesture>;

package/src/handlers/gestures/gestureObjects.ts

@@ -16,6 +16,8 @@ import { RotationGesture } from './rotationGesture';
 import { TapGesture } from './tapGesture';
 
 /**
+ * @deprecated `Gesture` builder API is deprecated and will be removed in a future version of Gesture Handler. Please migrate to the new, hook-based API.
+ *
  * `Gesture` is the object that allows you to create and compose gestures.
  *
  * ### Remarks
@@ -25,6 +27,8 @@ import { TapGesture } from './tapGesture';
  */
 export const GestureObjects = {
   /**
+   * @deprecated `Gesture.Tap()` is deprecated and will be removed in the future. Please use `useTapGesture` instead.
+   *
    * A discrete gesture that recognizes one or many taps.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/tap-gesture
    */
@@ -33,6 +37,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Pan()` is deprecated and will be removed in the future. Please use `usePanGesture` instead.
+   *
    * 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
    */
@@ -41,6 +47,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Pinch()` is deprecated and will be removed in the future. Please use `usePinchGesture` instead.
+   *
    * 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
    */
@@ -49,6 +57,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Rotation()` is deprecated and will be removed in the future. Please use `useRotationGesture` instead.
+   *
    * A continuous gesture that can recognize rotation and track its movement.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/rotation-gesture
    */
@@ -57,6 +67,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Fling()` is deprecated and will be removed in the future. Please use `useFlingGesture` instead.
+   *
    * A discrete gesture that activates when the movement is sufficiently fast.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture
    */
@@ -65,6 +77,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.LongPress()` is deprecated and will be removed in the future. Please use `useLongPressGesture` instead.
+   *
    * 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
    */
@@ -73,7 +87,7 @@ export const GestureObjects = {
   },
 
   /**
-   * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+   * @deprecated `Gesture.ForceTouch()` 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.
@@ -84,6 +98,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Native()` is deprecated and will be removed in the future. Please use `useNativeGesture` instead.
+   *
    * 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
@@ -93,6 +109,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Manual()` is deprecated and will be removed in the future. Please use `useManualGesture` instead.
+   *
    * 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.
@@ -103,6 +121,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Hover()` is deprecated and will be removed in the future. Please use `useHoverGesture` instead.
+   *
    * 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.
    *
@@ -113,6 +133,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Race()` is deprecated and will be removed in the future. Please use `useCompetingGestures` instead.
+   *
    * 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
@@ -122,6 +144,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Simultaneous()` is deprecated and will be removed in the future. Please use `useSimultaneousGestures` instead.
+   *
    * 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
    */
@@ -130,6 +154,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Exclusive()` is deprecated and will be removed in the future. Please use `useExclusiveGestures` instead.
+   *
    * 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.

package/src/handlers/gestures/gestureStateManager.ts

@@ -1,6 +1,9 @@
 import { State } from '../../State';
 import { tagMessage } from '../../utils';
 
+/**
+ * @deprecated `LegacyGestureStateManagerType` is deprecated and will be removed in the future. Please use the new, hook-based API instead.
+ */
 export interface GestureStateManagerType {
   begin: () => void;
   activate: () => void;
@@ -49,6 +52,9 @@ function create(handlerTag: number): GestureStateManagerType {
   };
 }
 
+/**
+ * @deprecated `LegacyGestureStateManager` is deprecated and will be removed in the future. Please use the new, hook-based API instead.
+ */
 export const GestureStateManager = {
   create,
 };

package/src/handlers/gestures/hoverGesture.ts

@@ -41,6 +41,9 @@ function changeEventCalculator(
   return { ...current, ...changePayload };
 }
 
+/**
+ * @deprecated `HoverGesture` is deprecated and will be removed in the future. Please use `useHoverGesture` instead.
+ */
 export class HoverGesture extends ContinousBaseGesture<
   HoverGestureHandlerEventPayload,
   HoverGestureChangeEventPayload
@@ -75,4 +78,7 @@ export class HoverGesture extends ContinousBaseGesture<
   }
 }
 
+/**
+ * @deprecated `HoverGestureType` is deprecated and will be removed in the future. Please use `HoverGesture` instead.
+ */
 export type HoverGestureType = InstanceType<typeof HoverGesture>;

package/src/handlers/gestures/longPressGesture.ts

@@ -3,6 +3,9 @@ import type { LongPressGestureConfig } from '../LongPressGestureHandler';
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `LongPressGesture` is deprecated and will be removed in the future. Please use `useLongPressGesture` instead.
+ */
 export class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPayload> {
   public override config: BaseGestureConfig & LongPressGestureConfig = {};
 
@@ -43,4 +46,7 @@ export class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPa
   }
 }
 
+/**
+ * @deprecated `LongPressGestureType` is deprecated and will be removed in the future. Please use `LongPressGesture` instead.
+ */
 export type LongPressGestureType = InstanceType<typeof LongPressGesture>;

package/src/handlers/gestures/manualGesture.ts

@@ -9,6 +9,9 @@ function changeEventCalculator(
   return current;
 }
 
+/**
+ * @deprecated `ManualGesture` is deprecated and will be removed in the future. Please use `useManualGesture` instead.
+ */
 export class ManualGesture extends ContinousBaseGesture<
   Record<string, never>,
   Record<string, never>
@@ -28,4 +31,7 @@ export class ManualGesture extends ContinousBaseGesture<
   }
 }
 
+/**
+ * @deprecated `ManualGestureType` is deprecated and will be removed in the future. Please use `ManualGesture` instead.
+ */
 export type ManualGestureType = InstanceType<typeof ManualGesture>;

package/src/handlers/gestures/nativeGesture.ts

@@ -3,6 +3,9 @@ import type { NativeViewGestureConfig } from '../NativeViewGestureHandler';
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `NativeGesture` is deprecated and will be removed in the future. Please use `useNativeGesture` instead.
+ */
 export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload> {
   public override config: BaseGestureConfig & NativeViewGestureConfig = {};
 
@@ -31,4 +34,7 @@ export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload>
   }
 }
 
+/**
+ * @deprecated `NativeGestureType` is deprecated and will be removed in the future. Please use `NativeGesture` instead.
+ */
 export type NativeGestureType = InstanceType<typeof NativeGesture>;