Skip to content

Commit dfff6e9

Browse files
authored
Rename onTouchesCancelled to onTouchesCancel (#3818)
## Description Renames `onTouchesCancelled` to `onTouchesCancel` to unify the naming convention. Also changes `success` to `didSucceed`, but this change should be transparent, besides code hints. ## Test plan Static checks
1 parent a2216e2 commit dfff6e9

File tree

13 files changed

+24
-25
lines changed

13 files changed

+24
-25
lines changed

packages/react-native-gesture-handler/android/src/main/java/com/swmansion/gesturehandler/core/GestureHandler.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ open class GestureHandler {
537537
}
538538

539539
private fun cancelPointers() {
540-
touchEventType = RNGestureHandlerTouchEvent.EVENT_TOUCH_CANCELLED
540+
touchEventType = RNGestureHandlerTouchEvent.EVENT_TOUCH_CANCEL
541541
changedTouchesPayload = null
542542
extractAllPointersData()
543543

packages/react-native-gesture-handler/android/src/main/java/com/swmansion/gesturehandler/react/events/RNGestureHandlerTouchEvent.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class RNGestureHandlerTouchEvent private constructor() : Event<RNGestureHandlerT
4949
const val EVENT_TOUCH_DOWN = 1
5050
const val EVENT_TOUCH_MOVE = 2
5151
const val EVENT_TOUCH_UP = 3
52-
const val EVENT_TOUCH_CANCELLED = 4
52+
const val EVENT_TOUCH_CANCEL = 4
5353

5454
const val EVENT_NAME = "onGestureHandlerEvent"
5555
const val REANIMATED_EVENT_NAME = "onGestureHandlerReanimatedTouchEvent"

packages/react-native-gesture-handler/apple/RNGHTouchEventType.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ typedef NS_ENUM(NSInteger, RNGHTouchEventType) {
55
RNGHTouchEventTypePointerDown,
66
RNGHTouchEventTypePointerMove,
77
RNGHTouchEventTypePointerUp,
8-
RNGHTouchEventTypeCancelled,
8+
RNGHTouchEventTypePointerCancel,
99
};

packages/react-native-gesture-handler/apple/RNGestureHandlerPointerTracker.mm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ - (void)cancelPointers
228228
}
229229
}
230230

231-
_eventType = RNGHTouchEventTypeCancelled;
231+
_eventType = RNGHTouchEventTypePointerCancel;
232232
_changedPointersData = [[NSArray alloc] initWithObjects:data count:registeredTouches];
233233
[self sendEvent];
234234
_trackedPointersCount = 0;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const TouchEventType = {
33
TOUCHES_DOWN: 1,
44
TOUCHES_MOVE: 2,
55
TOUCHES_UP: 3,
6-
TOUCHES_CANCELLED: 4,
6+
TOUCHES_CANCEL: 4,
77
} as const;
88

99
// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; it can be used as a type and as a value

packages/react-native-gesture-handler/src/handlers/gestures/GestureDetector/useAnimatedGesture.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ function getHandler(
3838
return gesture.onTouchesMove;
3939
case CALLBACK_TYPE.TOUCHES_UP:
4040
return gesture.onTouchesUp;
41-
case CALLBACK_TYPE.TOUCHES_CANCELLED:
41+
case CALLBACK_TYPE.TOUCHES_CANCEL:
4242
return gesture.onTouchesCancelled;
4343
}
4444
}
@@ -54,8 +54,8 @@ function touchEventTypeToCallbackType(
5454
return CALLBACK_TYPE.TOUCHES_MOVE;
5555
case TouchEventType.TOUCHES_UP:
5656
return CALLBACK_TYPE.TOUCHES_UP;
57-
case TouchEventType.TOUCHES_CANCELLED:
58-
return CALLBACK_TYPE.TOUCHES_CANCELLED;
57+
case TouchEventType.TOUCHES_CANCEL:
58+
return CALLBACK_TYPE.TOUCHES_CANCEL;
5959
}
6060
return CALLBACK_TYPE.UNDEFINED;
6161
}

