Gestures

React Native Gesture Handler

Software Mansion's production gesture patterns for React Native using Gesture Handler. Never suggest PanResponder when RNGH is available -- it runs on the JS thread and is effectively deprecated.

Version Decision Tree

Check package.json - "react-native-gesture-handler" version   │   ├── user asks to migrate v2 -> v3   │   → webfetch https://docs.swmansion.com/react-native-gesture-handler/docs/guides/upgrading-to-3   ├── starts with "2." → use builder API (Gesture.Pan(), Gesture.Simultaneous(), useMemo)   └── starts with "3." → use hook API (usePanGesture(), useSimultaneousGestures())

Key API Differences (v2 vs v3)

Critical Rules

GestureHandlerRootView is mandatory -- GestureDetector will crash at runtime without it as an ancestor. Place it as close to the app root as possible. With Expo Router, wrap <Stack /> in the root _layout.tsx:

// app/_layout.tsximport { Stack } from 'expo-router';import { GestureHandlerRootView } from 'react-native-gesture-handler';
export default function RootLayout() {  return (    <GestureHandlerRootView>      <Stack />    </GestureHandlerRootView>  );}

With React Navigation (no Expo Router), wrap the <NavigationContainer> children. With bare React Native, wrap the app root component. Nested GestureHandlerRootViews are ignored -- only the topmost instance is used. Default style is { flex: 1 }.

v2: useMemo every gesture -- without it, gesture objects recreate on every render, causing recognizers to re-attach and lose state:

const pan = useMemo(() => Gesture.Pan().onBegin(...).onUpdate(...).onEnd(...), []);

v3 hook API handles memoization internally, but the input object must be memoized for it to work correctly.

Never call JS-thread functions directly from gesture callbacks -- when Reanimated is installed, gesture callbacks run on the UI thread (workletized). Calling any non-worklet function (state setters, navigation, audio APIs, native module methods, useCallback handlers) directly from a gesture callback crashes with "Tried to synchronously call a non-worklet function on the UI thread". Wrap every JS-thread call in scheduleOnRN from react-native-worklets:

import { scheduleOnRN } from 'react-native-worklets';
// WRONG -- crashes: calling JS function directly from UI threadconst gesture = useMemo(() =>  Gesture.Pan().onUpdate((e) => {    handleTouch(e.absoluteX, e.absoluteY); // non-worklet function  }),[]);
// CORRECT -- schedules JS function on RN threadconst gesture = useMemo(() =>  Gesture.Pan().onUpdate((e) => {    scheduleOnRN(handleTouch, e.absoluteX, e.absoluteY);  }),[]);

This applies to all gesture callback types including onTouchesDown, onTouchesMove, onTouchesUp, onStart, onUpdate, onEnd, etc. The only code safe to run directly is worklet-compatible code (shared value mutations, other worklet functions).

Scroll containers -- import ScrollView/FlatList from react-native-gesture-handler, not react-native. Use RectButton (v2) or Touchable (v3) for tappable items inside scroll containers:

import { ScrollView, FlatList, RectButton, Touchable } from 'react-native-gesture-handler';

Never mix React Native touch handlers with RNGH in the same component tree -- causes double-tap bugs and gesture conflicts. Pick one system per app.

Callbacks are auto-workletized -- do not add 'worklet'; to callbacks passed directly (inline) to gesture hooks/builders. The Babel plugin handles this. Only add 'worklet'; to standalone functions assigned to variables before being passed as callbacks.

References

Load at most one reference file per question. For API signatures and config options, webfetch the documentation pages linked in each reference file.