@siberiacancode/reactuse 0.0.90 → 0.0.93

package/dist/types/index.d.ts

@@ -275,6 +275,7 @@ declare const useBrowserLanguage: () => string;
 interface StateRef<Value> {
     (node: Value): void;
     current: Value;
+    state?: Value;
 }
 /**
  * @name useRefState
@@ -620,6 +621,64 @@ interface UseDisclosureReturn {
  */
 declare const useDisclosure: (initialValue?: boolean, options?: UseDisclosureOptions) => UseDisclosureReturn;
 
+/** The use display media return type */
+interface UseDisplayMediaReturn {
+    /** Whether screen sharing is currently active */
+    sharing: boolean;
+    /** The media stream object */
+    stream: MediaStream | null;
+    /** Whether the display media API is supported */
+    supported: boolean;
+    /** Start screen sharing */
+    start: () => Promise<void>;
+    /** Stop screen sharing */
+    stop: () => void;
+}
+/** The use display media options type */
+interface UseDisplayMediaOptions {
+    /** Whether to enable audio sharing */
+    audio?: boolean | MediaTrackConstraints;
+    /** Whether to start immediately */
+    enabled?: boolean;
+    /** Whether to enable video sharing */
+    video?: boolean | MediaTrackConstraints;
+}
+/** The use display media target type */
+type UseDisplayMediaTarget = string | HTMLVideoElement | RefObject<HTMLVideoElement | null | undefined>;
+interface UseDisplayMediaOverload {
+    <Target extends UseDisplayMediaTarget>(target: Target, options?: UseDisplayMediaOptions): UseDisplayMediaReturn;
+    <Target extends UseDisplayMediaTarget = HTMLVideoElement>(options?: UseDisplayMediaOptions, target?: Target): {
+        ref: StateRef<Target>;
+    } & UseDisplayMediaReturn;
+}
+/**
+ * @name useDisplayMedia
+ * @description - Hook that provides screen sharing functionality using the Display Media API
+ * @category Browser
+ *
+ * @overload
+ * @template Target The target video element
+ * @param {Target} target The target video element to display the media stream
+ * @param {boolean | MediaTrackConstraints} [options.audio] Whether to enable audio sharing
+ * @param {boolean} [options.enabled=false] Whether to start immediately
+ * @param {boolean | MediaTrackConstraints} [options.video] Whether to enable video sharing
+ * @returns {UseDisplayMediaReturn} Object containing stream, sharing status and control methods
+ *
+ * @example
+ * const { stream, sharing, start, stop } = useDisplayMedia(ref);
+ *
+ * @overload
+ * @template Target The target video element
+ * @param {boolean | MediaTrackConstraints} [options.audio] Whether to enable audio sharing
+ * @param {boolean} [options.enabled=false] Whether to start immediately
+ * @param {boolean | MediaTrackConstraints} [options.video] Whether to enable video sharing
+ * @returns {UseDisplayMediaReturn & { ref: StateRef<HTMLVideoElement> }} Object containing stream, sharing status, control methods and ref
+ *
+ * @example
+ * const { ref, stream, sharing, start, stop } = useDisplayMedia<HTMLVideoElement>();
+ */
+declare const useDisplayMedia: UseDisplayMediaOverload;
+
 /** The use event listener target type */
 type UseEventListenerTarget = string | Document | Element | RefObject<Element | null | undefined> | Window;
 /** The use event listener options */
@@ -1230,41 +1289,61 @@ declare const useHash: () => UseHashReturn;
 /** The use hotkeys params type */
 interface UseHotkeysOptions {
     /** Alias map for hotkeys */
-    aliasMap?: Record<string, string>;
+    alias?: Record<string, string>;
     /** Enable or disable the event listeners */
     enabled?: boolean;
-    /** Whether to prevent the default behavior of the event */
-    preventDefault?: boolean;
-    /** The target to attach the event listeners to */
-    target?: UseEventListenerTarget;
 }
 declare const isHotkeyMatch: (hotkey: string, keys: UseHotkeysKey[]) => boolean;
