@siberiacancode/reactuse 0.0.98 → 0.0.100

package/dist/types/index.d.ts

@@ -69,6 +69,8 @@ interface UseBatteryStateReturn {
  * @description - Hook for getting information about battery status
  * @category Browser
  *
+ * @browserapi navigator.getBattery https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getBattery
+ *
  * @returns {UseBatteryStateReturn} Object containing battery information & Battery API support
  *
  * @example
@@ -103,6 +105,8 @@ interface UseBluetoothOptions {
  * @description - Hook for getting information about bluetooth
  * @category Browser
  *
+ * @browserapi navigator.bluetooth https://developer.mozilla.org/en-US/docs/Web/API/Navigator/bluetooth
+ *
  * @param {boolean} [options.acceptAllDevices=false] The options to request all Bluetooth devices
  * @param {Array<BluetoothLEScanFilter>} [options.filters] Array of filters to apply when scanning Bluetooth devices
  * @param {Array<BluetoothServiceUUID>} [options.optionalServices] Array of optional services that the application can use
@@ -122,7 +126,7 @@ type UseBooleanReturn = [
 ];
 /**
  * @name useBoolean
- * @description - Hook provides a boolean state and a function to toggle the boolean value
+ * @description - Hook provides opportunity to manage boolean state
  * @category Utilities
  *
  * @param {boolean} [initialValue=false] The initial boolean value
@@ -264,6 +268,8 @@ declare const BREAKPOINTS_PRIME_FLEX: {
  * @description - Hook that returns the current browser language
  * @category Browser
  *
+ * @browserapi navigator.language https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language
+ *
  * @returns {string} The current browser language
  *
  * @example
@@ -279,7 +285,7 @@ interface StateRef<Value> {
 /**
  * @name useRefState
  * @description - Hook that returns the state reference of the value
- * @category Lifecycle
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value} [initialValue] The initial value
@@ -341,6 +347,8 @@ interface UseCopyToClipboardParams {
  * @description - Hook that manages a copy to clipboard
  * @category Browser
  *
+ * @browserapi navigator.clipboard https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clipboard
+ *
  * @param {boolean} [params.enabled=false] Whether the copy to clipboard is enabled
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
  *
@@ -481,7 +489,7 @@ interface UseCounter {
 }
 /**
  * @name useCounter
- * @description - Hook that manages a counter with increment, decrement, reset, and set functionalities
+ * @description - Hook that manages a counter
  * @category Utilities
  *
  * @overload
@@ -519,7 +527,7 @@ interface UseCssVar {
 }
 /**
  * @name useCssVar
- * @description - Hook that returns the value of a CSS variable
+ * @description - Hook that returns the value of a css variable
  * @category Utilities
  *
  * @overload
@@ -544,7 +552,7 @@ declare const useCssVar: UseCssVar;
 
 /**
  * @name useDebounceCallback
- * @description - Hook that creates a debounced callback and returns a stable reference of it
+ * @description - Hook that creates a debounced callback
  * @category Utilities
  *
  * @template Params The type of the params
@@ -560,7 +568,7 @@ declare const useDebounceCallback: <Params extends unknown[], Return>(callback:
 
 /**
  * @name useDebounceValue
- * @description - Hook that creates a debounced value and returns a stable reference of it
+ * @description - Hook that creates a debounced value
  * @category Utilities
  *
  * @template Value The type of the value
@@ -607,6 +615,8 @@ interface UseDeviceMotionParams {
  * @description - Hook that work with device motion
  * @category Utilities
  *
+ * @browserapi DeviceMotionEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceMotionEvent
+ *
  * @param {number} [delay=1000] The delay in milliseconds
  * @param {(event: DeviceMotionEvent) => void} [callback] The callback function to be invoked
  * @param {boolean} [enabled=true] Whether to enable the hook
@@ -638,6 +648,8 @@ interface UseDeviceOrientationReturn {
  * @description - Hook that provides the current device orientation
  * @category Sensors
  *
+ * @browserapi DeviceOrientationEvent https://developer.mozilla.org/en-US/docs/Web/API/Window/DeviceOrientationEvent
+ *
  * @returns {UseDeviceOrientationReturn} The current device orientation
  *
  * @example
@@ -654,9 +666,11 @@ interface UseDevicePixelRatioReturn {
 }
 /**
  * @name useDevicePixelRatio
- * @description - Hook that returns the ratio of the resolution in physical pixels to the resolution in CSS pixels for the current display device
+ * @description - Hook that returns the device's pixel ratio
  * @category Utilities
  *
+ * @browserapi window.devicePixelRatio https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
+ *
  * @returns {UseDevicePixelRatioReturn} The ratio and supported flag
  *
  * @example
@@ -666,14 +680,14 @@ declare const useDevicePixelRatio: () => UseDevicePixelRatioReturn;
 
 /**
  * @name useDidUpdate
- * @description – Hook that behaves like useEffect, but skips the effect on the initial render
+ * @description – Hook that triggers the effect callback on updates
  * @category Lifecycle
  *
  * @param {EffectCallback} effect The effect callback
  * @param {DependencyList} [deps] The dependencies list for the effect
  *
  * @example
- * useDidUpdate(() => console.log('Won't be called when mounted'), [deps]);
+ * useDidUpdate(() => console.log("Won't be called when mounted"), [deps]);
  */
 declare const useDidUpdate: (effect: EffectCallback, deps?: DependencyList) => void;
 
@@ -742,9 +756,11 @@ interface UseDisplayMediaOverload {
 }
 /**
  * @name useDisplayMedia
- * @description - Hook that provides screen sharing functionality using the Display Media API
+ * @description - Hook that provides screen sharing functionality
  * @category Browser
  *
+ * @browserapi mediaDevices.getDisplayMedia https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia
+ *
  * @overload
  * @template Target The target video element
  * @param {Target} target The target video element to display the media stream
@@ -973,6 +989,8 @@ interface UseEyeDropperReturn {
  * @description - Hook that gives you access to the eye dropper
  * @category Browser
  *
+ * @browserapi EyeDropper https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper
+ *
  * @param {string} [initialValue=undefined] The initial value for the eye dropper
  * @returns {UseEyeDropperReturn} An object containing the supported status, the value and the open method
  *
@@ -1191,6 +1209,8 @@ declare const useFocus: UseFocus;
  * @description - Hook that measures frames per second
  * @category Sensors
  *
+ * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
+ *
  * @returns {number} A number which determines frames per second
  *
  * @example
@@ -1254,6 +1274,37 @@ interface UseFullScreen {
  */
 declare const useFullscreen: UseFullScreen;
 
+declare global {
+    interface Gamepad {
+        hapticActuators?: GamepadHapticActuator[];
+    }
+}
+/** The use gamepad return type  */
+interface UseGamepadStateReturn {
+    /** The gamepad active status */
+    active: boolean;
+    /** The gamepad state */
+    gamepads: Gamepad[];
+    /** The gamepad supported status */
+    supported: boolean;
+}
+/**
+ * @name useGamepad
+ * @description - Hook for getting information about gamepad
+ * @category Browser
+ *
+ * @browserapi navigator.getGamepads https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getGamepads
+ *
+ * @returns {UseGamepadStateReturn} An object containing the gamepad information
+ *
+ * @example
+ * const { supported, gamepads, active } = useGamepad();
+ */
+declare const useGamepad: () => {
+    active: boolean;
+    supported: boolean;
+    gamepads: Gamepad[];
+};
 declare const mapGamepadToXbox360Controller: (gamepad: Gamepad) => {
     buttons: {
         a: GamepadButton;
@@ -1291,36 +1342,6 @@ declare const mapGamepadToXbox360Controller: (gamepad: Gamepad) => {
     start: GamepadButton;
 };
 
-declare global {
-    interface Gamepad {
-        hapticActuators?: GamepadHapticActuator[];
-    }
-}
-/** The use gamepad return type  */
-interface UseGamepadStateReturn {
-    /** The gamepad active status */
-    active: boolean;
-    /** The gamepad state */
-    gamepads: Gamepad[];
-    /** The gamepad supported status */
-    supported: boolean;
-}
-/**
- * @name useGamepad
- * @description - Hook for getting information about gamepad
- * @category Browser
- *
- * @returns {UseGamepadStateReturn} An object containing the gamepad information
- *
- * @example
- * const { supported, gamepads, active } = useGamepad();
- */
-declare const useGamepad: () => {
-    active: boolean;
-    supported: boolean;
-    gamepads: Gamepad[];
-};
-
 /** The use geolocation return type */
 interface UseGeolocationReturn {
     /** The accuracy of the last position update */
@@ -1351,6 +1372,8 @@ type UseGeolocationParams = PositionOptions;
  * @description - Hook that returns the current geolocation
  * @category Browser
  *
+ * @browserapi navigator.geolocation https://developer.mozilla.org/en-US/docs/Web/API/Navigator/geolocation
+ *
  * @param {boolean} [params.enableHighAccuracy] Enable high accuracy
  * @param {number} [params.maximumAge] Maximum age
  * @param {number} [params.timeout] Timeout
@@ -1926,6 +1949,20 @@ declare const useLastChanged: (source: any, options?: UseLastChangedOptions) =>
  */
 declare const useLatest: <Value>(value: Value) => Value;
 
+/**
+ * @name useLess
+ * @description - Hook that humorously suggests using it less not for production
+ * @category Humor
+ *
+ * @template Value The type of the value
+ * @param {Value} [value] The value to be returned
+ * @returns {Value} The value passed to the hook
+ *
+ * @example
+ * const value = useLess(state);
+ */
+declare const useLess: (value?: any) => any;
+
 /** The use list return type */
 interface UseListReturn<Item> {
     /** The current list of items */
@@ -2012,6 +2049,8 @@ declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<V
  * @description - Hook that manages local storage value
  * @category Browser
  *
+ * @browserapi localStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
+ *
  * @template Value The type of the value
  * @param {string} key The key of the storage
  * @param {UseStorageInitialValue<Value>} [initialValue] The initial value of the storage
@@ -2145,6 +2184,8 @@ declare const useMeasure: UseMeasureScreen;
  * @description - Hook that manages a media query
  * @category Browser
  *
+ * @browserapi window.matchMedia https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia
+ *
  * @param {string} query The media query string
  * @returns {boolean} A boolean indicating if the media query matches
  *
@@ -2174,6 +2215,8 @@ interface UseMemoryReturn {
  * @description - Hook that gives you current memory usage
  * @category Browser
  *
+ * @browserapi performance.memory https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
+ *
  * @returns {UseMemoryReturn} An object containing the current memory usage
  *
  * @example
@@ -2379,6 +2422,8 @@ declare const getConnection: () => Connection;
  * @description - Hook to track network status
  * @category Sensors
  *
+ * @browserapi navigator.connection https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection
+ *
  * @returns {UseNetworkReturn} An object containing the network status
  *
  * @example
@@ -2460,6 +2505,8 @@ declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange
  * @description - Hook that manages if the user is online
  * @category Sensors
  *
+ * @browserapi navigator.onLine https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
+ *
  * @returns {boolean} A boolean indicating if the user is online
  *
  * @example
@@ -2513,6 +2560,8 @@ interface UseOrientationReturn {
  * @description - Hook that returns the current screen orientation
  * @category Browser
  *
+ * @browserapi window.screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
+ *
  * @returns {UseOrientationReturn} An object containing the current screen orientation
  *
  * @example
@@ -2551,6 +2600,8 @@ interface UseOtpCredential {
  * @description - Hook that creates an otp credential
  * @category Browser
  *
+ * @browserapi navigator.credentials https://developer.mozilla.org/en-US/docs/Web/API/Navigator/credentials
+ *
  * @overload
  * @param {UseOtpCredentialCallback} callback The callback function to be invoked
  * @returns {UseOtpCredentialReturn}
@@ -2733,6 +2784,32 @@ interface UseParallax {
  */
 declare const useParallax: UseParallax;
 
+/** The use performance observer options type */
+type UsePerformanceObserverOptions = PerformanceObserverInit & {
+    /** Whether to start the observer immediately */
+    immediate?: boolean;
+};
+/**
+ * @name usePerformanceObserver
+ * @description - Hook that allows you to observe performance entries
+ * @category Sensors
+ *
+ * @browserapi PerformanceObserver https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver
+ *
+ * @param {UsePerformanceObserverOptions} options The options for the performance observer
+ * @param {PerformanceObserverCallback} callback The function to handle performance entries
+ * @returns {object} An object containing the observer's support status and methods to start and stop the observer
+ *
+ * @example
+ * const { supported, entries, start, stop } = usePerformanceObserver();
+ */
+declare const usePerformanceObserver: (options: UsePerformanceObserverOptions, callback?: PerformanceObserverCallback) => {
+    supported: boolean;
+    entries: PerformanceEntry[];
+    start: () => void;
+    stop: () => void;
+};
+
 /** The permission name */
 type UsePermissionName = 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker' | PermissionName;
 /** The use permission options type */
@@ -2754,6 +2831,8 @@ interface UsePermissionReturn {
  *  @description - Hook that gives you the state of permission
  *  @category Browser
  *
+ *  @browserapi navigator.permissions https://developer.mozilla.org/en-US/docs/Web/API/Navigator/permissions
+ *
  *  @param {UsePermissionName} permissionDescriptorName - The permission name
  *  @param {boolean} [options.enabled=true] - Whether the permission is enabled
  *  @returns {UsePermissionReturn} An object containing the state and the supported status
@@ -2769,9 +2848,13 @@ declare const usePermission: (permissionDescriptorName: UsePermissionName, optio
 
 /** The use pointer lock return type */
 interface UsePointerLockReturn {
+    /** The pointer lock element */
     element?: Element;
+    /** Whether the pointer lock is supported */
     supported: boolean;
+    /** Lock the pointer lock */
     lock: (event: MouseEvent$1) => void;
+    /** Unlock the pointer lock */
     unlock: () => boolean;
 }
 /**
@@ -2779,6 +2862,8 @@ interface UsePointerLockReturn {
  * @description - Hook that provides reactive pointer lock
  * @category Sensors
  *
+ * @browserapi pointerLockElement https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerLockElement
+ *
  * @returns {UsePointerLockReturn} An object containing the pointer lock element and functions to interact with the pointer lock
  *
  * @example
@@ -2846,6 +2931,8 @@ declare const usePreferredDark: () => boolean;
  * @description Hook that returns a browser preferred languages from navigator
  * @category Browser
  *
+ * @browserapi navigator.languages https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages
+ *
  * @returns {readonly string[]} An array of strings representing the user's preferred languages
  *
  * @example
@@ -2942,6 +3029,8 @@ interface UseRafReturn {
  * @description - Hook that defines the logic for raf callback
  * @category Utilities
  *
+ * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
+ *
  * @param {UseRafCallback} callback The callback to execute
  * @param {number} [options.delay] The delay between each frame in milliseconds
  * @param {boolean} [options.enabled=true] Whether the callback should be enabled
@@ -3038,6 +3127,8 @@ interface UseResizeObserver {
  *  @description - Hook that gives you resize observer state
  *  @category Browser
  *
+ *  @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
+ *
  *  @overload
  *  @template Target The target element
  *  @param {boolean} [options.enabled=true] The IntersectionObserver options
@@ -3088,6 +3179,8 @@ interface useScreenOrientationReturn {
  * @description - Hook that provides the current screen orientation
  * @category Sensors
  *
+ * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
+ *
  * @returns {useScreenOrientationReturn} The current screen orientation
  *
  * @example
@@ -3157,8 +3250,14 @@ interface UseScrollCallbackParams {
 interface UseScroll {
     <Target extends UseScrollTarget>(target: Target, callback?: (params: UseScrollCallbackParams, event: Event) => void): boolean;
     <Target extends UseScrollTarget>(target: Target, options?: UseScrollOptions): boolean;
-    <Target extends UseScrollTarget>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): [StateRef<Target>, boolean];
-    <Target extends UseScrollTarget>(options?: UseScrollOptions, target?: never): [StateRef<Target>, boolean];
+    <Target extends UseScrollTarget>(callback?: (params: UseScrollCallbackParams, event: Event) => void, target?: never): {
+        ref: StateRef<Target>;
+        scrolling: boolean;
+    };
+    <Target extends UseScrollTarget>(options?: UseScrollOptions, target?: never): {
+        ref: StateRef<Target>;
+        scrolling: boolean;
+    };
 }
 /**
  * @name useScroll
@@ -3200,7 +3299,7 @@ interface UseScroll {
  * @returns {[StateRef<Target>, boolean]} The state of scrolling
  *
  * @example
- * const [ref, scrolling] = useScroll(options);
+ * const { ref, scrolling } = useScroll(options);
  *
  * @overload
  * @template Target The target element
@@ -3209,7 +3308,7 @@ interface UseScroll {
  * @returns {[StateRef<Target>, boolean]} The state of scrolling
  *
  * @example
- * const [ref, scrolling] = useScroll(() => console.log('callback'));
+ * const { ref, scrolling } = useScroll(() => console.log('callback'));
  */
 declare const useScroll: UseScroll;
 
@@ -3324,6 +3423,8 @@ declare const useScrollTo: UseScrollTo;
  * @description - Hook that manages session storage value
  * @category Browser
  *
+ * @browserapi sessionStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
+ *
  * @template Value The type of the value
  * @param {string} key The key of the storage
  * @param {UseStorageInitialValue<Value>} [initialValue] The initial value of the storage
@@ -3613,6 +3714,8 @@ interface UseTextSelectionReturn {
  * @description - Hook that manages the text selection
  * @category Sensors
  *
+ * @browserapi document.getSelection https://developer.mozilla.org/en-US/docs/Web/API/Document/getSelection
+ *
  * @returns {UseTextSelectionReturn} An object containing the current text selection
  *
  * @example
@@ -3622,7 +3725,7 @@ declare const useTextSelection: () => UseTextSelectionReturn;
 
 /**
  * @name useThrottleCallback
- * @description - Hook that creates a throttled callback and returns a stable reference of it
+ * @description - Hook that creates a throttled callback
  * @category Utilities
  *
  * @template Params The type of the params
@@ -3638,7 +3741,7 @@ declare const useThrottleCallback: <Params extends unknown[], Return>(callback:
 
 /**
  * @name useThrottleValue
- * @description - Hook that creates a throttled value and returns a stable reference of it
+ * @description - Hook that creates a throttled value
  * @category Utilities
  *
  * @template Value The type of the value
@@ -3813,6 +3916,8 @@ interface UseVibrateReturn {
  * @description - Hook that provides vibrate api
  * @category Browser
  *
+ * @browserapi navigator.vibrate https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate
+ *
  * @overload
  * @param {UseVibratePattern} options.pattern The pattern for vibration
  * @param {number} [options.interval=0] Time in milliseconds between vibrations
@@ -3850,7 +3955,7 @@ interface UseWebSocketReturn {
 /**
  * @name useWebSocket
  * @description - Hook that connects to a WebSocket server and handles incoming and outgoing messages
- * @category Network
+ * @category Browser
  *
  * @param {UseWebSocketUrl} url The URL of the WebSocket server
  * @param {(webSocket: WebSocket) => void} [options.onConnected] The callback function that is called when the WebSocket connection is established
@@ -3996,4 +4101,4 @@ declare const isTarget: (target: any) => any;
 
 declare const throttle: <Params extends any[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
-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, COOKIE_EVENT, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, Paint, type Point, Pointer, type RemoveCookieParams, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, STORAGE_EVENT, type ScrollPosition, type SetCookieParams, type StateRef, type UseAsyncReturn, type UseBatteryStateReturn, type UseBatteryValue, type UseBluetoothOptions, type UseBluetoothReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCookieInitialValue, type UseCookieOptions, type UseCookieReturn, 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, clearCookies, debounce, dispatchCookieEvent, dispatchStorageEvent, getConnection, getCookies, getDate, getElement, getOperatingSystem, getParsedCookies, getRangesSelection, getRetry, getTimeFromSeconds, isHotkeyMatch, isPermissionAllowed, isTarget, legacyCopyToClipboard, mapGamepadToXbox360Controller, removeCookie, scrollTo, setCookie, throttle, useActiveElement, useAsync, useBattery, useBluetooth, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useConst, useCookie, useCookies, 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 };
+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, COOKIE_EVENT, type ColorSelectionOptions, type ColorSelectionResult, type Connection, type ConnectionEffectiveType, type ConnectionType, type EyeDropper, type EyeDropperConstructor, type GetElementTarget, type LongPressReactEvents, type OperatingSystem, type OrientationLockType, Paint, type Point, Pointer, type RemoveCookieParams, type RequestOptions, SCRIPT_STATUS_ATTRIBUTE_NAME, STORAGE_EVENT, type ScrollPosition, type SetCookieParams, type StateRef, type UseAsyncReturn, type UseBatteryStateReturn, type UseBatteryValue, type UseBluetoothOptions, type UseBluetoothReturn, type UseBooleanReturn, type UseBreakpointsReturn, type UseBreakpointsStrategy, type UseClickOutside, type UseClickOutsideTarget, type UseCookieInitialValue, type UseCookieOptions, type UseCookieReturn, 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 UsePerformanceObserverOptions, 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, clearCookies, debounce, dispatchCookieEvent, dispatchStorageEvent, getConnection, getCookies, getDate, getElement, getOperatingSystem, getParsedCookies, getRangesSelection, getRetry, getTimeFromSeconds, isHotkeyMatch, isPermissionAllowed, isTarget, legacyCopyToClipboard, mapGamepadToXbox360Controller, removeCookie, scrollTo, setCookie, throttle, useActiveElement, useAsync, useBattery, useBluetooth, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useConst, useCookie, useCookies, 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, useLess, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePerformanceObserver, 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,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.98",
+  "version": "0.0.100",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",

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

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

package/dist/cjs/hooks/useGamepad/helpers/index.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.98 */
-"use strict";var o=require("./mapGamepadToXbox360Controller.js");exports.mapGamepadToXbox360Controller=o.mapGamepadToXbox360Controller;
-//# sourceMappingURL=index.js.map

package/dist/cjs/hooks/useGamepad/helpers/index.js.map

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

package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.98 */
-"use strict";exports.mapGamepadToXbox360Controller=function(t){return{buttons:{a:t.buttons[0],b:t.buttons[1],x:t.buttons[2],y:t.buttons[3]},bumper:{left:t.buttons[4],right:t.buttons[5]},triggers:{left:t.buttons[6],right:t.buttons[7]},stick:{left:{horizontal:t.axes[0],vertical:t.axes[1],button:t.buttons[10]},right:{horizontal:t.axes[2],vertical:t.axes[3],button:t.buttons[11]}},dpad:{up:t.buttons[12],down:t.buttons[13],left:t.buttons[14],right:t.buttons[15]},back:t.buttons[8],start:t.buttons[9]}};
-//# sourceMappingURL=mapGamepadToXbox360Controller.js.map

package/dist/cjs/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mapGamepadToXbox360Controller.js","sources":["../../../../../src/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.ts"],"sourcesContent":["export const mapGamepadToXbox360Controller = (gamepad: Gamepad) => ({\n  buttons: {\n    a: gamepad.buttons[0],\n    b: gamepad.buttons[1],\n    x: gamepad.buttons[2],\n    y: gamepad.buttons[3]\n  },\n  bumper: {\n    left: gamepad.buttons[4],\n    right: gamepad.buttons[5]\n  },\n  triggers: {\n    left: gamepad.buttons[6],\n    right: gamepad.buttons[7]\n  },\n  stick: {\n    left: {\n      horizontal: gamepad.axes[0],\n      vertical: gamepad.axes[1],\n      button: gamepad.buttons[10]\n    },\n    right: {\n      horizontal: gamepad.axes[2],\n      vertical: gamepad.axes[3],\n      button: gamepad.buttons[11]\n    }\n  },\n  dpad: {\n    up: gamepad.buttons[12],\n    down: gamepad.buttons[13],\n    left: gamepad.buttons[14],\n    right: gamepad.buttons[15]\n  },\n  back: gamepad.buttons[8],\n  start: gamepad.buttons[9]\n});\n"],"names":["gamepad","buttons","a","b","x","y","bumper","left","right","triggers","stick","horizontal","axes","vertical","button","dpad","up","down","back","start"],"mappings":";mDAA6C,SAACA,GAAgB,MAAM,CAClEC,QAAS,CACPC,EAAGF,EAAQC,QAAQ,GACnBE,EAAGH,EAAQC,QAAQ,GACnBG,EAAGJ,EAAQC,QAAQ,GACnBI,EAAGL,EAAQC,QAAQ,IAErBK,OAAQ,CACNC,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBQ,SAAU,CACRF,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBS,MAAO,CACLH,KAAM,CACJI,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,KAE1BO,MAAO,CACLG,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,MAG5Bc,KAAM,CACJC,GAAIhB,EAAQC,QAAQ,IACpBgB,KAAMjB,EAAQC,QAAQ,IACtBM,KAAMP,EAAQC,QAAQ,IACtBO,MAAOR,EAAQC,QAAQ,KAEzBiB,KAAMlB,EAAQC,QAAQ,GACtBkB,MAAOnB,EAAQC,QAAQ,GACxB"}

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

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

package/dist/esm/hooks/useGamepad/helpers/index.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.98 */
-export{mapGamepadToXbox360Controller}from"./mapGamepadToXbox360Controller.js";
-//# sourceMappingURL=index.js.map

package/dist/esm/hooks/useGamepad/helpers/index.js.map

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

package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js

@@ -1,3 +0,0 @@
-/* @license @siberiacancode/reactuse v0.0.98 */
-var t=function(t){return{buttons:{a:t.buttons[0],b:t.buttons[1],x:t.buttons[2],y:t.buttons[3]},bumper:{left:t.buttons[4],right:t.buttons[5]},triggers:{left:t.buttons[6],right:t.buttons[7]},stick:{left:{horizontal:t.axes[0],vertical:t.axes[1],button:t.buttons[10]},right:{horizontal:t.axes[2],vertical:t.axes[3],button:t.buttons[11]}},dpad:{up:t.buttons[12],down:t.buttons[13],left:t.buttons[14],right:t.buttons[15]},back:t.buttons[8],start:t.buttons[9]}};export{t as mapGamepadToXbox360Controller};
-//# sourceMappingURL=mapGamepadToXbox360Controller.js.map

package/dist/esm/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mapGamepadToXbox360Controller.js","sources":["../../../../../src/hooks/useGamepad/helpers/mapGamepadToXbox360Controller.ts"],"sourcesContent":["export const mapGamepadToXbox360Controller = (gamepad: Gamepad) => ({\n  buttons: {\n    a: gamepad.buttons[0],\n    b: gamepad.buttons[1],\n    x: gamepad.buttons[2],\n    y: gamepad.buttons[3]\n  },\n  bumper: {\n    left: gamepad.buttons[4],\n    right: gamepad.buttons[5]\n  },\n  triggers: {\n    left: gamepad.buttons[6],\n    right: gamepad.buttons[7]\n  },\n  stick: {\n    left: {\n      horizontal: gamepad.axes[0],\n      vertical: gamepad.axes[1],\n      button: gamepad.buttons[10]\n    },\n    right: {\n      horizontal: gamepad.axes[2],\n      vertical: gamepad.axes[3],\n      button: gamepad.buttons[11]\n    }\n  },\n  dpad: {\n    up: gamepad.buttons[12],\n    down: gamepad.buttons[13],\n    left: gamepad.buttons[14],\n    right: gamepad.buttons[15]\n  },\n  back: gamepad.buttons[8],\n  start: gamepad.buttons[9]\n});\n"],"names":["mapGamepadToXbox360Controller","gamepad","buttons","a","b","x","y","bumper","left","right","triggers","stick","horizontal","axes","vertical","button","dpad","up","down","back","start"],"mappings":";IAAaA,EAAgC,SAACC,GAAgB,MAAM,CAClEC,QAAS,CACPC,EAAGF,EAAQC,QAAQ,GACnBE,EAAGH,EAAQC,QAAQ,GACnBG,EAAGJ,EAAQC,QAAQ,GACnBI,EAAGL,EAAQC,QAAQ,IAErBK,OAAQ,CACNC,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBQ,SAAU,CACRF,KAAMP,EAAQC,QAAQ,GACtBO,MAAOR,EAAQC,QAAQ,IAEzBS,MAAO,CACLH,KAAM,CACJI,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,KAE1BO,MAAO,CACLG,WAAYX,EAAQY,KAAK,GACzBC,SAAUb,EAAQY,KAAK,GACvBE,OAAQd,EAAQC,QAAQ,MAG5Bc,KAAM,CACJC,GAAIhB,EAAQC,QAAQ,IACpBgB,KAAMjB,EAAQC,QAAQ,IACtBM,KAAMP,EAAQC,QAAQ,IACtBO,MAAOR,EAAQC,QAAQ,KAEzBiB,KAAMlB,EAAQC,QAAQ,GACtBkB,MAAOnB,EAAQC,QAAQ,GACxB"}