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

package/src/findNodeHandle.web.ts

@@ -1,41 +0,0 @@
-import { FlatList } from 'react-native';
-import type { GestureHandlerRef, SVGRef } from './web/interfaces';
-import { isRNSVGElement } from './web/utils';
-
-export default function findNodeHandle(
-  viewRef: GestureHandlerRef | SVGRef | HTMLElement | SVGElement
-): HTMLElement | SVGElement | number {
-  // TODO: Remove this once we remove old API.
-  if (viewRef instanceof FlatList) {
-    // @ts-ignore This is the only way to get the scroll ref from FlatList.
-    return viewRef._listRef._scrollRef.firstChild;
-  }
-  // Old API assumes that child handler is HTMLElement.
-  // However, if we nest handlers, we will get ref to another handler.
-  // In that case, we want to recursively call findNodeHandle with new handler viewTag (which can also be ref to another handler).
-  if ((viewRef as GestureHandlerRef)?.viewTag !== undefined) {
-    return findNodeHandle((viewRef as GestureHandlerRef).viewTag);
-  }
-
-  if (viewRef instanceof Element) {
-    if (viewRef.style.display === 'contents') {
-      return findNodeHandle(viewRef.firstChild as HTMLElement);
-    }
-
-    return viewRef;
-  }
-
-  if (isRNSVGElement(viewRef)) {
-    return (viewRef as SVGRef).elementRef.current;
-  }
-
-  // In new API, we receive ref object which `current` field points to  wrapper `div` with `display: contents;`.
-  // We want to return the first descendant (in DFS order) that doesn't have this property.
-  let element = (viewRef as GestureHandlerRef)?.current;
-
-  while (element && element.style.display === 'contents') {
-    element = element.firstChild as HTMLElement;
-  }
-
-  return element;
-}

package/src/getShadowNodeFromRef.ts

@@ -1,50 +0,0 @@
-// Used by GestureDetector (unsupported on web at the moment) to check whether the
-// attached view may get flattened on Fabric. This implementation causes errors
-// on web due to the static resolution of `require` statements by webpack breaking
-// the conditional importing. Solved by making .web file.
-let findHostInstance_DEPRECATED: (ref: unknown) => void;
-let getInternalInstanceHandleFromPublicInstance: (ref: unknown) => {
-  stateNode: { node: unknown };
-};
-
-export function getShadowNodeFromRef(ref: unknown) {
-  // Load findHostInstance_DEPRECATED lazily because it may not be available before render
-  if (findHostInstance_DEPRECATED === undefined) {
-    try {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const ReactFabric = require('react-native/Libraries/Renderer/shims/ReactFabric');
-      // Since RN 0.77 ReactFabric exports findHostInstance_DEPRECATED in default object so we're trying to
-      // access it first, then fallback on named export
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      findHostInstance_DEPRECATED =
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        ReactFabric?.default?.findHostInstance_DEPRECATED ||
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        ReactFabric?.findHostInstance_DEPRECATED;
-    } catch (e) {
-      findHostInstance_DEPRECATED = (_ref: unknown) => null;
-    }
-  }
-
-  // Load findHostInstance_DEPRECATED lazily because it may not be available before render
-  if (getInternalInstanceHandleFromPublicInstance === undefined) {
-    try {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      getInternalInstanceHandleFromPublicInstance =
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        require('react-native/Libraries/ReactNative/ReactFabricPublicInstance/ReactFabricPublicInstance')
-          .getInternalInstanceHandleFromPublicInstance ??
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return
-        ((ref: any) => ref._internalInstanceHandle);
-    } catch (e) {
-      getInternalInstanceHandleFromPublicInstance = (ref: any) =>
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return
-        ref._internalInstanceHandle;
-    }
-  }
-
-  // @ts-ignore Fabric
-  return getInternalInstanceHandleFromPublicInstance(
-    findHostInstance_DEPRECATED(ref)
-  ).stateNode.node;
-}

package/src/getShadowNodeFromRef.web.ts