-type UseHotkeysHotkeys = string | string[];
+/** The hotkeys string type */
+type UseHotkeysHotkeys = string;
+/** The hotkey key information */
 interface UseHotkeysKey {
+    /** The alias for the key */
     alias: string;
+    /** The key code */
     code: string;
+    /** The key value */
     key: string;
 }
+/** The use hotkeys target type */
+type UseHotkeysTarget = Element | React.RefObject<Element | null | undefined>;
+interface UseHotkeys {
+    <Target extends UseHotkeysTarget>(target: Target, hotkeys: UseHotkeysHotkeys, callback: (event: KeyboardEvent) => void, options?: UseHotkeysOptions): void;
+    <Target extends UseHotkeysTarget>(hotkeys: UseHotkeysHotkeys, callback: (event: KeyboardEvent) => void, options?: UseHotkeysOptions, target?: never): StateRef<Target>;
+}
 /**
  * @name useHotkeys
  * @description - Hook that listens for hotkeys
  * @category Sensors
  *
- * @param {UseHotkeysHotkeys} hotkeys The key or keys to listen for
- * @param {(event: KeyboardEvent) => void} callback The callback function to be called when the hotkey is pressed
- * @param {UseEventListenerTarget} [options.target=window] The target to attach the event listeners to
- * @param {boolean} [options.enabled=true] The enable or disable the event listeners
- * @param {boolean} [options.preventDefault=true] Whether to prevent the default behavior of the event
- * @param {Record<string, string>} [options.aliasMap] Alias map for hotkeys
- * @returns {useKeysPressedReturns} Array of strings with keys that were press
+ * @overload
+ * @template Target The target element
+ * @param {Target} [target=window] The target element to attach the event listener to
+ * @param {string} hotkeys The hotkey to listen for
+ * @param {(event: KeyboardEvent) => void} callback The callback function to execute when hotkey is pressed
+ * @param {Record<string, string>} [options.alias] Alias map for hotkeys
+ * @param {boolean} [options.enabled=true] Enable or disable the event listeners
+ * @returns {void}
  *
  * @example
- * useHotkeys('control+a', () => console.log('hotkey pressed'));
+ * useHotkeys(ref, 'ctrl+a', () => console.log('hotkey pressed'));
+ * @example
+ * useHotkeys(ref, 'ctrl+a, ctrl+b', () => console.log('hotkey pressed'));
+ *
+ * @overload
+ * @template Target The target element
+ * @param {string} hotkeys The hotkey to listen for
+ * @param {(event: KeyboardEvent) => void} callback The callback function to execute when hotkey is pressed
+ * @param {Record<string, string>} [options.alias] Alias map for hotkeys
+ * @param {boolean} [options.enabled=true] Enable or disable the event listeners
+ * @returns {StateRef<Target>} A reference to the target element
  *
  * @example
- * useHotkeys('ControlLeft+KeyA', () => console.log('hotkey pressed'));
+ * const ref = useHotkeys('ctrl+a', () => console.log('hotkey pressed'));
+ * @example
+ * const ref = useHotkeys('ctrl+a, ctrl+b', () => console.log('hotkey pressed'));
  */
-declare const useHotkeys: (hotkeys: UseHotkeysHotkeys, callback: (event: KeyboardEvent) => void, options?: UseHotkeysOptions) => void;
+declare const useHotkeys: UseHotkeys;
 
 /** The use hover target type */
 type UseHoverTarget = string | Element | RefObject<Element | null | undefined>;
