@siberiacancode/reactuse 0.0.72 → 0.0.74

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect, MouseEventHandler, TouchEventHandler } from 'react';
+import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect, MouseEventHandler, TouchEventHandler, MouseEvent as MouseEvent$1 } from 'react';
 
 /**
  * @name useActiveElement
@@ -15,9 +15,9 @@ declare const useActiveElement: <ActiveElement extends HTMLElement>() => ActiveE
 
 interface UseAsyncReturn<Data> {
     data?: Data;
-    isLoading: boolean;
-    isError: boolean;
     error?: Error;
+    isError: boolean;
+    isLoading: boolean;
 }
 /**
  * @name useAsync
@@ -44,12 +44,8 @@ declare global {
         readonly getBattery: () => Promise<BatteryManager>;
     }
 }
-/** State for hook use battery */
-interface UseBatteryStateReturn {
-    /** Is battery API supported? */
-    supported: boolean;
-    /** Is battery information loading? */
-    loading: boolean;
+/** The use battery value type */
+interface UseBatteryValue {
     /** Is charging battery? */
     charging: boolean;
     /** Time until the battery is fully charged */
@@ -58,6 +54,15 @@ interface UseBatteryStateReturn {
     dischargingTime: number;
     /** Battery charge level from 0 to 1 */
     level: number;
+    /** Is battery information loading? */
+    loading: boolean;
+}
+/** The use battery return type */
+interface UseBatteryStateReturn {
+    /** Battery API support */
+    supported: boolean;
+    /** The use battery value type  */
+    value: UseBatteryValue;
 }
 /**
  * @name useBattery
@@ -175,7 +180,7 @@ declare const BREAKPOINTS_PRIME_FLEX: {
 /** The breakpoints type */
 type Breakpoints<Breakpoint extends string = string> = Record<Breakpoint, number>;
 /** The use breakpoints strategy */
-type UseBreakpointsStrategy = 'mobile-first' | 'desktop-first';
+type UseBreakpointsStrategy = 'desktop-first' | 'mobile-first';
 /** The use breakpoints return type */
 type UseBreakpointsReturn<Breakpoint extends string = string> = {
     /** The function that checks if the current breakpoint is greater than to the given breakpoint */
@@ -231,7 +236,7 @@ declare const useBreakpoints: <Breakpoint extends string>(breakpoints: Breakpoin
 declare const useBrowserLanguage: () => string;
 
 /** The use click outside target element type */
-type UseClickOutsideTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseClickOutsideTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 interface UseClickOutside {
     <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(target: Target, callback: (event: Event) => void): void;
     <Target extends UseClickOutsideTarget | UseClickOutsideTarget[]>(callback: (event: Event) => void, target?: never): (node: Target) => void;
@@ -264,12 +269,12 @@ declare const isPermissionAllowed: (status: PermissionState) => status is "promp
 declare const legacyCopyToClipboard: (value: string) => void;
 /** The use copy to clipboard return type */
 interface UseCopyToClipboardReturn {
+    /** Whether the copy to clipboard is supported */
+    supported: boolean;
     /** The copied value */
     value: string | null;
     /** Function to copy to clipboard  */
     copy: (value: string) => Promise<void>;
-    /** Whether the copy to clipboard is supported */
-    supported: boolean;
 }
 /** The use copy to clipboard params type */
 interface UseCopyToClipboardParams {
@@ -291,23 +296,23 @@ declare const useClipboard: (params?: UseCopyToClipboardParams) => UseCopyToClip
 
 /** The use counter options */
 interface UseCounterOptions {
-    /** The min of count value */
-    min?: number;
     /** The max of count value */
     max?: number;
+    /** The min of count value */
+    min?: number;
 }
 /** The use counter return type */
 interface UseCounterReturn {
-    /** The current count value */
-    value: number;
     /** Function to set a specific value to the counter */
     set: Dispatch<SetStateAction<number>>;
-    /** Function to reset the counter to its initial value. */
-    reset: () => void;
-    /** Function to increment the counter */
-    inc: (value?: number) => void;
+    /** The current count value */
+    value: number;
     /** Function to decrement the counter */
     dec: (value?: number) => void;
+    /** Function to increment the counter */
+    inc: (value?: number) => void;
+    /** Function to reset the counter to its initial value. */
+    reset: () => void;
 }
 interface UseCounter {
     (initialValue?: number, options?: UseCounterOptions): UseCounterReturn;
@@ -341,7 +346,7 @@ interface UseCounter {
 declare const useCounter: UseCounter;
 
 /** The css variable target element type */
-type UseCssVarTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseCssVarTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The css variable return type */
 interface UseCssVarReturn {
     /** The value of the CSS variable */
@@ -422,21 +427,21 @@ declare const useDebounceValue: <Value>(value: Value, delay: number) => Value;
  * @example
  * const [value, setValue] = useDefault(initialValue, defaultValue);
  */
-declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultValue: Value) => readonly [Value, react.Dispatch<react.SetStateAction<Value | null | undefined>>];
+declare const useDefault: <Value>(initialValue: (() => Value) | Value, defaultValue: Value) => readonly [Value, react.Dispatch<react.SetStateAction<Value | null | undefined>>];
 
 interface UseDeviceMotionReturn {
-    interval: DeviceMotionEvent['interval'];
     acceleration: DeviceMotionEventAcceleration;
     accelerationIncludingGravity: DeviceMotionEventAcceleration;
+    interval: DeviceMotionEvent['interval'];
     rotationRate: DeviceMotionEventRotationRate;
 }
 interface UseDeviceMotionParams {
     /** The delay in milliseconds */
     delay?: number;
-    /** The callback function to be invoked */
-    callback?: (event: DeviceMotionEvent) => void;
     /** Whether to enable the hook */
     enabled?: boolean;
+    /** The callback function to be invoked */
+    callback?: (event: DeviceMotionEvent) => void;
 }
 /**
  * @name useDeviceMotion
@@ -454,14 +459,14 @@ interface UseDeviceMotionParams {
 declare const useDeviceMotion: (params?: UseDeviceMotionParams) => UseDeviceMotionReturn;
 
 interface UseDeviceOrientationValue {
+    /** The current absolute value */
+    absolute: boolean;
     /** A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 to 360 */
     alpha: number | null;
     /** A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 to 180 */
     beta: number | null;
     /** A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 to 90 */
     gamma: number | null;
-    /** The current absolute value */
-    absolute: boolean;
 }
 interface UseDeviceOrientationReturn {
     /** Whether the device orientation is supported */
@@ -496,19 +501,19 @@ declare const useDidUpdate: (effect: EffectCallback, deps?: DependencyList) => v
 
 /** The use disclosure options type */
 interface UseDisclosureOptions {
-    /** The callback function to be invoked on open */
-    onOpen?: () => void;
     /** The callback function to be invoked on close */
     onClose?: () => void;
+    /** The callback function to be invoked on open */
+    onOpen?: () => void;
 }
 /** The use disclosure return type */
 interface UseDisclosureReturn {
     /** The opened value */
     opened: boolean;
-    /** Function to open the modal */
-    open: () => void;
     /** Function to close the modal */
     close: () => void;
+    /** Function to open the modal */
+    open: () => void;
     /** Function to toggle the modal */
     toggle: () => void;
 }
@@ -527,7 +532,7 @@ interface UseDisclosureReturn {
  */
 declare const useDisclosure: (initialValue?: boolean, options?: UseDisclosureOptions) => UseDisclosureReturn;
 
-type UseEventListenerTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
+type UseEventListenerTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
 type UseEventListenerOptions = boolean | AddEventListenerOptions;
 type UseEventListenerReturn<Target extends UseEventListenerTarget> = RefObject<Target>;
 interface UseEventListener {
@@ -593,6 +598,44 @@ declare function useDocumentTitle(value?: string, options?: UseDocumentTitleOpti
  */
 declare const useDocumentVisibility: () => DocumentVisibilityState;
 
+interface ElementSize {
+    height: number;
+    width: number;
+}
+/** The use element size target element type */
+type UseElementSizeTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
+interface UseElementSizeReturn {
+    value: ElementSize;
+}
+interface UseElementSize {
+    <Target extends UseElementSizeTarget>(target: Target, initialSize?: ElementSize): UseElementSizeReturn;
+    <Target extends UseElementSizeTarget>(initialSize?: ElementSize, target?: never): {
+        ref: (node: Target) => void;
+    } & UseElementSizeReturn;
+}
+/**
+ * @name useElementSize
+ * @description - Hook that observes and returns the width and height of element
+ * @category Elements
+ *
+ * @overload
+ * @template Target The target element type.
+ * @param {UseElementSizeTarget} target The target element to observe.
+ * @param {ElementSize} [initialSize = { width: 0, height: 0 }]
+ * @returns {UseElementSizeReturn} An object containing the current width and height of the element.
+ *
+ * @example
+ * const { value } = useElementSize(elementRef);
+ *
+ * @overload
+ * @param {ElementSize} [initialSize = { width: 0, height: 0 }] The initial size of the element.
+ * @returns { { ref: (node: Target) => void } & UseElementSizeReturn } A reference function to attach to the element to observe size changes.
+ *
+ * @example
+ * const { ref, value } = useElementSize({ width: 100, height: 100 });
+ */
+declare const useElementSize: UseElementSize;
+
 /**
  * @name useEvent
  * @description - Hook that creates an event and returns a stable reference of it
@@ -667,35 +710,37 @@ declare const useFavicon: (initialHref?: string) => {
 
 /** The use field params type */
 interface UseFieldParams<Value> {
-    /** The initial value */
-    initialValue?: Value;
-    /** The initial touched */
-    initialTouched?: boolean;
     /** The auto focus */
     autoFocus?: boolean;
-    /** The validate on mount */
-    validateOnChange?: boolean;
+    /** The initial touched */
+    initialTouched?: boolean;
+    /** The initial value */
+    initialValue?: Value;
     /** The validate on blur */
     validateOnBlur?: boolean;
     /** The validate on mount */
+    validateOnChange?: boolean;
+    /** The validate on mount */
     validateOnMount?: boolean;
 }
 /** The use field register params type */
 interface UseFieldRegisterParams {
     /** The required validation */
     required?: string;
+    /** The custom validation */
+    validate?: (value: string) => Promise<string | true>;
     /** The min value validation */
     max?: {
         value: number;
         message: string;
     };
-    /** The max value validation */
-    min?: {
+    /** The max length validation */
+    maxLength?: {
         value: number;
         message: string;
     };
-    /** The max length validation */
-    maxLength?: {
+    /** The max value validation */
+    min?: {
         value: number;
         message: string;
     };
@@ -709,37 +754,35 @@ interface UseFieldRegisterParams {
         value: RegExp;
         message: string;
     };
-    /** The custom validation */
-    validate?: (value: string) => Promise<string | true>;
 }
 /** The use field return type */
 interface UseFieldReturn<Value> {
-    /** The register function */
-    register: (params?: UseFieldRegisterParams) => {
-        onBlur: () => void;
-        onChange: () => void;
-        ref: (node: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | null | undefined) => void;
-    };
-    /** The get value function */
-    getValue: () => Value;
-    /** The  set value function */
-    setValue: (value: Value) => void;
     /** The dirty state */
     dirty: boolean;
     /** The error state */
     error?: string;
     /** The set error function */
     touched: boolean;
+    /** The set error function */
+    clearError: () => void;
     /** The focus function */
     focus: () => void;
-    /** The watch function */
-    watch: () => Value;
+    /** The get value function */
+    getValue: () => Value;
+    /** The register function */
+    register: (params?: UseFieldRegisterParams) => {
+        onBlur: () => void;
+        onChange: () => void;
+        ref: (node: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | null | undefined) => void;
+    };
     /** The reset function */
     reset: () => void;
     /** The set error function */
     setError: (error: string) => void;
-    /** The set error function */
-    clearError: () => void;
+    /** The  set value function */
+    setValue: (value: Value) => void;
+    /** The watch function */
+    watch: () => Value;
 }
 /**
  * @name useField
@@ -759,9 +802,9 @@ interface UseFieldReturn<Value> {
  * @example
  * const { register, getValue, setValue, reset, dirty, error, setError, clearError, touched, focus, watch } = useField();
  */
-declare const useField: <Value extends string | boolean = string, Type = Value extends string ? string : boolean>(params?: UseFieldParams<Value>) => UseFieldReturn<Type>;
+declare const useField: <Value extends boolean | string = string, Type = Value extends string ? string : boolean>(params?: UseFieldParams<Value>) => UseFieldReturn<Type>;
 
-interface UseFileDialogOptions extends Pick<ComponentProps<'input'>, 'multiple' | 'accept'> {
+interface UseFileDialogOptions extends Pick<ComponentProps<'input'>, 'accept' | 'multiple'> {
     /** The capture value */
     capture?: string;
     /** The reset value */
@@ -807,7 +850,7 @@ interface UseFileDialog {
  */
 declare const useFileDialog: UseFileDialog;
 
-type UseFocusTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseFocusTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The use focus options type */
 interface UseFocusOptions {
     /** The initial focus state of the target */
@@ -815,12 +858,12 @@ interface UseFocusOptions {
 }
 /** The use focus return type */
 interface UseFocusReturn {
-    /** Is the target focused */
-    focus: () => void;
-    /** Is the target focused */
-    blur: () => void;
     /** The boolean state value of the target */
     focused: boolean;
+    /** Is the target focused */
+    blur: () => void;
+    /** Is the target focused */
+    focus: () => void;
 }
 interface UseFocus {
     <Target extends UseFocusTarget>(target: Target, options?: UseFocusOptions): UseFocusReturn;
@@ -864,7 +907,7 @@ declare const useFocus: UseFocus;
 declare const useFps: () => number;
 
 /** The use fullscreen target element type */
-type UseFullScreenTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseFullScreenTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The use fullscreen options type */
 interface UseFullScreenOptions {
     /** initial value */
@@ -876,10 +919,10 @@ interface UseFullScreenOptions {
 }
 /** The use click outside return type */
 interface UseFullScreenReturn {
+    value: boolean;
     enter: () => void;
     exit: () => void;
     toggle: () => void;
-    value: boolean;
 }
 interface UseFullScreen {
     <Target extends UseFullScreenTarget>(target: Target, options?: UseFullScreenOptions): UseFullScreenReturn;
@@ -959,12 +1002,12 @@ declare global {
 }
 /** The use gamepad return type  */
 interface UseGamepadStateReturn {
-    /** The gamepad supported status */
-    supported: boolean;
-    /** The gamepad state */
-    gamepads: Gamepad[];
     /** The gamepad active status */
     active: boolean;
+    /** The gamepad state */
+    gamepads: Gamepad[];
+    /** The gamepad supported status */
+    supported: boolean;
 }
 /**
  * @name useGamepad
@@ -984,26 +1027,26 @@ declare const useGamepad: () => {
 
 /** The use geolocation return type */
 interface UseGeolocationReturn {
-    /** The loading state */
-    loading: boolean;
-    /** The error of the last position update */
-    error: GeolocationPositionError | null;
-    /** The timestamp of the last position update */
-    timestamp: number | null;
     /** The accuracy of the last position update */
     accuracy: number | null;
-    /** The latitude of the last position update */
-    latitude: number | null;
-    /** The longitude of the last position update */
-    longitude: number | null;
     /** The altitude of the last position update */
     altitude: number | null;
     /** The altitude accuracy of the last position update */
     altitudeAccuracy: number | null;
+    /** The error of the last position update */
+    error: GeolocationPositionError | null;
     /** The heading of the last position update */
     heading: number | null;
+    /** The latitude of the last position update */
+    latitude: number | null;
+    /** The loading state */
+    loading: boolean;
+    /** The longitude of the last position update */
+    longitude: number | null;
     /** The speed of the last position update */
     speed: number | null;
+    /** The timestamp of the last position update */
+    timestamp: number | null;
 }
 /** The use geolocation params type */
 type UseGeolocationParams = PositionOptions;
@@ -1038,21 +1081,21 @@ declare const useHash: () => UseHashReturn;
 
 /** The use hotkeys params type */
 interface UseHotkeysOptions {
-    /** The target to attach the event listeners to */
-    target?: UseEventListenerTarget;
+    /** Alias map for hotkeys */
+    aliasMap?: Record<string, string>;
     /** Enable or disable the event listeners */
     enabled?: boolean;
     /** Whether to prevent the default behavior of the event */
     preventDefault?: boolean;
-    /** Alias map for hotkeys */
-    aliasMap?: Record<string, string>;
+    /** The target to attach the event listeners to */
+    target?: UseEventListenerTarget;
 }
 declare const isHotkeyMatch: (hotkey: string, keys: UseHotkeysKey[]) => boolean;
-type UseHotkeysHotkeys = string[] | string;
+type UseHotkeysHotkeys = string | string[];
 interface UseHotkeysKey {
-    key: string;
-    code: string;
     alias: string;
+    code: string;
+    key: string;
 }
 /**
  * @name useHotkeys
@@ -1079,7 +1122,7 @@ interface UseHoverOptions {
     onEntry?: () => void;
     onLeave?: () => void;
 }
-type UseHoverTarget = RefObject<Element | null | undefined> | Element;
+type UseHoverTarget = Element | RefObject<Element | null | undefined>;
 interface UseHover {
     <Target extends UseHoverTarget>(target: Target, callback?: () => void): boolean;
     <Target extends UseHoverTarget>(target: Target, options?: UseHoverOptions): boolean;
@@ -1136,8 +1179,8 @@ interface UseHover {
 declare const useHover: UseHover;
 
 interface UseIdleOptions {
-    initialValue?: boolean;
     events?: Array<keyof DocumentEventMap>;
+    initialValue?: boolean;
 }
 interface UseIdleReturn {
     idle: boolean;
@@ -1159,30 +1202,30 @@ interface UseIdleReturn {
 declare const useIdle: (milliseconds?: number, { initialValue, events }?: UseIdleOptions) => UseIdleReturn;
 
 interface UseQueryOptions<QueryData, Data> {
+    enabled?: boolean;
+    initialData?: (() => Data) | Data;
     keys?: DependencyList;
-    onSuccess?: (data: Data) => void;
+    placeholderData?: (() => Data) | Data;
+    refetchInterval?: number;
+    retry?: boolean | number;
     onError?: (error: Error) => void;
+    onSuccess?: (data: Data) => void;
     select?: (data: QueryData) => Data;
-    initialData?: Data | (() => Data);
-    placeholderData?: Data | (() => Data);
-    retry?: boolean | number;
-    refetchInterval?: number;
-    enabled?: boolean;
 }
 interface UseQueryCallbackParams {
-    signal: AbortSignal;
     keys: DependencyList;
+    signal: AbortSignal;
 }
 interface UseQueryReturn<Data> {
+    abort: AbortController['abort'];
+    aborted: boolean;
     data?: Data;
-    isLoading: boolean;
+    error?: Error;
     isError: boolean;
+    isLoading: boolean;
+    isRefetching: boolean;
     isSuccess: boolean;
-    error?: Error;
     refetch: () => void;
-    isRefetching: boolean;
-    abort: AbortController['abort'];
-    aborted: boolean;
 }
 /**
  * @name useQuery
@@ -1208,20 +1251,20 @@ declare const useQuery: <QueryData, Data = QueryData>(callback: (params: UseQuer
 
 /** The use image options */
 interface UseImageOptions {
-    /** The srcset of the image */
-    srcset?: string;
-    /** The sizes of the image */
-    sizes?: string;
     /** The alt of the image */
     alt?: string;
     /** The class of the image */
     class?: string;
-    /** The loading of the image */
-    loading?: HTMLImageElement['loading'];
     /** The crossorigin of the image */
     crossorigin?: string;
+    /** The loading of the image */
+    loading?: HTMLImageElement['loading'];
     /** The referrer policy of the image */
     referrerPolicy?: HTMLImageElement['referrerPolicy'];
+    /** The sizes of the image */
+    sizes?: string;
+    /** The srcset of the image */
+    srcset?: string;
 }
 /** The use image return type */
 type UseImageReturn = UseQueryReturn<HTMLImageElement>;
@@ -1248,16 +1291,16 @@ type UseImageReturn = UseQueryReturn<HTMLImageElement>;
  * @example
  * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useImage('https://example.com/image.png');
  */
-declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "select" | "initialData" | "placeholderData">) => UseQueryReturn<HTMLImageElement>;
+declare const useImage: (src: string, options?: UseImageOptions, useQueryOptions?: Omit<UseQueryOptions<HTMLImageElement, HTMLImageElement>, "initialData" | "placeholderData" | "select">) => UseQueryReturn<HTMLImageElement>;
 
 /** The use infinite scroll target element type */
-type UseInfiniteScrollTarget = RefObject<Element | null> | (() => Element) | Element;
+type UseInfiniteScrollTarget = (() => Element) | Element | RefObject<Element | null>;
 /** The use infinite scroll options type */
 interface UseInfiniteScrollOptions {
+    /** The direction to trigger the callback */
+    direction?: 'bottom' | 'left' | 'right' | 'top';
     /** The distance in pixels to trigger the callback */
     distance?: number;
-    /** The direction to trigger the callback */
-    direction?: 'top' | 'bottom' | 'left' | 'right';
 }
 interface UseInfiniteScroll {
     <Target extends UseInfiniteScrollTarget>(target: Target, callback: (event: Event) => void, options?: UseInfiniteScrollOptions): boolean;
@@ -1295,17 +1338,17 @@ interface UseInfiniteScroll {
 declare const useInfiniteScroll: UseInfiniteScroll;
 
 /** The intersection observer target element type */
-type UseIntersectionObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseIntersectionObserverTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The intersection observer options type */
 interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
     enabled?: boolean;
-    onChange?: (entry: IntersectionObserverEntry) => void;
     root?: IntersectionObserverInit['root'] | RefObject<Element | null | undefined>;
+    onChange?: (entry: IntersectionObserverEntry) => void;
 }
 /** The intersection observer return type */
 interface UseIntersectionObserverReturn {
-    inView: boolean;
     entry?: IntersectionObserverEntry;
+    inView: boolean;
 }
 interface UseIntersectionObserver {
     <Target extends UseIntersectionObserverTarget>(target: Target, options?: UseIntersectionObserverOptions): UseIntersectionObserverReturn;
@@ -1458,14 +1501,60 @@ interface UseKeyPressEvent {
     <Target extends UseEventListenerTarget>(key: UseKeyPressEventKey, target: Target, listener: (this: Target, event: HTMLElementEventMap['keydown']) => void, options?: UseEventListenerOptions): void;
     <Target extends Element>(key: UseKeyPressEventKey, listener: (this: Target, event: HTMLElementEventMap['keydown']) => void, options?: UseEventListenerOptions, target?: never): void;
 }
+/**
+ * @name useKeyPressEvent
+ * @description - Hook that listens for key press events on specified targets
+ * @category Sensors
+ *
+ * @overload
+ * @param {UseKeyPressEventKey} key The key or array of keys to listen for.
+ * @param {Window} target The window object to attach the event listener to.
+ * @param {(event: KeyboardEvent) => void} listener The callback function to be executed when the specified key or keys are pressed.
+ * @param {UseEventListenerOptions} [options] The options for the event listener.
+ * @returns {void}
+ *
+ * @example
+ * useKeyPressEvent('Enter', window, () => console.log('Enter key pressed'));
+ *
+ * @overload
+ * @param {UseKeyPressEventKey} key The key or array of keys to listen for.
+ * @param {Document} target The document object to attach the event listener to.
+ * @param {(event: KeyboardEvent) => void} listener The callback function to be executed when the specified key or keys are pressed.
+ * @param {UseEventListenerOptions} [options] The options for the event listener.
+ * @returns {void}
+ *
+ * @example
+ * useKeyPressEvent('Enter', document, () => console.log('Enter key pressed'));
+ *
+ * @overload
+ * @template Target The target element type.
+ * @param {UseKeyPressEventKey} key The key or array of keys to listen for.
+ * @param {Target} target The target element to attach the event listener to.
+ * @param {(event: KeyboardEvent) => void} listener The callback function to be executed when the specified key or keys are pressed.
+ * @param {UseEventListenerOptions} [options] The options for the event listener.
+ * @returns {void}
+ *
+ * @example
+ * useKeyPressEvent('Enter', ref, () => console.log('Enter key pressed'));
+ *
+ * @overload
+ * @template Target extends Element
+ * @param {UseKeyPressEventKey} key The key or array of keys to listen for.
+ * @param {(event: KeyboardEvent) => void} listener The callback function to be executed when the specified key or keys are pressed.
+ * @param {UseEventListenerOptions} [options] The options for the event listener.
+ * @returns {void}
+ *
+ * @example
+ * useKeyPressEvent('Enter', (event) => console.log('Enter key pressed'));
+ */
 declare const useKeyPressEvent: UseKeyPressEvent;
 
 /** The use keys pressed params type */
 interface UseKeysPressedParams {
-    /** The target to attach the event listeners to */
-    target?: UseEventListenerTarget;
     /** Enable or disable the event listeners */
     enabled?: boolean;
+    /** The target to attach the event listeners to */
+    target?: UseEventListenerTarget;
 }
 /**
  * @name useKeysPressed
@@ -1506,18 +1595,18 @@ declare const useLastChanged: (source: any, options?: UseLastChangedOptions) =>
 interface UseListReturn<Item> {
     /** The current list of items */
     value: Item[];
-    /** Sets the list of items */
-    set: (list: Item[]) => void;
+    /** Clears the list */
+    clear: () => void;
+    /** Inserts an item at the specified index */
+    insertAt: (insertAtIndex: number, item: Item) => void;
     /** Adds an item to the list */
     push: (item: Item) => void;
     /** Removes an item from the list */
     removeAt: (removeAtIndex: number) => void;
-    /** Inserts an item at the specified index */
-    insertAt: (insertAtIndex: number, item: Item) => void;
+    /** Sets the list of items */
+    set: (list: Item[]) => void;
     /** Updates an item at the specified index */
     updateAt: (updateAtIndex: number, item: Item) => void;
-    /** Clears the list */
-    clear: () => void;
 }
 /**
  * @name useList
@@ -1542,17 +1631,17 @@ declare const useList: <Item>(initialList?: Item[]) => {
     reset: () => void;
 };
 
-type UseStorageInitialValue<Value> = Value | (() => Value);
+type UseStorageInitialValue<Value> = (() => Value) | Value;
 interface UseStorageOptions<Value> {
-    serializer?: (value: Value) => string;
-    deserializer?: (value: string) => Value;
-    storage?: Storage;
     initialValue?: UseStorageInitialValue<Value>;
+    storage?: Storage;
+    deserializer?: (value: string) => Value;
+    serializer?: (value: Value) => string;
 }
 interface UseStorageReturn<Value> {
     value: Value;
-    set: (value: Value) => void;
     remove: () => void;
+    set: (value: Value) => void;
 }
 declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => boolean;
 /**
@@ -1608,23 +1697,23 @@ 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 UseLongPressTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 type LongPressReactEvents<Target extends Element = Element> = MouseEventHandler<Target> | TouchEventHandler<Target>;
 interface UseLongPressOptions {
     threshold?: number;
-    onStart?: (event: LongPressReactEvents) => void;
-    onFinish?: (event: LongPressReactEvents) => void;
     onCancel?: (event: LongPressReactEvents) => void;
+    onFinish?: (event: LongPressReactEvents) => void;
+    onStart?: (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>;
+    /** The callback function to be invoked on touch start */
+    onTouchStart: TouchEventHandler<Element>;
 }
 type UseLongPressReturn = [UseLongPressBind, boolean];
 /**
@@ -1648,20 +1737,20 @@ declare const useLongPress: (callback: (event: LongPressReactEvents) => void, op
 
 /** The use map return type */
 interface UseMapReturn<Key, Value> {
-    /** The current map */
-    value: Map<Key, Value>;
     /** The size of the map */
     size: number;
+    /** The current map */
+    value: Map<Key, Value>;
+    /** Function to clear the map */
+    clear: () => void;
     /** Function to check if a value exists in the map */
     has: (key: Key) => boolean;
-    /** Function to add a value to the map */
-    set: (key: Key, value: Value) => void;
     /** Function to remove a value from the map */
     remove: (key: Key) => void;
-    /** Function to clear the map */
-    clear: () => void;
     /** Function to toggle a value in the map */
     reset: () => void;
+    /** Function to add a value to the map */
+    set: (key: Key, value: Value) => void;
 }
 /**
  * @name useMap
@@ -1678,9 +1767,9 @@ interface UseMapReturn<Key, Value> {
 declare const useMap: <Key, Value>(values?: [Key, Value][]) => UseMapReturn<Key, Value>;
 
 /** The use measure target element type */
-type UseMeasureTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseMeasureTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The use measure return type */
-type UseMeasureReturn = Pick<DOMRectReadOnly, 'x' | 'y' | 'top' | 'left' | 'right' | 'bottom' | 'height' | 'width'>;
+type UseMeasureReturn = Pick<DOMRectReadOnly, 'bottom' | 'height' | 'left' | 'right' | 'top' | 'width' | 'x' | 'y'>;
 interface UseMeasureScreen {
     <Target extends UseMeasureTarget>(target: Target): UseMeasureReturn;
     <Target extends UseMeasureTarget>(target?: never): UseMeasureReturn & {
@@ -1763,23 +1852,23 @@ declare const useMemory: () => UseMemoryReturn;
 declare const useMount: (effect: EffectCallback) => void;
 
 /** The use mouse target element type */
-type UseMouseTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseMouseTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The use mouse return type */
 interface UseMouseReturn {
-    /** The current mouse x position */
-    x: number;
-    /** The current mouse y position */
-    y: number;
     /** The current element */
     element: Element;
-    /** The current element x position */
-    elementX: number;
-    /** The current element y position */
-    elementY: number;
     /** The current element position x */
     elementPositionX: number;
     /** The current element position y */
     elementPositionY: number;
+    /** The current element x position */
+    elementX: number;
+    /** The current element y position */
+    elementY: number;
+    /** The current mouse x position */
+    x: number;
+    /** The current mouse y position */
+    y: number;
 }
 interface UseMouse {
     <Target extends UseMouseTarget>(target: Target): UseMouseReturn;
@@ -1810,19 +1899,19 @@ interface UseMouse {
 declare const useMouse: UseMouse;
 
 interface UseMutationOptions<Data> {
-    retry?: boolean | number | ((failureCount: number, error: Error) => boolean);
-    retryDelay?: number | ((retry: number, error: Error) => number);
-    onSuccess?: (data: Data) => void;
+    retry?: ((failureCount: number, error: Error) => boolean) | boolean | number;
+    retryDelay?: ((retry: number, error: Error) => number) | number;
     onError?: (error: Error) => void;
+    onSuccess?: (data: Data) => void;
 }
 interface UseMutationReturn<Body, Data> {
     data: Data | null;
     error: Error | null;
-    mutate: (body?: Body, options?: UseMutationOptions<Data>) => void;
-    mutateAsync: (body?: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
-    isLoading: boolean;
     isError: boolean;
+    isLoading: boolean;
     isSuccess: boolean;
+    mutate: (body?: Body, options?: UseMutationOptions<Data>) => void;
+    mutateAsync: (body?: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
 }
 interface RequestOptions<Data> extends UseMutationOptions<Data> {
     attempt?: number;
@@ -1846,13 +1935,13 @@ interface RequestOptions<Data> extends UseMutationOptions<Data> {
 declare const useMutation: <Body, Data>(callback: (body: Body) => Promise<Data>, options?: UseMutationOptions<Data>) => UseMutationReturn<Body, Data>;
 
 /** The mutation observer target element type */
-type UseMutationObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
+type UseMutationObserverTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
 /** The mutation observer return type */
 interface UseMutationObserverReturn {
-    /** The mutation observer entries */
-    stop: () => void;
     /** The mutation observer instance */
     observer: MutationObserver;
+    /** The mutation observer entries */
+    stop: () => void;
 }
 /** The mutation observer options type */
 interface UseMutationObserverOptions extends MutationObserverInit {
@@ -1908,11 +1997,11 @@ declare const useMutationObserver: UseMutationObserver;
 interface Connection extends EventTarget {
     readonly downlink: number;
     readonly downlinkMax: number;
-    readonly effectiveType: 'slow-2g' | '2g' | '3g' | '4g';
+    readonly effectiveType: '2g' | '3g' | '4g' | 'slow-2g';
     readonly rtt: number;
     readonly saveData: boolean;
-    readonly type: 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi' | 'wimax';
     onChange: (event: Event) => void;
+    readonly type: 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi' | 'wimax';
 }
 declare global {
     interface Navigator {
@@ -1927,14 +2016,14 @@ type ConnectionType = Connection['type'];
 type ConnectionEffectiveType = Connection['effectiveType'];
 /** The use network return type */
 interface UseNetworkReturn {
-    /** Indicates if the device is currently online */
-    online: boolean;
     /** The estimated downlink speed in megabits per seconds */
     downlink?: Connection['downlink'];
     /** The maximum downlink speed, if available */
     downlinkMax?: Connection['downlinkMax'];
     /** The effective type of connection (e.g., '2g', '3g', '4g') */
     effectiveType?: Connection['effectiveType'];
+    /** Indicates if the device is currently online */
+    online: boolean;
     /** The estimated round-trip time in milliseconds */
     rtt?: Connection['rtt'];
     /** Indicates if the user has enabled data saving mode */
@@ -1957,44 +2046,44 @@ declare const useNetwork: () => UseNetworkReturn;
 
 /** The use offset pagination return type */
 interface UseOffsetPaginationOptions {
-    /** The total number of items */
-    total?: number;
-    /** The number of items per page */
-    pageSize?: number;
     /** The initial page number */
     initialPage?: number;
+    /** The number of items per page */
+    pageSize?: number;
+    /** The total number of items */
+    total?: number;
     /** The callback function to be invoked when page changes */
     onPageChange?: ({ page, pageSize }: {
         page: number;
         pageSize: number;
     }) => void;
-    /** The callback function to be invoked when page size changes */
-    onPageSizeChange?: ({ page, pageSize }: {
+    /** The callback function to be invoked when page count changes */
+    onPageCountChange?: ({ page, pageSize }: {
         page: number;
         pageSize: number;
     }) => void;
-    /** The callback function to be invoked when page count changes */
-    onPageCountChange?: ({ page, pageSize }: {
+    /** The callback function to be invoked when page size changes */
+    onPageSizeChange?: ({ page, pageSize }: {
         page: number;
         pageSize: number;
     }) => void;
 }
 /** The use offset pagination return type */
 interface UseOffsetPaginationReturn {
-    /** The current page number */
-    page: number;
     /** The number of items per page */
     currentPageSize: number;
-    /** The total number of pages */
-    pageCount: number;
     /** Whether the current page is the first page */
     isFirstPage: boolean;
     /** Whether the current page is the last page */
     isLastPage: boolean;
-    /** The callback function to go to the previous page */
-    prev: () => void;
+    /** The current page number */
+    page: number;
+    /** The total number of pages */
+    pageCount: number;
     /** The callback function to go to the next page */
     next: () => void;
+    /** The callback function to go to the previous page */
+    prev: () => void;
     /** The callback function to set the current page */
     set: (page: number) => void;
 }
@@ -2037,7 +2126,7 @@ declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange
 declare const useOnline: () => boolean;
 
 /** The operating system type */
-type OperatingSystem = 'undetermined' | 'macos' | 'ios' | 'windows' | 'android' | 'linux';
+type OperatingSystem = 'android' | 'ios' | 'linux' | 'macos' | 'undetermined' | 'windows';
 declare const getOperatingSystem: () => OperatingSystem;
 /**
  * @name useOperatingSystem
@@ -2102,14 +2191,14 @@ declare global {
 }
 type UseOtpCredentialCallback = (otp: Credential | null) => void;
 interface UseOtpCredentialParams {
-    onSuccess: (credential: Credential | null) => void;
     onError: (error: any) => void;
+    onSuccess: (credential: Credential | null) => void;
 }
 interface UseOtpCredentialReturn {
-    supported: boolean;
-    get: () => Promise<Credential | null>;
     abort: AbortController['abort'];
     aborted: boolean;
+    supported: boolean;
+    get: () => Promise<Credential | null>;
 }
 interface UseOtpCredential {
     (callback?: UseOtpCredentialCallback): UseOtpCredentialReturn;
@@ -2198,14 +2287,14 @@ declare class Paint {
 interface UsePaintOptions {
     /** Brush color */
     color?: string;
+    /** Initial lines */
+    initialLines?: Paint['lines'];
+    /** Brush opacity */
+    opacity?: number;
     /** Brush radius */
     radius?: number;
     /** Smooth brush movement */
     smooth?: boolean;
-    /** Brush opacity */
-    opacity?: number;
-    /** Initial lines */
-    initialLines?: Paint['lines'];
     /** Callback when the mouse is down */
     onMouseDown?: (event: MouseEvent, paint: Paint) => void;
     /** Callback when the mouse is moved */
@@ -2215,13 +2304,13 @@ interface UsePaintOptions {
 }
 interface UsePaintReturn {
     drawing: boolean;
+    lines: Paint['lines'];
     clear: () => void;
-    undo: () => void;
     draw: (points: Point[], color: string, opacity: number, radius: number) => void;
-    lines: Paint['lines'];
+    undo: () => void;
 }
 /** The use paint return type */
-type UsePaintTarget = RefObject<HTMLCanvasElement> | (() => HTMLCanvasElement) | HTMLCanvasElement;
+type UsePaintTarget = (() => HTMLCanvasElement) | HTMLCanvasElement | RefObject<HTMLCanvasElement>;
 interface UsePaint {
     <Target extends UsePaintTarget>(target: Target, options?: UsePaintOptions): UsePaintReturn;
     (options?: UsePaintOptions, target?: never): {
@@ -2255,21 +2344,21 @@ declare const usePaint: UsePaint;
 interface UseParallaxValue {
     /** Roll value. Scaled to `-0.5 ~ 0.5` */
     roll: number;
-    /** Tilt value. Scaled to `-0.5 ~ 0.5` */
-    tilt: number;
     /** Sensor source, can be `mouse` or `deviceOrientation` */
     source: 'deviceOrientation' | 'mouse';
+    /** Tilt value. Scaled to `-0.5 ~ 0.5` */
+    tilt: number;
 }
 /** The use parallax options type */
 interface UseParallaxOptions {
-    /** Device orientation tilt adjust function */
-    deviceOrientationTiltAdjust?: (value: number) => number;
     /** Device orientation roll adjust function */
     deviceOrientationRollAdjust?: (value: number) => number;
-    /** Mouse tilt adjust function */
-    mouseTiltAdjust?: (value: number) => number;
+    /** Device orientation tilt adjust function */
+    deviceOrientationTiltAdjust?: (value: number) => number;
     /** Mouse roll adjust function */
     mouseRollAdjust?: (value: number) => number;
+    /** Mouse tilt adjust function */
+    mouseTiltAdjust?: (value: number) => number;
 }
 interface UseParallaxReturn {
     value: UseParallaxValue;
@@ -2304,7 +2393,7 @@ interface UseParallax {
 declare const useParallax: UseParallax;
 
 /** The permission name */
-type UsePermissionName = PermissionName | 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker';
+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 */
 interface UsePermissionOptions {
     /** Whether the permission is enabled */
@@ -2337,6 +2426,26 @@ declare const usePermission: (permissionDescriptorName: UsePermissionName, optio
     query: () => Promise<PermissionState>;
 };
 
+type UsePointerLockTarget = RefObject<Element | null | undefined>;
+interface UsePointerLockReturn {
+    element?: Element;
+    supported: boolean;
+    lock: (event: Event | MouseEvent$1<Element>) => void;
+    unlock: () => boolean;
+}
+/**
+ * @name usePointerLock
+ * @description - Hook that provides reactive pointer lock
+ * @category Sensors
+ *
+ * @param {UsePointerLockTarget} target The target element for the pointer lock
+ * @returns {UsePointerLockReturn} An object containing the pointer lock element and functions to interact with the pointer lock
+ *
+ * @example
+ * const { supported, lock, unlock, element } = usePointerLock();
+ */
+declare const usePointerLock: (target?: UsePointerLockTarget) => UsePointerLockReturn;
+
 /** The use preferred color scheme return type */
 type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
 /**
@@ -2352,7 +2461,7 @@ type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
 declare const usePreferredColorScheme: () => UsePreferredColorSchemeReturn;
 
 /** The use preferred contrast return type */
-type UsePreferredContrastReturn = 'more' | 'less' | 'custom' | 'no-preference';
+type UsePreferredContrastReturn = 'custom' | 'less' | 'more' | 'no-preference';
 /**
  * @name usePreferredContrast
  * @description - Hook that returns the contrast preference
@@ -2388,7 +2497,7 @@ declare const usePreferredDark: () => boolean;
 declare const usePreferredLanguages: () => readonly string[];
 
 /** The use preferred reduced motion return type */
-type UsePreferredReducedMotionReturn = 'reduce' | 'no-preference';
+type UsePreferredReducedMotionReturn = 'no-preference' | 'reduce';
 /**
  * @name usePreferredReducedMotion
  * @description - Hook that returns the reduced motion preference
@@ -2417,20 +2526,20 @@ declare const usePrevious: <Value>(value: Value) => Value | undefined;
 
 /** The use queue return type */
 interface UseQueueReturn<Value> {
-    /** The current queue */
-    queue: Value[];
-    /** Add an element to the queue */
-    add: (element: Value) => void;
-    /** Remove an element from the queue */
-    remove: () => Value;
-    /** Clear the queue */
-    clear: () => void;
     /** Get the first element of the queue */
     first: Value;
     /** Get the last element of the queue */
     last: Value;
+    /** The current queue */
+    queue: Value[];
     /** Get the size of the queue */
     size: number;
+    /** Add an element to the queue */
+    add: (element: Value) => void;
+    /** Clear the queue */
+    clear: () => void;
+    /** Remove an element from the queue */
+    remove: () => Value;
 }
 /**
  * @name useQueue
@@ -2495,7 +2604,7 @@ type UseRafValueReturn<Value> = [Value, (value: Value) => void];
  * @example
  * const [value, setValue] = useRafValue(initialValue);
  */
-declare const useRafValue: <Value>(initialValue: Value | (() => Value)) => readonly [Value, (value: Value) => void];
+declare const useRafValue: <Value>(initialValue: (() => Value) | Value) => readonly [Value, (value: Value) => void];
 
 /**
  * @name useRenderCount
@@ -2512,8 +2621,8 @@ declare const useRenderCount: () => number;
 interface UseRenderInfoReturn {
     component: string;
     renders: number;
-    timestamp: null | number;
     sinceLast: number;
+    timestamp: number | null;
 }
 /**
  * @name useRenderInfo
@@ -2549,7 +2658,7 @@ interface UseRerenderReturns {
 declare const useRerender: () => UseRerenderReturns;
 
 /** The resize observer target element type */
-type UseResizeObserverTarget = RefObject<Element | null | undefined> | (() => Element) | Element;
+type UseResizeObserverTarget = (() => Element) | Element | RefObject<Element | null | undefined>;
 /** The resize observer options type */
 interface UseResizeObserverOptions extends ResizeObserverOptions {
     enabled?: boolean;
@@ -2604,7 +2713,7 @@ interface UseScreenOrientationValue {
     /** The current orientation type */
     orientationType: OrientationType;
 }
-type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
+type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
 interface useScreenOrientationReturn {
     /** Whether the screen orientation is supported */
     supported: boolean;
@@ -2628,7 +2737,7 @@ interface useScreenOrientationReturn {
 declare const useScreenOrientation: () => useScreenOrientationReturn;
 
 /** The use script status */
-type UseScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
+type UseScriptStatus = 'error' | 'loading' | 'ready' | 'unknown';
 declare const SCRIPT_STATUS_ATTRIBUTE_NAME = "script-status";
 /** The use script options extends from attributes script tag */
 interface UseScriptOptions extends ComponentProps<'script'> {
@@ -2672,30 +2781,30 @@ declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageI
 
 /** The use set return type */
 interface UseSetReturn<Value> {
-    /** The current set */
-    value: Set<Value>;
     /** The size of the set */
     size: number;
-    /** Function to check if a value exists in the set */
-    has: (value: Value) => boolean;
+    /** The current set */
+    value: Set<Value>;
     /** Function to add a value to the set */
     add: (value: Value) => void;
-    /** Function to remove a value from the set */
-    remove: (value: Value) => void;
     /** Function to clear the set */
     clear: () => void;
+    /** Function to get the symmetric difference of two sets */
+    difference: (other: Set<Value>) => void;
+    /** Function to check if a value exists in the set */
+    has: (value: Value) => boolean;
+    /** Function to get the difference of two sets */
+    intersection: (other: Set<Value>) => void;
+    /** Function to remove a value from the set */
+    remove: (value: Value) => void;
     /** Function to toggle a value in the set */
     reset: () => void;
+    /** Function to get the symmetric difference of two sets */
+    symmetricDifference: (other: Set<Value>) => void;
     /** Function to toggle a value in the set */
     toggle: (value: Value) => void;
     /** Function to get the union of two sets */
     union: (other: Set<Value>) => void;
-    /** Function to get the difference of two sets */
-    intersection: (other: Set<Value>) => void;
-    /** Function to get the symmetric difference of two sets */
-    difference: (other: Set<Value>) => void;
-    /** Function to get the symmetric difference of two sets */
-    symmetricDifference: (other: Set<Value>) => void;
 }
 /**
  * @name useSet
@@ -2713,21 +2822,21 @@ declare const useSet: <Value>(values?: Value[]) => UseSetReturn<Value>;
 
 /** The use share options type */
 interface UseShareParams {
-    /** The title of the share */
-    title?: string;
     /** The files of the share */
     files?: File[];
     /** The text of the share */
     text?: string;
+    /** The title of the share */
+    title?: string;
     /** The url of the share */
     url?: string;
 }
 /** The use share return type */
 interface UseShareReturn {
-    /** The share function */
-    share: (shareParams: ShareData) => Promise<void>;
     /** The share supported status */
     supported: boolean;
+    /** The share function */
+    share: (shareParams: ShareData) => Promise<void>;
 }
 /**
  * @name useShare
@@ -2762,14 +2871,14 @@ interface UseStepReturn {
     isFirst: boolean;
     /** Boolean value if current step is last */
     isLast: boolean;
-    /** Go to next step */
-    next: () => void;
     /** Go to back step */
     back: () => void;
+    /** Go to next step */
+    next: () => void;
     /** Reset current step to initial value */
     reset: () => void;
     /** Go to custom step */
-    set: (value: number | 'last' | 'first') => void;
+    set: (value: number | 'first' | 'last') => void;
 }
 /**
  * @name useStep
@@ -2795,26 +2904,26 @@ declare const useStep: (params: number | UseStepParams) => UseStepReturn;
 
 /** The use stopwatch return type */
 interface UseStopwatchReturn {
-    /** The paused state of the stopwatch */
-    paused: boolean;
-    /** The over state of the stopwatch */
-    over: boolean;
+    /** The total count of the stopwatch */
+    count: number;
     /** The day count of the stopwatch */
     days: number;
     /** The hour count of the stopwatch */
     hours: number;
     /** The minute count of the stopwatch */
     minutes: number;
+    /** The over state of the stopwatch */
+    over: boolean;
+    /** The paused state of the stopwatch */
+    paused: boolean;
     /** The second count of the stopwatch */
     seconds: number;
-    /** The total count of the stopwatch */
-    count: number;
     /** The function to pause the stopwatch */
     pause: () => void;
-    /** The function to start the stopwatch */
-    start: () => void;
     /** The function to reset the stopwatch */
     reset: () => void;
+    /** The function to start the stopwatch */
+    start: () => void;
     /** The function to toggle the stopwatch */
     toggle: () => void;
 }
@@ -2855,14 +2964,14 @@ declare const useStopwatch: UseStopwatch;
 declare const getRangesSelection: (selection: Selection) => Range[];
 /** The use text selection return type */
 interface UseTextSelectionReturn {
-    /** The current selection text */
-    text: string;
     /** The current selection ranges */
     ranges: Range[];
     /** The current selection rects */
     rects: DOMRect[];
     /** The current selection */
     selection: Selection | null;
+    /** The current selection text */
+    text: string;
 }
 /**
  * @name useTextSelection
@@ -2877,17 +2986,17 @@ interface UseTextSelectionReturn {
 declare const useTextSelection: () => UseTextSelectionReturn;
 
 interface UseTimeReturn {
-    seconds: number;
-    minutes: number;
+    day: number;
     hours: number;
     meridiemHours: {
         value: number;
         type: string;
     };
-    day: number;
+    minutes: number;
     month: number;
-    year: number;
+    seconds: number;
     timestamp: number;
+    year: number;
 }
 /**
  * @name useTime
@@ -2937,22 +3046,22 @@ interface UseTimerOptions {
 }
 /** The use timer return type */
 interface UseTimerReturn {
-    /** flag to indicate if timer is running or not */
-    running: boolean;
     /** The day count of the timer */
     days: number;
     /** The hour count of the timer */
     hours: number;
     /** The minute count of the timer */
     minutes: number;
+    /** flag to indicate if timer is running or not */
+    running: boolean;
     /** The second count of the timer */
     seconds: number;
     /** The function to pause the timer */
     pause: () => void;
-    /** The function to start the timer */
-    start: () => void;
     /** The function to restart the timer */
     restart: (time: number, autostart?: boolean) => void;
+    /** The function to start the timer */
+    start: () => void;
     /** The function to toggle the timer */
     toggle: () => void;
 }
@@ -3002,22 +3111,22 @@ declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonl
  */
 declare const useUnmount: (callback: () => void) => void;
 
-type UseWebSocketUrl = string | (() => string);
+type UseWebSocketUrl = (() => string) | string;
 interface UseWebSocketOptions {
+    protocols?: Array<'soap' | 'wasm'>;
+    retry?: boolean | number;
     onConnected?: (webSocket: WebSocket) => void;
     onDisconnected?: (event: CloseEvent, webSocket: WebSocket) => void;
     onError?: (event: Event, webSocket: WebSocket) => void;
     onMessage?: (event: MessageEvent, webSocket: WebSocket) => void;
-    retry?: boolean | number;
-    protocols?: Array<'soap' | 'wasm'>;
 }
-type UseWebSocketStatus = 'connecting' | 'failed' | 'connected' | 'disconnected';
+type UseWebSocketStatus = 'connected' | 'connecting' | 'disconnected' | 'failed';
 interface UseWebSocketReturn {
-    status: UseWebSocketStatus;
+    client?: WebSocket;
     close: WebSocket['close'];
     send: WebSocket['send'];
+    status: UseWebSocketStatus;
     open: () => void;
-    client?: WebSocket;
 }
 /**
  * @name useWebSocket
@@ -3093,10 +3202,10 @@ interface UseWindowSizeParams {
 }
 /** The use window size return type */
 interface UseWindowSizeReturn {
-    /** The current window width */
-    width: number;
     /** The current window height */
     height: number;
+    /** The current window width */
+    width: number;
 }
 /**
  * @name useWindowSize
@@ -3145,10 +3254,10 @@ declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardSte
 
 declare function debounce<Params extends unknown[]>(callback: (...args: Params) => void, delay: number): (...args: Params) => void;
 
-type GetElementTarget = RefObject<Element | null | undefined> | (() => Element) | Element | Window | Document;
+type GetElementTarget = (() => Element) | Document | Element | RefObject<Element | null | undefined> | Window;
 declare const getElement: <Target extends GetElementTarget>(target: Target) => Element | (Target & Document) | (Target & Window) | null | undefined;
 
-declare const getRetry: (retry: number | boolean) => number;
+declare const getRetry: (retry: boolean | number) => number;
 
 declare const isClient: boolean;
 
@@ -3168,4 +3277,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 UseAsyncReturn, type UseBatteryStateReturn, 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 UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, 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 UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, 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 UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useActiveElement, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, 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, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useTimer, useToggle, useUnmount, 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 UseAsyncReturn, type UseBatteryStateReturn, type UseBatteryValue, 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 UseDisclosureOptions, type UseDisclosureReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseElementSize, type UseElementSizeReturn, type UseElementSizeTarget, 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 UsePreferredColorSchemeReturn, type UsePreferredContrastReturn, type UsePreferredReducedMotionReturn, 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 UseShareParams, type UseShareReturn, type UseStopwatchOptions, type UseStopwatchReturn, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseTimerOptions, type UseTimerReturn, type UseToggleReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UseWebSocketStatus, type UseWebSocketUrl, type UseWindowSizeReturn, type WizardItem, debounce, dispatchStorageEvent, getConnection, getDate, getElement, getOperatingSystem, getRangesSelection, getRetry, getTimeFromSeconds, isClient, isHotkeyMatch, isPermissionAllowed, legacyCopyToClipboard, mapGamepadToXbox360Controller, scrollTo, throttle, useActiveElement, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useCssVar, useDebounceCallback, useDebounceValue, useDefault, useDeviceMotion, useDeviceOrientation, 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, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useMutationObserver, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOptimistic, useOrientation, useOtpCredential, usePageLeave, usePaint, useParallax, usePermission, usePointerLock, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScreenOrientation, type useScreenOrientationReturn, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useTimer, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowFocus, useWindowScroll, useWindowSize, useWizard };