@sigx/lynx-gestures
v0.26.0
Published
Gesture system for sigx-lynx - declarative composables for tap, pan, pinch, swipe, long press
Maintainers
Readme
@sigx/lynx-gestures
Declarative, frame-locked gesture and animation primitives for SignalX on Lynx. Touch handlers, drag/swipe components, and animation linkage all run on the platform's main UI thread — your gestures track the finger at the display refresh rate even when the JS thread is busy fetching, parsing, or re-rendering.
📚 Documentation
Full guides, component & hook reference, animation mappers and live examples → sigx.dev/lynx/modules/gestures/overview
Why it's interesting
- Built-in gesture components —
<Pressable>,<Draggable>,<Swipeable>,<ScrollView>,<Swiper>,<PinchRotate>— drop in for instant 60/120 fps interactions, no worklet plumbing in user code. - Sheet coordination — a vertical
<ScrollView>inside a@sigx/lynx-navigationbottom sheet auto-adopts the sheet'sScrollDragHost: sheet drags and content scrolling arbitrate like a native bottom sheet (scroll locked below the max detent; pull-down-from-top collapses the sheet), with no wiring in user code. - Main-Thread Scripting under the hood — touch handlers, transform updates, and visual feedback run on Lynx's main thread (Lepus), so gestures don't block on your background JS and don't pay a thread crossing per touchmove.
- Native pinch & rotation —
<PinchRotate>wraps a native<sigx-pinch>element that attaches the platform's own recognizers (UIKitUIPinchGestureRecognizer/UIRotationGestureRecognizer, AndroidScaleGestureDetector+ a rotation tracker) to its backing view and applies the transform on the UI thread. Lynx's gesture arena reserves the pinch/rotation enum slots but ships no handler for them in any released version, soGesture.Pinch()/Gesture.Rotation()never fire on native — this is the real thing. Requiressigx prebuild(it's a native element). - Native touch guard —
<TouchGuard>(and the raw<sigx-touch-guard>tag) consumes the platform touch stream, fixing the Android overlay fall-through where a native input (EditText) under acatchtapdim still grabs focus + keyboard. - Cross-thread observability — pass a
SharedValueto a gesture component and read its live position reactively on the background thread via a SignalXeffect, without injecting BG into the gesture hot path.
Install
npm install @sigx/lynx-gesturesRequires
@sigx/lynxas a peer dependency. The build pipeline (@sigx/lynx-plugin) handles the'main thread'worklet transform automatically — including for this package's pre-built dist when installed via npm or pnpm.
A taste
import { signal, component, useSharedValue } from '@sigx/lynx';
import { Pressable, Draggable, Swipeable } from '@sigx/lynx-gestures';
const App = component(() => {
const taps = signal(0);
const dragX = useSharedValue(0);
return () => (
<view>
<Pressable
pressedOpacity={0.5}
pressedScale={0.95}
onPress={() => { taps.value++; }}
style={{ width: '100px', height: '100px', backgroundColor: '#3b82f6' }}
/>
<Draggable
translateX={dragX}
snapBack
onDragEnd={(e) => console.log('released at', e.x, e.y)}
style={{ width: '90px', height: '90px', backgroundColor: '#a855f7' }}
/>
<text>BG sees x = {dragX.value}</text>
</view>
);
});Native pinch & rotate
<PinchRotate> gives you a real two-finger pinch-zoom + twist backed by the platform's own recognizers. The transform is applied natively (no JS/thread hop), and change/start/end report the live scale/rotation for app logic. It's also controlled — drive scale/rotation from a signal (e.g. a slider) on hosts without multi-touch.
import { signal, component } from '@sigx/lynx';
import { PinchRotate } from '@sigx/lynx-gestures';
const Photo = component(() => {
const scale = signal(1);
return () => (
<PinchRotate maxScale={5} scale={scale.value} onChange={(e) => { scale.value = e.scale; }}>
<image src="photo.jpg" style={{ width: '240px', height: '240px' }} />
</PinchRotate>
);
});
<PinchRotate>is a native element — runsigx prebuildafter adding this package so the autolinker registers<sigx-pinch>.rotationis in radians. (Lynx's gesture arena ships no pinch/rotation handler, which is why this can't be aGesture.*builder — see signalxjs/lynx#418.)
Native touch guard
What it fixes: on Android, a Lynx catchtap overlay blocks Lynx-level handlers beneath it, but the raw platform touch still falls through to native views — an EditText under an overlay dim receives the touch and grabs focus + keyboard. flatten={false}, catchtouchstart, block-native-event and ignore-focus are all insufficient (the fall-through is in Android's native dispatch, below anything the Lynx event system can veto — signalxjs/lynx#787).
<TouchGuard> renders the native <sigx-touch-guard> element, whose Android view claims the touch target so the stream never reaches native views underneath, while catchtap on the guard itself (and Lynx handlers on its children) keep working. iOS and web overlays don't leak platform touches, so the element is an inert container there — the same JSX works on all platforms.
import { TouchGuard } from '@sigx/lynx-gestures';
<TouchGuard
style={{ position: 'absolute', top: 0, left: 0, right: 0, bottom: 0 }}
onTap={() => dismiss()}
>
{/* optional overlay content */}
</TouchGuard>When to use it: any full-surface overlay that must not let touches reach native inputs beneath it — dims, modal scrims, drawers. Components that render their own overlay root can use the raw tag: TOUCH_GUARD_TAG ('sigx-touch-guard', with a guard-enabled boolean attr) — @sigx/lynx-sheet's backdrop adopts it via its guardTag option.
<TouchGuard>is a native element — runsigx prebuildafter adding this package so the autolinker registers<sigx-touch-guard>.
The cross-thread primitives — useSharedValue, SharedValue, useAnimatedStyle — live in @sigx/lynx since 0.3.0; import them from @sigx/lynx directly. For the full architecture write-up, the component prop tables, animation mappers, range mapping, custom mappers and performance notes, see the docs site.
Related
@sigx/lynx— the framework barrel; import everything from here.@sigx/lynx-runtime-main— main-thread runtime and PAPI integration.@sigx/lynx-plugin— the rspack/rspeedy plugin that runs the worklet transform at build time.@sigx/lynx-motion— spring/tween animation drivers built on the sameSharedValuebridge.
License
MIT
