react-native-gesture-handler/src/handlers/gestures/nativeGesture.ts

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

import type { NativeViewGestureHandlerPayload } from '../GestureHandlerEventPayload';
import type { NativeViewGestureConfig } from '../NativeViewGestureHandler';
import type { BaseGestureConfig } from './gesture';
import { BaseGesture } from './gesture';

/**
 * @deprecated `NativeGesture` is deprecated and will be removed in the future. Please use `useNativeGesture` instead.
 */
export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload> {
  public override config: BaseGestureConfig & NativeViewGestureConfig = {};

  constructor() {
    super();

    this.handlerName = 'NativeViewGestureHandler';
  }

  /**
   * When true, underlying handler will activate unconditionally when in `BEGAN` or `UNDETERMINED` state.
   * @param value
   */
  shouldActivateOnStart(value: boolean) {
    this.config.shouldActivateOnStart = value;
    return this;
  }

  /**
   * When true, cancels all other gesture handlers when this `NativeViewGestureHandler` receives an `ACTIVE` state event.
   * @param value
   */
  disallowInterruption(value: boolean) {
    this.config.disallowInterruption = value;
    return this;
  }
}

/**
 * @deprecated `NativeGestureType` is deprecated and will be removed in the future. Please use `NativeGesture` instead.
 */
export type NativeGestureType = InstanceType<typeof NativeGesture>;