@mantine/hooks 7.13.4 → 7.13.5-alpha.0

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

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

package/lib/use-focus-trap/create-aria-hider.d.ts

@@ -1 +0,0 @@
-export declare function createAriaHider(containerNode: HTMLElement, selector?: string): () => void;

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

@@ -1 +0,0 @@
-export declare function scopeTab(node: HTMLElement, event: KeyboardEvent): void;

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

@@ -1,4 +0,0 @@
-export declare const FOCUS_SELECTOR = "a, input, select, textarea, button, object, [tabindex]";
-export declare function focusable(element: HTMLElement): boolean | "";
-export declare function tabbable(element: HTMLElement): boolean | "";
-export declare function findTabbableDescendants(element: HTMLElement): HTMLElement[];

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

@@ -1 +0,0 @@
-export declare function useFocusTrap(active?: boolean): (instance: HTMLElement | null) => void;

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

@@ -1,8 +0,0 @@
-export interface UseFocusWithinOptions {
-    onFocus?: (event: FocusEvent) => void;
-    onBlur?: (event: FocusEvent) => void;
-}
-export declare function useFocusWithin<T extends HTMLElement = any>({ onBlur, onFocus, }?: UseFocusWithinOptions): {
-    ref: React.MutableRefObject<T>;
-    focused: boolean;
-};

package/lib/use-force-update/use-force-update.d.ts

@@ -1 +0,0 @@
-export declare function useForceUpdate(): () => void;

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

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

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

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

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

@@ -1,17 +0,0 @@
-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 useScrollDirection: () => boolean;
-interface UseHeadroomInput {
-    /** Number in px at which element should be fixed */
-    fixedAt?: number;
-    /** Called when element is pinned */
-    onPin?: () => void;
-    /** Called when element is at fixed position */
-    onFix?: () => void;
-    /** Called when element is unpinned */
-    onRelease?: () => void;
-}
-export declare function useHeadroom({ fixedAt, onPin, onFix, onRelease }?: UseHeadroomInput): boolean;
-export {};

package/lib/use-hotkeys/parse-hotkey.d.ts

@@ -1,19 +0,0 @@
-export type KeyboardModifiers = {
-    alt: boolean;
-    ctrl: boolean;
-    meta: boolean;
-    mod: boolean;
-    shift: boolean;
-};
-export type Hotkey = KeyboardModifiers & {
-    key?: string;
-};
-type CheckHotkeyMatch = (event: KeyboardEvent) => boolean;
-export declare function parseHotkey(hotkey: string): Hotkey;
-export declare function getHotkeyMatcher(hotkey: string): CheckHotkeyMatch;
-export interface HotkeyItemOptions {
-    preventDefault?: boolean;
-}
-type HotkeyItem = [string, (event: any) => void, HotkeyItemOptions?];
-export declare function getHotkeyHandler(hotkeys: HotkeyItem[]): (event: React.KeyboardEvent<HTMLElement> | KeyboardEvent) => void;
-export {};

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

@@ -1,5 +0,0 @@
-import { getHotkeyHandler, HotkeyItemOptions } from './parse-hotkey';
-export type { HotkeyItemOptions };
-export { getHotkeyHandler };
-export type HotkeyItem = [string, (event: KeyboardEvent) => void, HotkeyItemOptions?];
-export declare function useHotkeys(hotkeys: HotkeyItem[], tagsToIgnore?: string[], triggerOnContentEditable?: boolean): void;

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

@@ -1,4 +0,0 @@
-export declare function useHover<T extends HTMLElement = HTMLDivElement>(): {
-    ref: import("react").RefObject<T>;
-    hovered: boolean;
-};

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

@@ -1 +0,0 @@
-export declare function useId(staticId?: string): string;

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

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

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

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

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

@@ -1,4 +0,0 @@
-export declare function useInViewport<T extends HTMLElement>(): {
-    ref: (node: T | null) => void;
-    inViewport: boolean;
-};

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

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

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

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

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

@@ -1,11 +0,0 @@
-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): {
-    start: () => void;
-    stop: () => void;
-    toggle: () => void;
-    active: boolean;
-};
-export {};

package/lib/use-is-first-render/use-is-first-render.d.ts

@@ -1 +0,0 @@
-export declare function useIsFirstRender(): boolean;

package/lib/use-isomorphic-effect/use-isomorphic-effect.d.ts

@@ -1,2 +0,0 @@
-import { useEffect } from 'react';
-export declare const useIsomorphicEffect: typeof useEffect;

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

