react-native-gesture-handler 2.16.0 → 2.16.1

package/lib/typescript/RNGestureHandlerModule.d.ts

@@ -1,2 +1,15 @@
-import Module from './specs/NativeRNGestureHandlerModule';
-export default Module;
+import React from 'react';
+import type { ActionType } from './ActionType';
+import { Gestures } from './web/Gestures';
+import type { Config } from './web/interfaces';
+declare const _default: {
+    handleSetJSResponder(tag: number, blockNativeResponder: boolean): void;
+    handleClearJSResponder(): void;
+    createGestureHandler<T>(handlerName: keyof typeof Gestures, handlerTag: number, config: T): void;
+    attachGestureHandler(handlerTag: number, newView: any, _actionType: ActionType, propsRef: React.RefObject<unknown>): void;
+    updateGestureHandler(handlerTag: number, newConfig: Config): void;
+    getGestureHandlerNode(handlerTag: number): import("./web/handlers/IGestureHandler").default | import("./web_hammer/NativeViewGestureHandler").default | import("./web_hammer/PanGestureHandler").default | import("./web_hammer/TapGestureHandler").default | import("./web_hammer/LongPressGestureHandler").default | import("./web_hammer/PinchGestureHandler").default | import("./web_hammer/RotationGestureHandler").default | import("./web_hammer/FlingGestureHandler").default;
+    dropGestureHandler(handlerTag: number): void;
+    flushOperations(): void;
+};
+export default _default;

package/lib/typescript/RNGestureHandlerModule.native.d.ts

@@ -0,0 +1,2 @@
+import Module from './specs/NativeRNGestureHandlerModule';
+export default Module;

package/lib/typescript/RNRenderer.d.ts

@@ -1 +1,3 @@
-export { default as RNRenderer } from 'react-native/Libraries/Renderer/shims/ReactNative';
+export declare const RNRenderer: {
+    findHostInstance_DEPRECATED: (_ref: any) => null;
+};

package/lib/typescript/RNRenderer.native.d.ts

@@ -0,0 +1 @@
+export { default as RNRenderer } from 'react-native/Libraries/Renderer/shims/ReactNative';

package/lib/typescript/components/GestureComponents.d.ts

@@ -1,22 +1,8 @@
 import * as React from 'react';
-import { PropsWithChildren, ForwardedRef, RefAttributes, ReactElement } from 'react';
-import { ScrollView as RNScrollView, ScrollViewProps as RNScrollViewProps, Switch as RNSwitch, SwitchProps as RNSwitchProps, TextInput as RNTextInput, TextInputProps as RNTextInputProps, DrawerLayoutAndroid as RNDrawerLayoutAndroid, DrawerLayoutAndroidProps as RNDrawerLayoutAndroidProps, FlatList as RNFlatList, FlatListProps as RNFlatListProps, RefreshControl as RNRefreshControl } from 'react-native';
-import { NativeViewGestureHandlerProps } from '../handlers/NativeViewGestureHandler';
-export declare const RefreshControl: React.ForwardRefExoticComponent<import("react-native").RefreshControlProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
-export type RefreshControl = typeof RefreshControl & RNRefreshControl;
-declare const GHScrollView: React.ForwardRefExoticComponent<RNScrollViewProps & {
-    children?: React.ReactNode;
-} & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
-export declare const ScrollView: React.ForwardRefExoticComponent<RNScrollViewProps & NativeViewGestureHandlerProps & React.RefAttributes<RNScrollView>>;
-export type ScrollView = typeof GHScrollView & RNScrollView;
-export declare const Switch: React.ForwardRefExoticComponent<RNSwitchProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
-export type Switch = typeof Switch & RNSwitch;
-export declare const TextInput: React.ForwardRefExoticComponent<RNTextInputProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
-export type TextInput = typeof TextInput & RNTextInput;
-export declare const DrawerLayoutAndroid: React.ForwardRefExoticComponent<RNDrawerLayoutAndroidProps & {
-    children?: React.ReactNode;
-} & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
-export type DrawerLayoutAndroid = typeof DrawerLayoutAndroid & RNDrawerLayoutAndroid;
-export declare const FlatList: <ItemT = any>(props: React.PropsWithChildren<RNFlatListProps<ItemT> & React.RefAttributes<FlatList<ItemT>> & NativeViewGestureHandlerProps>, ref: React.ForwardedRef<FlatList<ItemT>>) => ReactElement | null;
-export type FlatList<ItemT = any> = typeof FlatList & RNFlatList<ItemT>;
-export {};
+import { FlatListProps } from 'react-native';
+export declare const ScrollView: React.ForwardRefExoticComponent<import("react-native").ScrollViewProps & import("..").NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export declare const Switch: React.ForwardRefExoticComponent<import("react-native").SwitchProps & import("..").NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export declare const TextInput: React.ForwardRefExoticComponent<import("react-native").TextInputProps & import("..").NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export declare const DrawerLayoutAndroid: () => React.JSX.Element;
+export declare const RefreshControl: React.ForwardRefExoticComponent<import("react-native").ViewProps & import("..").NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export declare const FlatList: React.ForwardRefExoticComponent<FlatListProps<unknown> & React.RefAttributes<unknown>>;