packages/react-native-gesture-handler/src/handlers/gestures/eventReceiver.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export function onGestureHandlerEvent(
9696
case TouchEventType.TOUCHES_UP:
9797
handler.handlers?.onTouchesUp?.(event, manager);
9898
break;
99-
case TouchEventType.TOUCHES_CANCELLED:
99+
case TouchEventType.TOUCHES_CANCEL:
100100
handler.handlers?.onTouchesCancelled?.(event, manager);
101101
break;
102102
}

packages/react-native-gesture-handler/src/handlers/gestures/gesture.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export const CALLBACK_TYPE = {
9696
TOUCHES_DOWN: 7,
9797
TOUCHES_MOVE: 8,
9898
TOUCHES_UP: 9,
99-
TOUCHES_CANCELLED: 10,
99+
TOUCHES_CANCEL: 10,
100100
} as const;
101101

102102
// Allow using CALLBACK_TYPE as object and type
@@ -274,7 +274,7 @@ export abstract class BaseGesture<
274274
onTouchesCancelled(callback: TouchEventHandlerType) {
275275
this.config.needsPointerData = true;
276276
this.handlers.onTouchesCancelled = callback;
277-
this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_CANCELLED] =
277+
this.handlers.isWorklet[CALLBACK_TYPE.TOUCHES_CANCEL] =
278278
this.isWorklet(callback);
279279

280280
return this;

packages/react-native-gesture-handler/src/v3/hooks/utils/eventHandlersUtils.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,13 @@ export function extractUpdateHandlers<THandlerData, TConfig>(
4444
export function extractTouchHandlers<THandlerData, TConfig>(
4545
config: BaseGestureConfig<THandlerData, TConfig>
4646
): GestureCallbacks<THandlerData> {
47-
const { onTouchesDown, onTouchesMove, onTouchesUp, onTouchesCancelled } =
48-
config;
47+
const { onTouchesDown, onTouchesMove, onTouchesUp, onTouchesCancel } = config;
4948

5049
const handlers: GestureCallbacks<THandlerData> = {
5150
...(onTouchesDown ? { onTouchesDown } : {}),
5251
...(onTouchesMove ? { onTouchesMove } : {}),
5352
...(onTouchesUp ? { onTouchesUp } : {}),
54-
...(onTouchesCancelled ? { onTouchesCancelled } : {}),
53+
...(onTouchesCancel ? { onTouchesCancel } : {}),
5554
};
5655

5756
return handlers;
@@ -79,8 +78,8 @@ export function getHandler<THandlerData>(
7978
return callbacks.onTouchesMove;
8079
case CALLBACK_TYPE.TOUCHES_UP:
8180
return callbacks.onTouchesUp;
82-
case CALLBACK_TYPE.TOUCHES_CANCELLED:
83-
return callbacks.onTouchesCancelled;
81+
case CALLBACK_TYPE.TOUCHES_CANCEL:
82+
return callbacks.onTouchesCancel;
8483
}
8584
}
8685

@@ -95,8 +94,8 @@ export function touchEventTypeToCallbackType(
9594
return CALLBACK_TYPE.TOUCHES_MOVE;
9695
case TouchEventType.TOUCHES_UP:
9796
return CALLBACK_TYPE.TOUCHES_UP;
98-
case TouchEventType.TOUCHES_CANCELLED:
99-
return CALLBACK_TYPE.TOUCHES_CANCELLED;
97+
case TouchEventType.TOUCHES_CANCEL:
98+
return CALLBACK_TYPE.TOUCHES_CANCEL;
10099
}
101100
return CALLBACK_TYPE.UNDEFINED;
102101
}

packages/react-native-gesture-handler/src/v3/hooks/utils/eventUtils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export function shouldHandleTouchEvents<THandlerData, TConfig>(
7777
!!config.onTouchesDown ||
7878
!!config.onTouchesMove ||
7979
!!config.onTouchesUp ||
80-
!!config.onTouchesCancelled
80+
!!config.onTouchesCancel
8181
);
8282
}
8383

0 commit comments

Comments
 (0)