@@ -1,7 +0,0 @@
-// Used by GestureDetector (unsupported on web at the moment) to check whether the
-// attached view may get flattened on Fabric. Original implementation causes errors
-// on web due to the static resolution of `require` statements by webpack breaking
-// the conditional importing.
-export function getShadowNodeFromRef(_ref: any) {
-  return null;
-}

package/src/ghQueueMicrotask.ts

@@ -1,8 +0,0 @@
-// We check for typeof requestAnimationFrame because of SSR
-// Functions are bound to null to avoid issues with scope when using Metro inline requires.
-export const ghQueueMicrotask =
-  typeof setImmediate === 'function'
-    ? setImmediate.bind(null)
-    : typeof requestAnimationFrame === 'function'
-      ? requestAnimationFrame.bind(null)
-      : queueMicrotask.bind(null);

package/src/handlers/FlingGestureHandler.ts

@@ -1,64 +0,0 @@
-import type { FlingGestureHandlerEventPayload } from './GestureHandlerEventPayload';
-import createHandler from './createHandler';
-import {
-  BaseGestureHandlerProps,
-  baseGestureHandlerProps,
-} from './gestureHandlerCommon';
-
-export const flingGestureHandlerProps = [
-  'numberOfPointers',
-  'direction',
-] as const;
-
-export interface FlingGestureConfig {
-  /**
-   * Expressed allowed direction of movement. It's possible to pass one or many
-   * directions in one parameter:
-   *
-   * ```js
-   * direction={Directions.RIGHT | Directions.LEFT}
-   * ```
-   *
-   * or
-   *
-   * ```js
-   * direction={Directions.DOWN}
-   * ```
-   */
-  direction?: number;
-
-  /**
-   * Determine exact number of points required to handle the fling gesture.
-   */
-  numberOfPointers?: number;
-}
-
-/**
- * @deprecated FlingGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Fling()` instead.
- */
-export interface FlingGestureHandlerProps
-  extends BaseGestureHandlerProps<FlingGestureHandlerEventPayload>,
-    FlingGestureConfig {}
-
-export const flingHandlerName = 'FlingGestureHandler';
-
-/**
- * @deprecated FlingGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Fling()` instead.
- */
-export type FlingGestureHandler = typeof FlingGestureHandler;
-
-/**
- * @deprecated FlingGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Fling()` instead.
- */
-// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
-export const FlingGestureHandler = createHandler<
-  FlingGestureHandlerProps,
-  FlingGestureHandlerEventPayload
->({
-  name: flingHandlerName,
-  allowedProps: [
-    ...baseGestureHandlerProps,
-    ...flingGestureHandlerProps,
-  ] as const,
-  config: {},
-});

package/src/handlers/ForceTouchGestureHandler.ts

