react-native-gesture-handler/lib/typescript/handlers/gestures/GestureDetector/index.d.ts

Declarative API exposing native platform touch and gesture system to React Native

import React from 'react';
import { GestureType } from '../gesture';
import { UserSelect, TouchAction } from '../../gestureHandlerCommon';
import { ComposedGesture } from '../gestureComposition';
interface GestureDetectorProps {
    children?: React.ReactNode;
    /**
     * A gesture object containing the configuration and callbacks.
     * Can be any of:
     * - base gestures (`Tap`, `Pan`, ...)
     * - `ComposedGesture` (`Race`, `Simultaneous`, `Exclusive`)
     */
    gesture: ComposedGesture | GestureType;
    /**
     * #### 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 {};
//# sourceMappingURL=index.d.ts.map