react-native-gesture-handler 3.0.0-beta.2 → 3.0.0-beta.4

package/src/v3/hooks/gestures/index.ts

@@ -1,59 +1,128 @@
-import type { FlingGestureEvent, FlingGesture } from './fling/useFlingGesture';
-import type { HoverGestureEvent, HoverGesture } from './hover/useHoverGesture';
 import type {
-  LongPressGestureEvent,
+  FlingGesture,
+  FlingGestureActiveEvent,
+  FlingGestureConfig,
+  FlingGestureEvent,
+} from './fling/FlingTypes';
+import type {
+  HoverGesture,
+  HoverGestureActiveEvent,
+  HoverGestureConfig,
+  HoverGestureEvent,
+} from './hover/HoverTypes';
+import type {
   LongPressGesture,
-} from './longPress/useLongPressGesture';
+  LongPressGestureActiveEvent,
+  LongPressGestureConfig,
+  LongPressGestureEvent,
+} from './longPress/LongPressTypes';
 import type {
-  ManualGestureEvent,
   ManualGesture,
-} from './manual/useManualGesture';
+  ManualGestureActiveEvent,
+  ManualGestureConfig,
+  ManualGestureEvent,
+} from './manual/ManualTypes';
 import type {
-  NativeGestureEvent,
   NativeGesture,
-} from './native/useNativeGesture';
-import type { PanGestureEvent, PanGesture } from './pan/usePanGesture';
-import type { PinchGestureEvent, PinchGesture } from './pinch/usePinchGesture';
+  NativeGestureActiveEvent,
+  NativeGestureConfig,
+  NativeGestureEvent,
+} from './native/NativeTypes';
+import type {
+  PanGesture,
+  PanGestureActiveEvent,
+  PanGestureConfig,
+  PanGestureEvent,
+} from './pan/PanTypes';
+import type {
+  PinchGesture,
+  PinchGestureActiveEvent,
+  PinchGestureConfig,
+  PinchGestureEvent,
+} from './pinch/PinchTypes';
 import type {
-  RotationGestureEvent,
   RotationGesture,
-} from './rotation/useRotationGesture';
-import type { TapGestureEvent, TapGesture } from './tap/useTapGesture';
+  RotationGestureActiveEvent,
+  RotationGestureConfig,
+  RotationGestureEvent,
+} from './rotation/RotationTypes';
+import type {
+  TapGesture,
+  TapGestureActiveEvent,
+  TapGestureConfig,
+  TapGestureEvent,
+} from './tap/TapTypes';
 
-export type { TapGestureConfig } from './tap/useTapGesture';
-export type { TapGesture, TapGestureEvent };
+export type {
+  TapGesture,
+  TapGestureActiveEvent,
+  TapGestureConfig,
+  TapGestureEvent,
+};
 export { useTapGesture } from './tap/useTapGesture';
 
-export type { FlingGestureConfig } from './fling/useFlingGesture';
-export type { FlingGesture, FlingGestureEvent };
+export type {
+  FlingGesture,
+  FlingGestureActiveEvent,
+  FlingGestureConfig,
+  FlingGestureEvent,
+};
 export { useFlingGesture } from './fling/useFlingGesture';
 
-export type { LongPressGestureConfig } from './longPress/useLongPressGesture';
-export type { LongPressGesture, LongPressGestureEvent };
+export type {
+  LongPressGesture,
+  LongPressGestureActiveEvent,
+  LongPressGestureConfig,
+  LongPressGestureEvent,
+};
 export { useLongPressGesture } from './longPress/useLongPressGesture';
 
-export type { PinchGestureConfig } from './pinch/usePinchGesture';
-export type { PinchGesture, PinchGestureEvent };
+export type {
+  PinchGesture,
+  PinchGestureActiveEvent,
+  PinchGestureConfig,
+  PinchGestureEvent,
+};
 export { usePinchGesture } from './pinch/usePinchGesture';
 
-export type { RotationGestureConfig } from './rotation/useRotationGesture';
-export type { RotationGesture, RotationGestureEvent };
+export type {
+  RotationGesture,
+  RotationGestureActiveEvent,
+  RotationGestureConfig,
+  RotationGestureEvent,
+};
 export { useRotationGesture } from './rotation/useRotationGesture';
 
-export type { HoverGestureConfig } from './hover/useHoverGesture';
-export type { HoverGesture, HoverGestureEvent };
+export type {
+  HoverGesture,
+  HoverGestureActiveEvent,
+  HoverGestureConfig,
+  HoverGestureEvent,
+};
 export { useHoverGesture } from './hover/useHoverGesture';
 