@@ -1,88 +0,0 @@
-import React, { PropsWithChildren } from 'react';
-import { tagMessage } from '../utils';
-import PlatformConstants from '../PlatformConstants';
-import createHandler from './createHandler';
-import {
-  BaseGestureHandlerProps,
-  baseGestureHandlerProps,
-} from './gestureHandlerCommon';
-import type { ForceTouchGestureHandlerEventPayload } from './GestureHandlerEventPayload';
-
-export const forceTouchGestureHandlerProps = [
-  'minForce',
-  'maxForce',
-  'feedbackOnActivation',
-] as const;
-
-// implicit `children` prop has been removed in @types/react^18.0.0
-class ForceTouchFallback extends React.Component<PropsWithChildren<unknown>> {
-  static forceTouchAvailable = false;
-  componentDidMount() {
-    console.warn(
-      tagMessage(
-        'ForceTouchGestureHandler is not available on this platform. Please use ForceTouchGestureHandler.forceTouchAvailable to conditionally render other components that would provide a fallback behavior specific to your usecase'
-      )
-    );
-  }
-  render() {
-    return this.props.children;
-  }
-}
-
-export interface ForceTouchGestureConfig {
-  /**
-   *
-   * A minimal pressure that is required before handler can activate. Should be a
-   * value from range `[0.0, 1.0]`. Default is `0.2`.
-   */
-  minForce?: number;
-
-  /**
-   * A maximal pressure that could be applied for handler. If the pressure is
-   * greater, handler fails. Should be a value from range `[0.0, 1.0]`.
-   */
-  maxForce?: number;
-
-  /**
-   * Boolean value defining if haptic feedback has to be performed on
-   * activation.
-   */
-  feedbackOnActivation?: boolean;
-}
-
-/**
- * @deprecated ForceTouchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.ForceTouch()` instead.
- */
-export interface ForceTouchGestureHandlerProps
-  extends BaseGestureHandlerProps<ForceTouchGestureHandlerEventPayload>,
-    ForceTouchGestureConfig {}
-
-/**
- * @deprecated ForceTouchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.ForceTouch()` instead.
- */
-export type ForceTouchGestureHandler = typeof ForceTouchGestureHandler & {
-  forceTouchAvailable: boolean;
-};
-
-export const forceTouchHandlerName = 'ForceTouchGestureHandler';
-
-/**
- * @deprecated ForceTouchGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.ForceTouch()` instead.
- */
-// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
-export const ForceTouchGestureHandler = PlatformConstants?.forceTouchAvailable
-  ? createHandler<
-      ForceTouchGestureHandlerProps,
-      ForceTouchGestureHandlerEventPayload
-    >({
-      name: forceTouchHandlerName,
-      allowedProps: [
-        ...baseGestureHandlerProps,
-        ...forceTouchGestureHandlerProps,
-      ] as const,
-      config: {},
-    })
-  : ForceTouchFallback;
-
-(ForceTouchGestureHandler as ForceTouchGestureHandler).forceTouchAvailable =
-  PlatformConstants?.forceTouchAvailable || false;

package/src/handlers/GestureHandlerEventPayload.ts