@@ -1565,7 +1644,7 @@ interface UseInterval {
  * @overload
  * @param {() => void} callback Any callback function
  * @param {number} [interval=1000] Time in milliseconds
- * @param {boolean} [options.immediate=true] Start the interval immediately
+ * @param {boolean} [options.enabled=true] Start the interval immediately
  * @returns {UseIntervalReturn}
  *
  * @example
@@ -1574,7 +1653,7 @@ interface UseInterval {
  * @overload
  * @param {() => void} callback Any callback function
  * @param {number} [options.interval=1000] Time in milliseconds
- * @param {boolean} [options.immediate=true] Start the interval immediately
+ * @param {boolean} [options.enabled=true] Start the interval immediately
  *
  * @example
  * const { active, pause, resume } = useInterval(() => console.log('inside interval'), { interval: 2500 });
@@ -2855,8 +2934,8 @@ interface UseResizeObserverReturn {
     entries: ResizeObserverEntry[];
 }
 interface UseResizeObserver {
-    <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(target: Target, options?: UseResizeObserverOptions): UseResizeObserverReturn;
-    <Target extends UseResizeObserverTarget | UseResizeObserverTarget[]>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
+    <Target extends UseResizeObserverTarget>(target: Target, options?: UseResizeObserverOptions): UseResizeObserverReturn;
+    <Target extends UseResizeObserverTarget>(options?: UseResizeObserverOptions, target?: never): UseResizeObserverReturn & {
         ref: StateRef<Target>;
     };
 }
@@ -3040,12 +3119,64 @@ interface UseScroll {
  */
 declare const useScroll: UseScroll;
 
+/** The scroll into view options type */
+interface UseScrollIntoViewOptions extends ScrollIntoViewOptions {
+    /** Whether to enable the scroll into view */
+    enabled?: boolean;
+}
+/** The scroll into view target type */
+type UseScrollIntoViewTarget = string | Element | RefObject<Element | null | undefined>;
+/** The scroll into view return type */
+interface UseScrollIntoViewReturn {
+    /** Function to scroll element into view */
+    trigger: (params?: {
+        behavior?: ScrollBehavior;
+        block?: ScrollLogicalPosition;
+        inline?: ScrollLogicalPosition;
+    }) => void;
+}
+interface UseScrollIntoViewOverload {
+    <Target extends UseScrollIntoViewTarget>(target: Target, options?: UseScrollIntoViewOptions): UseScrollIntoViewReturn;
+    <Target extends UseScrollIntoViewTarget>(options?: UseScrollIntoViewOptions, target?: never): {
+        ref: StateRef<Target>;
+    } & UseScrollIntoViewReturn;
+}
+/**
+ * @name useScrollIntoView
+ * @description - Hook that provides functionality to scroll an element into view
+ * @category Sensors
+ *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to scroll into view
+ * @param {ScrollBehavior} [options.behavior='smooth'] The scrolling behavior
+ * @param {ScrollLogicalPosition} [options.block='start'] The vertical alignment
+ * @param {ScrollLogicalPosition} [options.inline='nearest'] The horizontal alignment
+ * @returns {UseScrollIntoViewReturn} Object containing scroll function
+ *
+ * @example
+ * const { trigger } = useScrollIntoView(ref);
+ *
+ * @overload
+ * @template Target The target element
+ * @param {ScrollBehavior} [options.behavior='smooth'] The scrolling behavior
+ * @param {ScrollLogicalPosition} [options.block='start'] The vertical alignment
+ * @param {ScrollLogicalPosition} [options.inline='nearest'] The horizontal alignment
+ * @returns {UseScrollIntoViewReturn & { ref: StateRef<Target> }} Object containing scroll function and ref
+ *
+ * @example
+ * const { ref, trigger } = useScrollIntoView<HTMLDivElement>();
+ */
+declare const useScrollIntoView: UseScrollIntoViewOverload;
+
 /** The use scroll target element type */
 type UseScrollToTarget = string | Document | Element | RefObject<Element | null | undefined> | Window;
 /** The use scroll to options type */
 interface UseScrollToOptions {
     /** The scrolling behavior */
     behavior?: ScrollBehavior;
+    /** Whether to enable the scroll to */
+    enabled?: boolean;
     /** The horizontal position to scroll to */
     x: number;
     /** The vertical position to scroll to */
@@ -3054,7 +3185,7 @@ interface UseScrollToOptions {
 /** The use scroll to return type */
 interface UseScrollToReturn {
     /** The state of scrolling */
-    trigger: (params: {
+    trigger: (params?: {
         x: number;
         y: number;
         behavior?: ScrollBehavior;
@@ -3156,20 +3287,20 @@ declare const useSet: <Value>(values?: Value[]) => UseSetReturn<Value>;
 
 /** The use share options type */
 interface UseShareParams {
-    /** The files of the share */
+    /** Array of files to be shared */
     files?: File[];
-    /** The text of the share */
+    /** Text content to be shared */
     text?: string;
-    /** The title of the share */
+    /** Title of the content being shared */
     title?: string;
-    /** The url of the share */
+    /** URL link to be shared */
     url?: string;
 }
 /** The use share return type */
 interface UseShareReturn {
-    /** The share supported status */
+    /** Whether the Web Share API is supported in the current environment */
     supported: boolean;
-    /** The share function */
+    /** Function to trigger the native share dialog */
     share: (shareParams: ShareData) => Promise<void>;
 }
 /**
@@ -3188,6 +3319,39 @@ declare const useShare: (params?: UseShareParams) => {
     supported: boolean;
 };
 
+/** The use state history hook return type */
+interface UseStateHistoryReturn<Value> {
+    /** All history values */
+    history: Value[];
+    /** Current index in history */
+    index: number;
+    /** Current value */
+    value: Value;
+    /** Go back specified number of steps in history (default: 1) */
+    back: (steps?: number) => void;
+    /** Go forward specified number of steps in history (default: 1) */
+    forward: (steps?: number) => void;
+    /** Reset history to initial state */
+    reset: () => void;
+    /** Set a new value */
+    set: (value: Value) => void;
+    /** Undo the last change */
+    undo: () => void;
+}
+/**
+ * @name useStateHistory
+ * @description - Hook that manages state with history functionality
+ * @category Utilities
+ *
+ * @param {Value} initialValue - The initial value to start the history with
+ * @param {number} [maxSize=10] - Maximum number of history entries to keep
+ * @returns {UseStateHistoryReturn<Value>} Object containing current value, history array and control methods
+ *
+ * @example
+ * const { value, history, index, set, back, forward, reset, undo } = useStateHistory(0);
+ */
+declare const useStateHistory: <Value>(initialValue: Value, maxSize?: number) => UseStateHistoryReturn<Value>;
+
 /** The use step params type */
 interface UseStepParams {
     /** Initial value for step */
@@ -3720,8 +3884,6 @@ declare const getElement: <Target extends GetElementTarget>(target: Target) => E
 
 declare const getRetry: (retry: boolean | number) => number;
 
-declare const isClient: boolean;
-
 declare const isTarget: (target: any) => any;
 
 declare const throttle: <Params extends any[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
@@ -3740,4 +3902,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type StateRef, type UseAsyncReturn, type UseBatteryStateReturn, type UseBatteryValue, type UseBluetoothOptions, type UseBluetoothReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDevicePixelRatioReturn, type UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseElementSize, type UseElementSizeReturn, type UseElementSizeTarget, type UseElementSizeValue, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFocus, type UseFocusOptions, type UseFocusReturn, type UseFocusTarget, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseLastChangedOptions, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UseParallax, type UseParallaxOptions, type UseParallaxValue, type UsePermissionName, type UsePermissionOptions, type UsePermissionReturn, type UsePostMessageReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UsePreviousOptions, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseScroll, type UseScrollCallbackParams, type UseScrollOptions, type UseScrollTarget, type UseScrollTo, type UseScrollToOptions, type UseScrollToReturn, type UseScrollToTarget, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextDirection, type UseTextDirectionReturn, type UseTextDirectionTarget, type UseTextDirectionValue, type UseTextSelectionReturn, type UseTimeReturn, type UseTimer, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseVibratePattern, type UseVibrateReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, isTarget, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useActiveElement, useAsync, useBattery, useBluetooth, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useConst, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDevicePixelRatio, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useElementSize, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFocus, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useLastChanged, useLatest, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePointerLock, usePostMessage, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRefState, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useScroll, useScrollTo, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextDirection, useTextSelection, useThrottleCallback, useThrottleValue, useTime, useTimeout, useTimer, useToggle, useUnmount, useVibrate, useWebSocket, useWindowEvent, useWindowFocus, useWindowScroll, useWindowSize, useWizard };
+export { BREAKPOINTS_ANT_DESIGN, BREAKPOINTS_BOOTSTRAP_V5, BREAKPOINTS_MANTINE, BREAKPOINTS_MASTER_CSS, BREAKPOINTS_MATERIAL_UI, BREAKPOINTS_PRIME_FLEX, BREAKPOINTS_QUASAR_V2, BREAKPOINTS_SEMANTIC, BREAKPOINTS_TAILWIND, type BatteryManager, type Breakpoints, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, type ScrollPosition, type StateRef, type UseAsyncReturn, type UseBatteryStateReturn, type UseBatteryValue, type UseBluetoothOptions, type UseBluetoothReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCopyToClipboardParams, type UseCopyToClipboardReturn, type UseCounter, type UseCounterOptions, type UseCounterReturn, type UseCssVar, type UseCssVarReturn, type UseCssVarTarget, type UseDeviceMotionParams, type UseDeviceMotionReturn, type UseDeviceOrientationReturn, type UseDeviceOrientationValue, type UseDevicePixelRatioReturn, type UseDisclosureOptions, type UseDisclosureReturn, type UseDisplayMediaOptions, type UseDisplayMediaOverload, type UseDisplayMediaReturn, type UseDisplayMediaTarget, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseElementSize, type UseElementSizeReturn, type UseElementSizeTarget, type UseElementSizeValue, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFieldParams, type UseFieldRegisterParams, type UseFieldReturn, type UseFileDialog, type UseFileDialogOptions, type UseFileDialogReturn, type UseFocus, type UseFocusOptions, type UseFocusReturn, type UseFocusTarget, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseFullScreenTarget, type UseGamepadStateReturn, type UseGeolocationParams, type UseGeolocationReturn, type UseHotkeys, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHotkeysTarget, type UseHover, type UseHoverOptions, type UseHoverTarget, type UseIdleOptions, type UseIdleReturn, type UseImageOptions, type UseImageReturn, type UseInfiniteScroll, type UseInfiniteScrollOptions, type UseInfiniteScrollTarget, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseKeysPressedParams, type UseLastChangedOptions, type UseListReturn, type UseLongPressBind, type UseLongPressOptions, type UseLongPressReturn, type UseLongPressTarget, type UseMapReturn, type UseMeasureReturn, type UseMeasureScreen, type UseMeasureTarget, type UseMemoryReturn, type UseMouse, type UseMouseReturn, type UseMouseTarget, type UseMutationObserver, type UseMutationObserverOptions, type UseMutationObserverReturn, type UseMutationObserverTarget, type UseNetworkReturn, type UseOffsetPaginationOptions, type UseOffsetPaginationReturn, type UseOptimisticReturn, type UseOrientationReturn, type UseOtpCredential, type UseOtpCredentialCallback, type UseOtpCredentialParams, type UseOtpCredentialReturn, type UsePaint, type UsePaintOptions, type UsePaintReturn, type UsePaintTarget, type UseParallax, type UseParallaxOptions, type UseParallaxValue, type UsePermissionName, type UsePermissionOptions, type UsePermissionReturn, type UsePostMessageReturn, type UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, type UsePreviousOptions, type UseQueryOptions, type UseQueryReturn, type UseQueueReturn, type UseRafCallback, type UseRafOptions, type UseRafParams, type UseRafReturn, type UseRafValueReturn, type UseRenderInfoReturn, type UseResizeObserver, type UseResizeObserverOptions, type UseResizeObserverReturn, type UseResizeObserverTarget, type UseScreenOrientationValue, type UseScriptOptions, type UseScriptStatus, type UseScroll, type UseScrollCallbackParams, type UseScrollIntoViewOptions, type UseScrollIntoViewOverload, type UseScrollIntoViewReturn, type UseScrollIntoViewTarget, type UseScrollOptions, type UseScrollTarget, type UseScrollTo, type UseScrollToOptions, type UseScrollToReturn, type UseScrollToTarget, type UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextDirection, type UseTextDirectionReturn, type UseTextDirectionTarget, type UseTextDirectionValue, type UseTextSelectionReturn, type UseTimeReturn, type UseTimer, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseVibratePattern, type UseVibrateReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isHotkeyMatch, isPermissionAllowed, isTarget, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useActiveElement, useAsync, useBattery, useBluetooth, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useConst, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDevicePixelRatio, useDidUpdate, useDisclosure, useDisplayMedia, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useElementSize, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFocus, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useLastChanged, useLatest, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePointerLock, usePostMessage, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRefState, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useScroll, useScrollIntoView, useScrollTo, useSessionStorage, useSet, useShare, useStateHistory, useStep, useStopwatch, useStorage, useTextDirection, useTextSelection, useThrottleCallback, useThrottleValue, useTime, useTimeout, useTimer, useToggle, useUnmount, useVibrate, useWebSocket, useWindowEvent, useWindowFocus, useWindowScroll, useWindowSize, useWizard };

package/package.json

@@ -1,114 +1,89 @@
-{
-  "name": "@siberiacancode/reactuse",
-  "version": "0.0.90",
-  "description": "Ultimate tool",
-  "author": {
-    "name": "SIBERIA CAN CODE 🧊",
-    "url": "https://github.com/siberiacancode"
-  },
-  "contributors": [
-    {
-      "name": "Dmitry Babin",
-      "url": "https://github.com/debabin"
-    }
-  ],
-  "license": "MIT",
-  "homepage": "https://siberiacancode.github.io/reactuse/",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/siberiacancode/reactuse.git"
-  },
-  "bugs": "https://github.com/siberiacancode/reactuse/issues",
-  "keywords": [
-    "react",
-    "react hooks",
-    "react use",
-    "use",
-    "hooks"
-  ],
-  "sideEffects": false,
-  "exports": {
-    "types": "./dist/types/index.d.ts",
-    "import": "./dist/esm/index.js",
-    "require": "./dist/cjs/index.cjs"
-  },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=14"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "prepublishOnly": "yarn type && yarn unit-test run && yarn build",
-    "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
-    "lint": "eslint . --fix",
-    "type": "tsc --noEmit",
-    "format": "prettier --write .",
-    "pretty": "yarn type && yarn lint && yarn format",
-    "prepare": "husky",
-    "unit-test": "vitest",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
-  },
-  "peerDependencies": {
-    "@types/react": "^18.0.0",
-    "react": "^17.0.2 || ^18.0.0",
-    "react-dom": "^17.0.2 || ^18.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@types/react": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "screenfull": "^6.0.2"
-  },
-  "devDependencies": {
-    "@siberiacancode/builder": "^1.3.17",
-    "@siberiacancode/eslint": "^2.8.0",
-    "@siberiacancode/prettier": "^1.2.0",
-    "@siberiacancode/vitest": "^1.2.4",
-    "@tailwindcss/postcss": "^4.0.4",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/react": "^16.2.0",
-    "@types/doctrine": "^0.0.9",
-    "@types/node": "^22.13.1",
-    "@types/react": "^18.3.12",
-    "@types/react-dom": "^18.3.2",
-    "@types/web-bluetooth": "^0.0.20",
-    "clsx": "^2.1.1",
-    "comment-parser": "^1.4.1",
-    "core-js": "^3.40.0",
-    "doctrine": "^3.0.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "markdown-table": "^3.0.4",
-    "postcss": "^8.5.1",
-    "prettier-plugin-tailwindcss": "^0.6.11",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "shx": "^0.3.4",
-    "tailwind-merge": "^3.0.1",
-    "tailwindcss": "^4.0.4",
-    "typescript": "^5.7.3",
-    "vite": "^6.0.11",
-    "vitepress": "^1.6.3"
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "@siberiacancode/reactuse",
+  "version": "0.0.93",
+  "description": "Ultimate tool",
+  "author": {
+    "name": "SIBERIA CAN CODE 🧊",
+    "url": "https://github.com/siberiacancode"
+  },
+  "license": "MIT",
+  "homepage": "https://siberiacancode.github.io/reactuse/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/siberiacancode/reactuse.git"
+  },
+  "bugs": "https://github.com/siberiacancode/reactuse/issues",
+  "keywords": [
+    "react",
+    "react hooks",
+    "react use",
+    "use",
+    "hooks"
+  ],
+  "sideEffects": false,
+  "exports": {
+    "types": "./dist/types/index.d.ts",
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.cjs"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "yarn type && yarn unit-test run && yarn build",
+    "build": "shx rm -rf dist && rollup -c --bundleConfigAsCjs",
+    "lint": "eslint . --fix",
+    "lint-inspector": "npx @eslint/config-inspector@latest",
+    "type": "tsc --noEmit",
+    "pretty": "yarn type && yarn lint && yarn format",
+    "unit-test": "vitest",
+    "lint-staged": "lint-staged"
+  },
+  "peerDependencies": {
+    "@types/react": "^18.0.0",
+    "react": "^17.0.2 || ^18.0.0",
+    "react-dom": "^17.0.2 || ^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "screenfull": "^6.0.2"
+  },
+  "devDependencies": {
+    "@siberiacancode/builder": "^1.3.17",
+    "@siberiacancode/vitest": "^2.0.2",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.2.0",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.2",
+    "@types/web-bluetooth": "^0.0.20",
+    "core-js": "^3.40.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "shx": "^0.3.4",
+    "vite": "^6.1.1",
+    "vitest": "^3.0.6"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 siberiacancode
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

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

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

package/dist/cjs/utils/helpers/isClient.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.90 */
-"use strict";var e,n,d=!("undefined"==typeof window||null===(e=window)||void 0===e||!e.document||null===(n=window)||void 0===n||null===(n=n.document)||void 0===n||!n.createElement);exports.isClient=d;
-//# sourceMappingURL=isClient.js.map

package/dist/cjs/utils/helpers/isClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isClient.js","sources":["../../../../src/utils/helpers/isClient.ts"],"sourcesContent":["export const isClient = !!(\n  typeof window !== 'undefined' &&\n  window?.document &&\n  window?.document?.createElement\n);\n"],"names":["isClient","window","_window","document","_window2","createElement"],"mappings":";qBAAaA,IACO,oBAAXC,QACDC,QADuBA,EAC7BD,kBAAMC,IAANA,EAAQC,UACFC,QADUA,EAChBH,kBAAMG,GAAUA,QAAVA,EAANA,EAAQD,oBAAQC,IAAhBA,EAAkBC"}

package/dist/esm/_rollupPluginBabelHelpers-CNZ3s-mD.js.map

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

package/dist/esm/utils/helpers/isClient.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.90 */
-var n,d,e=!("undefined"==typeof window||null===(n=window)||void 0===n||!n.document||null===(d=window)||void 0===d||null===(d=d.document)||void 0===d||!d.createElement);export{e as isClient};
-//# sourceMappingURL=isClient.js.map

package/dist/esm/utils/helpers/isClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isClient.js","sources":["../../../../src/utils/helpers/isClient.ts"],"sourcesContent":["export const isClient = !!(\n  typeof window !== 'undefined' &&\n  window?.document &&\n  window?.document?.createElement\n);\n"],"names":["isClient","window","_window","document","_window2","createElement"],"mappings":";QAAaA,IACO,oBAAXC,QACDC,QADuBA,EAC7BD,kBAAMC,IAANA,EAAQC,UACFC,QADUA,EAChBH,kBAAMG,GAAUA,QAAVA,EAANA,EAAQD,oBAAQC,IAAhBA,EAAkBC"}