react-native-gesture-handler/src/v3/hooks/gestures/tap/useTapGesture.ts

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

import { SingleGestureName } from '../../../types';
import { useGesture } from '../../useGesture';
import { useClonedAndRemappedConfig } from '../../utils';
import type {
  TapGesture,
  TapGestureConfig,
  TapGestureInternalConfig,
  TapGestureInternalProperties,
  TapGestureProperties,
  TapHandlerData,
} from './TapTypes';

const TapPropsMapping = new Map<
  keyof TapGestureProperties,
  keyof TapGestureInternalProperties
>([
  ['maxDistance', 'maxDist'],
  ['maxDuration', 'maxDurationMs'],
  ['maxDelay', 'maxDelayMs'],
]);

function transformTapProps(
  config: TapGestureConfig & TapGestureInternalConfig
) {
  if (config.shouldCancelWhenOutside === undefined) {
    config.shouldCancelWhenOutside = true;
  }

  return config;
}

const EMPTY_TAP_CONFIG: TapGestureConfig = {};

export function useTapGesture(
  config: TapGestureConfig = EMPTY_TAP_CONFIG
): TapGesture {
  const tapConfig = useClonedAndRemappedConfig<
    TapGestureProperties,
    TapHandlerData,
    TapGestureInternalProperties
  >(config, TapPropsMapping, transformTapProps);

  return useGesture<TapGestureInternalProperties, TapHandlerData>(
    SingleGestureName.Tap,
    tapConfig
  );
}