Skip to content

Commit 48cb976

Browse files
authored
[General] Rename onStart/onEnd to onActivate/onDeactivate (#3847)
## Description It's easy to confuse `onBegin` with `onStart`, `onEnd` with `onFinalize`, maybe less so, but it can still be confusing. We wanted to rename `onStart` and the replacement was `onActivate`. To show that `onEnd` is complementary to that, this PR also changes it to `onDeactivate`. Let me know what you think. ## Test plan Static checks
1 parent bf76e72 commit 48cb976

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

packages/react-native-gesture-handler/src/components/ReanimatedDrawerLayout.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ const DrawerLayout = forwardRef<DrawerLayoutMethods, DrawerLayoutProps>(
501501

502502
const overlayDismissGesture = useTapGesture({
503503
maxDistance: 25,
504-
onEnd: () => {
504+
onDeactivate: () => {
505505
'worklet';
506506
if (
507507
isDrawerOpen.value &&
@@ -535,7 +535,7 @@ const DrawerLayout = forwardRef<DrawerLayoutMethods, DrawerLayoutProps>(
535535
(drawerOpened
536536
? drawerLockMode !== DrawerLockMode.LOCKED_OPEN
537537
: drawerLockMode !== DrawerLockMode.LOCKED_CLOSED),
538-
onStart: () => {
538+
onActivate: () => {
539539
'worklet';
540540
emitStateChanged(DrawerState.DRAGGING, false);
541541
runOnJS(setDrawerState)(DrawerState.DRAGGING);
@@ -577,7 +577,7 @@ const DrawerLayout = forwardRef<DrawerLayoutMethods, DrawerLayoutProps>(
577577
Extrapolation.CLAMP
578578
);
579579
},
580-
onEnd: handleRelease,
580+
onDeactivate: handleRelease,
581581
});
582582

583583
// When using RTL, row and row-reverse flex directions are flipped.

packages/react-native-gesture-handler/src/components/ReanimatedSwipeable/ReanimatedSwipeable.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ const Swipeable = (props: SwipeableProps) => {
460460
simultaneousWith: simultaneousWithExternalGesture,
461461
requireToFail: requireExternalGestureToFail,
462462
block: blocksExternalGesture,
463-
onStart: () => {
463+
onActivate: () => {
464464
'worklet';
465465
if (rowState.value !== 0) {
466466
close();
@@ -476,7 +476,7 @@ const Swipeable = (props: SwipeableProps) => {
476476
requireToFail: requireExternalGestureToFail,
477477
block: blocksExternalGesture,
478478
hitSlop: hitSlop,
479-
onStart: updateElementWidths,
479+
onActivate: updateElementWidths,
480480
onUpdate: (event: PanGestureUpdateEvent) => {
481481
'worklet';
482482
userDrag.value = event.translationX;
@@ -501,7 +501,7 @@ const Swipeable = (props: SwipeableProps) => {
501501

502502
updateAnimatedEvent();
503503
},
504-
onEnd: (event: PanGestureStateChangeEvent) => {
504+
onDeactivate: (event: PanGestureStateChangeEvent) => {
505505
'worklet';
506506
handleRelease(event);
507507
},

packages/react-native-gesture-handler/src/v3/hooks/callbacks/js/useGestureStateChangeEvent.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ export function useGestureStateChangeEvent<THandlerData, TConfig>(
1212
return useMemo(() => {
1313
const handlers = prepareStateChangeHandlers({
1414
onBegin: config.onBegin,
15-
onStart: config.onStart,
16-
onEnd: config.onEnd,
15+
onActivate: config.onActivate,
16+
onDeactivate: config.onDeactivate,
1717
onFinalize: config.onFinalize,
1818
});
1919
return getStateChangeHandler(handlerTag, handlers, context);
2020
}, [
2121
handlerTag,
2222
config.onBegin,
23-
config.onStart,
24-
config.onEnd,
23+
config.onActivate,
24+
config.onDeactivate,
2525
config.onFinalize,
2626
context,
2727
]);

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ export function prepareStateChangeHandlers<THandlerData>(
1010
callbacks: GestureCallbacks<THandlerData>
1111
): GestureCallbacks<THandlerData> {
1212
'worklet';
13-
const { onBegin, onStart, onEnd, onFinalize } = callbacks;
13+
const { onBegin, onActivate, onDeactivate, onFinalize } = callbacks;
1414

1515
const handlers: GestureCallbacks<THandlerData> = {
1616
...(onBegin ? { onBegin } : {}),
17-
...(onStart ? { onStart } : {}),
18-
...(onEnd ? { onEnd } : {}),
17+
...(onActivate ? { onActivate } : {}),
18+
...(onDeactivate ? { onDeactivate } : {}),
1919
...(onFinalize ? { onFinalize } : {}),
2020
};
2121

@@ -66,11 +66,11 @@ export function getHandler<THandlerData>(
6666
case CALLBACK_TYPE.BEGAN:
6767
return callbacks.onBegin;
6868
case CALLBACK_TYPE.START:
69-
return callbacks.onStart;
69+
return callbacks.onActivate;
7070
case CALLBACK_TYPE.UPDATE:
7171
return callbacks.onUpdate;
7272
case CALLBACK_TYPE.END:
73-
return callbacks.onEnd;
73+
return callbacks.onDeactivate;
7474
case CALLBACK_TYPE.FINALIZE:
7575
return callbacks.onFinalize;
7676
case CALLBACK_TYPE.TOUCHES_DOWN:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ export const HandlerCallbacks = new Set<
3636
keyof Required<GestureCallbacks<unknown>>
3737
>([
3838
'onBegin',
39-
'onStart',
39+
'onActivate',
4040
'onUpdate',
41-
'onEnd',
41+
'onDeactivate',
4242
'onFinalize',
4343
'onTouchesDown',
4444
'onTouchesMove',

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ import { WithSharedValue } from './ReanimatedTypes';
1616

1717
export type GestureCallbacks<THandlerData> = {
1818
onBegin?: (event: GestureStateChangeEvent<THandlerData>) => void;
19-
onStart?: (event: GestureStateChangeEvent<THandlerData>) => void;
20-
onEnd?: (
19+
onActivate?: (event: GestureStateChangeEvent<THandlerData>) => void;
20+
onDeactivate?: (
2121
event: GestureStateChangeEvent<THandlerData>,
2222
didSucceed: boolean
2323
) => void;

0 commit comments

Comments
 (0)