@mantine/hooks 8.3.13 → 9.0.0-alpha.0

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

@@ -20,7 +20,7 @@ export interface UseScrollSpyOptions {
     /** Offset from the top of the viewport to use when determining the active heading, `0` by default */
     offset?: number;
 }
-export interface UseScrollSpyReturnType {
+export interface UseScrollSpyReturnValue {
     /** Index of the active heading in the `data` array */
     active: number;
     /** Headings data. If not initialize, data is represented by an empty array. */
@@ -30,4 +30,8 @@ export interface UseScrollSpyReturnType {
     /** Function to update headings values after the parent component has mounted. */
     reinitialize: () => void;
 }
-export declare function useScrollSpy({ selector, getDepth, getValue, offset, scrollHost, }?: UseScrollSpyOptions): UseScrollSpyReturnType;
+export declare function useScrollSpy({ selector, getDepth, getValue, offset, scrollHost, }?: UseScrollSpyOptions): UseScrollSpyReturnValue;
+export declare namespace useScrollSpy {
+    type Options = UseScrollSpyOptions;
+    type ReturnValue = UseScrollSpyReturnValue;
+}

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

@@ -0,0 +1,42 @@
+import { RefCallback } from 'react';
+export interface UseScrollerOptions {
+    /** Amount of pixels to scroll when calling scroll functions, `200` by default */
+    scrollAmount?: number;
+    /** Determines whether content can be scrolled by dragging with mouse, `true` by default */
+    draggable?: boolean;
+    /** Called when scroll state changes (canScrollStart or canScrollEnd) */
+    onScrollStateChange?: (state: UseScrollerScrollState) => void;
+}
+export interface UseScrollerScrollState {
+    /** Whether content can be scrolled towards the start (left in LTR, right in RTL) */
+    canScrollStart: boolean;
+    /** Whether content can be scrolled towards the end (right in LTR, left in RTL) */
+    canScrollEnd: boolean;
+}
+export interface UseScrollerReturnValue<T extends HTMLElement = HTMLDivElement> {
+    /** Ref callback to attach to the scrollable container element */
+    ref: RefCallback<T | null>;
+    /** Whether content can be scrolled towards the start */
+    canScrollStart: boolean;
+    /** Whether content can be scrolled towards the end */
+    canScrollEnd: boolean;
+    /** Scrolls towards the start direction */
+    scrollStart: () => void;
+    /** Scrolls towards the end direction */
+    scrollEnd: () => void;
+    /** `true` if the user is currently dragging the content */
+    isDragging: boolean;
+    /** Props to spread on the scrollable container for drag functionality */
+    dragHandlers: {
+        onMouseDown: (e: React.MouseEvent) => void;
+        onMouseMove: (e: React.MouseEvent) => void;
+        onMouseUp: () => void;
+        onMouseLeave: () => void;
+    };
+}
+export declare function useScroller<T extends HTMLElement = HTMLDivElement>(options?: UseScrollerOptions): UseScrollerReturnValue<T>;
+export declare namespace useScroller {
+    type Options = UseScrollerOptions;
+    type ReturnValue<T extends HTMLElement = HTMLDivElement> = UseScrollerReturnValue<T>;
+    type ScrollState = UseScrollerScrollState;
+}

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

@@ -24,3 +24,8 @@ export interface UseSelectionHandlers<T> {
 }
 export type UseSelectionReturnValue<T> = readonly [T[], UseSelectionHandlers<T>];
 export declare function useSelection<T>(input: UseSelectionInput<T>): UseSelectionReturnValue<T>;
+export declare namespace useSelection {
+    type Input<T> = UseSelectionInput<T>;
+    type Handlers<T> = UseSelectionHandlers<T>;
+    type ReturnValue<T> = UseSelectionReturnValue<T>;
+}

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

@@ -1,3 +1,7 @@
 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>;
+export declare namespace useSetState {
+    type Callback<T> = UseSetStateCallback<T>;
+    type ReturnValue<T> = UseSetStateReturnValue<T>;
+}

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

@@ -14,3 +14,8 @@ export type UseStateHistoryReturnValue<T> = [
     UseStateHistoryValue<T>
 ];
 export declare function useStateHistory<T>(initialValue: T): UseStateHistoryReturnValue<T>;
+export declare namespace useStateHistory {
+    type Handlers<T> = UseStateHistoryHandlers<T>;
+    type Value<T> = UseStateHistoryValue<T>;
+    type ReturnValue<T> = UseStateHistoryReturnValue<T>;
+}

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

@@ -6,3 +6,7 @@ export interface UseTimeoutReturnValue {
     clear: () => void;
 }
 export declare function useTimeout(callback: (...args: any[]) => void, delay: number, options?: UseTimeoutOptions): UseTimeoutReturnValue;
+export declare namespace useTimeout {
+    type Options = UseTimeoutOptions;
+    type ReturnValue = UseTimeoutReturnValue;
+}

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

@@ -1,4 +1,7 @@
 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 declare namespace useToggle {
+    type ReturnValue<T> = UseToggleReturnValue<T>;
+}
 export {};

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

@@ -17,3 +17,7 @@ export type UseUncontrolledReturnValue<T> = [
     boolean
 ];
 export declare function useUncontrolled<T>({ value, defaultValue, finalValue, onChange, }: UseUncontrolledOptions<T>): UseUncontrolledReturnValue<T>;
+export declare namespace useUncontrolled {
+    type Options<T> = UseUncontrolledOptions<T>;
+    type ReturnValue<T> = UseUncontrolledReturnValue<T>;
+}

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

@@ -13,3 +13,6 @@ export type UseValidatedStateReturnValue<T> = [
     (value: T) => void
 ];
 export declare function useValidatedState<T>(initialValue: T, validate: (value: T) => boolean, initialValidationState?: boolean): UseValidatedStateReturnValue<T>;
+export declare namespace useValidatedState {
+    type ReturnValue<T> = UseValidatedStateReturnValue<T>;
+}

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

@@ -5,3 +5,8 @@ export interface UseWindowScrollPosition {
 export type UseWindowScrollTo = (position: Partial<UseWindowScrollPosition>) => void;
 export type UseWindowScrollReturnValue = [UseWindowScrollPosition, UseWindowScrollTo];
 export declare function useWindowScroll(): UseWindowScrollReturnValue;
+export declare namespace useWindowScroll {
+    type Position = UseWindowScrollPosition;
+    type ScrollTo = UseWindowScrollTo;
+    type ReturnValue = UseWindowScrollReturnValue;
+}

package/package.json

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

package/cjs/use-id/use-react-id.cjs

@@ -1,17 +0,0 @@
-'use client';
-'use strict';
-
-var React = require('react');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var React__default = /*#__PURE__*/_interopDefault(React);
-
-const __useId = React__default.default["useId".toString()] || (() => void 0);
-function useReactId() {
-  const id = __useId();
-  return id ? `mantine-${id.replace(/:/g, "")}` : "";
-}
-
-exports.useReactId = useReactId;
-//# sourceMappingURL=use-react-id.cjs.map

package/cjs/use-id/use-react-id.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-react-id.cjs","sources":["../../src/use-id/use-react-id.ts"],"sourcesContent":["import React from 'react';\n\nconst __useId: () => string | undefined = (React as any)['useId'.toString()] || (() => undefined);\n\nexport function useReactId() {\n  const id = __useId();\n  return id ? `mantine-${id.replace(/:/g, '')}` : '';\n}\n"],"names":["React"],"mappings":";;;;;;;;;AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,IAAqCA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAA,CAAc,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAU,MAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEhF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAS,UAAA,CAAA,CAAA,CAAa,CAAA;AAC3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,IAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAA;AACnB,CAAA,CAAA,OAAO,CAAA,IAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAW,CAAA,CAAA,CAAG,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAQ,IAAA,CAAA,CAAM,CAAA,CAAE,CAAC,CAAA,CAAA,GAAK,CAAA,CAAA,CAAA;AAClD,CAAA;;"}

package/esm/use-id/use-react-id.mjs

@@ -1,11 +0,0 @@
-'use client';
-import React from 'react';
-
-const __useId = React["useId".toString()] || (() => void 0);
-function useReactId() {
-  const id = __useId();
-  return id ? `mantine-${id.replace(/:/g, "")}` : "";
-}
-
-export { useReactId };
-//# sourceMappingURL=use-react-id.mjs.map

package/esm/use-id/use-react-id.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-react-id.mjs","sources":["../../src/use-id/use-react-id.ts"],"sourcesContent":["import React from 'react';\n\nconst __useId: () => string | undefined = (React as any)['useId'.toString()] || (() => undefined);\n\nexport function useReactId() {\n  const id = __useId();\n  return id ? `mantine-${id.replace(/:/g, '')}` : '';\n}\n"],"names":[],"mappings":";;;AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,IAAqC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAU,MAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEhF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAS,UAAA,CAAA,CAAA,CAAa,CAAA;AAC3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAM,CAAA,IAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAQ,CAAA;AACnB,CAAA,CAAA,OAAO,CAAA,IAAK,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAW,CAAA,CAAA,CAAG,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAQ,IAAA,CAAA,CAAM,CAAA,CAAE,CAAC,CAAA,CAAA,GAAK,CAAA,CAAA,CAAA;AAClD,CAAA;;"}

package/lib/use-id/use-react-id.d.ts

@@ -1 +0,0 @@
-export declare function useReactId(): string;