-export type { ManualGestureConfig } from './manual/useManualGesture';
-export type { ManualGesture, ManualGestureEvent };
+export type {
+  ManualGesture,
+  ManualGestureActiveEvent,
+  ManualGestureConfig,
+  ManualGestureEvent,
+};
 export { useManualGesture } from './manual/useManualGesture';
 
-export type { NativeViewGestureConfig } from './native/useNativeGesture';
-export type { NativeGesture, NativeGestureEvent };
+export type {
+  NativeGesture,
+  NativeGestureActiveEvent,
+  NativeGestureConfig,
+  NativeGestureEvent,
+};
 export { useNativeGesture } from './native/useNativeGesture';
 
-export type { PanGestureConfig } from './pan/usePanGesture';
-export type { PanGesture, PanGestureEvent };
+export type {
+  PanGesture,
+  PanGestureActiveEvent,
+  PanGestureConfig,
+  PanGestureEvent,
+};
 export { usePanGesture } from './pan/usePanGesture';
 
 export type SingleGesture =
@@ -67,12 +136,22 @@ export type SingleGesture =
   | NativeGesture
   | PanGesture;
 
+/* eslint-disable @typescript-eslint/no-duplicate-type-constituents */
 export type SingleGestureEvent =
   | TapGestureEvent
+  | TapGestureActiveEvent
   | FlingGestureEvent
+  | FlingGestureActiveEvent
   | LongPressGestureEvent
+  | LongPressGestureActiveEvent
   | RotationGestureEvent
+  | RotationGestureActiveEvent
   | HoverGestureEvent
+  | HoverGestureActiveEvent
   | ManualGestureEvent
+  | ManualGestureActiveEvent
   | NativeGestureEvent
-  | PanGestureEvent;
+  | NativeGestureActiveEvent
+  | PanGestureEvent
+  | PanGestureActiveEvent;
+/* eslint-enable @typescript-eslint/no-duplicate-type-constituents */

package/src/v3/hooks/gestures/longPress/{LongPressProperties.ts → LongPressTypes.ts}

