react-native-gesture-handler/src/v3/hooks/gestures/pan/PanTypes.ts

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

import type { StylusData } from '../../../../handlers/gestureHandlerCommon';
import type {
  BaseGestureConfig,
  ExcludeInternalConfigProps,
  GestureEvent,
  SingleGesture,
  WithSharedValue,
} from '../../../types';

type CommonPanGestureProperties = {
  /**
   * Minimum distance the finger (or multiple finger) need to travel before the
   * handler activates. Expressed in points.
   */
  minDistance?: number;

  /**
   * Android only.
   */
  averageTouches?: boolean;

  /**
   * Enables two-finger gestures on supported devices, for example iPads with
   * trackpads. If not enabled the gesture will require click + drag, with
   * enableTrackpadTwoFingerGesture swiping with two fingers will also trigger
   * the gesture.
   */
  enableTrackpadTwoFingerGesture?: boolean;

  /**
   * A number of fingers that is required to be placed before handler can
   * activate. Should be a higher or equal to 0 integer.
   */
  minPointers?: number;

  /**
   * When the given number of fingers is placed on the screen and handler hasn't
   * yet activated it will fail recognizing the gesture. Should be a higher or
   * equal to 0 integer.
   */
  maxPointers?: number;

  minVelocity?: number;
  minVelocityX?: number;
  minVelocityY?: number;
  activateAfterLongPress?: number;
};

export type OffsetProps = {
  /**
   * Range along X axis (in points) where fingers travels without activation of
   * handler. Moving outside of this range implies activation of handler. Range
   * can be given as an array or a single number. If range is set as an array,
   * first value must be lower or equal to 0, a the second one higher or equal
   * 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, number];

  /**
   * Range along X axis (in points) where fingers travels without activation of
   * handler. Moving outside of this range implies activation of handler. Range
   * can be given as an array or a single number. If range is set as an array,
   * first value must be lower or equal to 0, a the second one higher or equal
   * 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, 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
   * can be given as an array or a single number. If range is set as an array,
   * first value must be lower or equal to 0, a the second one higher or equal
   * 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, 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
   * can be given as an array or a single number. If range is set as an array,
   * first value must be lower or equal to 0, a the second one higher or equal
   * 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, number];
};

export type PanGestureExternalProperties = CommonPanGestureProperties &
  OffsetProps;

export type PanGestureNativeProperties = Omit<
  CommonPanGestureProperties,
  'minDistance' | 'averageTouches'
> & {
  minDist?: number;
  avgTouches?: boolean;
  activeOffsetYStart?: number;
  activeOffsetYEnd?: number;
  activeOffsetXStart?: number;
  activeOffsetXEnd?: number;
  failOffsetYStart?: number;
  failOffsetYEnd?: number;
  failOffsetXStart?: number;
  failOffsetXEnd?: number;
};

export const PanNativeProperties = new Set<keyof PanGestureNativeProperties>([
  'minDist',
  'avgTouches',
  'enableTrackpadTwoFingerGesture',
  'minPointers',
  'maxPointers',
  'minVelocity',
  'minVelocityX',
  'minVelocityY',
  'activateAfterLongPress',
  'activeOffsetYStart',
  'activeOffsetYEnd',
  'activeOffsetXStart',
  'activeOffsetXEnd',
  'failOffsetYStart',
  'failOffsetYEnd',
  'failOffsetXStart',
  'failOffsetXEnd',
]);

export type PanHandlerData = {
  x: number;
  y: number;
  absoluteX: number;
  absoluteY: number;
  stylusData: StylusData;
};

export type PanExtendedHandlerData = PanHandlerData & {
  changeX: number;
  changeY: number;
  translationX: number;
  translationY: number;
  velocityX: number;
  velocityY: number;
};

export type PanGestureProperties =
  WithSharedValue<PanGestureExternalProperties>;

export type PanGestureInternalProperties =
  WithSharedValue<PanGestureNativeProperties>;

export type PanGestureConfig = ExcludeInternalConfigProps<
  BaseGestureConfig<
    PanGestureProperties,
    PanHandlerData,
    PanExtendedHandlerData
  >
>;

export type PanGestureInternalConfig = BaseGestureConfig<
  PanGestureInternalProperties,
  PanHandlerData,
  PanExtendedHandlerData
>;

export type PanGestureEvent = GestureEvent<PanHandlerData>;
export type PanGestureActiveEvent = GestureEvent<PanExtendedHandlerData>;

export type PanGesture = SingleGesture<
  PanGestureInternalProperties,
  PanHandlerData,
  PanExtendedHandlerData
>;