react-hook-toolkit 1.0.3 → 1.0.4

package/README.md

@@ -1,122 +1,581 @@
+
 **react-hook-toolkit** package offers a comprehensive set of hooks to simplify React development. It includes hooks for managing state, handling API requests, optimizing performance, and improving user interactions. Key features include data fetching, form handling, local storage management, debouncing/throttling, window size tracking, event listeners, and more. These hooks are designed to enhance productivity by providing reusable, easy-to-use solutions for common tasks.
 
 ## Installation
 
-Install the package with npm:
+Install the package:
 
 ```bash
-  npm i react-hook-toolkit
+npm install react-hook-toolkit
+# or
+yarn add react-hook-toolkit
+# or
+pnpm add react-hook-toolkit
 ```
 
 ## Features  
+Here's the properly structured documentation with clear purpose explanations:
+
+###  **HOOKS** ------------------------------------------------------------------------------------------
+### 📌 **useAxios**  
+A custom hook for making API requests using Axios. It manages request states (`loading`, `error`, `data`) and provides a function (`makeRequest`) to initiate a request.
+```ts
+const { data, loading, error, makeRequest, cancelRequest } = useAxios({ baseURL: '/api' });
+
+useEffect(() => {
+  makeRequest('/users', 'GET');
+}, []);
+```
+
+---
+
+### 📌 **useAdvReducer**  
+A custom reducer function that takes an `initialState` and an object of actions, returning a new state based on the action type. 
+
+```ts
+const reducer = useAdvReducer(initialState, {
+  increment: (state) => ({ count: state.count + 1 }),
+});
+const [state, dispatch] = useReducer(reducer, initialState);
+```
+
+---
+
+### 📌 **useFetch**  
+Fetches data from a given URL and manages the loading, error, and data states.
+
+```ts
+const { data, loading, error } = useFetch<User[]>('/api/users');
+```
+
+---
+
+### 📌 **useLocalStorage**  
+ A hook to persist state in `localStorage`. It initializes state from `localStorage` and updates it whenever the value changes.
+
+```ts
+const [token, setToken] = useLocalStorage('authToken', '');
+```
+
+---
+
+### 📌 **useToggle**  
+A simple boolean toggle hook that returns a state and a function to toggle its value.
+
+```ts
+const [isOpen, toggle] = useToggle(false);
+```
+
+---
+
+### 📌 **useDebounce**  
+Delays updating the state until after a specified delay, useful for preventing frequent updates (e.g., handling user input).
+
+```ts
+const debouncedSearch = useDebounce(searchText, 500);
+```
+
+---
+
+### 📌 **useThrottle**  
+Limits how often a value updates within a given time interval, useful for performance optimization.
+
+```ts
+const throttledScroll = useThrottle(scrollValue, 300);
+```
+
+---
+
+### 📌 **usePrevious**  
+Returns the previous value of a state or prop.
+
+```ts
+const prevValue = usePrevious(currentValue);
+```
+
+---
+
+### 📌 **useMediaQuery**  
+Checks if a media query matches the current viewport size and updates the state accordingly.
+
+```ts
+const isMobile = useMediaQuery('(max-width: 768px)');
+```
+
+---
+
+### 📌 **useClipboard**  
+Copies text to the clipboard and provides a state to indicate if copying was successful.
+
+```ts
+const [copied, copyToClipboard] = useClipboard();
+copyToClipboard('Text to copy');
+```
+
+---
+
+### 📌 **useInterval**  
+Runs a callback function at a specified time interval and clears it when the delay is null or the component unmounts.
+
+```ts
+useInterval(() => {
+  console.log('Tick');
+}, 1000);
+```
+
+---
+
+### 📌 **useWindowSize**  
+Tracks the width and height of the browser window and updates when resized. 
+
+```ts
+const { width, height } = useWindowSize();
+```
+
+---
+
+### 📌 **useKeyPress**  
+Detects whether a specific key is being pressed or released.
+
+```ts
+const isEnterPressed = useKeyPress('Enter');
+```
+
+---
+
+### 📌 **useOnlineStatus**  
+Monitors the user's network connection status (online/offline).
+
+```ts
+const isOnline = useOnlineStatus();
+```
+
+---
+
+### 📌 **useScrollPosition**  
+Tracks the horizontal (x) and vertical (y) scroll positions of the window.
+
+```ts
+const { x, y } = useScrollPosition();
+```
+
+---
+
+### 📌 **useTimeout**  
+Executes a function after a specified delay and cleans up automatically when dependencies change.
+
+```ts
+useTimeout(() => {
+  console.log('Time\'s up!');
+}, 2000);
+```
+
+---
+
+### 📌 **useDarkMode**  
+Detects and toggles dark mode based on the user's system preference.
+
+```ts
+const [isDarkMode, toggleDarkMode] = useDarkMode();
+```
+
+---
+
+### 📌 **useForm**  
+Manages form state, handles input changes, and performs validation using provided validators.
+
+```ts
+const { values, errors, handleChange, validate } = useForm({ name: '', email: '' });
+
+handleChange('name', 'John');
+
+validate({
+  name: (val) => (!val ? 'Required' : null),
+  email: (val) => (!val.includes('@') ? 'Invalid email' : null),
+});
+```
+
+---
+
+### 📌 **useArray**
+Provides an array state with helper functions to manipulate it, including setting, adding, removing by index, and clearing elements.
+
+```ts
+const { array, set, push, removeByIndex, clear } = useArray([1, 2, 3]);
+
+push(4);            // ➝ [1, 2, 3, 4]
+removeByIndex(1);   // ➝ [1, 3, 4]
+clear();            // ➝ []
+```
+
+---
+
+### 📌 **useStepper**  
+Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
+
+```ts
+const { activeStep, handleNext, handleBack, handleReset, isFirstStep, isLastStep } = useStepper(5);
+
+handleNext(); // ➝ advances step
+handleBack(); // ➝ goes back
+handleReset(); // ➝ step 0
+```
+
+---
+
+### 📌 **useTimeoutFn**  
+Executes a callback function after a specified delay and provides functions to reset or clear the timeout.  
+
+```ts
+const { reset, clear } = useTimeoutFn(() => doSomething(), 1000);
+
+reset(); // ➝ restarts timeout
+clear(); // ➝ clears timeout
+```
+
+---
+
+### 📌 **useDebouncedCallback**  
+Delays the execution of a callback function until after a specified delay, resetting the delay on each call to prevent frequent execution.
+
+```ts
+const debounced = useDebouncedCallback(() => search(input), 300);
+
+input.onChange = debounced;
+```
+
+---
+
+### 📌 **useScrollLock**  
+Locks or unlocks scrolling on the webpage when the `lock` parameter changes.
+
+```ts
+useScrollLock(true); // ➝ disables body scroll
+```
+
+---
+
+### 📌 **useResizeObserver**  
+Observes and returns the dimensions of an HTML element using the `ResizeObserver` API.
+
+```ts
+const size = useResizeObserver(ref);
+
+// size = { width: 200, height: 100 }
+```
+
+---
 
