@mantine/hooks 8.0.2 → 8.1.0

package/lib/use-event-listener/use-event-listener.d.ts

@@ -1 +1 @@
-export declare function useEventListener<K extends keyof HTMLElementEventMap, T extends HTMLElement = any>(type: K, listener: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): import("react").RefObject<T | null>;
+export declare function useEventListener<K extends keyof HTMLElementEventMap, T extends HTMLElement = any>(type: K, listener: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): React.RefCallback<T | null>;

package/lib/use-eye-dropper/use-eye-dropper.d.ts

@@ -1,11 +1,11 @@
-interface EyeDropperOpenOptions {
+export interface EyeDropperOpenOptions {
     signal?: AbortSignal;
 }
 export interface EyeDropperOpenReturnType {
     sRGBHex: string;
 }
-export declare function useEyeDropper(): {
+export interface UseEyeDropperReturnValue {
     supported: boolean;
     open: (options?: EyeDropperOpenOptions) => Promise<EyeDropperOpenReturnType | undefined>;
-};
-export {};
+}
+export declare function useEyeDropper(): UseEyeDropperReturnValue;

package/lib/use-fetch/use-fetch.d.ts

@@ -1,10 +1,11 @@
 export interface UseFetchOptions extends RequestInit {
     autoInvoke?: boolean;
 }
-export declare function useFetch<T>(url: string, { autoInvoke, ...options }?: UseFetchOptions): {
+export interface UseFetchReturnValue<T> {
     data: T | null;
     loading: boolean;
     error: Error | null;
-    refetch: () => Promise<any> | undefined;
+    refetch: () => Promise<any>;
     abort: () => void;
-};
+}
+export declare function useFetch<T>(url: string, { autoInvoke, ...options }?: UseFetchOptions): UseFetchReturnValue<T>;

package/lib/use-file-dialog/use-file-dialog.d.ts

@@ -16,8 +16,9 @@ export interface UseFileDialogOptions {
     /** Called when file dialog is canceled */
     onCancel?: () => void;
 }
-export declare function useFileDialog(input?: UseFileDialogOptions): {
+export interface UseFileDialogReturnValue {
     files: FileList | null;
     open: () => void;
     reset: () => void;
-};
+}
+export declare function useFileDialog(input?: UseFileDialogOptions): UseFileDialogReturnValue;

package/lib/use-focus-return/use-focus-return.d.ts

@@ -1,7 +1,6 @@
-interface UseFocusReturn {
+export interface UseFocusReturnOptions {
     opened: boolean;
     shouldReturnFocus?: boolean;
 }
-/** Returns focus to last active element, used in Modal and Drawer */
-export declare function useFocusReturn({ opened, shouldReturnFocus }: UseFocusReturn): () => void;
-export {};
+export type UseFocusReturnReturnValue = () => void;
+export declare function useFocusReturn({ opened, shouldReturnFocus, }: UseFocusReturnOptions): UseFocusReturnReturnValue;

package/lib/use-focus-trap/use-focus-trap.d.ts

@@ -1 +1 @@
-export declare function useFocusTrap(active?: boolean): (instance: HTMLElement | null) => void;
+export declare function useFocusTrap(active?: boolean): React.RefCallback<HTMLElement | null>;

package/lib/use-focus-within/use-focus-within.d.ts

@@ -2,7 +2,8 @@ export interface UseFocusWithinOptions {
     onFocus?: (event: FocusEvent) => void;
     onBlur?: (event: FocusEvent) => void;
 }
-export declare function useFocusWithin<T extends HTMLElement = any>({ onBlur, onFocus, }?: UseFocusWithinOptions): {
-    ref: React.RefObject<T>;
+export interface UseFocusWithinReturnValue<T extends HTMLElement = any> {
+    ref: React.RefCallback<T | null>;
     focused: boolean;
-};
+}
+export declare function useFocusWithin<T extends HTMLElement = any>({ onBlur, onFocus, }?: UseFocusWithinOptions): UseFocusWithinReturnValue<T>;

package/lib/use-fullscreen/use-fullscreen.d.ts

@@ -1,5 +1,6 @@
-export declare function useFullscreen<T extends HTMLElement = any>(): {
-    readonly ref: (element: T | null) => void;
-    readonly toggle: () => Promise<void>;
-    readonly fullscreen: boolean;
-};
+export interface UseFullscreenReturnValue<T extends HTMLElement = any> {
+    ref: React.RefCallback<T | null>;
+    toggle: () => Promise<void>;
+    fullscreen: boolean;
+}
+export declare function useFullscreen<T extends HTMLElement = any>(): UseFullscreenReturnValue<T>;

package/lib/use-hash/use-hash.d.ts

@@ -1,5 +1,5 @@
-interface UseHashOptions {
+export interface UseHashOptions {
     getInitialValueInEffect?: boolean;
 }
-export declare function useHash({ getInitialValueInEffect }?: UseHashOptions): readonly [string, (value: string) => void];
-export {};
+export type UseHashReturnValue = [string, (value: string) => void];
+export declare function useHash({ getInitialValueInEffect, }?: UseHashOptions): UseHashReturnValue;

package/lib/use-headroom/use-headroom.d.ts

@@ -1,9 +1,9 @@
 export declare const isFixed: (current: number, fixedAt: number) => boolean;
 export declare const isPinned: (current: number, previous: number) => boolean;
 export declare const isReleased: (current: number, previous: number, fixedAt: number) => boolean;
-export declare const isPinnedOrReleased: (current: number, fixedAt: number, isCurrentlyPinnedRef: React.MutableRefObject<boolean>, isScrollingUp: boolean, onPin?: () => void, onRelease?: () => void) => void;
+export declare const isPinnedOrReleased: (current: number, fixedAt: number, isCurrentlyPinnedRef: React.RefObject<boolean>, isScrollingUp: boolean, onPin?: () => void, onRelease?: () => void) => void;
 export declare const useScrollDirection: () => boolean;
-interface UseHeadroomInput {
+export interface UseHeadroomOptions {
     /** Number in px at which element should be fixed */
     fixedAt?: number;
     /** Called when element is pinned */
@@ -13,5 +13,4 @@ interface UseHeadroomInput {
     /** Called when element is unpinned */
     onRelease?: () => void;
 }
-export declare function useHeadroom({ fixedAt, onPin, onFix, onRelease }?: UseHeadroomInput): boolean;
-export {};
+export declare function useHeadroom({ fixedAt, onPin, onFix, onRelease }?: UseHeadroomOptions): boolean;

package/lib/use-hover/use-hover.d.ts

@@ -1,4 +1,5 @@
-export declare function useHover<T extends HTMLElement = any>(): {
-    ref: import("react").RefObject<T | null>;
+export interface UseHoverReturnValue<T extends HTMLElement = any> {
     hovered: boolean;
-};
+    ref: React.RefCallback<T | null>;
+}
+export declare function useHover<T extends HTMLElement = any>(): UseHoverReturnValue<T>;

package/lib/use-idle/use-idle.d.ts

@@ -1,4 +1,5 @@
-export declare function useIdle(timeout: number, options?: Partial<{
-    events: (keyof DocumentEventMap)[];
-    initialState: boolean;
-}>): boolean;
+export interface UseIdleOptions {
+    events?: (keyof DocumentEventMap)[];
+    initialState?: boolean;
+}
+export declare function useIdle(timeout: number, options?: UseIdleOptions): boolean;

package/lib/use-in-viewport/use-in-viewport.d.ts

@@ -1,4 +1,5 @@
-export declare function useInViewport<T extends HTMLElement = any>(): {
-    ref: (node: T | null) => void;
+export interface UseInViewportReturnValue<T extends HTMLElement = any> {
     inViewport: boolean;
-};
+    ref: React.RefCallback<T | null>;
+}
+export declare function useInViewport<T extends HTMLElement = any>(): UseInViewportReturnValue<T>;

package/lib/use-input-state/use-input-state.d.ts

@@ -1,2 +1,6 @@
 export declare function getInputOnChange<T>(setValue: (value: null | undefined | T | ((current: T) => T)) => void): (val: null | undefined | T | React.ChangeEvent<any> | ((current: T) => T)) => void;
-export declare function useInputState<T>(initialState: T): [T, (value: null | undefined | T | React.ChangeEvent<any>) => void];
+export type UseInputStateReturnValue<T> = [
+    T,
+    (value: null | undefined | T | React.ChangeEvent<any>) => void
+];
+export declare function useInputState<T>(initialState: T): UseInputStateReturnValue<T>;

package/lib/use-intersection/use-intersection.d.ts

@@ -1,4 +1,5 @@
-export declare function useIntersection<T extends HTMLElement = any>(options?: ConstructorParameters<typeof IntersectionObserver>[1]): {
-    ref: (element: T | null) => void;
+export interface UseIntersectionReturnValue<T> {
+    ref: React.RefCallback<T | null>;
     entry: IntersectionObserverEntry | null;
-};
+}
+export declare function useIntersection<T extends HTMLElement = any>(options?: IntersectionObserverInit): UseIntersectionReturnValue<T>;

package/lib/use-interval/use-interval.d.ts

@@ -1,11 +1,15 @@
-interface UseIntervalOptions {
+export interface UseIntervalOptions {
     /** If set, the interval will start automatically when the component is mounted, `false` by default */
     autoInvoke?: boolean;
 }
-export declare function useInterval(fn: () => void, interval: number, { autoInvoke }?: UseIntervalOptions): {
+export interface UseIntervalReturnValue {
+    /** Starts the interval */
     start: () => void;
+    /** Stops the interval */
     stop: () => void;
+    /** Toggles the interval */
     toggle: () => void;
+    /** Indicates if the interval is active */
     active: boolean;
-};
-export {};
+}
+export declare function useInterval(fn: () => void, interval: number, { autoInvoke }?: UseIntervalOptions): UseIntervalReturnValue;

package/lib/use-list-state/use-list-state.d.ts

@@ -20,5 +20,5 @@ export interface UseListStateHandlers<T> {
     setItemProp: <K extends keyof T, U extends T[K]>(index: number, prop: K, value: U) => void;
     filter: (fn: (item: T, i: number) => boolean) => void;
 }
-export type UseListState<T> = [T[], UseListStateHandlers<T>];
-export declare function useListState<T>(initialValue?: T[]): UseListState<T>;
+export type UseListStateReturnValue<T> = [T[], UseListStateHandlers<T>];
+export declare function useListState<T>(initialValue?: T[]): UseListStateReturnValue<T>;

package/lib/use-local-storage/create-storage.d.ts

@@ -1,5 +1,5 @@
 export type StorageType = 'localStorage' | 'sessionStorage';
-export interface StorageProperties<T> {
+export interface UseStorageOptions<T> {
     /** Storage key */
     key: string;
     /** Default value that will be set if value is not found in storage */
@@ -13,5 +13,10 @@ export interface StorageProperties<T> {
     /** Function to deserialize string value from storage to value */
     deserialize?: (value: string | undefined) => T;
 }
-export declare function createStorage<T>(type: StorageType, hookName: string): ({ key, defaultValue, getInitialValueInEffect, sync, deserialize, serialize, }: StorageProperties<T>) => [T, (val: T | ((prevState: T) => T)) => void, () => void];
-export declare function readValue(type: StorageType): <T>({ key, defaultValue, deserialize, }: StorageProperties<T>) => T;
+export type UseStorageReturnValue<T> = [
+    T,
+    (val: T | ((prevState: T) => T)) => void,
+    () => void
+];
+export declare function createStorage<T>(type: StorageType, hookName: string): ({ key, defaultValue, getInitialValueInEffect, sync, deserialize, serialize, }: UseStorageOptions<T>) => UseStorageReturnValue<T>;
+export declare function readValue(type: StorageType): <T>({ key, defaultValue, deserialize, }: UseStorageOptions<T>) => T;

package/lib/use-local-storage/use-local-storage.d.ts

@@ -1,3 +1,3 @@
-import { StorageProperties } from './create-storage';
-export declare function useLocalStorage<T = string>(props: StorageProperties<T>): [T, (val: T | ((prevState: T) => T)) => void, () => void];
-export declare const readLocalStorageValue: <T>({ key, defaultValue, deserialize, }: StorageProperties<T>) => T;
+import { UseStorageOptions } from './create-storage';
+export declare function useLocalStorage<T = string>(props: UseStorageOptions<T>): import("./create-storage").UseStorageReturnValue<T>;
+export declare const readLocalStorageValue: <T>({ key, defaultValue, deserialize, }: UseStorageOptions<T>) => T;

package/lib/use-long-press/use-long-press.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+export interface UseLongPressOptions {
+    /** Time in milliseconds to trigger the long press, default is 400ms */
+    threshold?: number;
+    /** Callback triggered when the long press starts */
+    onStart?: (event: React.MouseEvent | React.TouchEvent) => void;
+    /** Callback triggered when the long press finishes */
+    onFinish?: (event: React.MouseEvent | React.TouchEvent) => void;
+    /** Callback triggered when the long press is canceled */
+    onCancel?: (event: React.MouseEvent | React.TouchEvent) => void;
+}
+export interface UseLongPressReturnValue {
+    onMouseDown: (event: React.MouseEvent) => void;
+    onMouseUp: (event: React.MouseEvent) => void;
+    onMouseLeave: (event: React.MouseEvent) => void;
+    onTouchStart: (event: React.TouchEvent) => void;
+    onTouchEnd: (event: React.TouchEvent) => void;
+}
+export declare function useLongPress(onLongPress: (event: React.MouseEvent | React.TouchEvent) => void, options?: UseLongPressOptions): UseLongPressReturnValue;

package/lib/use-media-query/use-media-query.d.ts

@@ -1,4 +1,4 @@
 export interface UseMediaQueryOptions {
     getInitialValueInEffect: boolean;
 }
-export declare function useMediaQuery(query: string, initialValue?: boolean, { getInitialValueInEffect }?: UseMediaQueryOptions): boolean | undefined;
+export declare function useMediaQuery(query: string, initialValue?: boolean, { getInitialValueInEffect }?: UseMediaQueryOptions): boolean;

package/lib/use-merged-ref/use-merged-ref.d.ts

@@ -2,6 +2,6 @@ import { Ref, type RefCallback } from 'react';
 type PossibleRef<T> = Ref<T> | undefined;
 type RefCleanup<T> = ReturnType<RefCallback<T>>;
 export declare function assignRef<T>(ref: PossibleRef<T>, value: T): RefCleanup<T>;
-export declare function mergeRefs<T>(...refs: PossibleRef<T>[]): (node: T | null) => (() => void) | undefined;
-export declare function useMergedRef<T>(...refs: PossibleRef<T>[]): (node: T | null) => (() => void) | undefined;
+export declare function mergeRefs<T>(...refs: PossibleRef<T>[]): RefCallback<T>;
+export declare function useMergedRef<T>(...refs: PossibleRef<T>[]): RefCallback<T>;
 export {};

package/lib/use-move/use-move.d.ts

@@ -6,12 +6,12 @@ export declare function clampUseMovePosition(position: UseMovePosition): {
     x: number;
     y: number;
 };
-interface useMoveHandlers {
+export interface UseMoveHandlers {
     onScrubStart?: () => void;
     onScrubEnd?: () => void;
 }
-export declare function useMove<T extends HTMLElement = any>(onChange: (value: UseMovePosition) => void, handlers?: useMoveHandlers, dir?: 'ltr' | 'rtl'): {
-    ref: import("react").RefObject<T | null>;
+export interface UseMoveReturnValue<T extends HTMLElement = any> {
+    ref: React.RefCallback<T | null>;
     active: boolean;
-};
-export {};
+}
+export declare function useMove<T extends HTMLElement = any>(onChange: (value: UseMovePosition) => void, handlers?: UseMoveHandlers, dir?: 'ltr' | 'rtl'): UseMoveReturnValue<T>;

package/lib/use-network/use-network.d.ts

@@ -1,4 +1,5 @@
-interface NetworkStatus {
+export interface UserNetworkReturnValue {
+    online: boolean;
     downlink?: number;
     downlinkMax?: number;
     effectiveType?: 'slow-2g' | '2g' | '3g' | '4g';
@@ -6,7 +7,4 @@ interface NetworkStatus {
     saveData?: boolean;
     type?: 'bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'none' | 'other' | 'unknown';
 }
-export declare function useNetwork(): {
-    online: boolean;
-} & NetworkStatus;
-export {};
+export declare function useNetwork(): UserNetworkReturnValue;

package/lib/use-orientation/use-orientation.d.ts

@@ -1,4 +1,4 @@
-interface UseOrientationOptions {
+export interface UseOrientationOptions {
     /** Default angle value, used until the real can be retrieved
      * (during server side rendering and before js executes on the page)
      * If not provided, the default value is `0`
@@ -15,9 +15,8 @@ interface UseOrientationOptions {
      */
     getInitialValueInEffect?: boolean;
 }
-interface UseOrientationReturnType {
+export interface UseOrientationReturnType {
     angle: number;
     type: OrientationType;
 }
 export declare function useOrientation({ defaultAngle, defaultType, getInitialValueInEffect, }?: UseOrientationOptions): UseOrientationReturnType;
-export {};

package/lib/use-os/use-os.d.ts

@@ -1,6 +1,5 @@
-export type OS = 'undetermined' | 'macos' | 'ios' | 'windows' | 'android' | 'linux' | 'chromeos';
-interface UseOsOptions {
+export type UseOSReturnValue = 'undetermined' | 'macos' | 'ios' | 'windows' | 'android' | 'linux' | 'chromeos';
+export interface UseOsOptions {
     getValueInEffect: boolean;
 }
-export declare function useOs(options?: UseOsOptions): OS;
-export {};
+export declare function useOs(options?: UseOsOptions): UseOSReturnValue;

package/lib/use-pagination/use-pagination.d.ts

@@ -1,5 +1,5 @@
 export declare const DOTS = "dots";
-export interface PaginationParams {
+export interface UsePaginationOptions {
     /** Page selected on initial render, defaults to 1 */
     initialPage?: number;
     /** Controlled active page number */
@@ -13,12 +13,20 @@ export interface PaginationParams {
     /** Callback fired after change of each page */
     onChange?: (page: number) => void;
 }
-export declare function usePagination({ total, siblings, boundaries, page, initialPage, onChange, }: PaginationParams): {
-    range: (number | "dots")[];
+export interface UsePaginationReturnValue {
+    /** Array of page numbers and dots */
+    range: (number | 'dots')[];
+    /** Active page number */
     active: number;
-    setPage: (pageNumber: number) => void;
+    /** Function to set active page */
+    setPage: (page: number) => void;
+    /** Function to go to next page */
     next: () => void;
+    /** Function to go to previous page */
     previous: () => void;
+    /** Function to go to first page */
     first: () => void;
+    /** Function to go to last page */
     last: () => void;
-};
+}
+export declare function usePagination({ total, siblings, boundaries, page, initialPage, onChange, }: UsePaginationOptions): UsePaginationReturnValue;

package/lib/use-queue/use-queue.d.ts

@@ -1,10 +1,19 @@
-export declare function useQueue<T>({ initialValues, limit }: {
+export interface UseQueueOptions<T> {
+    /** Initial values to be added to the queue */
     initialValues?: T[];
+    /** Maximum number of items in the state */
     limit: number;
-}): {
-    state: T[];
+}
+export interface UseQueueReturnValue<T> {
+    /** Array of items in the queue */
     queue: T[];
+    /** Array of items in the state */
+    state: T[];
+    /** Function to add items to state or queue */
     add: (...items: T[]) => void;
+    /** Function to apply updates to current items */
     update: (fn: (state: T[]) => T[]) => void;
+    /** Function to clear the queue */
     cleanQueue: () => void;
-};
+}
+export declare function useQueue<T>({ initialValues, limit, }: UseQueueOptions<T>): UseQueueReturnValue<T>;

package/lib/use-radial-move/use-radial-move.d.ts

@@ -9,7 +9,10 @@ export interface UseRadialMoveOptions {
     /** Called in `onMouseUp` and `onTouchEnd` events */
     onScrubEnd?: () => void;
 }
-export declare function useRadialMove<T extends HTMLElement = any>(onChange: (value: number) => void, { step, onChangeEnd, onScrubStart, onScrubEnd }?: UseRadialMoveOptions): {
-    ref: import("react").RefObject<T | null>;
+export interface UseRadialMoveReturnValue<T extends HTMLElement = any> {
+    /** Ref to be passed to the element that should be used for radial move */
+    ref: React.RefCallback<T | null>;
+    /** Indicates whether the radial move is active */
     active: boolean;
-};
+}
+export declare function useRadialMove<T extends HTMLElement = any>(onChange: (value: number) => void, { step, onChangeEnd, onScrubStart, onScrubEnd }?: UseRadialMoveOptions): UseRadialMoveReturnValue<T>;

package/lib/use-reduced-motion/use-reduced-motion.d.ts

@@ -1,2 +1,2 @@
 import { UseMediaQueryOptions } from '../use-media-query/use-media-query';
-export declare function useReducedMotion(initialValue?: boolean, options?: UseMediaQueryOptions): boolean | undefined;
+export declare function useReducedMotion(initialValue?: boolean, options?: UseMediaQueryOptions): boolean;

package/lib/use-scroll-into-view/use-scroll-into-view.d.ts

@@ -1,8 +1,8 @@
-interface ScrollIntoViewAnimation {
+interface UseScrollIntoViewAnimation {
     /** Target element alignment relatively to parent based on current axis */
     alignment?: 'start' | 'end' | 'center';
 }
-interface ScrollIntoViewParams {
+export interface UseScrollIntoViewOptions {
     /** Callback fired after scroll */
     onScrollFinish?: () => void;
     /** Duration of scroll in milliseconds */
@@ -18,11 +18,11 @@ interface ScrollIntoViewParams {
     /** Prevents content jumping in scrolling lists with multiple targets */
     isList?: boolean;
 }
-interface ScrollIntoViewReturnType<Target extends HTMLElement = any, Parent extends HTMLElement | null = null> {
-    scrollableRef: React.RefObject<Parent>;
-    targetRef: React.RefObject<Target>;
-    scrollIntoView: (params?: ScrollIntoViewAnimation) => void;
+export interface UseScrollIntoViewReturnValue<Target extends HTMLElement = any, Parent extends HTMLElement | null = null> {
+    scrollableRef: React.RefObject<Parent | null>;
+    targetRef: React.RefObject<Target | null>;
+    scrollIntoView: (params?: UseScrollIntoViewAnimation) => void;
     cancel: () => void;
 }
-export declare function useScrollIntoView<Target extends HTMLElement = any, Parent extends HTMLElement | null = null>({ duration, axis, onScrollFinish, easing, offset, cancelable, isList, }?: ScrollIntoViewParams): ScrollIntoViewReturnType<Target, Parent>;
+export declare function useScrollIntoView<Target extends HTMLElement = any, Parent extends HTMLElement | null = null>({ duration, axis, onScrollFinish, easing, offset, cancelable, isList, }?: UseScrollIntoViewOptions): UseScrollIntoViewReturnValue<Target, Parent>;
 export {};

package/lib/use-session-storage/use-session-storage.d.ts

@@ -1,3 +1,3 @@
-import { StorageProperties } from '../use-local-storage/create-storage';
-export declare function useSessionStorage<T = string>(props: StorageProperties<T>): [T, (val: T | ((prevState: T) => T)) => void, () => void];
-export declare const readSessionStorageValue: <T>({ key, defaultValue, deserialize, }: StorageProperties<T>) => T;
+import { UseStorageOptions } from '../use-local-storage/create-storage';
+export declare function useSessionStorage<T = string>(props: UseStorageOptions<T>): import("../use-local-storage/create-storage").UseStorageReturnValue<T>;
+export declare const readSessionStorageValue: <T>({ key, defaultValue, deserialize, }: UseStorageOptions<T>) => T;

package/lib/use-set-state/use-set-state.d.ts

@@ -1 +1,3 @@
-export declare function useSetState<T extends Record<string, any>>(initialState: T): readonly [T, (statePartial: Partial<T> | ((currentState: T) => Partial<T>)) => void];
+export type UseSetStateCallback<T> = (state: Partial<T> | ((currentState: T) => Partial<T>)) => void;
+export type UseSetStateReturnValue<T> = [T, UseSetStateCallback<T>];
+export declare function useSetState<T extends Record<string, any>>(initialState: T): UseSetStateReturnValue<T>;

package/lib/use-state-history/use-state-history.d.ts

@@ -4,8 +4,13 @@ export interface UseStateHistoryHandlers<T> {
     forward: (steps?: number) => void;
     reset: () => void;
 }
-export interface StateHistory<T> {
+export interface UseStateHistoryValue<T> {
     history: T[];
     current: number;
 }
-export declare function useStateHistory<T>(initialValue: T): [T, UseStateHistoryHandlers<T>, StateHistory<T>];
+export type UseStateHistoryReturnValue<T> = [
+    T,
+    UseStateHistoryHandlers<T>,
+    UseStateHistoryValue<T>
+];
+export declare function useStateHistory<T>(initialValue: T): UseStateHistoryReturnValue<T>;

package/lib/use-timeout/use-timeout.d.ts

@@ -1,6 +1,8 @@
-export declare function useTimeout(callback: (...callbackParams: any[]) => void, delay: number, options?: {
+export interface UseTimeoutOptions {
     autoInvoke: boolean;
-}): {
-    start: (...callbackParams: any[]) => void;
+}
+export interface UseTimeoutReturnValue {
+    start: (...args: any[]) => void;
     clear: () => void;
-};
+}
+export declare function useTimeout(callback: (...args: any[]) => void, delay: number, options?: UseTimeoutOptions): UseTimeoutReturnValue;

package/lib/use-toggle/use-toggle.d.ts

@@ -1 +1,4 @@
-export declare function useToggle<T = boolean>(options?: readonly T[]): readonly [T, (value?: React.SetStateAction<T>) => void];
+type UseToggleAction<T> = (value?: React.SetStateAction<T>) => void;
+export type UseToggleReturnValue<T> = [T, UseToggleAction<T>];
+export declare function useToggle<T = boolean>(options?: readonly T[]): UseToggleReturnValue<T>;
+export {};

package/lib/use-uncontrolled/use-uncontrolled.d.ts

@@ -1,4 +1,4 @@
-interface UseUncontrolledInput<T> {
+export interface UseUncontrolledOptions<T> {
     /** Value for controlled state */
     value?: T;
     /** Initial value for uncontrolled state */
@@ -8,5 +8,12 @@ interface UseUncontrolledInput<T> {
     /** Controlled state onChange handler */
     onChange?: (value: T, ...payload: any[]) => void;
 }
-export declare function useUncontrolled<T>({ value, defaultValue, finalValue, onChange, }: UseUncontrolledInput<T>): [T, (value: T, ...payload: any[]) => void, boolean];
-export {};
+export type UseUncontrolledReturnValue<T> = [
+    /** Current value */
+    T,
+    /** Handler to update the state, passes `value` and `payload` to `onChange` */
+    (value: T, ...payload: any[]) => void,
+    /** True if the state is controlled, false if uncontrolled */
+    boolean
+];
+export declare function useUncontrolled<T>({ value, defaultValue, finalValue, onChange, }: UseUncontrolledOptions<T>): UseUncontrolledReturnValue<T>;

package/lib/use-validated-state/use-validated-state.d.ts

@@ -1,5 +1,15 @@
-export declare function useValidatedState<T>(initialValue: T, validation: (value: T) => boolean, initialValidationState?: boolean): readonly [{
-    readonly value: T;
-    readonly lastValidValue: T | undefined;
-    readonly valid: boolean;
-}, (val: T) => void];
+export interface UseValidatedStateValue<T> {
+    /** Current value */
+    value: T;
+    /** Last valid value */
+    lastValidValue: T | undefined;
+    /** True if the current value is valid, false otherwise */
+    valid: boolean;
+}
+export type UseValidatedStateReturnValue<T> = [
+    /** Current value */
+    UseValidatedStateValue<T>,
+    /** Handler to update the state, passes `value` and `payload` to `onChange` */
+    (value: T) => void
+];
+export declare function useValidatedState<T>(initialValue: T, validate: (value: T) => boolean, initialValidationState?: boolean): UseValidatedStateReturnValue<T>;

package/lib/use-window-scroll/use-window-scroll.d.ts

@@ -1,7 +1,7 @@
-interface ScrollPosition {
+export interface UseWindowScrollPosition {
     x: number;
     y: number;
 }
-declare function scrollTo({ x, y }: Partial<ScrollPosition>): void;
-export declare function useWindowScroll(): readonly [ScrollPosition, typeof scrollTo];
-export {};
+export type UseWindowScrollTo = (position: Partial<UseWindowScrollPosition>) => void;
+export type UseWindowScrollReturnValue = [UseWindowScrollPosition, UseWindowScrollTo];
+export declare function useWindowScroll(): UseWindowScrollReturnValue;

package/lib/utils/index.d.ts

@@ -4,3 +4,4 @@ export { randomId } from './random-id/random-id';
 export { range } from './range/range';
 export { shallowEqual } from './shallow-equal/shallow-equal';
 export { upperFirst } from './upper-first/upper-first';
+export { useCallbackRef } from './use-callback-ref/use-callback-ref';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mantine/hooks",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "A collection of 50+ hooks for state and UI management",
   "homepage": "https://mantine.dev",
   "license": "MIT",

package/cjs/use-callback-ref/use-callback-ref.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-callback-ref.cjs","sources":["../../src/use-callback-ref/use-callback-ref.ts"],"sourcesContent":["import { useEffect, useMemo, useRef } from 'react';\n\nexport function useCallbackRef<T extends (...args: any[]) => any>(callback: T | undefined): T {\n  const callbackRef = useRef(callback);\n\n  useEffect(() => {\n    callbackRef.current = callback;\n  });\n\n  return useMemo(() => ((...args) => callbackRef.current?.(...args)) as T, []);\n}\n"],"names":["useRef","useEffect","useMemo"],"mappings":";;;;;AAEO,CAAS,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAkD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAAA,CAAA,CAAA;AAC5F,CAAA,CAAM,MAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAcA,aAAO,QAAQ,CAAA,CAAA;AAEnC,CAAAC,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAA,CAAU,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAY,CAAU,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAAA,CAAA,CAAA,CACvB,CAAA,CAAA;AAED,CAAA,CAAO,OAAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAO,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,GAAI,CAAS,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAY,QAAU,CAAA,CAAA,CAAA,CAAA,CAAG,IAAI,CAAS,CAAA,CAAA,EAAE,CAAA,CAAA;AAC7E,CAAA;;"}

package/cjs/use-scroll-into-view/utils/ease-in-out-quad.cjs

@@ -1,7 +0,0 @@
-'use client';
-'use strict';
-
-const easeInOutQuad = (t) => t < 0.5 ? 2 * t * t : -1 + (4 - 2 * t) * t;
-
-exports.easeInOutQuad = easeInOutQuad;
-//# sourceMappingURL=ease-in-out-quad.cjs.map

package/cjs/use-scroll-into-view/utils/ease-in-out-quad.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"ease-in-out-quad.cjs","sources":["../../../src/use-scroll-into-view/utils/ease-in-out-quad.ts"],"sourcesContent":["export const easeInOutQuad = (t: number) => (t < 0.5 ? 2 * t * t : -1 + (4 - 2 * t) * t);\n"],"names":[],"mappings":";;;AAAa,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CAAA,CAAA,CAAC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAe,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,CAAA,CAAI,CAAA,CAAA,CAAA,CAAA,GAAI,CAAI,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAI,CAAA,CAAA,CAAA,CAAA,CAAI,CAAA,CAAA,CAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;;"}