package/lib/typescript/components/GestureComponents.native.d.ts

@@ -0,0 +1,22 @@
+import * as React from 'react';
+import { PropsWithChildren, ForwardedRef, RefAttributes, ReactElement } from 'react';
+import { ScrollView as RNScrollView, ScrollViewProps as RNScrollViewProps, Switch as RNSwitch, SwitchProps as RNSwitchProps, TextInput as RNTextInput, TextInputProps as RNTextInputProps, DrawerLayoutAndroid as RNDrawerLayoutAndroid, DrawerLayoutAndroidProps as RNDrawerLayoutAndroidProps, FlatList as RNFlatList, FlatListProps as RNFlatListProps, RefreshControl as RNRefreshControl } from 'react-native';
+import { NativeViewGestureHandlerProps } from '../handlers/NativeViewGestureHandler';
+export declare const RefreshControl: React.ForwardRefExoticComponent<import("react-native").RefreshControlProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export type RefreshControl = typeof RefreshControl & RNRefreshControl;
+declare const GHScrollView: React.ForwardRefExoticComponent<RNScrollViewProps & {
+    children?: React.ReactNode;
+} & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export declare const ScrollView: React.ForwardRefExoticComponent<RNScrollViewProps & NativeViewGestureHandlerProps & React.RefAttributes<RNScrollView>>;
+export type ScrollView = typeof GHScrollView & RNScrollView;
+export declare const Switch: React.ForwardRefExoticComponent<RNSwitchProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export type Switch = typeof Switch & RNSwitch;
+export declare const TextInput: React.ForwardRefExoticComponent<RNTextInputProps & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export type TextInput = typeof TextInput & RNTextInput;
+export declare const DrawerLayoutAndroid: React.ForwardRefExoticComponent<RNDrawerLayoutAndroidProps & {
+    children?: React.ReactNode;
+} & NativeViewGestureHandlerProps & React.RefAttributes<React.ComponentType<any>>>;
+export type DrawerLayoutAndroid = typeof DrawerLayoutAndroid & RNDrawerLayoutAndroid;
+export declare const FlatList: <ItemT = any>(props: React.PropsWithChildren<RNFlatListProps<ItemT> & React.RefAttributes<FlatList<ItemT>> & NativeViewGestureHandlerProps>, ref: React.ForwardedRef<FlatList<ItemT>>) => ReactElement | null;
+export type FlatList<ItemT = any> = typeof FlatList & RNFlatList<ItemT>;
+export {};

package/lib/typescript/components/GestureHandlerButton.d.ts

@@ -1,4 +1,4 @@
-import { HostComponent } from 'react-native';
-import { RawButtonProps } from './GestureButtons';
-declare const _default: HostComponent<RawButtonProps>;
+import * as React from 'react';
+import { View } from 'react-native';
+declare const _default: React.ForwardRefExoticComponent<React.RefAttributes<View>>;
 export default _default;

package/lib/typescript/components/GestureHandlerButton.native.d.ts

@@ -0,0 +1,4 @@
+import { HostComponent } from 'react-native';
+import { RawButtonProps } from './GestureButtons';
+declare const _default: HostComponent<RawButtonProps>;
+export default _default;

package/lib/typescript/getReactNativeVersion.d.ts

@@ -1,4 +1 @@
-export declare function getReactNativeVersion(): {
-    major: number;
-    minor: number;
-};
+export declare function getReactNativeVersion(): void;

package/lib/typescript/getReactNativeVersion.native.d.ts

@@ -0,0 +1,4 @@
+export declare function getReactNativeVersion(): {
+    major: number;
+    minor: number;
+};

package/lib/typescript/getShadowNodeFromRef.d.ts

@@ -1 +1 @@
-export declare function getShadowNodeFromRef(ref: unknown): unknown;
+export declare function getShadowNodeFromRef(_ref: any): null;

package/lib/typescript/getShadowNodeFromRef.native.d.ts

@@ -0,0 +1 @@
+export declare function getShadowNodeFromRef(ref: unknown): unknown;

package/lib/typescript/handlers/PanGestureHandler.d.ts

@@ -103,7 +103,7 @@ export interface PanGestureHandlerProps extends BaseGestureHandlerProps<PanGestu
      * to 0. If only one number `p` is given a range of `(-inf, p)` will be used
      * if `p` is higher or equal to 0 and `(-p, inf)` otherwise.
      */
-    activeOffsetY?: number | number[];
+    activeOffsetY?: number | [activeOffsetYStart: number, activeOffsetYEnd: number];
     /**
      * Range along X axis (in points) where fingers travels without activation of
      * handler. Moving outside of this range implies activation of handler. Range
@@ -112,7 +112,7 @@ export interface PanGestureHandlerProps extends BaseGestureHandlerProps<PanGestu
      * to 0. If only one number `p` is given a range of `(-inf, p)` will be used
      * if `p` is higher or equal to 0 and `(-p, inf)` otherwise.
      */
-    activeOffsetX?: number | number[];
+    activeOffsetX?: number | [activeOffsetXStart: number, activeOffsetXEnd: number];
     /**
      * When the finger moves outside this range (in points) along Y axis and
      * handler hasn't yet activated it will fail recognizing the gesture. Range
@@ -121,7 +121,7 @@ export interface PanGestureHandlerProps extends BaseGestureHandlerProps<PanGestu
      * to 0. If only one number `p` is given a range of `(-inf, p)` will be used
      * if `p` is higher or equal to 0 and `(-p, inf)` otherwise.
      */
-    failOffsetY?: number | number[];
+    failOffsetY?: number | [failOffsetYStart: number, failOffsetYEnd: number];
     /**
      * When the finger moves outside this range (in points) along X axis and
      * handler hasn't yet activated it will fail recognizing the gesture. Range
@@ -130,7 +130,7 @@ export interface PanGestureHandlerProps extends BaseGestureHandlerProps<PanGestu
      * to 0. If only one number `p` is given a range of `(-inf, p)` will be used
      * if `p` is higher or equal to 0 and `(-p, inf)` otherwise.
      */
-    failOffsetX?: number | number[];
+    failOffsetX?: number | [failOffsetXStart: number, failOffsetXEnd: number];
 }
 export declare const panHandlerName = "PanGestureHandler";
 export type PanGestureHandler = typeof PanGestureHandler;

package/lib/typescript/handlers/PressabilityDebugView.d.ts

@@ -1 +1 @@
-export { PressabilityDebugView } from 'react-native/Libraries/Pressability/PressabilityDebug';
+export declare function PressabilityDebugView(): null;

package/lib/typescript/handlers/PressabilityDebugView.native.d.ts

@@ -0,0 +1 @@
+export { PressabilityDebugView } from 'react-native/Libraries/Pressability/PressabilityDebug';

package/lib/typescript/handlers/customDirectEventTypes.d.ts

@@ -1 +1,2 @@
-export { customDirectEventTypes } from 'react-native/Libraries/Renderer/shims/ReactNativeViewConfigRegistry';
+declare const customDirectEventTypes: {};
+export { customDirectEventTypes };

package/lib/typescript/handlers/customDirectEventTypes.native.d.ts

@@ -0,0 +1 @@
+export { customDirectEventTypes } from 'react-native/Libraries/Renderer/shims/ReactNativeViewConfigRegistry';

package/lib/typescript/handlers/gestures/GestureDetector.d.ts

@@ -11,11 +11,47 @@ export type GestureConfigReference = {
     useReanimatedHook: boolean;
 };
 interface GestureDetectorProps {
+    /**
+     * A gesture object containing the configuration and callbacks.
+     * Can be any of:
+     * - base gestures (`Tap`, `Pan`, ...)
+     * - `ComposedGesture` (`Race`, `Simultaneous`, `Exclusive`)
+     */
     gesture: ComposedGesture | GestureType;
     children?: React.ReactNode;
+    /**
+     * #### Web only
+     * This parameter allows to specify which `userSelect` property should be applied to underlying view.
+     * Possible values are `"none" | "auto" | "text"`. Default value is set to `"none"`.
+     */
     userSelect?: UserSelect;
+    /**
+     * #### Web only
+     * Specifies whether context menu should be enabled after clicking on underlying view with right mouse button.
+     * Default value is set to `false`.
+     */
     enableContextMenu?: boolean;
+    /**
+     * #### Web only
+     * This parameter allows to specify which `touchAction` property should be applied to underlying view.
+     * Supports all CSS touch-action values (e.g. `"none"`, `"pan-y"`). Default value is set to `"none"`.
+     */
     touchAction?: TouchAction;
 }
+/**
+ * `GestureDetector` is responsible for creating and updating native gesture handlers based on the config of provided gesture.
+ *
+ * ### Props
+ * - `gesture`
+ * - `userSelect` (**Web only**)
+ * - `enableContextMenu` (**Web only**)
+ * - `touchAction` (**Web only**)
+ *
+ * ### Remarks
+ * - Gesture Detector will use first native view in its subtree to recognize gestures, however if this view is used only to group its children it may get automatically collapsed.
+ * - Using the same instance of a gesture across multiple Gesture Detectors is not possible.
+ *
+ * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture-detector
+ */
 export declare const GestureDetector: (props: GestureDetectorProps) => React.JSX.Element;
 export {};

package/lib/typescript/handlers/gestures/flingGesture.d.ts

@@ -3,7 +3,18 @@ import { FlingGestureConfig, FlingGestureHandlerEventPayload } from '../FlingGes
 export declare class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
     config: BaseGestureConfig & FlingGestureConfig;
     constructor();
+    /**
+     * Determine exact number of points required to handle the fling gesture.
+     * @param pointers
+     */
     numberOfPointers(pointers: number): this;
+    /**
+     * Expressed allowed direction of movement.
+     * Expected values are exported as constants in the Directions object.
+     * Arguments can be combined using `|` operator. Default value is set to `MouseButton.LEFT`.
+     * @param direction
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture/#directionvalue-directions
+     */
     direction(direction: number): this;
 }
 export type FlingGestureType = InstanceType<typeof FlingGesture>;

package/lib/typescript/handlers/gestures/forceTouchGesture.d.ts

@@ -7,8 +7,22 @@ export type ForceTouchGestureChangeEventPayload = {
 export declare class ForceTouchGesture extends ContinousBaseGesture<ForceTouchGestureHandlerEventPayload, ForceTouchGestureChangeEventPayload> {
     config: BaseGestureConfig & ForceTouchGestureConfig;
     constructor();
+    /**
+     * A minimal pressure that is required before gesture can activate.
+     * Should be a value from range [0.0, 1.0]. Default is 0.2.
+     * @param force
+     */
     minForce(force: number): this;
+    /**
+     * A maximal pressure that could be applied for gesture.
+     * If the pressure is greater, gesture fails. Should be a value from range [0.0, 1.0].
+     * @param force
+     */
     maxForce(force: number): this;
+    /**
+     * Value defining if haptic feedback has to be performed on activation.
+     * @param value
+     */
     feedbackOnActivation(value: boolean): this;
     onChange(callback: (event: GestureUpdateEvent<GestureUpdateEvent<ForceTouchGestureHandlerEventPayload & ForceTouchGestureChangeEventPayload>>) => void): this;
 }

package/lib/typescript/handlers/gestures/gesture.d.ts

@@ -77,26 +77,125 @@ export declare abstract class BaseGesture<EventPayloadT extends Record<string, u
     handlers: HandlerCallbacks<EventPayloadT>;
     constructor();
     private addDependency;
+    /**
+     * Sets a `ref` to the gesture object, allowing for interoperability with the old API.
+     * @param ref
+     */
     withRef(ref: React.MutableRefObject<GestureType | undefined>): this;
     protected isWorklet(callback: Function): boolean;
+    /**
+     * Set the callback that is being called when given gesture handler starts receiving touches.
+     * At the moment of this callback the handler is in `BEGAN` state and we don't know yet if it will recognize the gesture at all.
+     * @param callback
+     */
     onBegin(callback: (event: GestureStateChangeEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called when the gesture is recognized by the handler and it transitions to the `ACTIVE` state.
+     * @param callback
+     */
     onStart(callback: (event: GestureStateChangeEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called when the gesture that was recognized by the handler finishes and handler reaches `END` state.
+     * It will be called only if the handler was previously in the `ACTIVE` state.
+     * @param callback
+     */
     onEnd(callback: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void): this;
+    /**
+     * Set the callback that is being called when the handler finalizes handling gesture - the gesture was recognized and has finished or it failed to recognize.
+     * @param callback
+     */
     onFinalize(callback: (event: GestureStateChangeEvent<EventPayloadT>, success: boolean) => void): this;
+    /**
+     * Set the `onTouchesDown` callback which is called every time a pointer is placed on the screen.
+     * @param callback
+     */
     onTouchesDown(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesMove` callback which is called every time a pointer is moved on the screen.
+     * @param callback
+     */
     onTouchesMove(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesUp` callback which is called every time a pointer is lifted from the screen.
+     * @param callback
+     */
     onTouchesUp(callback: TouchEventHandlerType): this;
+    /**
+     * Set the `onTouchesCancelled` callback which is called every time a pointer stops being tracked, for example when the gesture finishes.
+     * @param callback
+     */
     onTouchesCancelled(callback: TouchEventHandlerType): this;
+    /**
+     * Indicates whether the given handler should be analyzing stream of touch events or not.
+     * @param enabled
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#enabledvalue-boolean
+     */
     enabled(enabled: boolean): this;
+    /**
+     * When true the handler will cancel or fail recognition (depending on its current state) whenever the finger leaves the area of the connected view.
+     * @param value
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#shouldcancelwhenoutsidevalue-boolean
+     */
     shouldCancelWhenOutside(value: boolean): this;
+    /**
+     * This parameter enables control over what part of the connected view area can be used to begin recognizing the gesture.
+     * When a negative number is provided the bounds of the view will reduce the area by the given number of points in each of the sides evenly.
+     * @param hitSlop
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#hitslopsettings
+     */
     hitSlop(hitSlop: HitSlop): this;
+    /**
+     * #### Web only
+     * This parameter allows to specify which `cursor` should be used when gesture activates.
+     * Supports all CSS cursor values (e.g. `"grab"`, `"zoom-in"`). Default value is set to `"auto"`.
+     * @param activeCursor
+     */
     activeCursor(activeCursor: ActiveCursor): this;
+    /**
+     * #### Web & Android only
+     * Allows users to choose which mouse button should handler respond to.
+     * Arguments can be combined using `|` operator, e.g. `mouseButton(MouseButton.LEFT | MouseButton.RIGHT)`.
+     * Default value is set to `MouseButton.LEFT`.
+     * @param mouseButton
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#mousebuttonvalue-mousebutton-web--android-only
+     */
     mouseButton(mouseButton: MouseButton): this;
+    /**
+     * When `react-native-reanimated` is installed, the callbacks passed to the gestures are automatically workletized and run on the UI thread when called.
+     * This option allows for changing this behavior: when `true`, all the callbacks will be run on the JS thread instead of the UI thread, regardless of whether they are worklets or not.
+     * Defaults to `false`.
+     * @param runOnJS
+     */
     runOnJS(runOnJS: boolean): this;
+    /**
+     * Allows gestures across different components to be recognized simultaneously.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneouswithexternalgesture
+     */
     simultaneousWithExternalGesture(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Allows to delay activation of the handler until all handlers passed as arguments to this method fail (or don't begin at all).
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#requireexternalgesturetofail
+     */
     requireExternalGestureToFail(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Works similarily to `requireExternalGestureToFail` but the direction of the relation is reversed - instead of being one-to-many relation, it's many-to-one.
+     * @param gestures
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#blocksexternalgesture
+     */
     blocksExternalGesture(...gestures: Exclude<GestureRef, number>[]): this;
+    /**
+     * Sets a `testID` property for gesture object, allowing for querying for it in tests.
+     * @param id
+     */
     withTestId(id: string): this;
+    /**
+     * #### iOS only
+     * When `true`, the handler will cancel touches for native UI components (`UIButton`, `UISwitch`, etc) it's attached to when it becomes `ACTIVE`.
+     * Default value is `true`.
+     * @param value
+     */
     cancelsTouchesInView(value: boolean): this;
     initialize(): void;
     toGestureArray(): GestureType[];
@@ -104,8 +203,22 @@ export declare abstract class BaseGesture<EventPayloadT extends Record<string, u
     get shouldUseReanimated(): boolean;
 }
 export declare abstract class ContinousBaseGesture<EventPayloadT extends Record<string, unknown>, EventChangePayloadT extends Record<string, unknown>> extends BaseGesture<EventPayloadT> {
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * @param callback
+     */
     onUpdate(callback: (event: GestureUpdateEvent<EventPayloadT>) => void): this;
+    /**
+     * Set the callback that is being called every time the gesture receives an update while it's active.
+     * This callback will receive information about change in value in relation to the last received event.
+     * @param callback
+     */
     onChange(callback: (event: GestureUpdateEvent<EventPayloadT & EventChangePayloadT>) => void): this;
+    /**
+     * When `true` the handler will not activate by itself even if its activation criteria are met.
+     * Instead you can manipulate its state using state manager.
+     * @param manualActivation
+     */
     manualActivation(manualActivation: boolean): this;
 }
 export {};

package/lib/typescript/handlers/gestures/gestureObjects.d.ts

@@ -10,24 +10,80 @@ import { TapGesture } from './tapGesture';
 import { NativeGesture } from './nativeGesture';
 import { ManualGesture } from './manualGesture';
 import { HoverGesture } from './hoverGesture';
+/**
+ * `Gesture` is the object that allows you to create and compose gestures.
+ *
+ * ### Remarks
+ * - Consider wrapping your gesture configurations with `useMemo`, as it will reduce the amount of work Gesture Handler has to do under the hood when updating gestures.
+ *
+ * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture
+ */
 export declare const GestureObjects: {
+    /**
+     * A discrete gesture that recognizes one or many taps.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/tap-gesture
+     */
     Tap: () => TapGesture;
+    /**
+     * A continuous gesture that can recognize a panning (dragging) gesture and track its movement.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture
+     */
     Pan: () => PanGesture;
+    /**
+     * A continuous gesture that recognizes pinch gesture. It allows for tracking the distance between two fingers and use that information to scale or zoom your content.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pinch-gesture
+     */
     Pinch: () => PinchGesture;
+    /**
+     * A continuous gesture that can recognize rotation and track its movement.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/rotation-gesture
+     */
     Rotation: () => RotationGesture;
+    /**
+     * A discrete gesture that activates when the movement is sufficiently fast.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture
+     */
     Fling: () => FlingGesture;
+    /**
+     * A discrete gesture that activates when the corresponding view is pressed for a sufficiently long time.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/long-press-gesture
+     */
     LongPress: () => LongPressGesture;
+    /**
+     * #### iOS only
+     * A continuous gesture that recognizes force of a touch. It allows for tracking pressure of touch on some iOS devices.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/force-touch-gesture
+     */
     ForceTouch: () => ForceTouchGesture;
+    /**
+     * A gesture that allows other touch handling components to participate in RNGH's gesture system.
+     * When used, the other component should be the direct child of a `GestureDetector`.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/native-gesture
+     */
     Native: () => NativeGesture;
+    /**
+     * A plain gesture that has no specific activation criteria nor event data set.
+     * Its state has to be controlled manually using a state manager.
+     * It will not fail when all the pointers are lifted from the screen.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/manual-gesture
+     */
     Manual: () => ManualGesture;
+    /**
+     * A continuous gesture that can recognize hovering above the view it's attached to.
+     * The hover effect may be activated by moving a mouse or a stylus over the view.
+     *
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/hover-gesture
+     */
     Hover: () => HoverGesture;
     /**
      * Builds a composed gesture consisting of gestures provided as parameters.
      * The first one that becomes active cancels the rest of gestures.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#race
      */
     Race: (...gestures: Gesture[]) => ComposedGesture;
     /**
      * Builds a composed gesture that allows all base gestures to run simultaneously.
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneous
      */
     Simultaneous(...gestures: Gesture[]): SimultaneousGesture;
     /**
@@ -36,6 +92,7 @@ export declare const GestureObjects: {
      * than the second one, second one has higher priority than the third one, and so on.
      * For example, to make a gesture that recognizes both single and double tap you need
      * to call Exclusive(doubleTap, singleTap).
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#exclusive
      */
     Exclusive(...gestures: Gesture[]): ExclusiveGesture;
 };

package/lib/typescript/handlers/gestures/hoverGesture.d.ts

@@ -23,8 +23,8 @@ export declare class HoverGesture extends ContinousBaseGesture<HoverGestureHandl
     config: BaseGestureConfig & HoverGestureConfig;
     constructor();
     /**
+     * #### iOS only
      * Sets the visual hover effect.
-     * iOS only
      */
     effect(effect: HoverEffect): this;
     onChange(callback: (event: GestureUpdateEvent<HoverGestureHandlerEventPayload & HoverGestureChangeEventPayload>) => void): this;

package/lib/typescript/handlers/gestures/longPressGesture.d.ts

@@ -3,7 +3,17 @@ import { LongPressGestureConfig, LongPressGestureHandlerEventPayload } from '../
 export declare class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPayload> {
     config: BaseGestureConfig & LongPressGestureConfig;
     constructor();
+    /**
+     * Minimum time, expressed in milliseconds, that a finger must remain pressed on the corresponding view.
+     * The default value is 500.
+     * @param duration
+     */
     minDuration(duration: number): this;
+    /**
+     * Maximum distance, expressed in points, that defines how far the finger is allowed to travel during a long press gesture.
+     * @param distance
+     * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/long-press-gesture#maxdistancevalue-number
+     */
     maxDistance(distance: number): this;
 }
 export type LongPressGestureType = InstanceType<typeof LongPressGesture>;

package/lib/typescript/handlers/gestures/nativeGesture.d.ts

@@ -3,7 +3,15 @@ import { NativeViewGestureConfig, NativeViewGestureHandlerPayload } from '../Nat
 export declare class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload> {
     config: BaseGestureConfig & NativeViewGestureConfig;
     constructor();
+    /**
+     * When true, underlying handler will activate unconditionally when in `BEGAN` or `UNDETERMINED` state.
+     * @param value
+     */
     shouldActivateOnStart(value: boolean): this;
+    /**
+     * When true, cancels all other gesture handlers when this `NativeViewGestureHandler` receives an `ACTIVE` state event.
+     * @param value
+     */
     disallowInterruption(value: boolean): this;
 }
 export type NativeGestureType = InstanceType<typeof NativeGesture>;