@amazon-devices/react-native-gesture-handler 4.0.0 → 4.0.2

package/src/handlers/gestures/gestureObjects.ts

@@ -1,143 +0,0 @@
-import { FlingGesture } from './flingGesture';
-import { ForceTouchGesture } from './forceTouchGesture';
-import { Gesture } from './gesture';
-import {
-  ComposedGesture,
-  ExclusiveGesture,
-  SimultaneousGesture,
-} from './gestureComposition';
-import { LongPressGesture } from './longPressGesture';
-import { PanGesture } from './panGesture';
-import { PinchGesture } from './pinchGesture';
-import { RotationGesture } from './rotationGesture';
-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 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new LongPressGesture();
-  },
-
-  /**
-   * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
-   *
-   *  #### 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new 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: () => {
-    return new 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[]) => {
-    return new ComposedGesture(...gestures);
-  },
-
-  /**
-   * 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[]) {
-    return new SimultaneousGesture(...gestures);
-  },
-
-  /**
-   * Builds a composed gesture where only one of the provided gestures can become active.
-   * Priority is decided through the order of gestures: the first one has higher priority
-   * 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[]) {
-    return new ExclusiveGesture(...gestures);
-  },
-};

package/src/handlers/gestures/gestureStateManager.ts

@@ -1,76 +0,0 @@
-import { Reanimated } from './reanimatedWrapper';
-import { State } from '../../State';
-import { tagMessage } from '../../utils';
-
-export interface GestureStateManagerType {
-  begin: () => void;
-  activate: () => void;
-  fail: () => void;
-  end: () => void;
-  /** @internal */
-  handlerTag: number;
-}
-
-const warningMessage = tagMessage(
-  'react-native-reanimated is required in order to use synchronous state management'
-);
-
-// Check if reanimated module is available, but look for useSharedValue as conditional
-// require of reanimated can sometimes return content of `utils.ts` file (?)
-const REANIMATED_AVAILABLE = Reanimated?.useSharedValue !== undefined;
-const setGestureState = Reanimated?.setGestureState;
-
-function create(handlerTag: number): GestureStateManagerType {
-  'worklet';
-  return {
-    handlerTag,
-
-    begin: () => {
-      'worklet';
-      if (REANIMATED_AVAILABLE) {
-        // When Reanimated is available, setGestureState should be defined
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        setGestureState!(handlerTag, State.BEGAN);
-      } else {
-        console.warn(warningMessage);
-      }
-    },
-
-    activate: () => {
-      'worklet';
-      if (REANIMATED_AVAILABLE) {
-        // When Reanimated is available, setGestureState should be defined
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        setGestureState!(handlerTag, State.ACTIVE);
-      } else {
-        console.warn(warningMessage);
-      }
-    },
-
-    fail: () => {
-      'worklet';
-      if (REANIMATED_AVAILABLE) {
-        // When Reanimated is available, setGestureState should be defined
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        setGestureState!(handlerTag, State.FAILED);
-      } else {
-        console.warn(warningMessage);
-      }
-    },
-
-    end: () => {
-      'worklet';
-      if (REANIMATED_AVAILABLE) {
-        // When Reanimated is available, setGestureState should be defined
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        setGestureState!(handlerTag, State.END);
-      } else {
-        console.warn(warningMessage);
-      }
-    },
-  };
-}
-
-export const GestureStateManager = {
-  create,
-};

package/src/handlers/gestures/gestureStateManager.web.ts

@@ -1,26 +0,0 @@
-import NodeManager from '../../web/tools/NodeManager';
-import { GestureStateManagerType } from './gestureStateManager';
-
-export const GestureStateManager = {
-  create(handlerTag: number): GestureStateManagerType {
-    return {
-      handlerTag,
-
-      begin: () => {
-        NodeManager.getHandler(handlerTag).begin();
-      },
-
-      activate: () => {
-        NodeManager.getHandler(handlerTag).activate(true);
-      },
-
-      fail: () => {
-        NodeManager.getHandler(handlerTag).fail();
-      },
-
-      end: () => {
-        NodeManager.getHandler(handlerTag).end();
-      },
-    };
-  },
-};