-- **`useAxios`**: A custom hook for making API requests using Axios. It manages request states (`loading`, `error`, `data`) and provides a function (`makeRequest`) to initiate a request.  
+### 📌 **useMousePosition**  
+Tracks the user's mouse position in real-time and returns the coordinates. 
 
-- **`useAdvReducer`**: A custom reducer function that takes an `initialState` and an object of actions, returning a new state based on the action type.  
+```ts
+const { x, y } = useMousePosition();
+```
 
-- **`useFetch`**: Fetches data from a given URL and manages the loading, error, and data states.  
+---
 
-- **`useLocalStorage`**: A hook to persist state in `localStorage`. It initializes state from `localStorage` and updates it whenever the value changes.  
+### 📌 **useScrollDirection**  
+Determines whether the user is scrolling up or down based on window scroll position changes.
 
-- **`useToggle`**: A simple boolean toggle hook that returns a state and a function to toggle its value.  
+```ts
+const direction = useScrollDirection(); // ➝ 'up' | 'down'
+```
 
-- **`useDebounce`**: Delays updating the state until after a specified delay, useful for preventing frequent updates (e.g., handling user input).  
+---
 
-- **`useThrottle`**: Limits how often a value updates within a given time interval, useful for performance optimization.  
+### 📌 **useImageLoader**  
+Loads an image and provides `loaded` and `error` states to track its loading status.
 
-- **`usePrevious`**: Keeps track of the previous value of a state or prop.  
+```ts
+const { loaded, error } = useImageLoader('/logo.png');
+```
 
