import { TouchEvent } from 'react'; /** * Type definition for swipe direction * @property {string | null} direction - The direction of the swipe (left, right, or null) */ export type UseSwipeFn = { /** * The direction of the swipe (left, right, or null) */ direction: string | null; }; /** * Custom hook for detecting swipe gestures on touch devices. * * Features: * - Detects left and right swipe gestures * - Configurable minimum swipe distance threshold * - Provides touch event handlers for easy integration * - Supports optional callback function for swipe events * - Tracks current swipe direction state * - Handles touch start, move, and end events * - Prevents false positives from regular touch events * * @param func - Optional callback function called when a swipe is detected * @returns Object containing touch event handlers and current swipe direction */ export declare const useSwipe: (func?: (direction: UseSwipeFn["direction"]) => void) => { onTouchMove: (e: TouchEvent) => void; onTouchEnd: (_e: TouchEvent) => void; onTouchStart: (e: TouchEvent) => void; direction: string | null; };