react-hook-toolkit 1.0.15 → 1.0.16

package/README.md

@@ -1,7 +1,7 @@
 
 **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.
 
-**Note : This package is written in TypeScript and offers full support for all modern browsers.**
+**Note : This lightweight and type-safe package is written in TypeScript and offers full support for all hooks across all modern browsers.**
 
 ### Installation
 
@@ -23,12 +23,15 @@ pnpm add react-hook-toolkit
 
 ### **Authors**
 
-![NPM](https://img.shields.io/badge/Author-Shivaji_(React_Expert)_&_Shyamal_(JS_Expert)-red)   ![npm](https://img.shields.io/npm/v/react-hook-toolkit?color=1C939D)   ![npm](https://img.shields.io/npm/dt/react-hook-toolkit)   ![NPM](https://img.shields.io/npm/l/react-hook-toolkit)   ![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/react-hook-toolkit)
+![NPM](https://img.shields.io/badge/Author-NPM_Teams-red)   ![npm](https://img.shields.io/npm/v/react-hook-toolkit?color=1C939D)   ![npm](https://img.shields.io/npm/dt/react-hook-toolkit)   ![NPM](https://img.shields.io/npm/l/react-hook-toolkit)   ![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/react-hook-toolkit)
+
 
 ## Features  
 Here's the properly structured documentation with clear purpose explanations:
 
-----------------------------------------------------  **Custom Hooks**  ------------------------------------------------
+------------------------------------------ **Custom Hooks**  ------------------------------------------------
+
+### 🌐 **API / Async**
 
 📌 **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.
@@ -39,67 +42,30 @@ useEffect(() => {
   makeRequest('/users', 'GET');
 }, []);
 ```
-
-📌 **useDrawer**  
-A custom hook for managing application drawer state. It provides control over drawer visibility (`drawerOpen`) and active menu selection (`currentMainMenu`), with methods to toggle these states.
-
-```tsx
-const { 
-  drawerOpen, 
-  currentMainMenu,
-  openDrawer, 
-  closeDrawer,
-  setCurrentMainMenu 
-} = useDrawer();
-
-// Example usage:
-<button onClick={openDrawer}>Open Menu</button>
-<button onClick={() => setCurrentMainMenu('settings')}>
-  Show Settings
-</button>
-```
-
 ---
-
-  📌 **useAdvReducer**  
-A custom reducer function that takes an `initialState` and an object of actions, returning a new state based on the action type. 
+📌 **useFetch**  
+Provides an easy way to fetch data with hooks, managing loading, data, and error states.
 
 ```ts
-const reducer = useAdvReducer(initialState, {
-  increment: (state) => ({ count: state.count + 1 }),
-});
-const [state, dispatch] = useReducer(reducer, initialState);
+const { data, loading, error } = useFetch('/api/data');
 ```
-
 ---
-
-  📌 **useFetch**  
-Fetches data from a given URL and manages the loading, error, and data states.
+  📌 **useFetchRetry**  
+Performs an HTTP request with retry logic, retrying a specified number of times upon failure before returning an error.
 
 ```ts
-const { data, loading, error } = useFetch<User[]>('/api/users');
+const { data, loading, error } = useFetchRetry('/api/user', { method: 'GET' }, 3);
 ```
-
 ---
-
-  📌 **useLocalStorage**  
- A hook to persist state in `localStorage`. It initializes state from `localStorage` and updates it whenever the value changes.
+  📌 **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.
 
 ```ts
-const [token, setToken] = useLocalStorage('authToken', '');
-```
-
----
-
-  📌 **useToggle**  
-A simple boolean toggle hook that returns a state and a function to toggle its value.
+const { execute, status, value, error } = useAsync(fetchUser);
 
-```ts
-const [isOpen, toggle] = useToggle(false);
+execute(); // ➝ runs the async function
 ```
-
 ---
-
   📌 **useDebounce**  
 Delays updating the state until after a specified delay, useful for preventing frequent updates (e.g., handling user input).
 
@@ -108,44 +74,44 @@ const debouncedSearch = useDebounce(searchText, 500);
 ```
 
 ---
-
-  📌 **useThrottle**  
-Limits how often a value updates within a given time interval, useful for performance optimization.
+  📌 **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 throttledScroll = useThrottle(scrollValue, 300);
-```
+const debounced = useDebouncedCallback(() => search(input), 300);
 
+input.onChange = debounced;
+```
 ---
-
-  📌 **usePrevious**  
-Returns the previous value of a state or prop.
+📌 **useDebouncedValue**  
+Returns a debounced version of a value.
 
 ```ts
-const prevValue = usePrevious(currentValue);
+const debouncedValue = useDebouncedValue(value, 300);
 ```
-
 ---
-
-  📌 **useMediaQuery**  
-Checks if a media query matches the current viewport size and updates the state accordingly.
+  📌 **useThrottle**  
+Limits how often a value updates within a given time interval, useful for performance optimization.
 
 ```ts
-const isMobile = useMediaQuery('(max-width: 768px)');
+const throttledScroll = useThrottle(scrollValue, 300);
 ```
 
 ---
-
-  📌 **useClipboard**  
-Copies text to the clipboard and provides a state to indicate if copying was successful.
+  📌 **useDelay**  
+Delays the update of a value for a specified amount of time before reflecting it in the state.
 
 ```ts
-const [copied, copyToClipboard] = useClipboard();
-copyToClipboard('Text to copy');
+const delayedValue = useDelay(value, 500);
 ```
-
 ---
+  📌 **useTimer**  
+Starts a countdown timer that updates the time every second, returning the current time and any errors.
 
+```ts
+const { time, error } = useTimer(60); // starts from 60 and counts down
+```
+---
   📌 **useInterval**  
 Runs a callback function at a specified time interval and clears it when the delay is null or the component unmounts.
 
@@ -154,45 +120,7 @@ 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.
 
@@ -204,14 +132,7 @@ useTimeout(() => {
 
 ---
 
-  📌 **useDarkMode**  
-Detects and toggles dark mode based on the user's system preference.
-
-```ts
-const [isDarkMode, toggleDarkMode] = useDarkMode();
-```
-
----
+### 📝 **Form / Validation**
 
   📌 **useForm**  
 Manages form state, handles input changes, and performs validation using provided validators.
@@ -226,285 +147,315 @@ validate({
   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.
+📌 **useFormSubmit**  
+ Handles form submission with loading/error states and success callbacks.
 
 ```ts
-const { array, set, push, removeByIndex, clear } = useArray([1, 2, 3]);
+const { submit, isLoading, error } = useFormSubmit(apiCall, {
+  onSuccess: (data) => console.log('Saved!', data)
+});
 
-push(4);            // ➝ [1, 2, 3, 4]
-removeByIndex(1);   // ➝ [1, 3, 4]
-clear();            // ➝ []
+// Example
+submit(formData);
 ```
-
 ---
-
-  📌 **useStepper**  
-Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
+📌 **useSmartForm**  
+ Complete form management with validation, submission, and state handling.
 
 ```ts
-const { activeStep, handleNext, handleBack, handleReset, isFirstStep, isLastStep } = useStepper(5);
+const { register, handleSubmit, errors } = useSmartForm({
+  initialValues,
+  validationSchema,
+  onSubmit: (data) => console.log(data)
+});
 
-handleNext(); // ➝ advances step
-handleBack(); // ➝ goes back
-handleReset(); // ➝ step 0
+// Example
+<input {...register('email') />
+<button onClick={handleSubmit}>Save</button>
 ```
-
 ---
-
-  📌 **useTimeoutFn**  
-Executes a callback function after a specified delay and provides functions to reset or clear the timeout.  
+📌 **useCrossFieldValidation**  
+ Handles complex validation rules that depend on multiple fields.
 
 ```ts
-const { reset, clear } = useTimeoutFn(() => doSomething(), 1000);
+const { errors, validate } = useCrossFieldValidation({
+  rules: {
+    password: (val, { confirmPassword }) => val === confirmPassword,
+  },
+  initialValues
+});
 
-reset(); // ➝ restarts timeout
-clear(); // ➝ clears timeout
+// Example
+validate('password', 'secret123', { confirmPassword: 'secret123' });
 ```
 
 ---
 
-  📌 **useDebouncedCallback**  
-Delays the execution of a callback function until after a specified delay, resetting the delay on each call to prevent frequent execution.
+📌 **useFieldArray**  
+ Manages dynamic arrays of form fields with add/remove/reorder operations.
 
 ```ts
-const debounced = useDebouncedCallback(() => search(input), 300);
+const { fields, append, remove, move } = useFieldArray(initialItems);
 
-input.onChange = debounced;
+// Example
+append({ name: '', email: '' });
+remove(0); // Remove first item
+move(1, 0); // Move second item to first position
 ```
-
 ---
-
-  📌 **useScrollLock**  
-Locks or unlocks scrolling on the webpage when the `lock` parameter changes.
+📌 **useFormWizard**  
+ Manages multi-step forms with navigation between steps.
 
 ```ts
-useScrollLock(true); // ➝ disables body scroll
+const { currentStep, next, prev, goto } = useFormWizard(steps.length);
+
+// Example
+next(); // Move to next step
+goto(3); // Jump to step 4
 ```
 
 ---
-
-  📌 **useResizeObserver**  
-Observes and returns the dimensions of an HTML element using the `ResizeObserver` API.
+ 📌 **usePersistedForm**  
+ Automatically persists form state to localStorage/sessionStorage and restores it on page reload.
 
 ```ts
-const size = useResizeObserver(ref);
+const { values, setField, reset } = usePersistedForm('form-key', initialValues);
 
-// size = { width: 200, height: 100 }
+// Example
+setField('username', 'john_doe'); // Auto-saves to storage
+reset(); // Clears storage
 ```
 
+
 ---
 
-  📌 **useMousePosition**  
-Tracks the user's mouse position in real-time and returns the coordinates. 
+### 🎯 **Event / Interaction**
+
+  📌 **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 { x, y } = useMousePosition();
+useEventListener('resize', (e) => {
+  console.log('Window resized');
+});
 ```
-
 ---
-
-  📌 **useScrollDirection**  
-Determines whether the user is scrolling up or down based on window scroll position changes.
+📌 **useEventListeners**  
+ Simplifies adding/removing event listeners.
 
 ```ts
-const direction = useScrollDirection(); // ➝ 'up' | 'down'
-```
+useEventListeners({
+  click: handleClick,
+  resize: handleResize
+});
 
+// Example
+useEventListeners({
+  keydown: (e) => console.log(e.key)
+});
+```
 ---
-
-  📌 **useImageLoader**  
-Loads an image and provides `loaded` and `error` states to track its loading status.
+  📌 **useKeyPress**  
+Detects whether a specific key is being pressed or released.
 
 ```ts
-const { loaded, error } = useImageLoader('/logo.png');
+const isEnterPressed = useKeyPress('Enter');
 ```
-
 ---
-
-  📌 **usePersistedState**  
-Stores and retrieves state from `localStorage` to persist data across page reloads.
+📌 **useLongPress**  
+ Detects long press gestures.
 
 ```ts
-const [theme, setTheme] = usePersistedState('theme', 'light');
-```
+const handlers = useLongPress(() => console.log('Long pressed!'), {
+  threshold: 1000
+});
 
+// Example
+<button {...handlers}>Hold me</button>
+```
 ---
-
-  📌 **useReducedMotion**  
-Detects if the user has enabled the "Reduce Motion" accessibility setting in their system preferences.  
+  📌 **useTouch**  
+Tracks touch events on a given DOM element, returning the touch positions for `touchstart`, `touchmove`, and `touchend`.
 
 ```ts
-const prefersReduced = useReducedMotion(); // ➝ true | false
-```
+const ref = useRef(null);
+const {
+  touchStart,
+  touchMove,
+  touchEnd
+} = useTouch(ref);
 
+<div ref={ref}>Swipe here</div>
+```
 ---
-
-  📌 **useCookie**  
-Manages cookies by providing functions to get, set, and delete a specific cookie by its key.
+📌 **useIdle**  
+ Detects when user becomes inactive.
 
 ```ts
-const [token, setToken, deleteToken] = useCookie('token');
+const isIdle = useIdle(30000); // 30s timeout
 
-setToken('abc123');
-deleteToken();
+// Example
+{isIdle && <ScreenSaver />}
 ```
-
 ---
-
-  📌 **useFetchRetry**  
-Performs an HTTP request with retry logic, retrying a specified number of times upon failure before returning an error.
+📌 **useDragReorder**  
+ Enables drag-and-drop reordering of lists.
 
 ```ts
-const { data, loading, error } = useFetchRetry('/api/user', { method: 'GET' }, 3);
-```
-
----
-
-  📌 **useDelay**  
-Delays the update of a value for a specified amount of time before reflecting it in the state.
+const { items, dragStart, dragOver, drop } = useDragReorder(initialItems);
 
-```ts
-const delayedValue = useDelay(value, 500);
+// Example
+<div 
+  draggable 
+  onDragStart={() => dragStart(index)}
+  onDragOver={() => dragOver(index)}
+  onDrop={drop}
+/>
 ```
 
 ---
 
-  📌 **useVisibilityChange**  
-Tracks the visibility state of the document and returns whether the page is currently visible or hidden.
-
-```ts
-const isVisible = useVisibilityChange(); // ➝ true | false
-```
+### 📦 **State / Logic**
 
----
 
-  📌 **useDebouncedValue**  
- Debounces a value to avoid immediate changes, returning the delayed value after a specified delay.
+  📌 **useToggle**  
+A simple boolean toggle hook that returns a state and a function to toggle its value.
 
 ```ts
-const debouncedSearch = useDebouncedValue(input, 300);
+const [isOpen, toggle] = useToggle(false);
 ```
-
 ---
-
-  📌 **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.
+  📌 **useArray**
+Provides an array state with helper functions to manipulate it, including setting, adding, removing by index, and clearing elements.
 
 ```ts
-const { execute, status, value, error } = useAsync(fetchUser);
+const { array, set, push, removeByIndex, clear } = useArray([1, 2, 3]);
 
-execute(); // ➝ runs the async function
+push(4);            // ➝ [1, 2, 3, 4]
+removeByIndex(1);   // ➝ [1, 3, 4]
+clear();            // ➝ []
 ```
-
 ---
-
-  📌 **useScript**  
-Dynamically loads an external script, managing its loading, ready, and error states, and optionally removes the script on unmount.
+  📌 **useStepper**  
+Manages step-based navigation by keeping track of the current step index and providing functions to move forward, backward, and reset.
 
 ```ts
-const status = useScript('https://js.stripe.com/v3');
+const { activeStep, handleNext, handleBack, handleReset, isFirstStep, isLastStep } = useStepper(5);
 
-// status ➝ 'loading' | 'ready' | 'error'
+handleNext(); // ➝ advances step
+handleBack(); // ➝ goes back
+handleReset(); // ➝ step 0
 ```
 
 ---
-
-  📌 **useIndexedDB**  
-Fetches data from an IndexedDB store, handling errors and updating the state with the fetched data.
+📌 **useUndo**  
+ Provides undo/redo functionality for state changes.
 
 ```ts
-const { data, error } = useIndexedDB<MyType>('myDB', 'myStore');
-```
-
----
-
-  📌 **useGeoLocation**  
-Retrieves the user's current geographic location and returns it along with any error encountered.
+const { state, setState, undo, redo } = useUndo(initialState);
 
-```ts
-const { position, error } = useGeoLocation();
+// Example
+setState({ items: [...] });
+undo(); // Reverts to previous state
 ```
-
 ---
-
-  📌 **useTimer**  
-Starts a countdown timer that updates the time every second, returning the current time and any errors.
+  📌 **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 { time, error } = useTimer(60); // starts from 60 and counts down
+const reducer = useAdvReducer(initialState, {
+  increment: (state) => ({ count: state.count + 1 }),
+});
+const [state, dispatch] = useReducer(reducer, initialState);
 ```
-
 ---
-
   📌 **useIsMounted**  
 Tracks whether the component is mounted or unmounted, returning a boolean value indicating the component's mount status.
 
 ```ts
 const isMounted = useIsMounted();
 ```
-
 ---
-
-  📌 **useCss**  
-Dynamically applies custom CSS to the document and removes it when the component unmounts, handling any errors during the process.
+📌 **useIsFirstRender**  
+ Returns true only on component's first render.
 
 ```ts
-const { error } = useCss('body { background: #f5f5f5; }');
-```
+const isFirst = useIsFirstRender();
 
+// Example
+useEffect(() => {
+  if (!isFirst) console.log('Updated!');
+}, [deps]);
+```
 ---
+📌 **usePrevious**  
+Tracks the previous value of a state or prop.
 
-  📌 **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();
+const previousValue = usePrevious(currentValue);
 ```
+---
+  📌 **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]);
+```
 ---
 
-  📌 **useCountUp**  
- Animates a counter that counts up from 0 to a target value within a specified duration, returning the current count and any errors.
+📌 **useList**  
+ Manages array state with utility methods.
 
 ```ts
-const { count, error } = useCountUp(100, 5000); // counts up to 100 in 5s
+const { list, push, remove, update } = useList(initialItems);
+
+// Example
+push(newItem);
+remove(0); // Remove first item
 ```
 
 ---
 
-  📌 **useCountDown**  
-Counts down from a specified start value to zero, updating every second and returning the current count and any errors.
+### 🧭 **Browser / Storage**
+
+  📌 **useLocalStorage**  
+ A hook to persist state in `localStorage`. It initializes state from `localStorage` and updates it whenever the value changes.
 
 ```ts
-const { count, error } = useCountDown(10); // counts down from 10
+const [token, setToken] = useLocalStorage('authToken', '');
 ```
-
 ---
-
-  📌 **useBattery**  
- Monitors the battery status of the device, including level, charging status, and remaining charging or discharging time.
+  📌 **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 { level, charging, supported, loading, chargingTime, dischargingTime } = useBattery();
+const [value, setValue] = useSessionStorage("myKey", "default");
+
+setValue("newValue");
+console.log(value);
 ```
 
 ---
-
-  📌 **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.
+  📌 **useCookie**  
+Manages cookies by providing functions to get, set, and delete a specific cookie by its key.
 
 ```ts
-useEventListener('resize', (e) => {
-  console.log('Window resized');
-});
-```
+const [token, setToken, deleteToken] = useCookie('token');
 
+setToken('abc123');
+deleteToken();
+```
 ---
+  📌 **usePersistedState**  
+Stores and retrieves state from `localStorage` to persist data across page reloads.
 
+```ts
+const [theme, setTheme] = usePersistedState('theme', 'light');
+```
+---
   📌 **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.
 
@@ -525,332 +476,217 @@ goForward();
 ```
 
 ---
-
-  📌 **usePreferredLanguage**  
-Retrieves the user's preferred language and languages from the browser, and checks if the browser supports the language APIs.
+📌 **useHistoryState**  
+ Manages state history with undo/redo capabilities.
 
 ```ts
-const {
-  language,
-  languages,
-  isSupported
-} = usePreferredLanguage();
+const { state, setState, undo, redo } = useHistoryState(initialState);
 
-console.log(language); // e.g., "en-US"
+// Example
+setState({...});
+undo(); // Reverts change
 ```
-
 ---
-
-  📌 **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.
+  📌 **useVisibilityChange**  
+Tracks the visibility state of the document and returns whether the page is currently visible or hidden.
 
 ```ts
-const [value, setValue] = useSessionStorage("myKey", "default");
-
-setValue("newValue");
-console.log(value);
+const isVisible = useVisibilityChange(); // ➝ true | false
 ```
-
 ---
-
-  📌 **useSound**  
-Controls the playback of an audio file, including play, pause, and stop functionalities, while also managing the audio volume and handling any errors.
+📌 **useDarkMode**  
+Detects and manages dark mode preferences in the browser.
 
 ```ts
-const {
-  play,
-  pause,
-  stop,
-  setVolume,
-  isPlaying,
-  error
-} = useSound("/sound.mp3");
-
-play();
-pause();
-stop();
-setVolume(0.5);
+const [isDarkMode, toggleDarkMode] = useDarkMode();
 ```
-
 ---
-
-  📌 **useTouch**  
-Tracks touch events on a given DOM element, returning the touch positions for `touchstart`, `touchmove`, and `touchend`.
+📌 **usePreferredLanguage**  
+Detects the preferred language set in the browser.
 
 ```ts
-const ref = useRef(null);
-const {
-  touchStart,
-  touchMove,
-  touchEnd
-} = useTouch(ref);
-
-<div ref={ref}>Swipe here</div>
+const language = usePreferredLanguage();
 ```
-
 ---
-
-  📌 **useUpdateEffect**  
-Executes a side effect on updates after the initial render, skipping the effect during the first render to avoid unnecessary executions.
+📌 **useIndexedDB**  
+Provides a hook to interact with IndexedDB in the browser, enabling persistent client-side storage.
 
 ```ts
-useUpdateEffect(() => {
-  console.log("This runs only on updates.");
-}, [value]);
+const { data, setData } = useIndexedDB('dbName');
 ```
-
 ---
 
- 📌 **usePersistedForm**  
- Automatically persists form state to localStorage/sessionStorage and restores it on page reload.
+### 🧱 **DOM / UI**
 
-```ts
-const { values, setField, reset } = usePersistedForm('form-key', initialValues);
+📌 **useMediaQuery**  
+Checks if a media query condition matches the current viewport, useful for responsive design.
 
-// Example
-setField('username', 'john_doe'); // Auto-saves to storage
-reset(); // Clears storage
+```ts
+const isMobile = useMediaQuery('(max-width: 768px)');
 ```
-
 ---
-
-📌 **useCrossFieldValidation**  
- Handles complex validation rules that depend on multiple fields.
+📌 **useWindowSize**  
+Returns the current window size (width and height).
 
 ```ts
-const { errors, validate } = useCrossFieldValidation({
-  rules: {
-    password: (val, { confirmPassword }) => val === confirmPassword,
-  },
-  initialValues
-});
-
-// Example
-validate('password', 'secret123', { confirmPassword: 'secret123' });
+const { width, height } = useWindowSize();
 ```
-
 ---
-
-📌 **useFieldArray**  
- Manages dynamic arrays of form fields with add/remove/reorder operations.
+  📌 **useResizeObserver**  
+Observes and returns the dimensions of an HTML element using the `ResizeObserver` API.
 
 ```ts
-const { fields, append, remove, move } = useFieldArray(initialItems);
+const size = useResizeObserver(ref);
 
-// Example
-append({ name: '', email: '' });
-remove(0); // Remove first item
-move(1, 0); // Move second item to first position
+// size = { width: 200, height: 100 }
 ```
-
 ---
-
-📌 **useFormSubmit**  
- Handles form submission with loading/error states and success callbacks.
+  📌 **useScrollPosition**  
+Tracks the horizontal (x) and vertical (y) scroll positions of the window.
 
 ```ts
-const { submit, isLoading, error } = useFormSubmit(apiCall, {
-  onSuccess: (data) => console.log('Saved!', data)
-});
-
-// Example
-submit(formData);
+const { x, y } = useScrollPosition();
 ```
-
 ---
-
-📌 **useSmartForm**  
- Complete form management with validation, submission, and state handling.
+  📌 **useScrollDirection**  
+Determines whether the user is scrolling up or down based on window scroll position changes.
 
 ```ts
-const { register, handleSubmit, errors } = useSmartForm({
-  initialValues,
-  validationSchema,
-  onSubmit: (data) => console.log(data)
-});
-
-// Example
-<input {...register('email') />
-<button onClick={handleSubmit}>Save</button>
+const direction = useScrollDirection(); // ➝ 'up' | 'down'
 ```
 
----
-
-📌 **useUndo**  
- Provides undo/redo functionality for state changes.
+📌 **useScrollLock**  
+Locks or unlocks scrolling on the page.
 
 ```ts
-const { state, setState, undo, redo } = useUndo(initialState);
-
-// Example
-setState({ items: [...] });
-undo(); // Reverts to previous state
+useScrollLock(true); // Lock scrolling
+useScrollLock(false); // Unlock scrolling
 ```
-
 ---
-
-📌 **useFormWizard**  
- Manages multi-step forms with navigation between steps.
+📌 **useLockBodyScroll**  
+Prevents scrolling on the body element, useful for modals or off-canvas menus.
 
 ```ts
-const { currentStep, next, prev, goto } = useFormWizard(steps.length);
-
-// Example
-next(); // Move to next step
-goto(3); // Jump to step 4
+useLockBodyScroll(true);
 ```
-
 ---
-
-📌 **useWebSocket**  
- Manages WebSocket connections with auto-reconnect.
+📌 **useCss**  
+Allows injecting dynamic CSS rules into the document.
 
 ```ts
-const { send, message, status } = useWebSocket('ws://api.example.com');
-
-// Example
-send(JSON.stringify({ action: 'ping' }));
+useCss('.class { color: red; }');
 ```
-
 ---
-
-📌 **useDragReorder**  
- Enables drag-and-drop reordering of lists.
+📌 **useReducedMotion**  
+Detects whether the user has reduced motion settings in their OS preferences.
 
 ```ts
-const { items, dragStart, dragOver, drop } = useDragReorder(initialItems);
-
-// Example
-<div 
-  draggable 
-  onDragStart={() => dragStart(index)}
-  onDragOver={() => dragOver(index)}
-  onDrop={drop}
-/>
+const prefersReducedMotion = useReducedMotion();
 ```
-
 ---
-
-📌 **useInfiniteScroll**  
- Implements infinite scroll pagination.
+📌 **useImageLoader**  
+Provides a way to load and display images in a way that improves performance and loading behavior.
 
 ```ts
-const { items, loadMore, isLoading } = useInfiniteScroll(fetchCallback);
-
-// Example
-<div onScroll={loadMore}>...</div>
+const { isLoading, image } = useImageLoader('imageURL');
 ```
 
 ---
 
-📌 **useEventListeners**  
- Simplifies adding/removing event listeners.
+### 📱 **Device / Sensors**
 
-```ts
-useEventListeners({
-  click: handleClick,
-  resize: handleResize
-});
+  📌 **useBattery**  
+ Monitors the battery status of the device, including level, charging status, and remaining charging or discharging time.
 
-// Example
-useEventListeners({
-  keydown: (e) => console.log(e.key)
-});
+```ts
+const { level, charging, supported, loading, chargingTime, dischargingTime } = useBattery();
 ```
-
 ---
-
-📌 **useHistoryState**  
- Manages state history with undo/redo capabilities.
+  📌 **useGeoLocation**  
+Retrieves the user's current geographic location and returns it along with any error encountered.
 
 ```ts
-const { state, setState, undo, redo } = useHistoryState(initialState);
-
-// Example
-setState({...});
-undo(); // Reverts change
+const { position, error } = useGeoLocation();
 ```
-
 ---
-
-📌 **useIdle**  
- Detects when user becomes inactive.
+  📌 **useMousePosition**  
+Tracks the user's mouse position in real-time and returns the coordinates. 
 
 ```ts
-const isIdle = useIdle(30000); // 30s timeout
-
-// Example
-{isIdle && <ScreenSaver />}
+const { x, y } = useMousePosition();
 ```
 
 ---
-
-📌 **useIsFirstRender**  
- Returns true only on component's first render.
+  📌 **useOnlineStatus**  
+Monitors the user's network connection status (online/offline).
 
 ```ts
-const isFirst = useIsFirstRender();
-
-// Example
-useEffect(() => {
-  if (!isFirst) console.log('Updated!');
-}, [deps]);
+const isOnline = useOnlineStatus();
 ```
 
 ---
 
-📌 **useList**  
- Manages array state with utility methods.
+### 🎵 **Media / Audio / Visual**
+
+  📌 **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 { list, push, remove, update } = useList(initialItems);
+const {
+  play,
+  pause,
+  stop,
+  setVolume,
+  isPlaying,
+  error
+} = useSound("/sound.mp3");
 
-// Example
-push(newItem);
-remove(0); // Remove first item
+play();
+pause();
+stop();
+setVolume(0.5);
 ```
-
 ---
-
-📌 **useLockBodyScroll**  
- Locks scrolling on the document body.
-
+  📌 **useSpeak**  
+Converts text to speech using the Web Speech API, allowing the text to be spoken and handling errors.
 ```ts
-useLockBodyScroll(true); // Enable lock
+const { speak, error } = useSpeak('Hello world!');
+speak();
+```
+---
+  📌 **useCountUp**  
+ Animates a counter that counts up from 0 to a target value within a specified duration, returning the current count and any errors.
 
-// Example
-useLockBodyScroll(modalIsOpen);
+```ts
+const { count, error } = useCountUp(100, 5000); // counts up to 100 in 5s
 ```
 
 ---
-
-📌 **useLongPress**  
- Detects long press gestures.
+  📌 **useCountDown**  
+Counts down from a specified start value to zero, updating every second and returning the current count and any errors.
 
 ```ts
-const handlers = useLongPress(() => console.log('Long pressed!'), {
-  threshold: 1000
-});
-
-// Example
-<button {...handlers}>Hold me</button>
+const { count, error } = useCountDown(10); // counts down from 10
 ```
 
 ---
 
-📌 **createOptimizedContext**  
- Creates optimized React context with selector support.
+### 🔄 **Networking / Real-time**
+
+📌 **useWebSocket**  
+ Manages WebSocket connections with auto-reconnect.
 
 ```ts
-const { Provider, useStore } = createOptimizedContext(initialState);
+const { send, message, status } = useWebSocket('ws://api.example.com');
 
 // Example
-const user = useStore(state => state.user);
+send(JSON.stringify({ action: 'ping' }));
 ```
-
 ---
 
------------------------------------------------- **Custom Components** --------------------------------------------
+Let me know if you'd like more information or changes!
+
+------------------------------------- **Custom 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.
@@ -1006,4 +842,4 @@ Displays a skeleton placeholder for a pie chart inside a card layout. Includes a
 
   **License** 
 
-[MIT](https://opensource.org/licenses)
+[MIT](https://www.npmjs.com/products/teams) © (2022-2024)

package/dist/hooks/chunk940514.d.ts

@@ -69,6 +69,19 @@ export declare const useStepper: (totalSteps: number) => {
     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;

package/dist/hooks/chunk940514.js

@@ -431,6 +431,14 @@ export var useStepper = function (totalSteps) {
     var handleReset = function () {
         setActiveStep(0);
     };
+    var goto = function (step) {
+        if (step >= 0 && step < totalSteps) {
+            setActiveStep(step);
+        }
+        else {
+            console.warn("Step ".concat(step, " is out of bounds (0-").concat(totalSteps - 1, ")"));
+        }
+    };
     return {
         activeStep: activeStep,
         handleNext: handleNext,
@@ -441,6 +449,44 @@ export var useStepper = function (totalSteps) {
         isLastStep: activeStep === totalSteps - 1,
         isProccesing: isProccesing,
         setIsProccesing: setIsProccesing,
+        goto: goto
+    };
+};
+export var useSteps = function (totalSteps) {
+    var _a = useState(0), activeStep = _a[0], setActiveStep = _a[1];
+    var _b = useState(false), isProcessing = _b[0], setIsProcessing = _b[1];
+    var handleNext = function () {
+        if (activeStep < totalSteps - 1) {
+            setActiveStep(function (prev) { return prev + 1; });
+        }
+    };
+    var handleBack = function () {
+        if (activeStep > 0) {
+            setActiveStep(function (prev) { return prev - 1; });
+        }
+    };
+    var handleReset = function () {
+        setActiveStep(0);
+    };
+    var goto = function (step) {
+        if (step >= 0 && step < totalSteps) {
+            setActiveStep(step);
+        }
+        else {
+            console.warn("Step ".concat(step, " is out of bounds (0-").concat(totalSteps - 1, ")"));
+        }
+    };
+    return {
+        activeStep: activeStep,
+        handleNext: handleNext,
+        handleBack: handleBack,
+        handleReset: handleReset,
+        goto: goto,
+        totalSteps: totalSteps,
+        isFirstStep: activeStep === 0,
+        isLastStep: activeStep === totalSteps - 1,
+        isProcessing: isProcessing,
+        setIsProcessing: setIsProcessing,
     };
 };
 export function useTimeoutFn(callback, delay) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hook-toolkit",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "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",