[docs] Gesture hooks #3868

m-bert · 2025-12-09T17:12:09Z

Description

This PR sets the base for V3 documentation:

Moves API v2 to versioned docs
Adds documentation for new hooks

Test plan

Read docs 🤓

m-bert · 2025-12-16T14:44:17Z

CI fails because of broken links, I'll fix them, but you can still share your thoughts about the structure/content.

j-piasecki · 2025-12-17T09:54:37Z

packages/docs-gesture-handler/docs/gestures/_shared/base-continuous-gesture-callbacks.mdx

+### Callbacks common to all continuous gestures:
+
+### onUpdate
+
+{
+<CodeBlock className="language-ts">
+    {`onUpdate: (event: ${props.gesture}HandlerData) => void`}
+</CodeBlock>
+}
+
+Set the callback that is being called every time the gesture receives an update while it's active.


I'm not sure it matters (to the end user) that onUpdate is on all continuous gestures. Can this be moved to the single callbacks file, which will get isContinuous as a prop and render this when true? Or maybe just removing the secondary headers would be enough?

Currently the sidebar is a bit weird due to the secondary headers:

Removed secondary headers in 6d2da5a

j-piasecki · 2025-12-17T09:54:56Z

packages/docs-gesture-handler/docs/gestures/_shared/base-continuous-gesture-config.md

@@ -1,5 +1,9 @@
 ### Properties common to all continuous gestures:


Same as above

j-piasecki · 2025-12-17T09:58:23Z

packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.md

@@ -1,19 +1,48 @@
 ### Properties common to all gestures:


Same-ish as above. Single file won't work here for sure, but removing the secondary headers would clean it up I think.

We could also go for the consistent ordering:

Gesture-specific fields

Continous fields

Common fields

Well, the order seems to be consistent but ok, we can move continuous field above. f90b378

j-piasecki · 2025-12-17T09:59:08Z

packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.md

+### enabled
+
+```ts
+enabled: boolean | SharedValue<boolean>;


Can SharedValue link to Reanimated docs about shared value, or is the technology not here yet?

If you mean SharedValue inside

```ts

then I'm afraid that technology is not here yet 😞

... but we can add a reference to it below (though it might be too redundant to do).

Let me know what you think about 41f7a4f (cc. @akwasniewski)

Not ideal, but since we can't add it in ```ts``` it is the best we can do.

j-piasecki · 2025-12-17T09:59:46Z

packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.md

+### hitSlop
+
+```ts
+hitSlop: HitSlop | SharedValue<HitSlop>;


Does this actually work with SharedValue like this?

That's something that I've mentioned in the docs thread in roadmap. For now there is a TS problem. It should work though (but we might rethink if it is a good idea).

packages/docs-gesture-handler/docs/gestures/use-rotation-gesture.mdx

j-piasecki · 2025-12-17T11:09:04Z

packages/docs-gesture-handler/docs/gestures/use-rotation-gesture.mdx

+
+## Event data
+
+### Event attributes specific to `RotationGesture`:


rotationChange is missing

packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx

packages/docs-gesture-handler/docs/guides/testing.md

packages/docs-gesture-handler/docs/under-the-hood/state.md

packages/docs-gesture-handler/docs/gestures/use-pan-gesture.mdx

packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx

...ages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-config.md

packages/docs-gesture-handler/docs/gestures/use-native-gesture.mdx

packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx

packages/docs-gesture-handler/docs/gestures/gesture-composition.md

m-bert added 8 commits December 9, 2025 18:11

Pan gesture

4e3e30f

Merge branch 'next' into @mbert/docs-v3

7ac164d

Finish (?) Pan

203131e

Tap

db99336

Long press

f01bd66

Rotation

5490439

Pinch

ded8083

Fling

e38591c

m-bert changed the title ~~[docs] Pan gesture~~ [docs] Gesture hooks Dec 10, 2025

m-bert added 12 commits December 10, 2025 18:23

Hover

f338fa7

Native

11c91a7

Manual

37d7438

Fix path

a93970a

Remove cache from workflow

d23e66b

composition

5c0b717

Remove PanHandlerData

f293949

Use correct HandlerData

34a93a5

Merge branch 'next' into @mbert/docs-v3

f4847dc

Merge branch 'next' into @mbert/docs-v3

87a1130

Bye bye API 2

b96d788

Fix hover

cf3f810

m-bert marked this pull request as ready for review December 16, 2025 14:39

m-bert requested review from akwasniewski and j-piasecki December 16, 2025 14:39

m-bert added 2 commits December 16, 2025 16:03

Fix old links

944d689

Another links

d2958e0

j-piasecki reviewed Dec 17, 2025

View reviewed changes

akwasniewski reviewed Dec 18, 2025

View reviewed changes

remove useless prop

d8eaaeb

m-bert added 20 commits December 22, 2025 12:09

Add warning to requireToFail

b2a373e

One composition

d3c7893

Remove outdated info

e96349e

Remove SharedValue notes

cd7c0d6

rephrase exclusive

ca2d46a

Other composition updates

1811c9c

Change reference to example

4fa234f

Change reference to example yet again (manual)

fb8e2ef

Tapp

47da2df

Native on web

c8a4a76

Add missing pan properties

5c3d918

Simplify pinch example

a8c6ccc

scaleChange

421d247

Add pan headers

b14eadf

Rotation gesture changes

b769862

Test id correct prop name

49b1d3e

Add SharedValue info

41f7a4f

Add missing shared value info to long press

1fb9b51

Remove secondary headers

6d2da5a

Change order

f90b378

m-bert requested a review from akwasniewski December 22, 2025 16:50

akwasniewski approved these changes Dec 23, 2025

View reviewed changes

m-bert merged commit ed1b1ef into next Dec 23, 2025
1 check passed

m-bert deleted the @mbert/docs-v3 branch December 23, 2025 08:58

		@@ -1,5 +1,9 @@
		### Properties common to all continuous gestures:


		## Event data

		### Event attributes specific to `RotationGesture`:

Uh oh!

[docs] Gesture hooks #3868

[docs] Gesture hooks #3868

Conversation

m-bert commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test plan

Uh oh!

m-bert commented Dec 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-bert Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-bert Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

m-bert commented Dec 9, 2025 •

edited

Loading

m-bert Dec 22, 2025 •

edited

Loading

m-bert Dec 22, 2025 •

edited

Loading