@@ -1,24 +0,0 @@
-export interface UseListStateHandlers<T> {
-    setState: React.Dispatch<React.SetStateAction<T[]>>;
-    append: (...items: T[]) => void;
-    prepend: (...items: T[]) => void;
-    insert: (index: number, ...items: T[]) => void;
-    pop: () => void;
-    shift: () => void;
-    apply: (fn: (item: T, index?: number) => T) => void;
-    applyWhere: (condition: (item: T, index: number) => boolean, fn: (item: T, index?: number) => T) => void;
-    remove: (...indices: number[]) => void;
-    reorder: ({ from, to }: {
-        from: number;
-        to: number;
-    }) => void;
-    swap: ({ from, to }: {
-        from: number;
-        to: number;
-    }) => void;
-    setItem: (index: number, item: T) => void;
-    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>;

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

@@ -1,15 +0,0 @@
-export type StorageType = 'localStorage' | 'sessionStorage';
-export interface StorageProperties<T> {
-    /** Storage key */
-    key: string;
-    /** Default value that will be set if value is not found in storage */
-    defaultValue?: T;
-    /** If set to true, value will be updated in useEffect after mount. Default value is true. */
-    getInitialValueInEffect?: boolean;
-    /** Function to serialize value into string to be save in storage */
-    serialize?: (value: T) => string;
-    /** 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, 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;

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

@@ -1,3 +0,0 @@
-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;

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

@@ -1 +0,0 @@
-export declare function useLogger(componentName: string, props: any[]): null;

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

@@ -1 +0,0 @@
-export declare function useMap<T, V>(initialState?: [T, V][]): Map<T, V>;

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

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

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

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

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

@@ -1 +0,0 @@
-export declare function useMounted(): boolean;

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

@@ -1,7 +0,0 @@
-export declare function useMouse<T extends HTMLElement = any>(options?: {
-    resetOnExit?: boolean;
-}): {
-    x: number;
-    y: number;
-    ref: import("react").MutableRefObject<T | undefined>;
-};

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

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

package/lib/use-mutation-observer/use-mutation-observer.d.ts

@@ -1,2 +0,0 @@
-import { RefObject } from 'react';
-export declare function useMutationObserver<Element extends HTMLElement>(callback: MutationCallback, options: MutationObserverInit, target?: HTMLElement | (() => HTMLElement) | null): RefObject<Element>;

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

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

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

@@ -1,4 +0,0 @@
-export declare function useOrientation(): {
-    angle: number;
-    type: string;
-};

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

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

package/lib/use-page-leave/use-page-leave.d.ts

@@ -1 +0,0 @@
-export declare function usePageLeave(onPageLeave: () => void): void;

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

@@ -1,24 +0,0 @@
-export declare const DOTS = "dots";
-export interface PaginationParams {
-    /** Page selected on initial render, defaults to 1 */
-    initialPage?: number;
-    /** Controlled active page number */
-    page?: number;
-    /** Total amount of pages */
-    total: number;
-    /** Siblings amount on left/right side of selected page, defaults to 1 */
-    siblings?: number;
-    /** Amount of elements visible on left/right edges, defaults to 1  */
-    boundaries?: number;
-    /** 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")[];
-    active: number;
-    setPage: (pageNumber: number) => void;
-    next: () => void;
-    previous: () => void;
-    first: () => void;
-    last: () => void;
-};

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

@@ -1 +0,0 @@
-export declare function usePrevious<T>(value: T): T | undefined;

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

@@ -1,10 +0,0 @@
-export declare function useQueue<T>({ initialValues, limit }: {
-    initialValues?: T[];
-    limit: number;
-}): {
-    state: T[];
-    queue: T[];
-    add: (...items: T[]) => void;
-    update: (fn: (state: T[]) => T[]) => void;
-    cleanQueue: () => void;
-};

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

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

package/lib/use-resize-observer/use-resize-observer.d.ts

@@ -1,8 +0,0 @@
-type ObserverRect = Omit<DOMRectReadOnly, 'toJSON'>;
-export declare function useResizeObserver<T extends HTMLElement = any>(options?: ResizeObserverOptions): readonly [import("react").RefObject<T>, ObserverRect];
-export declare function useElementSize<T extends HTMLElement = any>(options?: ResizeObserverOptions): {
-    ref: import("react").RefObject<T>;
-    width: number;
-    height: number;
-};
-export {};

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

@@ -1,28 +0,0 @@
-interface ScrollIntoViewAnimation {
-    /** Target element alignment relatively to parent based on current axis */
-    alignment?: 'start' | 'end' | 'center';
-}
-interface ScrollIntoViewParams {
-    /** Callback fired after scroll */
-    onScrollFinish?: () => void;
-    /** Duration of scroll in milliseconds */
-    duration?: number;
-    /** Axis of scroll */
-    axis?: 'x' | 'y';
-    /** Custom mathematical easing function */
-    easing?: (t: number) => number;
-    /** Additional distance between nearest edge and element */
-    offset?: number;
-    /** Indicator if animation may be interrupted by user scrolling */
-    cancelable?: boolean;
-    /** Prevents content jumping in scrolling lists with multiple targets */
-    isList?: boolean;
-}
-interface ScrollIntoViewReturnType<Target extends HTMLElement, Parent extends HTMLElement | null = null> {
-    scrollableRef: React.MutableRefObject<Parent>;
-    targetRef: React.MutableRefObject<Target>;
-    scrollIntoView: (params?: ScrollIntoViewAnimation) => void;
-    cancel: () => void;
-}
-export declare function useScrollIntoView<Target extends HTMLElement, Parent extends HTMLElement | null = null>({ duration, axis, onScrollFinish, easing, offset, cancelable, isList, }?: ScrollIntoViewParams): ScrollIntoViewReturnType<Target, Parent>;
-export {};

package/lib/use-scroll-into-view/utils/ease-in-out-quad.d.ts

@@ -1 +0,0 @@
-export declare const easeInOutQuad: (t: number) => number;

package/lib/use-scroll-into-view/utils/get-relative-position.d.ts

@@ -1 +0,0 @@
-export declare const getRelativePosition: ({ axis, target, parent, alignment, offset, isList, }: any) => number;

package/lib/use-scroll-into-view/utils/get-scroll-start.d.ts

@@ -1 +0,0 @@
-export declare const getScrollStart: ({ axis, parent }: any) => any;

package/lib/use-scroll-into-view/utils/set-scroll-param.d.ts

@@ -1 +0,0 @@
-export declare const setScrollParam: ({ axis, parent, distance }: any) => void;

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

@@ -1,3 +0,0 @@
-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;

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

@@ -1 +0,0 @@
-export declare function useSet<T>(values?: T[]): Set<T>;

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

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

package/lib/use-shallow-effect/use-shallow-effect.d.ts

@@ -1 +0,0 @@
-export declare function useShallowEffect(cb: () => void, dependencies?: React.DependencyList): void;

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

@@ -1,11 +0,0 @@
-export interface UseStateHistoryHandlers<T> {
-    set: (value: T) => void;
-    back: (steps?: number) => void;
-    forward: (steps?: number) => void;
-    reset: () => void;
-}
-export interface StateHistory<T> {
-    history: T[];
-    current: number;
-}
-export declare function useStateHistory<T>(initialValue: T): [T, UseStateHistoryHandlers<T>, StateHistory<T>];

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

@@ -1 +0,0 @@
-export declare function useTextSelection(): Selection | null;

package/lib/use-throttled-callback/use-throttled-callback.d.ts

@@ -1,2 +0,0 @@
-export declare function useThrottledCallbackWithClearTimeout<T extends (...args: any[]) => any>(callback: T, wait: number): readonly [(...args: Parameters<T>) => void, () => void];
-export declare function useThrottledCallback<T extends (...args: any[]) => any>(callback: T, wait: number): (...args: Parameters<T>) => void;

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

@@ -1 +0,0 @@
-export declare function useThrottledState<T = any>(defaultValue: T, wait: number): readonly [T, (value: import("react").SetStateAction<T>) => void];

package/lib/use-throttled-value/use-throttled-value.d.ts

@@ -1 +0,0 @@
-export declare function useThrottledValue<T>(value: T, wait: number): T;

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

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

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

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

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

@@ -1,12 +0,0 @@
-interface UseUncontrolledInput<T> {
-    /** Value for controlled state */
-    value?: T;
-    /** Initial value for uncontrolled state */
-    defaultValue?: T;
-    /** Final value for uncontrolled state when value and defaultValue are not provided */
-    finalValue?: 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 {};

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

@@ -1,5 +0,0 @@
-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];

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

@@ -1,4 +0,0 @@
-export declare function useViewportSize(): {
-    width: number;
-    height: number;
-};

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

@@ -1 +0,0 @@
-export declare function useWindowEvent<K extends string>(type: K, listener: K extends keyof WindowEventMap ? (this: Window, ev: WindowEventMap[K]) => void : (this: Window, ev: CustomEvent) => void, options?: boolean | AddEventListenerOptions): void;

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

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

package/lib/utils/clamp/clamp.d.ts

@@ -1 +0,0 @@
-export declare function clamp(value: number, min: number | undefined, max: number | undefined): number;

package/lib/utils/index.d.ts

@@ -1,6 +0,0 @@
-export { clamp } from './clamp/clamp';
-export { lowerFirst } from './lower-first/lower-first';
-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';

package/lib/utils/lower-first/lower-first.d.ts

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

package/lib/utils/random-id/random-id.d.ts

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

package/lib/utils/range/range.d.ts

@@ -1 +0,0 @@
-export declare function range(start: number, end: number): number[];

package/lib/utils/shallow-equal/shallow-equal.d.ts

@@ -1 +0,0 @@
-export declare function shallowEqual(a: any, b: any): boolean;

package/lib/utils/upper-first/upper-first.d.ts

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