@@ -1,3 +1,11 @@
+import type {
+  BaseDiscreteGestureConfig,
+  ExcludeInternalConfigProps,
+  GestureEvent,
+  SingleGesture,
+  WithSharedValue,
+} from '../../../types';
+
 type CommonLongPressGestureProperties = {
   /**
    * Determine exact number of points required to handle the long press gesture.
@@ -31,3 +39,34 @@ export type LongPressGestureNativeProperties =
 export const LongPressNativeProperties = new Set<
   keyof LongPressGestureNativeProperties
 >(['minDurationMs', 'maxDist', 'numberOfPointers']);
+
+export type LongPressHandlerData = {
+  x: number;
+  y: number;
+  absoluteX: number;
+  absoluteY: number;
+  duration: number;
+};
+
+export type LongPressGestureProperties =
+  WithSharedValue<LongPressGestureExternalProperties>;
+
+export type LongPressGestureInternalProperties =
+  WithSharedValue<LongPressGestureNativeProperties>;
+
+export type LongPressGestureConfig = ExcludeInternalConfigProps<
+  BaseDiscreteGestureConfig<LongPressGestureProperties, LongPressHandlerData>
+>;
+
+export type LongPressGestureInternalConfig = BaseDiscreteGestureConfig<
+  LongPressGestureInternalProperties,
+  LongPressHandlerData
+>;
+
+export type LongPressGestureEvent = GestureEvent<LongPressHandlerData>;
+export type LongPressGestureActiveEvent = LongPressGestureEvent;
+
+export type LongPressGesture = SingleGesture<
+  LongPressGestureProperties,
+  LongPressHandlerData
+>;

package/src/v3/hooks/gestures/longPress/useLongPressGesture.ts

@@ -1,47 +1,14 @@
-import {
-  BaseDiscreteGestureConfig,
-  ExcludeInternalConfigProps,
-  SingleGesture,
-  SingleGestureName,
-  WithSharedValue,
-  GestureEvent,
-} from '../../../types';
+import { SingleGestureName } from '../../../types';
 import { useGesture } from '../../useGesture';
 import { useClonedAndRemappedConfig } from '../../utils';
-import {
-  LongPressGestureExternalProperties,
-  LongPressGestureNativeProperties,
-} from './LongPressProperties';
-
-type LongPressHandlerData = {
-  x: number;
-  y: number;
-  absoluteX: number;
-  absoluteY: number;
-  duration: number;
-};
-
-type LongPressGestureProperties =
-  WithSharedValue<LongPressGestureExternalProperties>;
-
-type LongPressGestureInternalProperties =
-  WithSharedValue<LongPressGestureNativeProperties>;
-
-export type LongPressGestureConfig = ExcludeInternalConfigProps<
-  BaseDiscreteGestureConfig<LongPressHandlerData, LongPressGestureProperties>
->;
-
-type LongPressGestureInternalConfig = BaseDiscreteGestureConfig<
+import type {
+  LongPressGesture,
+  LongPressGestureConfig,
+  LongPressGestureInternalConfig,
+  LongPressGestureInternalProperties,
+  LongPressGestureProperties,
   LongPressHandlerData,
-  LongPressGestureInternalProperties
->;
-
-export type LongPressGestureEvent = GestureEvent<LongPressHandlerData>;
-
-export type LongPressGesture = SingleGesture<
-  LongPressHandlerData,
-  LongPressGestureProperties
->;
+} from './LongPressTypes';
 
 const LongPressPropsMapping = new Map<
   keyof LongPressGestureProperties,
@@ -61,16 +28,18 @@ function transformLongPressProps(
   return config;
 }
 
+const EMPTY_LONG_PRESS_CONFIG: LongPressGestureConfig = {};
+
 export function useLongPressGesture(
-  config: LongPressGestureConfig
+  config: LongPressGestureConfig = EMPTY_LONG_PRESS_CONFIG
 ): LongPressGesture {
   const longPressConfig = useClonedAndRemappedConfig<
-    LongPressHandlerData,
     LongPressGestureProperties,
+    LongPressHandlerData,
     LongPressGestureInternalProperties
   >(config, LongPressPropsMapping, transformLongPressProps);
 
-  return useGesture<LongPressHandlerData, LongPressGestureInternalProperties>(
+  return useGesture<LongPressGestureInternalProperties, LongPressHandlerData>(
     SingleGestureName.LongPress,
     longPressConfig
   );

package/src/v3/hooks/gestures/manual/ManualTypes.ts

@@ -0,0 +1,28 @@
+import type {
+  BaseGestureConfig,
+  ExcludeInternalConfigProps,
+  GestureEvent,
+  SingleGesture,
+} from '../../../types';
+
+export type ManualGestureNativeProperties = Record<string, never>;
+
+export type ManualHandlerData = Record<string, never>;
+
+export type ManualGestureProperties = ManualGestureNativeProperties;
+
+export type ManualGestureInternalConfig = BaseGestureConfig<
+  ManualGestureProperties,
+  ManualHandlerData
+>;
+
+export type ManualGestureConfig =
+  ExcludeInternalConfigProps<ManualGestureInternalConfig>;
+
+export type ManualGestureEvent = GestureEvent<ManualHandlerData>;
+export type ManualGestureActiveEvent = ManualGestureEvent;
+
+export type ManualGesture = SingleGesture<
+  ManualGestureProperties,
+  ManualHandlerData
+>;

package/src/v3/hooks/gestures/manual/useManualGesture.ts

@@ -1,38 +1,21 @@
-import {
-  BaseGestureConfig,
-  ExcludeInternalConfigProps,
-  SingleGesture,
-  SingleGestureName,
-  GestureEvent,
-} from '../../../types';
+import { SingleGestureName } from '../../../types';
 import { useGesture } from '../../useGesture';
 import { useClonedAndRemappedConfig } from '../../utils';
-import { ManualGestureNativeProperties } from './ManualProperties';
-
-type ManualHandlerData = Record<string, never>;
-
-type ManualGestureProperties = ManualGestureNativeProperties;
-
-type ManualGestureInternalConfig = BaseGestureConfig<
+import type {
+  ManualGesture,
+  ManualGestureConfig,
+  ManualGestureProperties,
   ManualHandlerData,
-  ManualGestureProperties
->;
+} from './ManualTypes';
 
-export type ManualGestureConfig =
-  ExcludeInternalConfigProps<ManualGestureInternalConfig>;
-
-export type ManualGestureEvent = GestureEvent<ManualHandlerData>;
-
-export type ManualGesture = SingleGesture<
-  ManualHandlerData,
-  ManualGestureProperties
->;
+const EMPTY_MANUAL_CONFIG: ManualGestureConfig = {};
 
-export function useManualGesture(config: ManualGestureConfig): ManualGesture {
+export function useManualGesture(
+  config: ManualGestureConfig = EMPTY_MANUAL_CONFIG
+): ManualGesture {
   const manualConfig = useClonedAndRemappedConfig<
-    ManualHandlerData,
     ManualGestureProperties,
-    ManualGestureProperties
+    ManualHandlerData
   >(config);
 
   return useGesture(SingleGestureName.Manual, manualConfig);

package/src/v3/hooks/gestures/native/NativeTypes.ts

@@ -0,0 +1,62 @@
+import type {
+  BaseGestureConfig,
+  ExcludeInternalConfigProps,
+  GestureEvent,
+  SingleGesture,
+  WithSharedValue,
+} from '../../../types';
+
+export type NativeGestureNativeProperties = {
+  /**
+   * 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;
+
+  /**
+   * Composes with `disallowInterruption`. When both are `true`, the handler still
+   * resists discrete gestures but yields to continuous gestures, so a wrapping
+   * gesture can take over the touch stream. No-op when `disallowInterruption` is
+   * `false`.
+   */
+  yieldsToContinuousGestures?: boolean;
+};
+
+export const NativeHandlerNativeProperties = new Set<
+  keyof NativeGestureNativeProperties
+>([
+  'shouldActivateOnStart',
+  'disallowInterruption',
+  'yieldsToContinuousGestures',
+]);
+
+export type NativeHandlerData = {
+  pointerInside: boolean;
+};
+
+export type NativeGestureProperties =
+  WithSharedValue<NativeGestureNativeProperties>;
+
+export type NativeGestureInternalConfig = BaseGestureConfig<
+  NativeGestureProperties,
+  NativeHandlerData
+>;
+
+export type NativeGestureConfig =
+  ExcludeInternalConfigProps<NativeGestureInternalConfig>;
+
+export type NativeGestureEvent = GestureEvent<NativeHandlerData>;
+export type NativeGestureActiveEvent = NativeGestureEvent;
+
+export type NativeGesture = SingleGesture<
+  NativeGestureProperties,
+  NativeHandlerData
+>;

