@siberiacancode/reactuse 0.2.24 → 0.2.26

package/dist/types/hooks/useLocalStorage/useLocalStorage.d.ts

@@ -2,7 +2,7 @@ import { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStor
 /**
  * @name useLocalStorage
  * @description - Hook that manages local storage value
- * @category Browser
+ * @category State
  *
  * @browserapi localStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
  *

package/dist/types/hooks/useLockCallback/useLockCallback.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name useLockCallback
  * @description - Hook that prevents a callback from being executed multiple times simultaneously
- * @category Utilities
+ * @category Async
  *
  * @param {Function} callback The callback to be locked
  * @returns {Function} The locked callback

package/dist/types/hooks/useLockScroll/useLockScroll.d.ts

@@ -0,0 +1,49 @@
+import { HookTarget } from '../../utils/helpers';
+import { StateRef } from '../useRefState/useRefState';
+/** The use lock scroll options type */
+export interface UseLockScrollOptions {
+    /** Enable or disable scroll locking. Default: true */
+    enabled?: boolean;
+}
+/** The use lock scroll return type */
+export interface UseLockScrollReturn<Target extends Element> {
+    /** The ref to attach to the element */
+    ref: StateRef<Target>;
+    /** The value of the lock state */
+    value: boolean;
+    /** Lock the scroll */
+    lock: () => void;
+    /** Toggle the scroll lock */
+    toggle: () => void;
+    /** Unlock the scroll */
+    unlock: () => void;
+}
+export interface UseLockScroll {
+    (target: HookTarget, options?: UseLockScrollOptions): UseLockScrollReturn<Element>;
+    <Target extends Element>(options?: UseLockScrollOptions, target?: never): UseLockScrollReturn<Target> & {
+        ref: StateRef<Target>;
+    };
+}
+/**
+ * @name useLockScroll
+ * @description - Hook that locks scroll on an element or document body
+ * @category Elements
+ *
+ *
+ * @overload
+ * @param {HookTarget} [target=document.body] The target element to lock scroll on
+ * @param {UseLockScrollOptions} [options] The options for scroll locking
+ * @returns {void}
+ *
+ * @example
+ * const { lock, unlock, value, toggle } = useLockScroll(ref);
+ *
+ * @overload
+ * @template Target The target element
+ * @param {UseLockScrollOptions} [options] The options for scroll locking
+ * @returns {StateRef<Target>} Ref to attach to element, or locks body scroll by default
+ *
+ * @example
+ * const { ref, lock, unlock, value, toggle } = useLockScroll();
+ */
+export declare const useLockScroll: UseLockScroll;

package/dist/types/hooks/useLogger/useLogger.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name useLogger
  * @description - Hook for debugging lifecycle
- * @category Lifecycle
+ * @category Debug
  *
  * @param {string} name The name or identifier for the logger
  * @param {unknown[]} params Additional arguments to be logged

package/dist/types/hooks/useLongPress/useLongPress.d.ts

@@ -17,7 +17,7 @@ export interface UseLongPress {
 /**
  * @name useLongPress
  * @description - Hook that defines the logic when long pressing an element
- * @category Sensors
+ * @category Elements
  *
  * @overload
  * @param {HookTarget} target The target element to be long pressed

package/dist/types/hooks/useMap/useMap.d.ts

@@ -18,7 +18,7 @@ export interface UseMapReturn<Key, Value> {
 /**
  * @name useMap
  * @description - Hook that manages a map structure
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the map

package/dist/types/hooks/useMutation/useMutation.d.ts

@@ -19,7 +19,7 @@ export interface RequestOptions<Data> extends UseMutationOptions<Data> {
 /**
  * @name useMutation
  * @description - Hook that defines the logic when mutate data
- * @category Utilities
+ * @category Async
  *
  * @template Body The type of the body
  * @template Data The type of the data

package/dist/types/hooks/useMutationObserver/useMutationObserver.d.ts

@@ -23,7 +23,7 @@ export interface UseMutationObserver {
 /**
  * @name useMutationObserver
  * @description - Hook that gives you mutation observer state
- * @category Browser
+ * @category Sensors
  *
  * @overload
  * @template Target The target element

package/dist/types/hooks/useNetwork/useNetwork.d.ts

@@ -39,7 +39,7 @@ export declare const getConnection: () => Connection;
 /**
  * @name useNetwork
  * @description - Hook to track network status
- * @category Sensors
+ * @category Browser
  *
  * @browserapi navigator.connection https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection
  *

package/dist/types/hooks/useOffsetPagination/useOffsetPagination.d.ts

@@ -44,7 +44,7 @@ export interface UseOffsetPaginationReturn {
 /**
  * @name useOffsetPagination
  * @description - Hook that defines the logic when pagination
- * @category Utilities
+ * @category State
  *
  * @param {UseOffsetPaginationOptions} options - The options for the hook
  * @param {number} [options.total] - The total number of items

package/dist/types/hooks/useOnline/useOnline.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name useOnline
  * @description - Hook that manages if the user is online
- * @category Sensors
+ * @category Browser
  *
  * @browserapi navigator.onLine https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
  *

package/dist/types/hooks/useOperatingSystem/useOperatingSystem.d.ts

@@ -4,7 +4,7 @@ export declare const getOperatingSystem: () => OperatingSystem;
 /**
  * @name useOperatingSystem
  * @description - Hook that returns the operating system of the current browser
- * @category Browser
+ * @category User
  *
  * @returns {OperatingSystem} The operating system
  *

package/dist/types/hooks/useOptimistic/useOptimistic.d.ts

@@ -5,7 +5,7 @@ export type UseOptimisticReturn<State> = [
 /**
  * @name useOptimistic
  * @description - Hook that allows get optimistic value before its update
- * @category Utilities
+ * @category Async
  *
  * @template State The type of the state
  * @param {State} state The value to be returned initially and whenever no action is pending

package/dist/types/hooks/useOrientation/useOrientation.d.ts

@@ -1,20 +1,35 @@
-/** The use orientation return type */
-export interface UseOrientationReturn {
-    /** The current screen orientation angle */
+declare global {
+    interface ScreenOrientation {
+        lock: (orientation: OrientationLockType) => Promise<void>;
+    }
+}
+export interface UseOrientationValue {
+    /** The current angle */
     angle: number;
-    /** The screen orientation type */
-    type: OrientationType;
+    /** The current orientation type */
+    orientationType: OrientationType;
+}
+export type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
+export interface useOrientationReturn {
+    /** Whether the screen orientation is supported */
+    supported: boolean;
+    /** The current screen orientation value */
+    value: UseOrientationValue;
+    /** Lock the screen orientation */
+    lock: (orientation: OrientationLockType) => void;
+    /** Unlock the screen orientation */
+    unlock: () => void;
 }
 /**
  * @name useOrientation
- * @description - Hook that returns the current screen orientation
- * @category Browser
+ * @description - Hook that provides the current screen orientation
+ * @category Sensors
  *
- * @browserapi window.screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
+ * @browserapi screen.orientation https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation
  *
- * @returns {UseOrientationReturn} An object containing the current screen orientation
+ * @returns {useOrientationReturn} The current screen orientation
  *
  * @example
- * const { angle, type } = useOrientation();
+ * const { supported, value, lock, unlock } = useOrientation();
  */
-export declare const useOrientation: () => UseOrientationReturn;
+export declare const useOrientation: () => useOrientationReturn;

package/dist/types/hooks/usePaint/usePaint.d.ts

@@ -77,7 +77,7 @@ export interface UsePaint {
 /**
  * @name usePaint
  * @description - Hook that allows you to draw in a specific area
- * @category Browser
+ * @category Elements
  *
  * @overload
  * @param {HookTarget} target The target element to be painted

package/dist/types/hooks/usePointerLock/usePointerLock.d.ts

@@ -13,7 +13,7 @@ interface UsePointerLockReturn {
 /**
  * @name usePointerLock
  * @description - Hook that provides reactive pointer lock
- * @category Sensors
+ * @category Browser
  *
  * @browserapi pointerLockElement https://developer.mozilla.org/en-US/docs/Web/API/Document/pointerLockElement
  *

package/dist/types/hooks/usePreferredColorScheme/usePreferredColorScheme.d.ts

@@ -3,7 +3,7 @@ export type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
 /**
  * @name usePreferredColorScheme
  * @description - Hook that returns user preferred color scheme
- * @category Browser
+ * @category User
  *
  * @returns {UsePreferredColorSchemeReturn} String of preferred color scheme
  *

package/dist/types/hooks/usePreferredContrast/usePreferredContrast.d.ts

@@ -3,7 +3,7 @@ export type UsePreferredContrastReturn = 'custom' | 'less' | 'more' | 'no-prefer
 /**
  * @name usePreferredContrast
  * @description - Hook that returns the contrast preference
- * @category Browser
+ * @category User
  *
  * @returns {UsePreferredContrastReturn} The contrast preference
  *

package/dist/types/hooks/usePreferredDark/usePreferredDark.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name usePreferredDark
  * @description - Hook that returns if the user prefers dark mode
- * @category Browser
+ * @category User
  *
  * @example
  * const isDark = usePreferredDark();

package/dist/types/hooks/usePreferredLanguages/usePreferredLanguages.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name usePreferredLanguages
  * @description Hook that returns a browser preferred languages from navigator
- * @category Browser
+ * @category User
  *
  * @browserapi navigator.languages https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages
  *

package/dist/types/hooks/usePreferredReducedMotion/usePreferredReducedMotion.d.ts

@@ -3,7 +3,7 @@ export type UsePreferredReducedMotionReturn = 'no-preference' | 'reduce';
 /**
  * @name usePreferredReducedMotion
  * @description - Hook that returns the reduced motion preference
- * @category Browser
+ * @category User
  *
  * @returns {UsePreferredReducedMotionReturn} The reduced motion preference
  *

package/dist/types/hooks/useQuery/useQuery.d.ts

@@ -28,7 +28,7 @@ export interface UseQueryReturn<Data> {
 /**
  * @name useQuery
  * @description - Hook that defines the logic when query data
- * @category Utilities
+ * @category Async
  *
  * @template Data The type of the data
  * @param {() => Promise<Data>} callback The callback function to be invoked

package/dist/types/hooks/useQueue/useQueue.d.ts

@@ -18,7 +18,7 @@ export interface UseQueueReturn<Value> {
 /**
  * @name useQueue
  * @description - Hook that manages a queue
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value[]} [initialValue=[]] The initial value of the queue

package/dist/types/hooks/useRaf/useRaf.d.ts

@@ -22,7 +22,7 @@ export interface UseRafReturn {
 /**
  * @name useRaf
  * @description - Hook that defines the logic for raf callback
- * @category Utilities
+ * @category Browser
  *
  * @browserapi requestAnimationFrame https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  *

package/dist/types/hooks/{useRafValue/useRafValue.d.ts → useRafState/useRafState.d.ts}

@@ -1,14 +1,14 @@
-export type UseRafValueReturn<Value> = [Value, (value: Value) => void];
+export type UseRafStateReturn<Value> = [Value, (value: Value) => void];
 /**
- * @name useRafValue
+ * @name useRafState
  * @description - Hook that returns the value and a function to set the value
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value} initialValue The initial value
- * @returns {UseRafValueReturn<Value>} An array containing the value and a function to set the value
+ * @returns {UseRafStateReturn<Value>} An array containing the value and a function to set the value
  *
  * @example
- * const [value, setValue] = useRafValue(initialValue);
+ * const [value, setValue] = useRafState(initialValue);
  */
-export declare const useRafValue: <Value>(initialValue: (() => Value) | Value) => readonly [Value, (value: Value) => void];
+export declare const useRafState: <Value>(initialValue: (() => Value) | Value) => readonly [Value, (value: Value) => void];

package/dist/types/hooks/useRefState/useRefState.d.ts

@@ -6,7 +6,7 @@ export interface StateRef<Value> {
 /**
  * @name useRefState
  * @description - Hook that returns the state reference of the value
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value} [initialValue] The initial value

package/dist/types/hooks/useRenderCount/useRenderCount.d.ts

@@ -1,7 +1,7 @@
 /**
  * @name useRenderCount
  * @description - Hook returns count component render times
- * @category Lifecycle
+ * @category Debug
  *
  * @returns {number} A number which determines how many times component renders
  *

package/dist/types/hooks/useRenderInfo/useRenderInfo.d.ts

@@ -1,13 +1,18 @@
+/** The use render info return type */
 export interface UseRenderInfoReturn {
+    /** The name of the component */
     component: string;
+    /** The number of renders */
     renders: number;
+    /** The time since the last render */
     sinceLast: number;
+    /** The timestamp of the render */
     timestamp: number | null;
 }
 /**
  * @name useRenderInfo
  * @description - Hook for getting information about component rerender
- * @category Lifecycle
+ * @category Debug
  *
  * @param {string} [name='Unknown'] Component name
  * @param {boolean} [log=true] Toggle logging

package/dist/types/hooks/useRerender/useRerender.d.ts

@@ -3,7 +3,7 @@ type UseRerenderReturn = () => void;
 /**
  * @name useRerender
  * @description - Hook that defines the logic to force rerender a component
- * @category Lifecycle
+ * @category Debug
  *
  * @returns {UseRerenderReturn} The rerender function
  *

package/dist/types/hooks/useResizeObserver/useResizeObserver.d.ts

@@ -21,7 +21,7 @@ export interface UseResizeObserver {
 /**
  *  @name useResizeObserver
  *  @description - Hook that gives you resize observer state
- *  @category Browser
+ *  @category Sensors
  *
  *  @browserapi ResizeObserver https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver
  *

package/dist/types/hooks/useRightClick/useRightClick.d.ts

@@ -0,0 +1,37 @@
+import { HookTarget } from '../../utils/helpers';
+import { StateRef } from '../useRefState/useRefState';
+export type RightClickEvent = MouseEvent | TouchEvent;
+export interface RightClickPositions {
+    x: number;
+    y: number;
+}
+export interface UseRightClickOptions {
+    onEnd?: (event: RightClickEvent) => void;
+    onStart?: (event: RightClickEvent) => void;
+}
+export interface UseRightClick {
+    (target: HookTarget, callback: (event: Event) => void, options?: UseRightClickOptions): void;
+    <Target extends Element>(callback: (positions: RightClickPositions, event: Event) => void, options?: UseRightClickOptions, target?: never): StateRef<Target>;
+}
+/**
+ * @name useRightClick
+ * @description - Hook that handles right-click events and long press on mobile devices
+ * @category Elements
+ *
+ * @overload
+ * @param {HookTarget} target The target element for right-click handling
+ * @param {(event: RightClickEvents) => void} callback The callback function to be invoked on right click
+ * @returns {void}
+ *
+ * @example
+ * useRightClick(ref, () => console.log('clicked'));
+ *
+ * @overload
+ * @template Target The target element
+ * @param {(event: RightClickEvents) => void} callback The callback function to be invoked on right click
+ * @returns {StateRef<Target>} Ref to attach to the element
+ *
+ * @example
+ * const ref = useRightClick(() => console.log('clicked'));
+ */
+export declare const useRightClick: UseRightClick;

package/dist/types/hooks/useScript/useScript.d.ts

@@ -10,7 +10,7 @@ export interface UseScriptOptions extends ComponentProps<'script'> {
 /**
  * @name useScript
  * @description - Hook that manages a script with onLoad, onError, and removeOnUnmount functionalities
- * @category Browser
+ * @category Elements
  *
  * @param {string} src The source of the script
  * @param {UseScriptOptions} [options] The options of the script extends from attributes script tag

package/dist/types/hooks/useSessionStorage/useSessionStorage.d.ts

@@ -2,7 +2,7 @@ import { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStor
 /**
  * @name useSessionStorage
  * @description - Hook that manages session storage value
- * @category Browser
+ * @category State
  *
  * @browserapi sessionStorage https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
  *

package/dist/types/hooks/useSet/useSet.d.ts

@@ -28,7 +28,7 @@ interface UseSetReturn<Value> {
 /**
  * @name useSet
  * @description - Hook that manages a set structure
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the set

package/dist/types/hooks/useSpeechRecognition/useSpeechRecognition.d.ts

@@ -47,7 +47,7 @@ export declare const getSpeechRecognition: () => {
 /**
  * @name useSpeechRecognition
  * @description - Hook that provides a streamlined interface for incorporating speech-to-text functionality
- * @category Sensors
+ * @category Browser
  *
  * @browserapi window.SpeechRecognition https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition
  *

package/dist/types/hooks/useSpeechSynthesis/useSpeechSynthesis.d.ts

@@ -41,7 +41,7 @@ export interface UseSpeechSynthesisReturn {
 /**
  * @name useSpeechSynthesis
  * @description - Hook that provides speech synthesis functionality
- * @category Sensors
+ * @category Browser
  *
  * @browserapi SpeechSynthesis https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis
  *

package/dist/types/hooks/useStateHistory/useStateHistory.d.ts

@@ -60,7 +60,7 @@ export declare const stateHistoryReducer: <Value>(state: StateHistory<Value>, ac
 /**
  * @name useStateHistory
  * @description - Hook that manages state with history functionality
- * @category Utilities
+ * @category State
  *
  * @param {Value} initialValue - The initial value to start the history with
  * @param {number} [capacity=10] - Maximum number of history entries and undo actions to keep

package/dist/types/hooks/useStep/useStep.d.ts

@@ -27,7 +27,7 @@ export interface UseStepReturn {
 /**
  * @name useStep
  * @description - Hook that create stepper
- * @category Utilities
+ * @category State
  *
  * @overload
  * @param {number} max Maximum number of steps

package/dist/types/hooks/useSticky/useSticky.d.ts

@@ -20,7 +20,7 @@ export interface UseSticky {
 /**
  * @name UseSticky
  * @description - Hook that allows you to detect that your sticky component is stuck
- * @category Browser
+ * @category Elements
  *
  * @overload
  * @param {HookTarget} target The target sticky element

package/dist/types/hooks/useStopwatch/useStopwatch.d.ts

@@ -25,8 +25,8 @@ export interface UseStopwatchReturn {
 }
 /** The use stopwatch options */
 export interface UseStopwatchOptions {
-    /** The enabled state of the timer */
-    enabled?: boolean;
+    /** The immediately state of the timer */
+    immediately?: boolean;
 }
 interface UseStopwatch {
     (initialTime?: number, options?: UseStopwatchOptions): UseStopwatchReturn;

package/dist/types/hooks/useStorage/useStorage.d.ts

@@ -19,7 +19,7 @@ export declare const dispatchStorageEvent: (params: Partial<StorageEvent>) => bo
 /**
  * @name useStorage
  * @description - Hook that manages storage value
- * @category Browser
+ * @category State
  *
  * @overload
  * @param {string} key The key of the storage

package/dist/types/hooks/useTextDirection/useTextDirection.d.ts

@@ -20,10 +20,10 @@ export interface UseTextDirection {
 /**
  * @name useTextDirection
  * @description - Hook that can get and set the direction of the element
- * @category Browser
+ * @category Elements
  *
  * @overload
- * @param {HookTarget} target The target element to observe
+ * @param {HookTarget} [target=document.querySelector('html')] The target element to observe
  * @param {UseTextDirectionValue} [initialValue = 'ltr'] The initial direction of the element
  * @returns {UseTextDirectionReturn} An object containing the current text direction of the element
  *

package/dist/types/hooks/useToggle/useToggle.d.ts

@@ -4,7 +4,7 @@ export type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
 /**
  * @name useToggle
  * @description - Hook that create toggle
- * @category Utilities
+ * @category State
  *
  * @template Value The type of the value
  * @param {Value[]} [values=[false, true]] The values to toggle

package/dist/types/hooks/useUrlSearchParam/useUrlSearchParam.d.ts

@@ -42,7 +42,7 @@ export interface UseUrlSearchParam {
 /**
  * @name useUrlSearchParam
  * @description - Hook that provides reactive URLSearchParams for a single key
- * @category Browser
+ * @category State
  *
  * @overload
  * @template Value The type of the url param values

package/dist/types/hooks/useUrlSearchParams/useUrlSearchParams.d.ts

@@ -37,7 +37,7 @@ export interface UseUrlSearchParams {
 /**
  * @name useUrlSearchParams
  * @description - Hook that provides reactive URLSearchParams
- * @category Browser
+ * @category State
  *
  * @overload
  * @template Value The type of the url param values

package/dist/types/hooks/useWindowEvent/useWindowEvent.d.ts

@@ -2,7 +2,7 @@ import { UseEventListenerOptions } from '../useEventListener/useEventListener';
 /**
  * @name useWindowEvent
  * @description - Hook attaches an event listener to the window object for the specified event
- * @category Events
+ * @category Sensors
  *
  * @template Event Key of window event map.
  * @param {Event} event The event to listen for.

package/dist/types/hooks/useWizard/useWizard.d.ts

@@ -5,7 +5,7 @@ export interface WizardItem<WizardStepId> {
 /**
  * @name useWizard
  * @description - Hook that manages a wizard
- * @category Utilities
+ * @category State
  *
  * @param {WizardItem<WizardStepId>[]} map The map of the wizard
  * @param {WizardStepId} [initialStepId] The initial step id

package/dist/types/hooks/user.d.ts

@@ -0,0 +1,7 @@
+export * from './useBrowserLanguage/useBrowserLanguage';
+export * from './useOperatingSystem/useOperatingSystem';
+export * from './usePreferredColorScheme/usePreferredColorScheme';
+export * from './usePreferredContrast/usePreferredContrast';
+export * from './usePreferredDark/usePreferredDark';
+export * from './usePreferredLanguages/usePreferredLanguages';
+export * from './usePreferredReducedMotion/usePreferredReducedMotion';

package/dist/types/hooks/utilities.d.ts

@@ -0,0 +1,9 @@
+export * from './useConst/useConst';
+export * from './useDebounceCallback/useDebounceCallback';
+export * from './useDebounceValue/useDebounceValue';
+export * from './useEvent/useEvent';
+export * from './useLastChanged/useLastChanged';
+export * from './useLatest/useLatest';
+export * from './usePrevious/usePrevious';
+export * from './useThrottleCallback/useThrottleCallback';
+export * from './useThrottleValue/useThrottleValue';

package/dist/types/utils/helpers/getElement.d.ts

@@ -9,4 +9,4 @@ export declare const target: (target: Target) => {
     value: Target;
     type: symbol;
 };
-export declare const getElement: (target: HookTarget) => Element | Window | Document | null | undefined;
+export declare const getElement: (target: HookTarget) => Window | Document | Element | null | undefined;