@@ -1,229 +0,0 @@
-import { StylusData } from '../web/interfaces';
-
-export type FlingGestureHandlerEventPayload = {
-  x: number;
-  y: number;
-  absoluteX: number;
-  absoluteY: number;
-};
-
-/**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
- */
-export type ForceTouchGestureHandlerEventPayload = {
-  x: number;
-  y: number;
-  absoluteX: number;
-  absoluteY: number;
-
-  /**
-   * The pressure of a touch.
-   */
-  force: number;
-};
-
-export type LongPressGestureHandlerEventPayload = {
-  /**
-   * X coordinate, expressed in points, of the current position of the pointer
-   * (finger or a leading pointer when there are multiple fingers placed)
-   * relative to the view attached to the handler.
-   */
-  x: number;
-
-  /**
-   * Y coordinate, expressed in points, of the current position of the pointer
-   * (finger or a leading pointer when there are multiple fingers placed)
-   * relative to the view attached to the handler.
-   */
-  y: number;
-
-  /**
-   * X coordinate, expressed in points, of the current position of the pointer
-   * (finger or a leading pointer when there are multiple fingers placed)
-   * relative to the window. It is recommended to use `absoluteX` instead of
-   * `x` in cases when the view attached to the handler can be transformed as an
-   * effect of the gesture.
-   */
-  absoluteX: number;
-
-  /**
-   * Y coordinate, expressed in points, of the current position of the pointer
-   * (finger or a leading pointer when there are multiple fingers placed)
-   * relative to the window. It is recommended to use `absoluteY` instead of
-   * `y` in cases when the view attached to the handler can be transformed as an
-   * effect of the gesture.
-   */
-  absoluteY: number;
-
-  /**
-   * Duration of the long press (time since the start of the event), expressed
-   * in milliseconds.
-   */
-  duration: number;
-};
-
-export type NativeViewGestureHandlerPayload = {
-  /**
-   * True if gesture was performed inside of containing view, false otherwise.
-   */
-  pointerInside: boolean;
-};
-
-export type PanGestureHandlerEventPayload = {
-  /**
-   * X coordinate of the current position of the pointer (finger or a leading
-   * pointer when there are multiple fingers placed) relative to the view
-   * attached to the handler. Expressed in point units.
-   */
-  x: number;
-
-  /**
-   * Y coordinate of the current position of the pointer (finger or a leading
-   * pointer when there are multiple fingers placed) relative to the view
-   * attached to the handler. Expressed in point units.
-   */
-  y: number;
-
-  /**
-   * X coordinate of the current position of the pointer (finger or a leading
-   * pointer when there are multiple fingers placed) relative to the window.
-   * The value is expressed in point units. It is recommended to use it instead
-   * of `x` in cases when the original view can be transformed as an effect of
-   * the gesture.
-   */
-  absoluteX: number;
-
-  /**
-   * Y coordinate of the current position of the pointer (finger or a leading
-   * pointer when there are multiple fingers placed) relative to the window.
-   * The value is expressed in point units. It is recommended to use it instead
-   * of `y` in cases when the original view can be transformed as an
-   * effect of the gesture.
-   */
-  absoluteY: number;
-
-  /**
-   * Translation of the pan gesture along X axis accumulated over the time of
-   * the gesture. The value is expressed in the point units.
-   */
-  translationX: number;
-
-  /**
-   * Translation of the pan gesture along Y axis accumulated over the time of
-   * the gesture. The value is expressed in the point units.
-   */
-  translationY: number;
-
-  /**
-   * Velocity of the pan gesture along the X axis in the current moment. The
-   * value is expressed in point units per second.
-   */
-  velocityX: number;
-
-  /**
-   * Velocity of the pan gesture along the Y axis in the current moment. The
-   * value is expressed in point units per second.
-   */
-  velocityY: number;
-
-  /**
-   * Object containing additional stylus data.
-   */
-  stylusData?: StylusData;
-};
-
-export type PinchGestureHandlerEventPayload = {
-  /**
-   * The scale factor relative to the points of the two touches in screen
-   * coordinates.
-   */
-  scale: number;
-
-  /**
-   * Position expressed in points along X axis of center anchor point of
-   * gesture.
-   */
-  focalX: number;
-
-  /**
-   * Position expressed in points along Y axis of center anchor point of
-   * gesture.
-   */
-  focalY: number;
-
-  /**
-   *
-   * Velocity of the pan gesture the current moment. The value is expressed in
-   * point units per second.
-   */
-  velocity: number;
-};
-
-export type TapGestureHandlerEventPayload = {
-  x: number;
-  y: number;
-  absoluteX: number;
-  absoluteY: number;
-};
-
-export type RotationGestureHandlerEventPayload = {
-  /**
-   * Amount rotated, expressed in radians, from the gesture's focal point
-   * (anchor).
-   */
-  rotation: number;
-
-  /**
-   * X coordinate, expressed in points, of the gesture's central focal point
-   * (anchor).
-   */
-  anchorX: number;
-
-  /**
-   * Y coordinate, expressed in points, of the gesture's central focal point
-   * (anchor).
-   */
-  anchorY: number;
-
-  /**
-   *
-   * Instantaneous velocity, expressed in point units per second, of the
-   * gesture.
-   */
-  velocity: number;
-};
-
-export type HoverGestureHandlerEventPayload = {
-  /**
-   * X coordinate of the current position of the pointer relative to the view
-   * attached to the handler. Expressed in point units.
-   */
-  x: number;
-
-  /**
-   * Y coordinate of the current position of the pointer relative to the view
-   * attached to the handler. Expressed in point units.
-   */
-  y: number;
-
-  /**
-   * X coordinate of the current position of the pointer relative to the window.
-   * The value is expressed in point units. It is recommended to use it instead
-   * of `x` in cases when the original view can be transformed as an
-   * effect of the gesture.
-   */
-  absoluteX: number;
-
-  /**
-   * Y coordinate of the current position of the pointer relative to the window.
-   * The value is expressed in point units. It is recommended to use it instead
-   * of `y` in cases when the original view can be transformed as an
-   * effect of the gesture.
-   */
-  absoluteY: number;
-
-  /**
-   * Object containing additional stylus data.
-   */
-  stylusData?: StylusData;
-};

package/src/handlers/LongPressGestureHandler.ts

