Skip to content

[General] Hide internal fields from gesture events #3844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 1, 2025
Merged

[General] Hide internal fields from gesture events #3844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04d756b
Hide internal fields from events
j-piasecki Nov 27, 2025
a53ad12
Update api
j-piasecki Dec 1, 2025
f30f2f0
Rename type
j-piasecki Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions packages/react-native-gesture-handler/apple/RNGestureHandlerDetector.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,12 @@ - (void)dispatchGestureEvent:(RNGestureHandlerDetectorEventEmitter::OnGestureHan
- (void)dispatchAnimatedGestureEvent:(RNGestureHandlerDetectorEventEmitter::OnGestureHandlerEvent)event
{
if (_eventEmitter != nullptr) {
std::dynamic_pointer_cast<const RNGestureHandlerDetectorEventEmitter>(_eventEmitter)->onGestureHandlerAnimatedEvent({
.state = event.state,
.handlerTag = event.handlerTag,
.handlerData = event.handlerData,
});
std::dynamic_pointer_cast<const RNGestureHandlerDetectorEventEmitter>(_eventEmitter)
->onGestureHandlerAnimatedEvent({
.state = event.state,
.handlerTag = event.handlerTag,
.handlerData = event.handlerData,
});
Comment on lines +98 to +103
Copy link
Contributor

@m-bert m-bert Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is only formatting, right? Do we want that in this PR?

Copy link
Member Author

@j-piasecki j-piasecki Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't even notice that. It must have been added by lint-staged.

Copy link
Member Author

@j-piasecki j-piasecki Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind it, so I'll leave it up to you.

Copy link
Contributor

@m-bert m-bert Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not to have it here as it will affect blame. But if you leave it it will also be fine.

}
}

Expand Down
4 changes: 2 additions & 2 deletions packages/react-native-gesture-handler/src/components/ReanimatedDrawerLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import {
HitSlop,
} from '../handlers/gestureHandlerCommon';
import {
PanGestureStateChangeEvent,
PanGestureEvent,
usePanGesture,
useTapGesture,
} from '../v3/hooks/gestures';
Expand Down Expand Up @@ -434,7 +434,7 @@ const DrawerLayout = forwardRef<DrawerLayoutMethods, DrawerLayoutProps>(
);

const handleRelease = useCallback(
(event: PanGestureStateChangeEvent) => {
(event: PanGestureEvent) => {
'worklet';
let { translationX: dragX, velocityX, x: touchX } = event;

Expand Down
9 changes: 4 additions & 5 deletions ...s/react-native-gesture-handler/src/components/ReanimatedSwipeable/ReanimatedSwipeable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ import {
SwipeDirection,
} from './ReanimatedSwipeableProps';
import {
PanGestureStateChangeEvent,
PanGestureUpdateEvent,
PanGestureEvent,
usePanGesture,
useTapGesture,
} from '../../v3/hooks/gestures';
Expand Down Expand Up @@ -403,7 +402,7 @@ const Swipeable = (props: SwipeableProps) => {
);

const handleRelease = useCallback(
(event: PanGestureStateChangeEvent) => {
(event: PanGestureEvent) => {
'worklet';
const { velocityX } = event;
userDrag.value = event.translationX;
Expand Down Expand Up @@ -477,7 +476,7 @@ const Swipeable = (props: SwipeableProps) => {
block: blocksExternalGesture,
hitSlop: hitSlop,
onActivate: updateElementWidths,
onUpdate: (event: PanGestureUpdateEvent) => {
onUpdate: (event: PanGestureEvent) => {
'worklet';
userDrag.value = event.translationX;

Expand All @@ -501,7 +500,7 @@ const Swipeable = (props: SwipeableProps) => {

updateAnimatedEvent();
},
onDeactivate: (event: PanGestureStateChangeEvent) => {
onDeactivate: (event: PanGestureEvent) => {
'worklet';
handleRelease(event);
},
Expand Down
25 changes: 13 additions & 12 deletions packages/react-native-gesture-handler/src/v3/hooks/callbacks/stateChangeHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
StateChangeEventWithHandlerData,
} from '../../types';
import {
flattenEvent,
flattenAndFilterEvent,
isEventForHandlerWithTag,
maybeExtractNativeEvent,
runCallback,
Expand All @@ -24,22 +24,23 @@ export function getStateChangeHandler<THandlerData>(
const eventWithData = maybeExtractNativeEvent(
sourceEvent
) as GestureStateChangeEventWithHandlerData<THandlerData>;
const event = flattenEvent(eventWithData);
const event = flattenAndFilterEvent(eventWithData);

if (!isEventForHandlerWithTag(handlerTag, event)) {
if (!isEventForHandlerWithTag(handlerTag, eventWithData)) {
return;
}

if (event.oldState === State.UNDETERMINED && event.state === State.BEGAN) {
const { state, oldState } = eventWithData;

if (oldState === State.UNDETERMINED && state === State.BEGAN) {
runCallback(CALLBACK_TYPE.BEGAN, callbacks, event);
} else if (
(event.oldState === State.BEGAN ||
event.oldState === State.UNDETERMINED) &&
event.state === State.ACTIVE
(oldState === State.BEGAN || oldState === State.UNDETERMINED) &&
state === State.ACTIVE
) {
runCallback(CALLBACK_TYPE.START, callbacks, event);
} else if (event.oldState !== event.state && event.state === State.END) {
if (event.oldState === State.ACTIVE) {
} else if (oldState !== state && state === State.END) {
if (oldState === State.ACTIVE) {
runCallback(CALLBACK_TYPE.END, callbacks, event, true);
}
runCallback(CALLBACK_TYPE.FINALIZE, callbacks, event, true);
Expand All @@ -48,10 +49,10 @@ export function getStateChangeHandler<THandlerData>(
context.lastUpdateEvent = undefined;
}
} else if (
(event.state === State.FAILED || event.state === State.CANCELLED) &&
event.state !== event.oldState
(state === State.FAILED || state === State.CANCELLED) &&
state !== oldState
) {
if (event.oldState === State.ACTIVE) {
if (oldState === State.ACTIVE) {
runCallback(CALLBACK_TYPE.END, callbacks, event, false);
}
runCallback(CALLBACK_TYPE.FINALIZE, callbacks, event, false);
Expand Down
6 changes: 3 additions & 3 deletions packages/react-native-gesture-handler/src/v3/hooks/callbacks/updateHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
UpdateEventWithHandlerData,
} from '../../types';
import {
flattenEvent,
flattenAndFilterEvent,
isEventForHandlerWithTag,
maybeExtractNativeEvent,
runCallback,
Expand All @@ -34,9 +34,9 @@ export function getUpdateHandler<THandlerData>(
)
: eventWithData;

const event = flattenEvent(eventWithChanges);
const event = flattenAndFilterEvent(eventWithChanges);

if (!isEventForHandlerWithTag(handlerTag, event)) {
if (!isEventForHandlerWithTag(handlerTag, eventWithData)) {
return;
}

Expand Down
8 changes: 2 additions & 6 deletions packages/react-native-gesture-handler/src/v3/hooks/gestures/fling/useFlingGesture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ import {
SingleGesture,
SingleGestureName,
WithSharedValue,
GestureStateChangeEvent,
GestureUpdateEvent,
GestureEvent,
} from '../../../types';
import { useGesture } from '../../useGesture';
import { useClonedAndRemappedConfig } from '../../utils';
Expand All @@ -28,10 +27,7 @@ type FlingGestureInternalConfig = BaseDiscreteGestureConfig<
export type FlingGestureConfig =
ExcludeInternalConfigProps<FlingGestureInternalConfig>;

export type FlingGestureStateChangeEvent =
GestureStateChangeEvent<FlingHandlerData>;

export type FlingGestureUpdateEvent = GestureUpdateEvent<FlingHandlerData>;
export type FlingGestureEvent = GestureEvent<FlingHandlerData>;

export type FlingGesture = SingleGesture<
FlingHandlerData,
Expand Down
8 changes: 2 additions & 6 deletions packages/react-native-gesture-handler/src/v3/hooks/gestures/hover/useHoverGesture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import {
HandlerData,
SingleGestureName,
WithSharedValue,
GestureStateChangeEvent,
GestureUpdateEvent,
GestureEvent,
} from '../../../types';
import { useGesture } from '../../useGesture';
import {
Expand Down Expand Up @@ -40,10 +39,7 @@ type HoverGestureInternalConfig = BaseGestureConfig<
export type HoverGestureConfig =
ExcludeInternalConfigProps<HoverGestureInternalConfig>;

export type HoverGestureStateChangeEvent =
GestureStateChangeEvent<HoverHandlerData>;

export type HoverGestureUpdateEvent = GestureUpdateEvent<HoverHandlerData>;
export type HoverGestureEvent = GestureEvent<HoverHandlerData>;

export type HoverGesture = SingleGesture<
HoverHandlerData,
Expand Down
116 changes: 27 additions & 89 deletions packages/react-native-gesture-handler/src/v3/hooks/gestures/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,59 @@
import type { FlingGestureEvent, FlingGesture } from './fling/useFlingGesture';
import type { HoverGestureEvent, HoverGesture } from './hover/useHoverGesture';
import type {
FlingGestureStateChangeEvent,
FlingGestureUpdateEvent,
FlingGesture,
} from './fling/useFlingGesture';
import type {
HoverGestureStateChangeEvent,
HoverGestureUpdateEvent,
HoverGesture,
} from './hover/useHoverGesture';
import type {
LongPressGestureStateChangeEvent,
LongPressGestureUpdateEvent,
LongPressGestureEvent,
LongPressGesture,
} from './longPress/useLongPressGesture';
import type {
ManualGestureStateChangeEvent,
ManualGestureUpdateEvent,
ManualGestureEvent,
ManualGesture,
} from './manual/useManualGesture';
import type {
NativeGestureStateChangeEvent,
NativeGestureUpdateEvent,
NativeGestureEvent,
NativeGesture,
} from './native/useNativeGesture';
import type { PanGestureEvent, PanGesture } from './pan/usePanGesture';
import type { PinchGestureEvent, PinchGesture } from './pinch/usePinchGesture';
import type {
PanGestureStateChangeEvent,
PanGestureUpdateEvent,
PanGesture,
} from './pan/usePanGesture';
import type {
PinchGestureStateChangeEvent,
PinchGestureUpdateEvent,
PinchGesture,
} from './pinch/usePinchGesture';
import type {
RotationGestureStateChangeEvent,
RotationGestureUpdateEvent,
RotationGestureEvent,
RotationGesture,
} from './rotation/useRotationGesture';
import type {
TapGestureStateChangeEvent,
TapGestureUpdateEvent,
TapGesture,
} from './tap/useTapGesture';
import type { TapGestureEvent, TapGesture } from './tap/useTapGesture';

export type { TapGestureConfig } from './tap/useTapGesture';
export type { TapGesture, TapGestureStateChangeEvent, TapGestureUpdateEvent };
export type { TapGesture, TapGestureEvent };
export { useTapGesture } from './tap/useTapGesture';

export type { FlingGestureConfig } from './fling/useFlingGesture';
export type {
FlingGesture,
FlingGestureStateChangeEvent,
FlingGestureUpdateEvent,
};
export type { FlingGesture, FlingGestureEvent };
export { useFlingGesture } from './fling/useFlingGesture';

export type { LongPressGestureConfig } from './longPress/useLongPressGesture';
export type {
LongPressGesture,
LongPressGestureStateChangeEvent,
LongPressGestureUpdateEvent,
};
export type { LongPressGesture, LongPressGestureEvent };
export { useLongPressGesture } from './longPress/useLongPressGesture';

export type { PinchGestureConfig } from './pinch/usePinchGesture';
export type {
PinchGesture,
PinchGestureStateChangeEvent,
PinchGestureUpdateEvent,
};
export type { PinchGesture, PinchGestureEvent };
export { usePinchGesture } from './pinch/usePinchGesture';

export type { RotationGestureConfig } from './rotation/useRotationGesture';
export type {
RotationGesture,
RotationGestureStateChangeEvent,
RotationGestureUpdateEvent,
};
export type { RotationGesture, RotationGestureEvent };
export { useRotationGesture } from './rotation/useRotationGesture';

export type { HoverGestureConfig } from './hover/useHoverGesture';
export type {
HoverGesture,
HoverGestureStateChangeEvent,
HoverGestureUpdateEvent,
};
export type { HoverGesture, HoverGestureEvent };
export { useHoverGesture } from './hover/useHoverGesture';

export type { ManualGestureConfig } from './manual/useManualGesture';
export type {
ManualGesture,
ManualGestureStateChangeEvent,
ManualGestureUpdateEvent,
};
export type { ManualGesture, ManualGestureEvent };
export { useManualGesture } from './manual/useManualGesture';

export type { NativeViewGestureConfig } from './native/useNativeGesture';
export type {
NativeGesture,
NativeGestureStateChangeEvent,
NativeGestureUpdateEvent,
};
export type { NativeGesture, NativeGestureEvent };
export { useNativeGesture } from './native/useNativeGesture';

export type { PanGestureConfig } from './pan/usePanGesture';
export type { PanGesture, PanGestureStateChangeEvent, PanGestureUpdateEvent };
export type { PanGesture, PanGestureEvent };
export { usePanGesture } from './pan/usePanGesture';

export type SingleGesture =
Expand All @@ -119,22 +67,12 @@ export type SingleGesture =
| NativeGesture
| PanGesture;

export type SingleGestureStateChangeEvent =
| TapGestureStateChangeEvent
| FlingGestureStateChangeEvent
| LongPressGestureStateChangeEvent
| RotationGestureStateChangeEvent
| HoverGestureStateChangeEvent
| ManualGestureStateChangeEvent
| NativeGestureStateChangeEvent
| PanGestureStateChangeEvent;

export type SingleGestureUpdateEvent =
| TapGestureUpdateEvent
| FlingGestureUpdateEvent
| LongPressGestureUpdateEvent
| RotationGestureUpdateEvent
| HoverGestureUpdateEvent
| ManualGestureUpdateEvent
| NativeGestureUpdateEvent
| PanGestureUpdateEvent;
export type SingleGestureEvent =
| TapGestureEvent
| FlingGestureEvent
| LongPressGestureEvent
| RotationGestureEvent
| HoverGestureEvent
| ManualGestureEvent
| NativeGestureEvent
| PanGestureEvent;
9 changes: 2 additions & 7 deletions packages/react-native-gesture-handler/src/v3/hooks/gestures/longPress/useLongPressGesture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ import {
SingleGesture,
SingleGestureName,
WithSharedValue,
GestureStateChangeEvent,
GestureUpdateEvent,
GestureEvent,
} from '../../../types';
import { useGesture } from '../../useGesture';
import { useClonedAndRemappedConfig } from '../../utils';
Expand Down Expand Up @@ -37,11 +36,7 @@ type LongPressGestureInternalConfig = BaseDiscreteGestureConfig<
LongPressGestureInternalProperties
>;

export type LongPressGestureStateChangeEvent =
GestureStateChangeEvent<LongPressHandlerData>;

export type LongPressGestureUpdateEvent =
GestureUpdateEvent<LongPressHandlerData>;
export type LongPressGestureEvent = GestureEvent<LongPressHandlerData>;

export type LongPressGesture = SingleGesture<
LongPressHandlerData,
Expand Down
7 changes: 2 additions & 5 deletions packages/react-native-gesture-handler/src/v3/hooks/gestures/manual/useManualGesture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ import {
ExcludeInternalConfigProps,
SingleGesture,
SingleGestureName,
GestureStateChangeEvent,
GestureUpdateEvent,
GestureEvent,
} from '../../../types';
import { useGesture } from '../../useGesture';
import { useClonedAndRemappedConfig } from '../../utils';
Expand All @@ -22,9 +21,7 @@ type ManualGestureInternalConfig = BaseGestureConfig<
export type ManualGestureConfig =
ExcludeInternalConfigProps<ManualGestureInternalConfig>;

export type ManualGestureStateChangeEvent =
GestureStateChangeEvent<ManualHandlerData>;
export type ManualGestureUpdateEvent = GestureUpdateEvent<ManualHandlerData>;
export type ManualGestureEvent = GestureEvent<ManualHandlerData>;

export type ManualGesture = SingleGesture<
ManualHandlerData,
Expand Down
Loading
Loading