Document configureGestureHandler

react-navigation · Dec 7, 2024 · fdbf5d6 · fdbf5d6
1 parent 48a6b03
commit fdbf5d6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/versioned_docs/version-7.x/drawer-layout.md b/versioned_docs/version-7.x/drawer-layout.md
@@ -200,11 +200,15 @@ Minimum swipe velocity that should activate opening the drawer. Defaults to `500
 
 This is only supported on iOS and Android.
 
-##### `gestureHandlerProps`
+#### `configureGestureHandler`
 
-Props to pass to the underlying pan gesture handler.
+Callback to configure the underlying [gesture from `react-native-gesture-handler`](https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture). It receives the `gesture` object as an argument:
 
-This is only supported on iOS and Android.
+```js
+configureGestureHandler={({ gesture }) => {
+  return gesture.enableTrackpadTwoFingerGesture(false);
+}}
+```
 
 ##### `children`
 

diff --git a/versioned_docs/version-7.x/drawer-navigator.md b/versioned_docs/version-7.x/drawer-navigator.md
@@ -534,9 +534,15 @@ Color overlay to be displayed on top of the content view when drawer gets open.
 
 Style object for the component wrapping the screen content.
 
-#### `gestureHandlerProps`
+#### `configureGestureHandler`
 
-Props to pass to the underlying pan gesture handler.
+Callback to configure the underlying [gesture from `react-native-gesture-handler`](https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture). It receives the `gesture` object as an argument:
+
+```js
+configureGestureHandler: ({ gesture }) => {
+  return gesture.enableTrackpadTwoFingerGesture(false);
+},
+```
 
 This is not supported on Web.
 

diff --git a/versioned_docs/version-7.x/upgrading-from-6.x.md b/versioned_docs/version-7.x/upgrading-from-6.x.md
@@ -451,7 +451,7 @@ We have removed all of the previously deprecated APIs. These APIs were deprecate
     - `minSwipeDistance` - use `swipeMinDistance` option instead
     - `overlayColor` - use `overlayColor` option instead
     - `statusBarAnimation` - use `drawerStatusBarAnimation` option instead
-    - `gestureHandlerProps` - use `gestureHandlerProps` option instead
+    - `gestureHandlerProps` - use `configureGestureHandler` option instead
 - `@react-navigation/bottom-tabs`
   - Removed `lazy` prop - use `lazy` option instead
   - Removed `tabBarOptions` prop which contained following options: