@sohanemon/utils 6.2.8 → 6.3.0

package/dist/hooks/index.d.ts

@@ -1,192 +0,0 @@
-import * as React from 'react';
-export * from './action';
-export * from './async';
-export * from './schedule';
-/**
- * Hook to detect clicks outside of a referenced element.
- * @param callback - A function to invoke when a click outside is detected.
- * @returns A React ref object to attach to the target element.
- */
-export declare const useClickOutside: (callback?: () => void) => React.RefObject<HTMLDivElement>;
-/**
- * Hook to match a media query based on Tailwind CSS breakpoints or custom queries.
- * @param tailwindBreakpoint - The Tailwind breakpoint or custom query string.
- * @returns A boolean indicating whether the media query matches.
- */
-export declare function useMediaQuery(tailwindBreakpoint: 'sm' | 'md' | 'lg' | 'xl' | '2xl' | `(${string})`): boolean;
-/**
- * Runs an effect only once when the component mounts.
- * @param effect - The effect callback function.
- */
-export declare function useEffectOnce(effect: React.EffectCallback): void;
-/**
- * Runs an effect only when dependencies update, excluding the initial render.
- * @param effect - The effect callback function.
- * @param deps - Dependency array for the effect.
- */
-export declare function useUpdateEffect(effect: React.EffectCallback, deps: React.DependencyList): void;
-/**
- * Debounces a state value with a specified delay.
- * @param state - The state value to debounce.
- * @param delay - The debounce delay in milliseconds (default: 500ms).
- * @returns The debounced state value.
- */
-export declare function useDebounce<T>(state: T, delay?: number): T;
-/**
- * Hook to handle effects with layout synchronization in the browser.
- */
-export declare const useIsomorphicEffect: typeof React.useEffect;
-/**
- * Hook to invoke a callback after a specified timeout.
- * @param callback - The callback function to invoke.
- * @param delay - The timeout delay in milliseconds (default: 1000ms).
- */
-export declare function useTimeout(callback: () => void, delay?: number | null): void;
-/**
- * Hook to add and remove a window event listener.
- * @param type - The type of the event to listen for.
- * @param listener - The event listener callback.
- * @param options - Options for the event listener.
- */
-export declare function useWindowEvent<K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
-/**
- * Tuple type for session storage value and updater.
- */
-type SessionStorageValue<T> = [T, React.Dispatch<React.SetStateAction<T>>];
-/**
- * Hook to persist state in session storage.
- * @param key - The key for session storage.
- * @param defaultValue - The default value if no value is found in session storage.
- * @returns A tuple of the stored value and an updater function.
- */
-export declare const useSessionStorage: <T extends Record<string, any>>(key: string, defaultValue: T) => SessionStorageValue<T>;
-/**
- * Tuple type for local storage value and updater.
- */
-type LocalStorageValue<T> = [T, React.Dispatch<React.SetStateAction<T>>];
-/**
- * Hook to persist state in local storage.
- * @param key - The key for local storage.
- * @param defaultValue - The default value if no value is found in local storage.
- * @returns A tuple of the stored value and an updater function.
- */
-export declare const useLocalStorage: <T extends Record<string, any>>(key: string, defaultValue: T) => LocalStorageValue<T>;
-/**
- * Hook to manage URL parameters as state.
- * @param key - The URL parameter key.
- * @param defaultValue - The default value if the parameter is not present.
- * @returns A tuple of the parameter value and a setter function.
- */
-export declare const useUrlParams: <T extends string | number | boolean>(key: string, defaultValue: T) => [T, (value: T) => void];
-/**
- * Hook to select a DOM element by CSS selector.
- * @param selector - The CSS selector string.
- * @returns The selected DOM element or null if not found.
- */
-export declare const useQuerySelector: <T extends Element>(selector: string) => T | null;
-/**
- * Hook to detect if the code is running on the client side.
- * @returns A boolean indicating whether the code is running on the client.
- */
-export declare function useIsClient(): boolean;
-/**
- * Hook to lock scroll by disabling body overflow.
- */
-export declare function useLockScroll(): void;
-/**
- * Hook to copy text to the clipboard and track the copy status.
- * @param timeout - The timeout duration in milliseconds to reset the copy status (default: 2000ms).
- * @returns An object with the `isCopied` state and `copy` function.
- */
-export declare function useCopyToClipboard({ timeout }: {
-    timeout?: number;
-}): {
-    isCopied: boolean;
-    copy: (value: string) => void;
-};
-/**
- * Properties for height calculation.
- */
-type CalculationProps2 = {
-    blockIds: string[];
-    dynamic?: boolean | string;
-    margin?: number;
-    substract?: boolean;
-};
-/**
- *
- * Hook to calculate the height of an element based on viewport and other block heights.
- * @param params - Configuration object for height calculation.
- * @returns The calculated height.
- */
-export declare const useHeightCalculation: ({ blockIds, margin, substract, dynamic, }: CalculationProps2) => number;
-/**
- * Properties for DOM calculation.
- */
-type CalculationProps = {
-    blockIds: string[];
-    dynamic?: boolean | string;
-    margin?: number;
-    substract?: boolean;
-    onChange?: (results: {
-        blocksHeight: number;
-        blocksWidth: number;
-        remainingWidth: number;
-        remainingHeight: number;
-    }) => void;
-};
-/**
- * Hook to calculate dimensions (height and width) of an element based on viewport and other block dimensions.
- * @param params - Configuration object for dimension calculation.
- * @returns An object containing the calculated height and width.
- */
-export declare const useDomCalculation: ({ blockIds, margin, substract, dynamic, onChange, }: CalculationProps) => {
-    height: number;
-    width: number;
-};
-/**
- * Hook to detect if the user is scrolling.
- * @returns An object containing the isScrolling state and a ref to the scrollable container.
- */
-export declare const useIsScrolling: () => {
-    isScrolling: boolean;
-    scrollableContainerRef: React.RefObject<HTMLElement>;
-};
-/**
- * Hook to detect if the user is at the top of the page.
- * @returns An object containing the isAtTop state and a ref to the scrollable container.
- */
-export declare const useIsAtTop: ({ offset }?: {
-    offset?: number;
-}) => {
-    scrollableContainerRef: React.RefObject<HTMLElement>;
-    isAtTop: boolean;
-};
-interface UseIntersectionOptions extends IntersectionObserverInit {
-    onInteractionStart?: () => void;
-    onInteractionEnd?: () => void;
-}
-/**
- * React hook that tracks when an element enters or leaves the viewport
- * using the Intersection Observer API.
- *
- * @example
- * ```tsx
- * const { ref, isIntersecting } = useIntersection({
- *   threshold: 0.1,
- *   onInteractionStart: () => console.log('👀 Element entered viewport'),
- *   onInteractionEnd: () => console.log('🙈 Element left viewport'),
- * });
- *
- * return <div ref={ref}>Watch me</div>;
- * ```
- *
- * @param options - Configuration for the intersection observer.
- * @returns Object containing:
- * - `ref`: React ref to attach to the observed element.
- * - `isIntersecting`: Whether the element is currently visible.
- */
-export declare const useIntersection: ({ threshold, root, rootMargin, onInteractionStart, onInteractionEnd, }?: UseIntersectionOptions) => {
-    ref: React.RefObject<any>;
-    isIntersecting: boolean;
-};