package/src/v3/hooks/gestures/native/useNativeGesture.ts

@@ -1,44 +1,21 @@
-import {
-  BaseDiscreteGestureConfig,
-  ExcludeInternalConfigProps,
-  SingleGesture,
-  SingleGestureName,
-  WithSharedValue,
-  GestureEvent,
-} from '../../../types';
+import { SingleGestureName } from '../../../types';
 import { useGesture } from '../../useGesture';
 import { useClonedAndRemappedConfig } from '../../utils';
-import { NativeGestureNativeProperties } from './NativeProperties';
+import type {
+  NativeGesture,
+  NativeGestureConfig,
+  NativeGestureProperties,
+  NativeHandlerData,
+} from './NativeTypes';
 
-export type NativeViewHandlerData = {
-  pointerInside: boolean;
-};
-
-type NativeViewGestureProperties =
-  WithSharedValue<NativeGestureNativeProperties>;
-
-type NativeViewGestureInternalConfig = BaseDiscreteGestureConfig<
-  NativeViewHandlerData,
-  NativeViewGestureProperties
->;
-
-export type NativeViewGestureConfig =
-  ExcludeInternalConfigProps<NativeViewGestureInternalConfig>;
-
-export type NativeGestureEvent = GestureEvent<NativeViewHandlerData>;
-
-export type NativeGesture = SingleGesture<
-  NativeViewHandlerData,
-  NativeViewGestureProperties
->;
+const EMPTY_NATIVE_CONFIG: NativeGestureConfig = {};
 
 export function useNativeGesture(
-  config: NativeViewGestureConfig
+  config: NativeGestureConfig = EMPTY_NATIVE_CONFIG
 ): NativeGesture {
   const nativeConfig = useClonedAndRemappedConfig<
-    NativeViewHandlerData,
-    NativeViewGestureProperties,
-    NativeViewGestureProperties
+    NativeGestureProperties,
+    NativeHandlerData
   >(config);
 
   return useGesture(SingleGestureName.Native, nativeConfig);

package/src/v3/hooks/gestures/pan/{PanProperties.ts → PanTypes.ts}

@@ -1,3 +1,12 @@
+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
@@ -117,3 +126,49 @@ export const PanNativeProperties = new Set<keyof PanGestureNativeProperties>([
   '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
+>;