@siberiacancode/reactuse 0.0.59 → 0.0.60

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect } from 'react';
+import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect, MouseEventHandler, TouchEventHandler } from 'react';
 import { BatteryManager, EyeDropperConstructor, ColorSelectionOptions, ColorSelectionResult, Connection } from '@/utils/types';
 
 interface UseAsyncReturn<Data> {
@@ -1260,37 +1260,29 @@ declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageIni
  */
 declare const useLogger: (name: string, params: unknown[]) => void;
 
-type UseLongPressTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type LongPressReactEvents<Target extends Element = Element> = MouseEventHandler<Target> | TouchEventHandler<Target>;
 interface UseLongPressOptions {
     threshold?: number;
-    onStart?: (event: Event) => void;
-    onFinish?: (event: Event) => void;
-    onCancel?: (event: Event) => void;
-}
-type UseLongPressReturn<Target extends UseLongPressTarget> = [RefObject<Target>, boolean];
-type UseLongPress = {
-    <Target extends UseLongPressTarget>(target: Target, callback: (event: Event) => void, options?: UseLongPressOptions): boolean;
-    <Target extends UseLongPressTarget>(callback: (event: Event) => void, options?: UseLongPressOptions, target?: never): UseLongPressReturn<Target>;
-};
+    onStart?: (event: LongPressReactEvents) => void;
+    onFinish?: (event: LongPressReactEvents) => void;
+    onCancel?: (event: LongPressReactEvents) => void;
+}
+interface UseLongPressBind {
+    /** The callback function to be invoked on mouse down */
+    onMouseDown: MouseEventHandler<Element>;
+    /** The callback function to be invoked on touch start */
+    onTouchStart: TouchEventHandler<Element>;
+    /** The callback function to be invoked on mouse up */
+    onMouseUp: MouseEventHandler<Element>;
+    /** The callback function to be invoked on touch end */
+    onTouchEnd: TouchEventHandler<Element>;
+}
+type UseLongPressReturn = [UseLongPressBind, boolean];
 /**
  * @name useLongPress
  * @description - Hook that defines the logic when long pressing an element
  * @category Sensors
  *
- * @overload
- * @template Target The target element
- * @param {Target} target The target element to be long pressed
- * @param {(event: Event) => void} callback The callback function to be invoked on long press
- * @param {number} [options.threshold=400] The threshold time in milliseconds
- * @param {(event: Event) => void} [options.onStart] The callback function to be invoked on long press start
- * @param {(event: Event) => void} [options.onFinish] The callback function to be invoked on long press finish
- * @param {(event: Event) => void} [options.onCancel] The callback function to be invoked on long press cancel
- * @returns {void}
- *
- * @example
- * const longPressing = useLongPress(ref, () => console.log('callback'));
- *
- * @overload
  * @template Target The target element
  * @param {Target} target The target element to be long pressed
  * @param {(event: Event) => void} callback The callback function to be invoked on long press
@@ -1301,9 +1293,9 @@ type UseLongPress = {
  * @returns {UseLongPressReturn<Target>} The ref of the target element
  *
  * @example
- * const [ref, longPressing] = useLongPress(() => console.log('callback'));
+ * const [bind, longPressing] = useLongPress(() => console.log('callback'));
  */
-declare const useLongPress: UseLongPress;
+declare const useLongPress: (callback: (event: LongPressReactEvents) => void, options?: UseLongPressOptions) => UseLongPressReturn;
 
 /** The use map return type */
 interface UseMapReturn<Key, Value> {
@@ -2466,6 +2458,9 @@ declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardSte
 
 declare const debounce: <Params extends unknown[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
+type GetElementTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
+declare const getElement: <Target extends GetElementTarget>(target: Target) => Element | (Target & Document) | (Target & Window) | null | undefined;
+
 declare const getRetry: (retry: number | boolean) => number;
 
 declare const isClient: boolean;
@@ -2488,4 +2483,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };
+export { type GetElementTarget, debounce, getDate, getElement, getRetry, isClient, isPermissionAllowed, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.59",
+  "version": "0.0.60",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

package/dist/cjs/_rollupPluginBabelHelpers-DBlUbyen.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-DBlUbyen.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-DwIyQruH.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-DwIyQruH.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}