Add missing types #3731

akwasniewski · 2025-10-03T10:56:03Z

Description

While writing examples I noticed that some types would be useful. This includes types for each gesture and their events. This PR adds those types.

Important: The v3 gesture types take over the names of old v2 types, the v2 types are getting a Legacy prefix. This change will have to be added to the migration guide. Added this as a task to roadmap.

Test plan

yarn lint-js

m-bert

Looks ok. Do we need SingleGestureType exported?

j-piasecki · 2025-10-03T14:38:32Z

packages/react-native-gesture-handler/src/index.ts

+export {
+  SingleGestureName,
+  SingleGestureType,
+  ComposedGesture as ComposedGestureType,


Hmm, what do you think about going in the other direction and exporting SingleGesture, LongPressGesture, ...?

That will conflict with the API v2, so we may want to rename those and keep that in mind for the migration guide.

Yeah, that would be prefarable, and was my first choice, but I didn't want to conflict with v2 api. If you think it is Ok I will gladly change it.

Yeah, I think we can rename the old types to something else to free up the "makes sense" names for the future. We would have to include that in the migration guide.

I'll just point out that we should write it somewhere in case we forget. Not sure if doing TODO comment` is the best, but but we could include it in the roadmap.

j-piasecki · 2025-10-03T14:39:06Z

packages/react-native-gesture-handler/src/index.ts


-export { SingleGestureName } from './v3/types';
+export {
+  SingleGestureName,


Why is that needed?

SingleGestureName? I'm preety sure it is no longer needed after we added dedicated gesture hooks, am I correct cc @m-bert? I could remove it in this PR

Yes, I think it is no longer required. It was with useGesture but now it is only internal (but please make sure that it's true before removing it 😅)

Removed it in c7a25ef

j-piasecki · 2025-10-03T14:40:24Z

packages/react-native-gesture-handler/src/v3/types.ts

  gestureRelations: GestureRelations;
 };

+export type SingleGestureType = SingleGesture<unknown, unknown>;


What do you think about a union: TapGestureType | PanGestureType | ...

It would have to be defined elsewhere, though.

Great idea, done in 43bd77d

akwasniewski · 2025-10-03T14:53:25Z

Looks ok. Do we need SingleGestureType exported?

I figured there is a need for a more general type than handlers corresponding to each gesture, so the user doesn't have to do PanGesture | TapGesture | .... Gesture and GestureType were taken so I figured I can stick with SingleGesture name

m-bert · 2025-10-06T06:45:40Z

packages/react-native-gesture-handler/src/v3/hooks/gestures/index.ts

+import { FlingGestureEvent, FlingGesture } from './useFling';
+import { HoverGestureEvent, HoverGesture } from './useHover';
+import { LongPressGestureEvent, LongPressGesture } from './useLongPress';
+import { ManualGestureEvent, ManualGesture } from './useManual';
+import { NativeGestureEvent, NativeGesture } from './useNative';
+import { PanGestureEvent, PanGesture } from './usePan';
+import { PinchGestureEvent, PinchGesture } from './usePinch';
+import { RotationGestureEvent, RotationGesture } from './useRotation';
+import { TapGestureEvent, TapGesture } from './useTap';


If this imports only types, please use import type instead of only import

Ok, done in 704d604

m-bert · 2025-10-06T06:54:51Z

packages/react-native-gesture-handler/src/index.ts

+export {
+  SingleGestureName,
+  SingleGestureType,
+  ComposedGesture as ComposedGestureType,


I'll just point out that we should write it somewhere in case we forget. Not sure if doing TODO comment` is the best, but but we could include it in the roadmap.

m-bert · 2025-10-07T08:46:44Z

packages/react-native-gesture-handler/src/v3/hooks/gestures/useFling.ts

+export type FlingGestureEvent =
+  | GestureStateChangeEvent<FlingHandlerData>
+  | GestureUpdateEvent<FlingHandlerData>;


Do we actually want to combine these? At the end of the day, those events are accessed in different callbacks

You are right, it is better to separate it. Done in 5113634

akwasniewski · 2025-10-13T10:33:03Z

packages/react-native-gesture-handler/src/index.ts


-export { SingleGestureName } from './v3/types';
+export type { ComposedGesture } from './v3/types';
+export type { GestureTouchEvent as SingleGestureTouchEvent } from './handlers/gestureHandlerCommon';


I added this reexport to keep naming consistency, but I'm not sure whether this is the best approach. Let me know what you think

j-piasecki · 2025-10-13T23:09:34Z

packages/react-native-gesture-handler/src/index.ts

+export type { TapGestureType } from './handlers/gestures/tapGesture';
+export type { PanGestureType } from './handlers/gestures/panGesture';
+export type { FlingGestureType } from './handlers/gestures/flingGesture';
+export type { LongPressGestureType } from './handlers/gestures/longPressGesture';
+export type { PinchGestureType } from './handlers/gestures/pinchGesture';
+export type { RotationGestureType } from './handlers/gestures/rotationGesture';
+export type { ForceTouchGestureType } from './handlers/gestures/forceTouchGesture';
+export type { ManualGestureType } from './handlers/gestures/manualGesture';
+export type { HoverGestureType } from './handlers/gestures/hoverGesture';
 export type {
-  ComposedGestureType as ComposedGesture,
-  RaceGestureType as RaceGesture,
-  SimultaneousGestureType as SimultaneousGesture,
-  ExclusiveGestureType as ExclusiveGesture,
+  ComposedGestureType,
+  RaceGestureType,
+  SimultaneousGestureType,
+  ExclusiveGestureType,


Not sure about that, TapGestureType may still be confused with TapGesture. What about OldTapGesture / LegacyTapGesture?

Ok, changed it to LegacyTapGesture, though I'm not sure it is the best name.

Legacy*Gesture sounds fine 😅

m-bert · 2025-10-15T16:05:59Z

packages/react-native-gesture-handler/src/v3/hooks/gestures/fling/useFling.ts

+export type FlingGestureStateChangeEvent =
+  GestureStateChangeEvent<FlingHandlerData>;
+export type FlingGestureUpdateEvent = GestureUpdateEvent<FlingHandlerData>;


Maybe we could move it (along with FlingHandlerData to FlingProperties file (and probably rename it so it would make sense).

But this one is also fine, if we decide to change it we can do it later 😅

akwasniewski and others added 2 commits October 3, 2025 12:47

add missing types

3cb1164

Merge branch 'next' into @akwasniewski/add-missing-types

a26c22d

akwasniewski marked this pull request as draft October 3, 2025 11:01

addded type suffix

052bfb7

akwasniewski marked this pull request as ready for review October 3, 2025 11:24

exporting single and composed gesture types

652fe3f

akwasniewski requested review from j-piasecki and m-bert October 3, 2025 11:50

m-bert reviewed Oct 3, 2025

View reviewed changes

j-piasecki reviewed Oct 3, 2025

View reviewed changes

akwasniewski added 2 commits October 3, 2025 17:11

SingleGestureType as a union

43bd77d

new api gets better names

2b291b6

m-bert reviewed Oct 6, 2025

View reviewed changes

akwasniewski and others added 6 commits October 6, 2025 10:47

import, export type

704d604

update types in tests and examples

4b3451d

Merge branch 'next' into @akwasniewski/add-missing-types

212bbc2

export correct types

679ab46

fix wrong import

f92baae

more specific export

762c71c

m-bert mentioned this pull request Oct 6, 2025

Filter config #3710

Merged

even more specific type

fb3be0e

m-bert reviewed Oct 7, 2025

View reviewed changes

akwasniewski added 3 commits October 13, 2025 11:58

not exporting singlegesturename

c7a25ef

separate update and state change types

5113634

exporting touch event

cc68f4c

akwasniewski commented Oct 13, 2025

View reviewed changes

j-piasecki reviewed Oct 13, 2025

View reviewed changes

akwasniewski added 2 commits October 14, 2025 14:29

Legacy prefix

2633ba1

Merge branch 'next' into @akwasniewski/add-missing-types

774002f

j-piasecki approved these changes Oct 15, 2025

View reviewed changes

m-bert approved these changes Oct 15, 2025

View reviewed changes

Merge branch 'next' into @akwasniewski/add-missing-types

7960b62

akwasniewski merged commit 1df7e30 into next Oct 16, 2025
4 checks passed

akwasniewski deleted the @akwasniewski/add-missing-types branch October 16, 2025 06:10

Uh oh!

Add missing types #3731

Add missing types #3731

Uh oh!

Conversation

akwasniewski commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test plan

Uh oh!

m-bert left a comment

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!

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!

akwasniewski commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

akwasniewski commented Oct 3, 2025 •

edited

Loading

akwasniewski commented Oct 3, 2025 •

edited

Loading