-- **`useMediaQuery`**: Checks if a media query matches the current viewport size and updates the state accordingly.  
+---
 
-- **`useClipboard`**: Copies text to the clipboard and provides a state to indicate if copying was successful.  
+### 📌 **usePersistedState**  
+Stores and retrieves state from `localStorage` to persist data across page reloads.
 
-- **`useInterval`**: Runs a callback function at a specified time interval and clears it when the delay is null or the component unmounts.  
+```ts
+const [theme, setTheme] = usePersistedState('theme', 'light');
+```
 
-- **`useWindowSize`**: Tracks the width and height of the browser window and updates when resized.  
+---
 
-- **`useKeyPress`**: Detects whether a specific key is being pressed or released.  
+### 📌 **useReducedMotion**  
+Detects if the user has enabled the "Reduce Motion" accessibility setting in their system preferences.  
 
-- **`useOnlineStatus`**: Monitors the user's network connection status (online/offline).  
+```ts
+const prefersReduced = useReducedMotion(); // ➝ true | false
+```
 
-- **`useScrollPosition`**: Tracks the horizontal (x) and vertical (y) scroll positions of the window.  
+---
 
-- **`useTimeout`**: Executes a function after a specified delay and cleans up automatically when dependencies change.  
+### 📌 **useCookie**  
+Manages cookies by providing functions to get, set, and delete a specific cookie by its key.
 
-- **`useDarkMode`**: Detects and toggles dark mode based on the user's system preference.  
+```ts
+const [token, setToken, deleteToken] = useCookie('token');
 
-- **`useForm`**: Manages form state, handles input changes, and performs validation using provided validators.  
+setToken('abc123');
+deleteToken();
+```
 
-- **`useArray<T>`**: Provides an array state with helper functions to manipulate it, including setting, adding, removing by index, and clearing elements.
+---
 
-- **`useStepper`**: Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
+### 📌 **useFetchRetry**  
+Performs an HTTP request with retry logic, retrying a specified number of times upon failure before returning an error.
 
-- **`useTimeoutFn`**: Executes a callback function after a specified delay and provides functions to reset or clear the timeout.  
+```ts
+const { data, loading, error } = useFetchRetry('/api/user', { method: 'GET' }, 3);
+```
 
-- **`useDebouncedCallback`**: Delays the execution of a callback function until after a specified delay, resetting the delay on each call to prevent frequent execution. 
+---
 
-- **`useScrollLock`**: Locks or unlocks scrolling on the webpage when the `lock` parameter changes.  
+### 📌 **useDelay**  
+Delays the update of a value for a specified amount of time before reflecting it in the state.
 
-- **`useResizeObserver<T>`**: Observes and returns the dimensions of an HTML element using the `ResizeObserver` API.  
+```ts
+const delayedValue = useDelay(value, 500);
+```
 
-- **`useMousePosition`**: Tracks the user's mouse position in real-time and returns the coordinates.  
+---
 
-- **`useScrollDirection`**: Determines whether the user is scrolling up or down based on window scroll position changes.  
+### 📌 **useVisibilityChange**  
+Tracks the visibility state of the document and returns whether the page is currently visible or hidden.
 
-- **`useImageLoader`**: Loads an image and provides `loaded` and `error` states to track its loading status.  
+```ts
+const isVisible = useVisibilityChange(); // ➝ true | false
+```
 
-- **`usePersistedState<T>`**: Stores and retrieves state from `localStorage` to persist data across page reloads.  
+---
 
-- **`useReducedMotion`**: Detects if the user has enabled the "Reduce Motion" accessibility setting in their system preferences.  
+### 📌 **useDebouncedValue**  
+ Debounces a value to avoid immediate changes, returning the delayed value after a specified delay.
 
-- **`useCookie`**: Manages cookies by providing functions to get, set, and delete a specific cookie by its key.
+```ts
+const debouncedSearch = useDebouncedValue(input, 300);
+```
 
-- **`useFetchRetry`**: Performs an HTTP request with retry logic, retrying a specified number of times upon failure before returning an error.
+---
 
-- **`useDelay`**: Delays the update of a value for a specified amount of time before reflecting it in the state.
+### 📌 **useAsync**  
+Handles the state of an asynchronous function, including loading, success, and error states, with the ability to trigger the execution of the async operation.
 
