@siberiacancode/reactuse 0.0.40 → 0.0.42

package/dist/index.d.ts

@@ -25,6 +25,7 @@ interface UseBatteryStateReturn {
 /**
  * @name useBattery
  * @description - Hook for getting information about battery status
+ * @category Browser
  *
  * @returns {UseBatteryStateReturn} Object containing battery information & Battery API support
  *
@@ -43,6 +44,7 @@ type UseBooleanReturn = [
 /**
  * @name useBoolean
  * @description - Hook provides a boolean state and a function to toggle the boolean value
+ * @category Utilities
  *
  * @param {boolean} [initialValue=false] The initial boolean value
  * @returns {UseBooleanReturn} An object containing the boolean state value and utility functions to manipulate the state
@@ -55,6 +57,7 @@ declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 /**
  * @name useBrowserLanguage
  * @description - Hook that returns the current browser language
+ * @category Browser
  *
  * @returns {string} The current browser language
  *
@@ -74,6 +77,7 @@ type UseClickOutside = {
 /**
  * @name useClickOutside
  * @description - Hook to handle click events outside the specified target element(s)
+ * @category Sensors
  *
  * @overload
  * @template Target The target element(s)
@@ -104,6 +108,7 @@ interface UseCopyToClipboardReturn {
 /**
  * @name useCopyToClipboard
  * @description - Hook that manages a copy to clipboard
+ * @category Browser
  *
  * @returns {UseCopyToClipboardReturn} An object containing the boolean state value and utility functions to manipulate the state
  *
@@ -147,6 +152,7 @@ type UseCounter = {
 /**
  * @name useCounter
  * @description - Hook that manages a counter with increment, decrement, reset, and set functionalities
+ * @category Utilities
  *
  * @overload
  * @param {number} [initialValue=0] The initial number value
@@ -171,6 +177,7 @@ declare const useCounter: UseCounter;
 /**
  * @name useDebounceCallback
  * @description - Hook that creates a debounced callback and returns a stable reference of it
+ * @category Utilities
  *
  * @template Params The type of the params
  * @template Return The type of the return
@@ -186,6 +193,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
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value} value The value to be debounced
@@ -200,6 +208,7 @@ declare const useDebounceValue: <Value>(value: Value, delay: number) => Value;
 /**
  * @name useDefault
  * @description - Hook that returns the default value
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value} initialValue The initial value
@@ -214,6 +223,7 @@ declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultVa
 /**
  * @name useDidUpdate
  * @description – Hook that behaves like useEffect, but skips the effect on the initial render
+ * @category Lifecycle
  *
  * @param {EffectCallback} effect The effect callback
  * @param {DependencyList} [deps] The dependencies list for the effect
@@ -236,6 +246,7 @@ interface UseDisclosureReturn {
 /**
  * @name useDisclosure
  * @description - Hook that allows you to open and close a modal
+ * @category Utilities
  *
  * @param {boolean} initialValue The initial value of the component
  * @param {() => void} [options.onOpen] The callback function to be invoked on open
@@ -262,6 +273,7 @@ declare const useEventListener: UseEventListener;
 /**
  * @name useDocumentEvent
  * @description - Hook attaches an event listener to the document object for the specified event
+ * @category Browser
  *
  * @template Event Key of document event map.
  * @param {Event} event The event to listen for.
@@ -289,6 +301,7 @@ type UseDocumentTitleReturn = [
 /**
  * @name useDocumentTitle
  * @description - Hook that manages the document title and allows updating it
+ * @category Browser
  *
  * @param {string} [value] The initial title. If not provided, the current document title will be used
  * @param {boolean} [options.restoreOnUnmount] Restore the previous title on unmount
@@ -302,6 +315,7 @@ declare function useDocumentTitle(value?: string, options?: UseDocumentTitleOpti
 /**
  * @name useDocumentVisibility
  * @description – Hook that provides the current visibility state of the document
+ * @category Browser
  *
  * @returns {DocumentVisibilityState} The current visibility state of the document, which can be 'visible' or 'hidden'
  *
@@ -313,6 +327,7 @@ declare const useDocumentVisibility: () => DocumentVisibilityState;
 /**
  * @name useEvent
  * @description - Hook that creates an event and returns a stable reference of it
+ * @category Browser
  *
  * @template Params The type of the params
  * @template Return The type of the return
@@ -326,7 +341,7 @@ declare const useEvent: <Params extends unknown[], Return>(callback: (...args: P
 
 declare global {
     interface Window {
-        EyeDropper?: EyeDropperConstructor | undefined;
+        readonly EyeDropper?: EyeDropperConstructor | undefined;
     }
 }
 /** The color selection return type */
@@ -338,6 +353,7 @@ interface UseEyeDropperReturn {
 /**
  * @name useEyeDropper
  * @description - Hook that gives you access to the eye dropper
+ * @category Browser
  *
  * @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
@@ -350,6 +366,7 @@ declare const useEyeDropper: (initialValue?: string | undefined) => UseEyeDroppe
 /**
  * @name useFavicon
  * @description - Hook that manages the favicon
+ * @category Browser
  *
  * @param {string} [initialFavicon] The initial favicon. If not provided, the current favicon will be used
  * @returns {UseFaviconReturn} An array containing the current favicon and a function to update the favicon
@@ -439,8 +456,9 @@ interface UseFieldReturn<Value> {
     clearError: () => void;
 }
 /**
- * @name UseField
+ * @name useField
  * @description - Hook to manage a form field
+ * @category Utilities
  *
  * @template Value The input value
  * @template Type The input value type
@@ -460,6 +478,7 @@ declare const useField: <Value extends string | boolean = string, Type = Value e
 /**
  * @name useFps
  * @description - Hook that measures frames per second
+ * @category Sensors
  *
  * @returns {number} A number which determines frames per second
  *
@@ -495,6 +514,7 @@ type UseFullScreen = {
 /**
  * @name useFullscreen
  * @description - Hook to handle fullscreen events
+ * @category Browser
  *
  * @overload
  * @template Target The target element for fullscreen
@@ -524,6 +544,7 @@ type UseHashReturn = [string, (value: string) => void];
 /**
  * @name useHash
  * @description - Hook that manages the hash value
+ * @category Browser
  *
  * @returns {UseHashReturn} An array containing the hash value and a function to set the hash value
  *
@@ -547,6 +568,7 @@ type UseHotkeysHotkeys = string[] | string;
 /**
  * @name useHotkeys
  * @description - Hook that listens for hotkeys
+ * @category Sensors
  *
  * @param {UseHotkeysHotkeys} hotkeys The key or keys to listen for
  * @param {(event: KeyboardEvent) => void} callback The callback function to be called when the hotkey is pressed
@@ -579,6 +601,7 @@ type UseHover = {
 /**
  * @name useHover
  * @description - Hook that defines the logic when hovering an element
+ * @category Sensors
  *
  * @overload
  * @template Target The target element
@@ -635,6 +658,7 @@ interface UseIdleReturn {
 /**
  * @name useIdle
  * @description - Hook that defines the logic when the user is idle
+ * @category Sensors
  *
  * @param {number} [milliseconds=ONE_MINUTE] The idle time in milliseconds
  * @param {boolean} [options.initialState=false] The options for the hook
@@ -687,6 +711,7 @@ type UseInterval = {
 /**
  * @name useInterval
  * @description - Hook that makes and interval and returns controlling functions
+ * @category Time
  *
  * @overload
  * @param {() => void} callback Any callback function
@@ -710,6 +735,7 @@ declare const useInterval: UseInterval;
 /**
  * @name useIsFirstRender
  * @description - Hook that returns true if the component is first render
+ * @category Lifecycle
  *
  * @returns {boolean} True if the component is first render
  *
@@ -721,6 +747,7 @@ declare const useIsFirstRender: () => boolean;
 /**
  * @name useIsomorphicLayoutEffect
  * @description - Hook conditionally selects either `useLayoutEffect` or `useEffect` based on the environment
+ * @category Lifecycle
  *
  * @example
  * useIsomorphicLayoutEffect(() => console.log('effect'), [])
@@ -739,6 +766,7 @@ type UseKeyboardParams = {
 /**
  * @name useKeyboard
  * @description - Hook that help to listen for keyboard events
+ * @category Sensors
  *
  * @param {UseEventListenerTarget} [target=window] The target to attach the event listeners to
  * @param {(event: KeyboardEvent) => void} [onKeyDown] The callback function to be invoked on key down
@@ -759,6 +787,7 @@ type UseKeyPressOptions = {
 /**
  * @name useKeyPress
  * @description - Hook that listens for key press events
+ * @category Sensors
  *
  * @param {UseKeyPressKey} key The key or keys to listen for
  * @param {UseEventListenerTarget} [options.target=window] The target to attach the event listeners to
@@ -788,6 +817,7 @@ interface UseKeysPressedParams {
 /**
  * @name useKeysPressed
  * @description - Hook for get keys that were pressed
+ * @category Sensors
  *
  * @param {UseEventListenerTarget} [params.target=window] The target to attach the event listeners to
  * @param {boolean} [params.enabled=bollean] Enable or disable the event listeners
@@ -804,9 +834,10 @@ declare const useKeysPressed: (params?: UseKeysPressedParams) => {
 /**
  * @name useList
  * @description - Hook that defines the logic when unmounting a component
+ * @category Utilities
  *
- * @template Item - The type of the item
- * @param {Item[] | (() => Item[])} initialList - The initial list of items
+ * @template Item The type of the item
+ * @param {Item[] | (() => Item[])} initialList The initial list of items
  * @returns {UseListReturn} An object containing the current list and functions to interact with the list
  *
  * @example
@@ -835,6 +866,7 @@ declare const useStorage: <Value>(key: string, params?: UseStorageInitialValue<V
 /**
  * @name useLocalStorage
  * @description - Hook that manages local storage value
+ * @category Browser
  *
  * @template Value The type of the value
  * @param {string} key The key of the storage
@@ -849,6 +881,7 @@ declare const useLocalStorage: <Value>(key: string, initialValue?: UseStorageIni
 /**
  * @name useLogger
  * @description - Hook for debugging lifecycle
+ * @category Lifecycle
  *
  * @param {string} name The name or identifier for the logger
  * @param {unknown[]} params Additional arguments to be logged
@@ -873,6 +906,7 @@ type UseLongPress = {
 /**
  * @name useLongPress
  * @description - Hook that defines the logic when long pressing an element
+ * @category Sensors
  *
  * @overload
  * @template Target The target element
@@ -922,6 +956,7 @@ interface UseMapReturn<Key, Value> {
 /**
  * @name useMap
  * @description - Hook that manages a map structure
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the map
@@ -935,6 +970,7 @@ declare const useMap: <Key, Value>(values?: [Key, Value][]) => UseMapReturn<Key,
 /**
  * @name useMediaQuery
  * @description - Hook that manages a media query
+ * @category Browser
  *
  * @param {string} query The media query string
  * @returns {boolean} A boolean indicating if the media query matches
@@ -944,9 +980,35 @@ declare const useMap: <Key, Value>(values?: [Key, Value][]) => UseMapReturn<Key,
  */
 declare const useMediaQuery: (query: string) => boolean;
 
+declare global {
+    interface Performance {
+        memory: {
+            readonly jsHeapSizeLimit: number;
+            readonly totalJSHeapSize: number;
+            readonly usedJSHeapSize: number;
+        };
+    }
+}
+interface UseMemoryReturn {
+    supported: boolean;
+    value: Performance['memory'];
+}
+/**
+ * @name useMemory
+ * @description - Hook that gives you current memory usage
+ * @category Browser
+ *
+ * @returns {UseMemoryReturn} An object containing the current memory usage
+ *
+ * @example
+ * const { supported, value } = useMemory();
+ */
+declare const useMemory: () => UseMemoryReturn;
+
 /**
  * @name useMount
  * @description - Hook that executes a callback when the component mounts
+ * @category Lifecycle
  *
  * @param {EffectCallback} effect The callback to execute
  *
@@ -981,6 +1043,7 @@ type UseMouse = {
 /**
  * @name useMouse
  * @description - Hook that manages a mouse position
+ * @category Sensors
  *
  * @overload
  * @template Target The target element
@@ -1016,13 +1079,14 @@ interface UseMutationReturn<Body, Data> {
 /**
  * @name useMutation
  * @description - Hook that defines the logic when mutate data
- *
- * @template Body - The type of the body
- * @template Data - The type of the data
- * @param {(body: Body) => Promise<Data>} callback - The callback function to be invoked
- * @param {boolean | number} [options.retry] - The retry count of requests
- * @param {(data: Data) => void} [options.onSuccess] - The callback function to be invoked on success
- * @param {(error: Error) => void} [options.onError] - The callback function to be invoked on error
+ * @category Utilities
+ *
+ * @template Body The type of the body
+ * @template Data The type of the data
+ * @param {(body: Body) => Promise<Data>} callback The callback function to be invoked
+ * @param {boolean | number} [options.retry] The retry count of requests
+ * @param {(data: Data) => void} [options.onSuccess] The callback function to be invoked on success
+ * @param {(error: Error) => void} [options.onError] The callback function to be invoked on error
  * @returns {UseMutationReturn<Data>} An object with the state of the mutation
  *
  * @example
@@ -1057,6 +1121,7 @@ interface UseNetworkReturn {
 /**
  * @name useNetwork
  * @description - Hook to track network status
+ * @category Sensors
  *
  * @returns {UseNetworkReturn} An object containing the network status
  *
@@ -1068,6 +1133,7 @@ declare const useNetwork: () => UseNetworkReturn;
 /**
  * @name useOnline
  * @description - Hook that manages if the user is online
+ * @category Sensors
  *
  * @returns {boolean} A boolean indicating if the user is online
  *
@@ -1081,6 +1147,7 @@ type OperatingSystem = 'undetermined' | 'macos' | 'ios' | 'windows' | 'android'
 /**
  * @name useOperatingSystem
  * @description - Hook that returns the operating system of the current browser
+ * @category Browser
  *
  * @returns {OperatingSystem} The operating system
  *
@@ -1099,6 +1166,7 @@ interface UseOrientationReturn {
 /**
  * @name useOrientation
  * @description - Hook that returns the current screen orientation
+ * @category Browser
  *
  * @returns {UseOrientationReturn} An object containing the current screen orientation
  *
@@ -1110,6 +1178,7 @@ declare const useOrientation: () => UseOrientationReturn;
 /**
  * @name usePageLeave
  * @description - Hook what calls given function when mouse leaves the page
+ * @category Sensors
  *
  * @param {() => void} [callback] The callback function what calls then mouse leaves the page
  * @returns {boolean} A boolean which determines if the mouse left the page
@@ -1119,32 +1188,88 @@ declare const useOrientation: () => UseOrientationReturn;
  */
 declare const usePageLeave: (callback?: () => void) => boolean;
 
-interface UsePaintPencil {
-    /** Pencil color */
+interface Point {
+    x: number;
+    y: number;
+}
+declare class Pointer implements Point {
+    x: number;
+    y: number;
+    constructor(x: number, y: number);
+    update(point: Point): void;
+    getDifferenceTo(point: Point): Pointer;
+    getDistanceTo(point: Point): number;
+    getAngleTo(point: Point): number;
+    equalsTo(point: Point): boolean;
+    moveByAngle(angle: number, distance: number): this;
+}
+
+declare class Paint {
+    pointer: Pointer;
+    brush: Pointer;
+    radius: number;
+    smooth: boolean;
+    points: Point[];
+    lines: {
+        points: Point[];
+        color: string;
+        radius: number;
+        opacity: number;
+    }[];
+    constructor({ x, y, radius, smooth }: {
+        x: number;
+        y: number;
+        radius: number;
+        smooth: boolean;
+    });
+    getBrushCoordinates(): {
+        x: number;
+        y: number;
+    };
+    getPointerCoordinates(): {
+        x: number;
+        y: number;
+    };
+    update(point: Point): boolean;
+}
+
+interface UsePaintOptions {
+    /** Brush color */
     color?: string;
-    /** Pencil width */
-    width?: number;
-    /** Pencil opacity */
+    /** 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 */
+    onMouseMove?: (event: MouseEvent, paint: Paint) => void;
+    /** Callback when the mouse is up */
+    onMouseUp?: (event: MouseEvent, paint: Paint) => void;
 }
-type UsePaintOptions = UsePaintPencil;
-/** The use paint return type */
 interface UsePaintReturn {
-    pencil: UsePaintPencil & {
-        set: Dispatch<SetStateAction<UsePaintPencil>>;
-    };
     drawing: boolean;
+    clear: () => void;
+    undo: () => void;
+    draw: (points: Point[], color: string, opacity: number, radius: number) => void;
+    lines: Paint['lines'];
 }
+/** The use paint return type */
 type UsePaintTarget = RefObject<HTMLCanvasElement> | (() => HTMLCanvasElement) | HTMLCanvasElement;
 type UsePaint = {
     <Target extends UsePaintTarget>(target: Target, options?: UsePaintOptions): UsePaintReturn;
-    (options?: UsePaintOptions, target?: never): UsePaintReturn & {
+    (options?: UsePaintOptions, target?: never): {
         ref: RefObject<HTMLCanvasElement>;
-    };
+    } & UsePaintReturn;
 };
 /**
  * @name usePaint
  * @description - Hook that allows you to draw in a specific area
+ * @category Browser
  *
  * @overload
  * @template Target The target element
@@ -1153,22 +1278,40 @@ type UsePaint = {
  * @returns {UsePaintReturn} An object containing the current pencil options and functions to interact with the paint
  *
  * @example
- * const { pencil, drawing } = usePaint(canvasRef);
+ * const drawing = usePaint(canvasRef);
  *
  * @overload
  * @param {UsePaintOptions} [options] The options to be used
  * @returns {UsePaintReturn & { ref: RefObject<HTMLCanvasElement> }} An object containing the current pencil options and functions to interact with the paint
  *
  * @example
- * const { ref, pencil, drawing } = usePaint();
+ * const { ref, drawing } = usePaint();
  */
 declare const usePaint: UsePaint;
 
+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';
+/**
+ *  @name usePermission
+ *  @description - Hook that gives you the state of permission
+ *  @category Browser
+ *
+ *  @returns {UsePermissionReturn} An object containing the state and the supported status
+ *
+ *  @example
+ *  const { state, supported, query } = usePermission('microphone');
+ */
+declare const usePermission: (permissionDescriptorName: UsePermissionName) => {
+    state: PermissionState;
+    supported: boolean;
+    query: () => Promise<PermissionState>;
+};
+
 /** The use preferred color scheme return type */
 type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
 /**
  * @name usePreferredColorScheme
  * @description - Hook that returns user preferred color scheme
+ * @category Browser
  *
  * @returns {UsePreferredColorSchemeReturn} String of preferred color scheme
  *
@@ -1180,6 +1323,7 @@ declare const usePreferredColorScheme: () => UsePreferredColorSchemeReturn;
 /**
  * @name usePreferredLanguages
  * @description Hook that returns a browser preferred languages from navigator
+ * @category Browser
  *
  * @returns {readonly string[]} An array of strings representing the user's preferred languages
  *
@@ -1191,6 +1335,7 @@ declare const usePreferredLanguages: () => readonly string[];
 /**
  * @name usePrevious
  * @description - Hook that returns the previous value
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value} value The value to get the previous value
@@ -1209,29 +1354,32 @@ interface UseQueryOptions<QueryData, Data> {
     initialData?: Data | (() => Data);
     placeholderData?: Data | (() => Data);
     retry?: boolean | number;
+    refetchInterval?: number;
 }
 interface UseQueryReturn<Data> {
-    data: Data | undefined;
+    data?: Data;
     isLoading: boolean;
     isError: boolean;
     isSuccess: boolean;
-    error: Error | undefined;
+    error?: Error;
     refetch: () => void;
     isRefetching: boolean;
 }
 /**
  * @name useQuery
  * @description - Hook that defines the logic when query data
- *
- * @template Data - The type of the data
- * @param {() => Promise<Data>} callback - The callback function to be invoked
- * @param {DependencyList} [options.keys] - The dependencies for the hook
- * @param {(data: Data) => void} [options.onSuccess] - The callback function to be invoked on success
- * @param {(error: Error) => void} [options.onError] - The callback function to be invoked on error
- * @param {UseQueryOptionsSelect<Data>} [options.select] - The select function to be invoked
- * @param {Data | (() => Data)} [options.initialData] - The initial data for the hook
- * @param {Data | (() => Data)} [options.placeholderData] - The placeholder data for the hook
- * @param {boolean | number} [options.retry] - The retry count of requests
+ * @category Utilities
+ *
+ * @template Data The type of the data
+ * @param {() => Promise<Data>} callback The callback function to be invoked
+ * @param {DependencyList} [options.keys] The dependencies for the hook
+ * @param {(data: Data) => void} [options.onSuccess] The callback function to be invoked on success
+ * @param {(error: Error) => void} [options.onError] The callback function to be invoked on error
+ * @param {UseQueryOptionsSelect<Data>} [options.select] The select function to be invoked
+ * @param {Data | (() => Data)} [options.initialData] The initial data for the hook
+ * @param {Data | (() => Data)} [options.placeholderData] The placeholder data for the hook
+ * @param {number} [options.refetchInterval] The refetch interval
+ * @param {boolean | number} [options.retry] The retry count of requests
  * @returns {UseQueryReturn<Data>} An object with the state of the query
  *
  * @example
@@ -1259,6 +1407,7 @@ interface UseQueueReturn<Value> {
 /**
  * @name useQueue
  * @description - Hook that manages a queue
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value[]} [initialValue=[]] The initial value of the queue
@@ -1272,6 +1421,7 @@ declare const useQueue: <Value>(initialValue?: Value[]) => UseQueueReturn<Value>
 /**
  * @name useRenderCount
  * @description - Hook returns count component render times
+ * @category Lifecycle
  *
  * @returns {number} A number which determines how many times component renders
  *
@@ -1289,6 +1439,7 @@ interface UseRenderInfoReturn {
 /**
  * @name useRenderInfo
  * @description - Hook for getting information about component rerender
+ * @category Lifecycle
  *
  * @param {string} [name='Unknown'] Component name
  * @param {boolean} [log=true] Toggle logging
@@ -1309,6 +1460,7 @@ interface UseRerenderReturns {
 /**
  * @name useRerender
  * @description - Hook that defines the logic to force rerender a component
+ * @category Lifecycle
  *
  * @returns {UseRerenderReturns} An object containing the id and update function
  *
@@ -1327,6 +1479,7 @@ interface UseScriptOptions extends ComponentProps<'script'> {
 /**
  * @name useScript
  * @description - Hook that manages a script with onLoad, onError, and removeOnUnmount functionalities
+ * @category Browser
  *
  * @param {string} src The source of the script
  * @param {UseScriptOptions} [options] The options of the script extends from attributes script tag
@@ -1342,6 +1495,7 @@ declare const useScript: (src: string, options?: UseScriptOptions) => UseScriptS
 /**
  * @name useSessionStorage
  * @description - Hook that manages session storage value
+ * @category Browser
  *
  * @template Value The type of the value
  * @param {string} key The key of the storage
@@ -1394,6 +1548,7 @@ interface UseSetReturn<Value> {
 /**
  * @name useSet
  * @description - Hook that manages a set structure
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the set
@@ -1418,6 +1573,7 @@ interface UseShareParams {
 /**
  * @name useShare
  * @description - Hook that utilizes the share api
+ * @category Browser
  *
  * @param {UseShareParams} [params] The use share options
  * @returns {UseShareReturn}
@@ -1459,6 +1615,7 @@ interface UseStepReturn {
 /**
  * @name useStep
  * @description - Hook that create stepper
+ * @category Utilities
  *
  * @overload
  * @param {number} max Maximum number of steps
@@ -1491,6 +1648,7 @@ interface UseTextSelectionReturn {
 /**
  * @name useTextSelection
  * @description - Hook that manages the text selection
+ * @category Sensors
  *
  * @returns {UseTextSelectionReturn} An object containing the current text selection
  *
@@ -1515,6 +1673,7 @@ interface UseTimeReturn {
 /**
  * @name useTime
  * @description - Hook that gives you current time in different values
+ * @category Time
  *
  * @returns {UseTimeReturn} An object containing the current time
  *
@@ -1533,6 +1692,7 @@ interface UseTimeoutReturn {
 /**
  * @name useTimeout
  * @description - Hook that executes a callback function after a specified delay
+ * @category Time
  *
  * @param {() => void} callback The function to be executed after the timeout
  * @param {number} delay The delay in milliseconds before the timeout executes the callback function
@@ -1546,6 +1706,7 @@ declare function useTimeout(callback: () => void, delay: number): UseTimeoutRetu
 /**
  * @name useToggle
  * @description - Hook that create toggle
+ * @category Utilities
  *
  * @template Value The type of the value
  * @param {Value[]} [values=[false, true]] The values to toggle
@@ -1561,6 +1722,7 @@ declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonl
 /**
  * @name useUnmount
  * @description - Hook that defines the logic when unmounting a component
+ * @category Lifecycle
  *
  * @param {() => void} callback The callback function to be invoked on component unmount
  * @returns {void}
@@ -1590,6 +1752,7 @@ interface UseWebSocketReturn {
 /**
  * @name useWebSocket
  * @description - Hook that connects to a WebSocket server and handles incoming and outgoing messages
+ * @category Network
  *
  * @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
@@ -1608,6 +1771,7 @@ declare const useWebSocket: (url: UseWebSocketUrl, options?: UseWebSocketOptions
 /**
  * @name useWindowEvent
  * @description - Hook attaches an event listener to the window object for the specified event
+ * @category Browser
  *
  * @template Event Key of window event map.
  * @param {Event} event The event to listen for.
@@ -1630,6 +1794,7 @@ interface UseWindowSizeParams {
 /**
  * @name useWindowSize
  * @description - Hook that manages a window size
+ * @category Browser
  *
  * @param {number} [params.initialWidth=Number.POSITIVE_INFINITY] The initial window width
  * @param {number} [params.initialHeight=Number.POSITIVE_INFINITY] The initial window height
@@ -1643,6 +1808,34 @@ declare const useWindowSize: (params?: UseWindowSizeParams) => {
     height: number;
 };
 
+interface WizardItem<WizardStepId> {
+    id: WizardStepId;
+    nodes?: WizardStepId[];
+}
+/**
+ * @name useWizard
+ * @description - Hook that manages a wizard
+ * @category Utilities
+ *
+ * @param {WizardItem<WizardStepId>[]} map The map of the wizard
+ * @param {WizardStepId} [initialStepId] The initial step id
+ * @returns {UseWizardReturn<WizardStepId>} An object containing the current step id and functions to interact with the wizard
+ *
+ * @example
+ * const { currentStepId, set, reset, back, history } = useWizard([
+ *  { id: 'step1', nodes: ['step2', 'step3'] },
+ *  { id: 'step2', nodes: ['step3'] },
+ *  { id: 'step3', nodes: [] },
+ * ])
+ */
+declare const useWizard: <WizardStepId extends string>(map: WizardItem<WizardStepId>[], initialStepId?: WizardStepId) => {
+    currentStepId: WizardStepId;
+    set: (id: WizardStepId) => void;
+    reset: () => void;
+    back: () => void;
+    history: WizardStepId[];
+};
+
 declare const debounce: <Params extends unknown[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
 declare const getRetry: (retry: number | boolean) => number;
@@ -1665,4 +1858,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useCopyToClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFps, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMediaQuery, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useScript, useSessionStorage, useSet, useShare, useStep, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize };
+export { debounce, getDate, getRetry, isClient, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useCopyToClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFps, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useScript, useSessionStorage, useSet, useShare, useStep, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };