react-hook-toolkit 0.0.5 → 0.0.7

package/README.md

@@ -48,7 +48,7 @@ Install the package with npm:
 
 - **`useArray<T>`**: Provides an array state with helper functions to manipulate it, including setting, adding, removing by index, and clearing elements.
 
-- **`useStep<T>`**: Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
+- **`useStepper`**: Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
 
 - **`useTimeoutFn`**: Executes a callback function after a specified delay and provides functions to reset or clear the timeout.  
 

package/dist/Hooks/hooks.d.ts

@@ -0,0 +1,194 @@
+import { RefObject } from 'react';
+import { AxiosRequestConfig } from 'axios';
+interface UseAxiosResponse<T> {
+    data: T | null;
+    loading: boolean;
+    error: string | null;
+    makeRequest: (url: string, method?: string, requestData?: any) => void;
+    cancelRequest: () => void;
+}
+interface UseAxiosConfig extends AxiosRequestConfig {
+    baseURL?: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export declare const useAxios: <T>(config?: UseAxiosConfig) => UseAxiosResponse<T>;
+export declare const useAdvReducer: <State, Action extends {
+    type: string;
+}>(initialState: State, actions: Record<string, (state: State, action: Action) => State>) => (state: State | undefined, action: Action) => State;
+interface FetchState<T> {
+    data: T | null;
+    loading: boolean;
+    error: string | null;
+}
+export declare function useFetch<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;
+interface WindowSize {
+    width: number;
+    height: number;
+}
+export declare function useWindowSize(): WindowSize;
+export declare function useKeyPress(targetKey: string): boolean;
+export declare function useOnlineStatus(): boolean;
+interface ScrollPosition {
+    x: number;
+    y: number;
+}
+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>>;
+};
+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;
+interface MousePosition {
+    x: number;
+    y: number;
+}
+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 useFetchRetry<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 type Status = 'idle' | 'pending' | 'success' | 'error';
+export type AsyncFunction<T> = () => Promise<T>;
+export interface UseAsyncReturn<T> {
+    execute: () => void;
+    status: Status;
+    value: T | null;
+    error: Error | null;
+}
+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 declare function useGeoLocation(): {
+    position: GeolocationPosition | null;
+    error: Error | null;
+};
+export declare function useTimer(initialTime: number): {
+    time: number;
+    error: Error | null;
+};
+export declare function useIsMounted(): boolean;
+export declare function useCss(css: string): {
+    error: Error | null;
+};
+export declare function useSpeak(text: string): {
+    speak: () => void;
+    error: Error | null;
+};
+export declare function useCountUp(target: number, duration: number): {
+    count: number;
+    error: Error | null;
+};
+export declare function useCountDown(start: number): {
+    count: number;
+    error: Error | null;
+};
+interface BatteryState {
+    supported: boolean;
+    loading: boolean;
+    level: number | null;
+    charging: boolean | null;
+    chargingTime: number | null;
+    dischargingTime: number | null;
+}
+export declare const useBattery: () => BatteryState;
+export declare const useEventListener: (eventName: string, handler: (event: Event) => void, elementRef?: React.RefObject<HTMLElement>, options?: boolean | AddEventListenerOptions) => void;
+interface HistoryState {
+    [key: string]: any;
+}
+interface UseHistory {
+    history: History;
+    state: HistoryState | null;
+    push: (path: string, state?: HistoryState) => void;
+    replace: (path: string, state?: HistoryState) => void;
+    goBack: () => void;
+    goForward: () => void;
+}
+export declare const useHistory: () => UseHistory;
+interface UsePreferredLanguage {
+    language: string;
+    languages: Array<string>;
+    isSupported: boolean;
+}
+export declare const usePreferredLanguage: () => UsePreferredLanguage;
+interface UseSessionStorage<T> {
+    (key: string, initialValue: T): [T, (value: T) => void];
+}
+export declare const useSessionStorage: UseSessionStorage<any>;
+interface UseSound {
+    play: () => void;
+    pause: () => void;
+    stop: () => void;
+    setVolume: (volume: number) => void;
+    isPlaying: boolean;
+    error: Error | null;
+}
+export declare const useSound: (url: string) => UseSound;
+interface TouchPosition {
+    x: number | null;
+    y: number | null;
+}
+interface UseTouch {
+    (elementRef: React.RefObject<HTMLElement>): {
+        touchStart: TouchPosition;
+        touchMove: TouchPosition;
+        touchEnd: TouchPosition;
+    };
+}
+export declare const useTouch: UseTouch;
+export declare const useUpdateEffect: (effect: React.EffectCallback, deps: React.DependencyList) => void;
+export {};