@@ -1,65 +0,0 @@
-import { LongPressGestureHandlerEventPayload } from './GestureHandlerEventPayload';
-import createHandler from './createHandler';
-import {
-  BaseGestureHandlerProps,
-  baseGestureHandlerProps,
-} from './gestureHandlerCommon';
-
-export const longPressGestureHandlerProps = [
-  'minDurationMs',
-  'maxDist',
-  'numberOfPointers',
-] as const;
-
-export interface LongPressGestureConfig {
-  /**
-   * Minimum time, expressed in milliseconds, that a finger must remain pressed on
-   * the corresponding view. The default value is 500.
-   */
-  minDurationMs?: number;
-
-  /**
-   * Maximum distance, expressed in points, that defines how far the finger is
-   * allowed to travel during a long press gesture. If the finger travels
-   * further than the defined distance and the handler hasn't yet activated, it
-   * will fail to recognize the gesture. The default value is 10.
-   */
-  maxDist?: number;
-
-  /**
-   * Determine exact number of points required to handle the long press gesture.
-   */
-  numberOfPointers?: number;
-}
-
-/**
- * @deprecated LongPressGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.LongPress()` instead.
- */
-export interface LongPressGestureHandlerProps
-  extends BaseGestureHandlerProps<LongPressGestureHandlerEventPayload>,
-    LongPressGestureConfig {}
-
-export const longPressHandlerName = 'LongPressGestureHandler';
-
-/**
- * @deprecated LongPressGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.LongPress()` instead.
- */
-export type LongPressGestureHandler = typeof LongPressGestureHandler;
-
-/**
- * @deprecated LongPressGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.LongPress()` instead.
- */
-// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
-export const LongPressGestureHandler = createHandler<
-  LongPressGestureHandlerProps,
-  LongPressGestureHandlerEventPayload
->({
-  name: longPressHandlerName,
-  allowedProps: [
-    ...baseGestureHandlerProps,
-    ...longPressGestureHandlerProps,
-  ] as const,
-  config: {
-    shouldCancelWhenOutside: true,
-  },
-});

package/src/handlers/NativeViewGestureHandler.ts

@@ -1,59 +0,0 @@
-import type { NativeViewGestureHandlerPayload } from './GestureHandlerEventPayload';
-import createHandler from './createHandler';
-import {
-  BaseGestureHandlerProps,
-  baseGestureHandlerProps,
-} from './gestureHandlerCommon';
-
-export const nativeViewGestureHandlerProps = [
-  'shouldActivateOnStart',
-  'disallowInterruption',
-] as const;
-
-export interface NativeViewGestureConfig {
-  /**
-   * Android only.
-   *
-   * Determines whether the handler should check for an existing touch event on
-   * instantiation.
-   */
-  shouldActivateOnStart?: boolean;
-
-  /**
-   * When `true`, cancels all other gesture handlers when this
-   * `NativeViewGestureHandler` receives an `ACTIVE` state event.
-   */
-  disallowInterruption?: boolean;
-}
-
-/**
- * @deprecated NativeViewGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Native()` instead.
- */
-export interface NativeViewGestureHandlerProps
-  extends BaseGestureHandlerProps<NativeViewGestureHandlerPayload>,
-    NativeViewGestureConfig {}
-
-export const nativeViewProps = [
-  ...baseGestureHandlerProps,
-  ...nativeViewGestureHandlerProps,
-] as const;
-
-export const nativeViewHandlerName = 'NativeViewGestureHandler';
-
-/**
- * @deprecated NativeViewGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Native()` instead.
- */
-export type NativeViewGestureHandler = typeof NativeViewGestureHandler;
-
-/**
- * @deprecated NativeViewGestureHandler will be removed in the future version of Gesture Handler. Use `Gesture.Native()` instead.
- */
-// eslint-disable-next-line @typescript-eslint/no-redeclare -- backward compatibility; see description on the top of gestureHandlerCommon.ts file
-export const NativeViewGestureHandler = createHandler<
-  NativeViewGestureHandlerProps,
-  NativeViewGestureHandlerPayload
->({
-  name: nativeViewHandlerName,
-  allowedProps: nativeViewProps,
-  config: {},
-});