-- **`useVisibilityChange`**: Tracks the visibility state of the document and returns whether the page is currently visible or hidden.
+```ts
+const { execute, status, value, error } = useAsync(fetchUser);
 
-- **`useDebouncedValue`**: Debounces a value to avoid immediate changes, returning the delayed value after a specified delay.
+execute(); // ➝ runs the async function
+```
 
-- **`useAsync`**: Handles the state of an asynchronous function, including loading, success, and error states, with the ability to trigger the execution of the async operation.
+---
 
-- **`useScript`**: Dynamically loads an external script, managing its loading, ready, and error states, and optionally removes the script on unmount.
+### 📌 **useScript**  
+Dynamically loads an external script, managing its loading, ready, and error states, and optionally removes the script on unmount.
 
-- **`useReducedMotion`**: Detects if the user has enabled the "Reduce Motion" accessibility setting and returns a boolean indicating whether reduced motion is preferred.
+```ts
+const status = useScript('https://js.stripe.com/v3');
 
-- **`useIndexedDB`**: Fetches data from an IndexedDB store, handling errors and updating the state with the fetched data.
+// status ➝ 'loading' | 'ready' | 'error'
+```
+
+---
+
+### 📌 **useIndexedDB**  
+Fetches data from an IndexedDB store, handling errors and updating the state with the fetched data.
+
+```ts
+const { data, error } = useIndexedDB<MyType>('myDB', 'myStore');
+```
 
-- **`useGeoLocation`**: Retrieves the user's current geographic location and returns it along with any error encountered.
+---
 
-- **`useTimer`**: Starts a countdown timer that updates the time every second, returning the current time and any errors.
+### 📌 **useGeoLocation**  
+Retrieves the user's current geographic location and returns it along with any error encountered.
 
-- **`useIsMounted`**: Tracks whether the component is mounted or unmounted, returning a boolean value indicating the component's mount status.
+```ts
+const { position, error } = useGeoLocation();
+```
 
-- **`useCss`**: Dynamically applies custom CSS to the document and removes it when the component unmounts, handling any errors during the process.
+---
 
-- **`useSpeak`**: Converts text to speech using the Web Speech API, allowing the text to be spoken and handling errors.
+### 📌 **useTimer**  
+Starts a countdown timer that updates the time every second, returning the current time and any errors.
 
-- **`useCountUp`**: Animates a counter that counts up from 0 to a target value within a specified duration, returning the current count and any errors.
+```ts
+const { time, error } = useTimer(60); // starts from 60 and counts down
+```
 
-- **`useCountDown`**: Counts down from a specified start value to zero, updating every second and returning the current count and any errors.
+---
 
-- **`useBattery`**: Monitors the battery status of the device, including level, charging status, and remaining charging or discharging time.
+### 📌 **useIsMounted**  
+Tracks whether the component is mounted or unmounted, returning a boolean value indicating the component's mount status.
 
-- **`useEventListener`**: Listens for a specified event on an element or window, and triggers the handler function when the event is fired. It ensures proper cleanup when the component is unmounted.
+```ts
+const isMounted = useIsMounted();
+```
 
-- **`useHistory`**: Provides methods to navigate the browser history, including pushing and replacing history states, as well as moving back and forward in the history stack.
+---
 
-- **`usePreferredLanguage`**: Retrieves the user's preferred language and languages from the browser, and checks if the browser supports the language APIs.
+### 📌 **useCss**  
+Dynamically applies custom CSS to the document and removes it when the component unmounts, handling any errors during the process.
 
-- **`useSessionStorage`**: Stores and retrieves data from the `sessionStorage` API, persisting the data during the session. It provides a getter and setter for session-based data.
+```ts
+const { error } = useCss('body { background: #f5f5f5; }');
+```
 
-- **`useSound`**: Controls the playback of an audio file, including play, pause, and stop functionalities, while also managing the audio volume and handling any errors.
+---
 
-- **`useTouch`**: Tracks touch events on a given DOM element, returning the touch positions for `touchstart`, `touchmove`, and `touchend`.
+### 📌 **useSpeak**  
+Converts text to speech using the Web Speech API, allowing the text to be spoken and handling errors.
+```ts
+const { speak, error } = useSpeak('Hello world!');
+speak();
+```
 
