feat: Add simultaneousWithExternalGesture to ReanimatedSwipable

docs/docs/components/reanimated_swipeable.md

@@ -128,6 +128,22 @@ style object for the container (`Animated.View`), for example to override `overf
 
 style object for the children container (`Animated.View`), for example to apply `flex: 1`.
 
+### `simultaneousWithExternalGestures`
+
+An array of gesture configurations to be recognized simultaneously with the swipeable gesture. This is useful for allowing other gestures to work simultaneously with swipeable gesture handler.
+
+For example, to enable a pan gesture alongside the swipeable gesture:
+
+```jsx
+const panGesture = Gesture.Pan();
+
+<GestureDetector gesture={panGesture}>
+  <ReanimatedSwipeable simultaneousWithExternalGestures={[panGesture]} />
+</GestureDetector>
+```
+
+More details can be found in the [gesture composition documentation](../fundamentals/gesture-composition.md#simultaneouswithexternalgesture).
+
 ### `enableTrackpadTwoFingerGesture` (iOS only)
 
 Enables two-finger gestures on supported devices, for example iPads with trackpads.

example/tsconfig.json

@@ -5,6 +5,9 @@
     "baseUrl": ".",
     "paths": {
       "react-native-gesture-handler": ["../src/index.ts"],
+      "react-native-gesture-handler/ReanimatedSwipeable": [
+        "../src/components/ReanimatedSwipeable.tsx"
+      ],
       "react-native-gesture-handler/jest-utils": ["../src/jestUtils/index.ts"]
     }
   },

src/components/ReanimatedSwipeable.tsx

@@ -9,6 +9,7 @@ import React, {
   useImperativeHandle,
   useMemo,
 } from 'react';
+import { GestureRef } from '../handlers/gestures/gesture';
 import { GestureObjects as Gesture } from '../handlers/gestures/gestureObjects';
 import { GestureDetector } from '../handlers/gestures/GestureDetector';
 import {
@@ -202,6 +203,12 @@ export interface SwipeableProps
    * apply `flex: 1`
    */
   childrenContainerStyle?: StyleProp<ViewStyle>;
+
+  /**
+   * An array of gesture objects containing the configuration and callbacks to be
+   * used with the swipeable's gesture handler.
+   */
+  simultaneousWithExternalGestures?: Exclude<GestureRef, number>[];
 }
 
 export interface SwipeableMethods {
@@ -247,6 +254,7 @@ const Swipeable = forwardRef<SwipeableMethods, SwipeableProps>(
       onSwipeableClose,
       renderLeftActions,
       renderRightActions,
+      simultaneousWithExternalGestures,
       ...remainingProps
     } = props;
 
@@ -686,7 +694,10 @@ const Swipeable = forwardRef<SwipeableMethods, SwipeableProps>(
           )
           .onFinalize(() => {
             dragStarted.value = false;
-          }),
+          })
+          .simultaneousWithExternalGesture(
+            ...(simultaneousWithExternalGestures ?? [])
+          ),
       [
         dragOffsetFromLeftEdge,
         dragOffsetFromRightEdge,
@@ -700,6 +711,7 @@ const Swipeable = forwardRef<SwipeableMethods, SwipeableProps>(
         updateAnimatedEvent,
         updateElementWidths,
         userDrag,
+        simultaneousWithExternalGestures,
       ]
     );