react-hook-toolkit 1.1.8 → 1.2.0

package/dist/chunk1516/chunk940514.d.ts

@@ -0,0 +1,93 @@
+import { RefObject } from 'react';
+import { AsyncFunction, FetchState, MousePosition, ScrollPosition, UseAsyncReturn, UseAxiosConfig, UseAxiosResponse, WindowSize } from '../type';
+export declare const isReady: () => boolean;
+export declare const useAxios: <T>(config?: UseAxiosConfig) => UseAxiosResponse<T>;
+export declare const useDrawer: () => import("../chunk1213/chunk158261").DrawerContextValue;
+export declare const useGenericReducer: <State, Action extends {
+    type: string;
+}>(initialState: State, actions: Record<string, (state: State, action: Action) => State>) => (state: State | undefined, action: Action) => State;
+export declare function useRequest<T>(url: string): FetchState<T>;
+export declare function useLocalStorage<T>(key: string, initialValue: T): [T, (value: T) => void];
+export declare function useToggle(initialValue?: boolean): [boolean, () => void];
+export declare function useDebounce<T>(value: T, delay: number): T;
+export declare function useThrottle<T>(value: T, limit: number): T;
+export declare function usePrevious<T>(value: T): T | undefined;
+export declare function useMediaQuery(query: string): boolean;
+export declare function useClipboard(): [boolean, (text: string) => Promise<void>];
+export declare function useInterval(callback: () => void, delay: number | null): void;
+export declare function useWindowSize(): WindowSize;
+export declare function useKeyPress(targetKey: string): boolean;
+export declare function useOnlineStatus(): boolean;
+export declare function useScrollPosition(): ScrollPosition;
+export declare function useTimeout(callback: () => void, delay: number | null): void;
+export declare function useDarkMode(): [boolean, () => void];
+export declare function useForm<T extends Record<string, any>>(initialValues: T): {
+    values: T;
+    errors: Partial<Record<keyof T, string>>;
+    handleChange: (name: keyof T, value: any) => void;
+    validate: (validators: Partial<Record<keyof T, (value: any) => string | null>>) => boolean;
+};
+export declare function useArray<T>(initialArray: T[]): {
+    array: T[];
+    set: import("react").Dispatch<import("react").SetStateAction<T[]>>;
+    push: (item: T) => void;
+    removeByIndex: (index: number) => void;
+    clear: () => void;
+};
+export declare const useStepper: (totalSteps: number) => {
+    activeStep: number;
+    handleNext: () => void;
+    handleBack: () => void;
+    handleReset: () => void;
+    totalSteps: number;
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    isProccesing: boolean;
+    setIsProccesing: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    goto: (step: number) => void;
+};
+export declare const useSteps: (totalSteps: number) => {
+    activeStep: number;
+    handleNext: () => void;
+    handleBack: () => void;
+    handleReset: () => void;
+    goto: (step: number) => void;
+    totalSteps: number;
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    isProcessing: boolean;
+    setIsProcessing: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+};
+export declare function useTimeoutFn(callback: () => void, delay: number | null): {
+    reset: () => void;
+    clear: () => void;
+};
+export declare function useDebouncedCallback(callback: () => void, delay: number): () => void;
+export declare function useScrollLock(lock: boolean): void;
+export declare function useResizeObserver<T extends HTMLElement>(ref: RefObject<T>): WindowSize | null;
+export declare function useMousePosition(): MousePosition;
+type ScrollDirection = 'up' | 'down';
+export declare function useScrollDirection(): ScrollDirection;
+export declare function useImageLoader(src: string): {
+    loaded: boolean;
+    error: boolean;
+};
+export declare function usePersistedState<T>(key: string, initialValue: T): [T, React.Dispatch<React.SetStateAction<T>>];
+export declare function useReducedMotion(): boolean;
+export declare function useCookie(key: string): [string | null, (value: string, options?: any) => void, () => void];
+export declare function useRequestRetry<T>(url: string, options: RequestInit, retries?: number): {
+    data: T | null;
+    error: string | null;
+    loading: boolean;
+};
+export declare function useDelay<T>(value: T, delay: number): T;
+export declare function useVisibilityChange(): boolean;
+export declare function useDebouncedValue<T>(value: T, delay: number): T;
+export declare function useAsync<T>(asyncFunction: AsyncFunction<T>, immediate?: boolean): UseAsyncReturn<T>;
+export type ScriptStatus = 'loading' | 'ready' | 'error' | 'unknown';
+export declare function useScript(src: string, removeOnUnmount?: boolean): ScriptStatus;
+export declare function useIndexedDB<T>(dbName: string, storeName: string): {
+    data: T | null;
+    error: Error | null;
+};
+export {};