Add description to averageTouches in the documentation (#2352)

## Description Description for `averageTouches` modifier (new API) and `avgTouches` prop (old API) was missing, this PR adds it.
software-mansion · Aug 9, 2023 · 6db514d · 6db514d
1 parent 4e5bf49
commit 6db514d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/docs/api/gestures/pan-gesture.md b/docs/docs/api/gestures/pan-gesture.md
@@ -80,6 +80,8 @@ If only one number `p` is given a range of `(-inf, p)` will be used if `p` is hi
 
 ### `averageTouches(value: boolean)` (Android only)
 
+Android, by default, will calculate translation values based on the position of the leading pointer (the first one that was placed on the screen). This modifier allows that behavior to be changed to the one that is default on iOS - the averaged position of all active pointers will be used to calculate the translation values.
+
 ### `enableTrackpadTwoFingerGesture(value: boolean)` (iOS only)
 
 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.

diff --git a/docs/docs/gesture-handlers/api/pan-gh.md b/docs/docs/gesture-handlers/api/pan-gh.md
@@ -121,6 +121,8 @@ Minimum distance along Y (in points) axis the finger (or multiple finger) need t
 
 ### `avgTouches` (Android only)
 
+Android, by default, will calculate translation values based on the position of the leading pointer (the first one that was placed on the screen). This prop allows that behavior to be changed to the one that is default on iOS - the averaged position of all active pointers will be used to calculate the translation values.
+
 ### `enableTrackpadTwoFingerGesture` (iOS only)
 
 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.