-- **`useUpdateEffect`**: Executes a side effect on updates after the initial render, skipping the effect during the first render to avoid unnecessary executions.
+---
 
-- **`DynamicLoader`**: A Higher-Order Component (HOC) that dynamically loads a React component using `React.lazy()` with `Suspense`, while wrapping it in an `ErrorBoundary` to handle potential errors gracefully. It ensures that the component is loaded only when needed, reducing the initial bundle size and improving performance.
+### 📌 **useCountUp**  
+ Animates a counter that counts up from 0 to a target value within a specified duration, returning the current count and any errors.
+
+```ts
+const { count, error } = useCountUp(100, 5000); // counts up to 100 in 5s
+```
+
+---
+
+### 📌 **useCountDown**  
+Counts down from a specified start value to zero, updating every second and returning the current count and any errors.
+
+```ts
+const { count, error } = useCountDown(10); // counts down from 10
+```
+
+---
+
+### 📌 **useBattery**  
+ Monitors the battery status of the device, including level, charging status, and remaining charging or discharging time.
+
+```ts
+const { level, charging, supported, loading, chargingTime, dischargingTime } = useBattery();
+```
+
+---
+
+### 📌 **useEventListener**  
+Listens for a specified event on an element or window, and triggers the handler function when the event is fired. It ensures proper cleanup when the component is unmounted.
+
+```ts
+useEventListener('resize', (e) => {
+  console.log('Window resized');
+});
+```
+
+---
+
+### 📌 **useHistory**  
+ Provides methods to navigate the browser history, including pushing and replacing history states, as well as moving back and forward in the history stack.
+
+```ts
+const {
+  history,
+  state,
+  push,
+  replace,
+  goBack,
+  goForward
+} = useHistory();
+
+push('/about', { from: 'home' });
+replace('/profile');
+goBack();
+goForward();
+```
+
+---
+
+### 📌 **usePreferredLanguage**  
+Retrieves the user's preferred language and languages from the browser, and checks if the browser supports the language APIs.
+
+```ts
+const {
+  language,
+  languages,
+  isSupported
+} = usePreferredLanguage();
+
+console.log(language); // e.g., "en-US"
+```
+
+---
+
+### 📌 **useSessionStorage**  
+Stores and retrieves data from the `sessionStorage` API, persisting the data during the session. It provides a getter and setter for session-based data.
+
+```ts
+const [value, setValue] = useSessionStorage("myKey", "default");
+
+setValue("newValue");
+console.log(value);
+```
+
+---
+
+### 📌 **useSound**  
+Controls the playback of an audio file, including play, pause, and stop functionalities, while also managing the audio volume and handling any errors.
+
+```ts
+const {
+  play,
+  pause,
+  stop,
+  setVolume,
+  isPlaying,
+  error
+} = useSound("/sound.mp3");
+
+play();
+pause();
+stop();
+setVolume(0.5);
+```
+
+---
+
+### 📌 **useTouch**  
+Tracks touch events on a given DOM element, returning the touch positions for `touchstart`, `touchmove`, and `touchend`.
+
+```ts
+const ref = useRef(null);
+const {
+  touchStart,
+  touchMove,
+  touchEnd
+} = useTouch(ref);
+
+<div ref={ref}>Swipe here</div>
+```
+
+---
+
+### 📌 **useUpdateEffect**  
+Executes a side effect on updates after the initial render, skipping the effect during the first render to avoid unnecessary executions.
+
+```ts
+useUpdateEffect(() => {
+  console.log("This runs only on updates.");
+}, [value]);
+```
+
+###  **COMPONENTS** -------------------------------------------------------------------------------------------
+### ✅ **DynamicLoader**  
+A Higher-Order Component (HOC) that dynamically loads a React component using `React.lazy()` with `Suspense`, while wrapping it in an `ErrorBoundary` to handle potential errors gracefully. It ensures that the component is loaded only when needed, reducing the initial bundle size and improving performance.
+
+```ts
+import React, { lazy } from "react";
+const MyComponent = DynamicLoader(lazy(() => import("./MyComponent")));
+
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hook-toolkit",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Ultimate package for React developers, offering a powerful collection of hooks and components to enhance their development experience.",
   "main": "dist/index.js",
   "module": "dist/index.js",