Skip to content

Commit 6db514d

Browse files
authored
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.
1 parent 4e5bf49 commit 6db514d

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/docs/api/gestures/pan-gesture.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ If only one number `p` is given a range of `(-inf, p)` will be used if `p` is hi
8080

8181
### `averageTouches(value: boolean)` (Android only)
8282

83+
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.
84+
8385
### `enableTrackpadTwoFingerGesture(value: boolean)` (iOS only)
8486

8587
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.

docs/docs/gesture-handlers/api/pan-gh.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ Minimum distance along Y (in points) axis the finger (or multiple finger) need t
121121

122122
### `avgTouches` (Android only)
123123

124+
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.
125+
124126
### `enableTrackpadTwoFingerGesture` (iOS only)
125127

126128
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.

0 commit comments

Comments
 (0)