package/src/handlers/gestures/hoverGesture.ts

@@ -1,77 +0,0 @@
-import { BaseGestureConfig, ContinousBaseGesture } from './gesture';
-import { GestureUpdateEvent } from '../gestureHandlerCommon';
-import type { HoverGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
-
-export type HoverGestureChangeEventPayload = {
-  changeX: number;
-  changeY: number;
-};
-
-export enum HoverEffect {
-  NONE = 0,
-  LIFT = 1,
-  HIGHLIGHT = 2,
-}
-
-export interface HoverGestureConfig {
-  hoverEffect?: HoverEffect;
-}
-
-export const hoverGestureHandlerProps = ['hoverEffect'] as const;
-
-function changeEventCalculator(
-  current: GestureUpdateEvent<HoverGestureHandlerEventPayload>,
-  previous?: GestureUpdateEvent<HoverGestureHandlerEventPayload>
-) {
-  'worklet';
-  let changePayload: HoverGestureChangeEventPayload;
-  if (previous === undefined) {
-    changePayload = {
-      changeX: current.x,
-      changeY: current.y,
-    };
-  } else {
-    changePayload = {
-      changeX: current.x - previous.x,
-      changeY: current.y - previous.y,
-    };
-  }
-
-  return { ...current, ...changePayload };
-}
-
-export class HoverGesture extends ContinousBaseGesture<
-  HoverGestureHandlerEventPayload,
-  HoverGestureChangeEventPayload
-> {
-  public config: BaseGestureConfig & HoverGestureConfig = {};
-
-  constructor() {
-    super();
-
-    this.handlerName = 'HoverGestureHandler';
-  }
-
-  /**
-   * #### iOS only
-   * Sets the visual hover effect.
-   */
-  effect(effect: HoverEffect) {
-    this.config.hoverEffect = effect;
-    return this;
-  }
-
-  onChange(
-    callback: (
-      event: GestureUpdateEvent<
-        HoverGestureHandlerEventPayload & HoverGestureChangeEventPayload
-      >
-    ) => void
-  ) {
-    // @ts-ignore TS being overprotective, HoverGestureHandlerEventPayload is Record
-    this.handlers.changeEventCalculator = changeEventCalculator;
-    return super.onChange(callback);
-  }
-}
-
-export type HoverGestureType = InstanceType<typeof HoverGesture>;

package/src/handlers/gestures/longPressGesture.ts

@@ -1,45 +0,0 @@
-import { BaseGesture, BaseGestureConfig } from './gesture';
-import { LongPressGestureConfig } from '../LongPressGestureHandler';
-import type { LongPressGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
-
-export class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPayload> {
-  public config: BaseGestureConfig & LongPressGestureConfig = {};
-
-  constructor() {
-    super();
-
-    this.handlerName = 'LongPressGestureHandler';
-    this.shouldCancelWhenOutside(true);
-  }
-
-  /**
-   * 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.config.minDurationMs = duration;
-    return 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.config.maxDist = distance;
-    return this;
-  }
-
-  /**
-   * Determine exact number of points required to handle the long press gesture.
-   * @param pointers
-   */
-  numberOfPointers(pointers: number) {
-    this.config.numberOfPointers = pointers;
-    return this;
-  }
-}
-
-export type LongPressGestureType = InstanceType<typeof LongPressGesture>;

package/src/handlers/gestures/manualGesture.ts

@@ -1,31 +0,0 @@
-import { GestureUpdateEvent } from '../gestureHandlerCommon';
-import { ContinousBaseGesture } from './gesture';
-
-function changeEventCalculator(
-  current: GestureUpdateEvent<Record<string, never>>,
-  _previous?: GestureUpdateEvent<Record<string, never>>
-) {
-  'worklet';
-  return current;
-}
-
-export class ManualGesture extends ContinousBaseGesture<
-  Record<string, never>,
-  Record<string, never>
-> {
-  constructor() {
-    super();
-
-    this.handlerName = 'ManualGestureHandler';
-  }
-
-  onChange(
-    callback: (event: GestureUpdateEvent<Record<string, never>>) => void
-  ) {
-    // @ts-ignore TS being overprotective, Record<string, never> is Record
-    this.handlers.changeEventCalculator = changeEventCalculator;
-    return super.onChange(callback);
-  }
-}
-
-export type ManualGestureType = InstanceType<typeof ManualGesture>;

package/src/handlers/gestures/nativeGesture.ts

@@ -1,33 +0,0 @@
-import { BaseGestureConfig, BaseGesture } from './gesture';
-import { NativeViewGestureConfig } from '../NativeViewGestureHandler';
-import type { NativeViewGestureHandlerPayload } from '../GestureHandlerEventPayload';
-
-export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload> {
-  public 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;
-  }
-}
-
-export type NativeGestureType = InstanceType<typeof NativeGesture>;

package/src/handlers/gestures/panGesture.ts

@@ -1,221 +0,0 @@
-import { BaseGestureConfig, ContinousBaseGesture } from './gesture';
-import { GestureUpdateEvent } from '../gestureHandlerCommon';
-import { PanGestureConfig } from '../PanGestureHandler';
-import type { PanGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
-
-export type PanGestureChangeEventPayload = {
-  changeX: number;
-  changeY: number;
-};
-
-function changeEventCalculator(
-  current: GestureUpdateEvent<PanGestureHandlerEventPayload>,
-  previous?: GestureUpdateEvent<PanGestureHandlerEventPayload>
-) {
-  'worklet';
-  let changePayload: PanGestureChangeEventPayload;
-  if (previous === undefined) {
-    changePayload = {
-      changeX: current.translationX,
-      changeY: current.translationY,
-    };
-  } else {
-    changePayload = {
-      changeX: current.translationX - previous.translationX,
-      changeY: current.translationY - previous.translationY,
-    };
-  }
-
-  return { ...current, ...changePayload };
-}
-
-export class PanGesture extends ContinousBaseGesture<
-  PanGestureHandlerEventPayload,
-  PanGestureChangeEventPayload
-> {
-  public config: BaseGestureConfig & PanGestureConfig = {};
-
-  constructor() {
-    super();
-
-    this.handlerName = 'PanGestureHandler';
-  }
-
-  /**
-   * Range along Y axis (in points) where fingers travels without activation of gesture.
-   * @param offset
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#activeoffsetyvalue-number--number
-   */
-  activeOffsetY(
-    offset: number | [activeOffsetYStart: number, activeOffsetYEnd: number]
-  ) {
-    if (Array.isArray(offset)) {
-      this.config.activeOffsetYStart = offset[0];
-      this.config.activeOffsetYEnd = offset[1];
-    } else if (offset < 0) {
-      this.config.activeOffsetYStart = offset;
-    } else {
-      this.config.activeOffsetYEnd = offset;
-    }
-    return this;
-  }
-
-  /**
-   * Range along X axis (in points) where fingers travels without activation of gesture.
-   * @param offset
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#activeoffsetxvalue-number--number
-   */
-  activeOffsetX(
-    offset: number | [activeOffsetXStart: number, activeOffsetXEnd: number]
-  ) {
-    if (Array.isArray(offset)) {
-      this.config.activeOffsetXStart = offset[0];
-      this.config.activeOffsetXEnd = offset[1];
-    } else if (offset < 0) {
-      this.config.activeOffsetXStart = offset;
-    } else {
-      this.config.activeOffsetXEnd = offset;
-    }
-    return this;
-  }
-
-  /**
-   * When the finger moves outside this range (in points) along Y axis and gesture hasn't yet activated it will fail recognizing the gesture.
-   * @param offset
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#failoffsetyvalue-number--number
-   */
-  failOffsetY(
-    offset: number | [failOffsetYStart: number, failOffsetYEnd: number]
-  ) {
-    if (Array.isArray(offset)) {
-      this.config.failOffsetYStart = offset[0];
-      this.config.failOffsetYEnd = offset[1];
-    } else if (offset < 0) {
-      this.config.failOffsetYStart = offset;
-    } else {
-      this.config.failOffsetYEnd = offset;
-    }
-    return this;
-  }
-
-  /**
-   * When the finger moves outside this range (in points) along X axis and gesture hasn't yet activated it will fail recognizing the gesture.
-   * @param offset
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture#failoffsetxvalue-number--number
-   */
-  failOffsetX(
-    offset: number | [failOffsetXStart: number, failOffsetXEnd: number]
-  ) {
-    if (Array.isArray(offset)) {
-      this.config.failOffsetXStart = offset[0];
-      this.config.failOffsetXEnd = offset[1];
-    } else if (offset < 0) {
-      this.config.failOffsetXStart = offset;
-    } else {
-      this.config.failOffsetXEnd = offset;
-    }
-    return this;
-  }
-
-  /**
-   * A number of fingers that is required to be placed before gesture can activate. Should be a higher or equal to 0 integer.
-   * @param minPointers
-   */
-  minPointers(minPointers: number) {
-    this.config.minPointers = minPointers;
-    return this;
-  }
-
-  /**
-   * When the given number of fingers is placed on the screen and gesture hasn't yet activated it will fail recognizing the gesture.
-   * Should be a higher or equal to 0 integer.
-   * @param maxPointers
-   */
-  maxPointers(maxPointers: number) {
-    this.config.maxPointers = maxPointers;
-    return this;
-  }
-
-  /**
-   * Minimum distance the finger (or multiple finger) need to travel before the gesture activates.
-   * Expressed in points.
-   * @param distance
-   */
-  minDistance(distance: number) {
-    this.config.minDist = distance;
-    return this;
-  }
-
-  /**
-   * Minimum velocity the finger has to reach in order to activate handler.
-   * @param velocity
-   */
-  minVelocity(velocity: number) {
-    this.config.minVelocity = velocity;
-    return this;
-  }
-
-  /**
-   * Minimum velocity along X axis the finger has to reach in order to activate handler.
-   * @param velocity
-   */
-  minVelocityX(velocity: number) {
-    this.config.minVelocityX = velocity;
-    return this;
-  }
-
-  /**
-   * Minimum velocity along Y axis the finger has to reach in order to activate handler.
-   * @param velocity
-   */
-  minVelocityY(velocity: number) {
-    this.config.minVelocityY = velocity;
-    return this;
-  }
-
-  /**
-   * #### Android only
-   * Android, by default, will calculate translation values based on the position of the leading pointer (the first one that was placed on the screen).
-   * This modifier allows that behavior to be changed to the one that is default on iOS - the averaged position of all active pointers will be used to calculate the translation values.
-   * @param value
-   */
-  averageTouches(value: boolean) {
-    this.config.avgTouches = value;
-    return this;
-  }
-
-  /**
-   * #### iOS only
-   * Enables two-finger gestures on supported devices, for example iPads with trackpads.
-   * @param value
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture/#enabletrackpadtwofingergesturevalue-boolean-ios-only
-   */
-  enableTrackpadTwoFingerGesture(value: boolean) {
-    this.config.enableTrackpadTwoFingerGesture = value;
-    return this;
-  }
-
-  /**
-   * Duration in milliseconds of the LongPress gesture before Pan is allowed to activate.
-   * @param duration
-   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture/#activateafterlongpressduration-number
-   */
-  activateAfterLongPress(duration: number) {
-    this.config.activateAfterLongPress = duration;
-    return this;
-  }
-
-  onChange(
-    callback: (
-      event: GestureUpdateEvent<
-        PanGestureHandlerEventPayload & PanGestureChangeEventPayload
-      >
-    ) => void
-  ) {
-    // @ts-ignore TS being overprotective, PanGestureHandlerEventPayload is Record
-    this.handlers.changeEventCalculator = changeEventCalculator;
-    return super.onChange(callback);
-  }
-}
-
-export type PanGestureType = InstanceType<typeof PanGesture>;