@arkyn/components 3.0.1-beta.143 → 3.0.1-beta.145

package/dist/hooks/useScopedParams.d.ts

@@ -1,84 +1,32 @@
 type ParamsType = Record<string, string | number | boolean | undefined>;
 /**
- * Utility function to manage URL search parameters with optional scoping.
- * Provides functionality to get parameters and generate updated search strings
- * while maintaining existing parameters.
+ * useScopedParams — reads and writes URL search parameters with an optional namespace prefix.
  *
- * @param searchString - The current URL search parameters string (e.g., "page=1&filter=active")
- * @param scope - Optional scope prefix for parameters. When provided, parameters will be prefixed with "scope:". Default: ""
+ * When `scope` is provided, every key is namespaced as `scope:key`, so multiple features
+ * can share the same URL without collisions (e.g. `filters:status` and `table:page`).
  *
- * @returns Object containing parameter management functions:
- * @returns getParam - Function to get a parameter value by key (considers scope if provided)
- * @returns getScopedSearch - Function to generate search string with updated parameters while preserving existing ones
+ * @param searchString - Current URL search string (e.g. `location.search`).
+ * @param scope - Namespace prefix. Default: `""` (no prefix).
  *
- * @example
- * ```tsx
- * // Basic usage without scope
- * const searchString = "page=1&filter=active";
- * const { getParam, getScopedSearch } = useScopedParams(searchString);
- *
- * // Get a parameter value
- * const page = getParam('page'); // Returns "1"
- * const filter = getParam('filter'); // Returns "active"
- *
- * // Generate search string with new/updated parameters
- * const newSearch = getScopedSearch({ page: 2, sort: 'name' });
- * // Result: "?page=2&filter=active&sort=name"
- * ```
+ * @returns
+ * - `getParam(key)` — returns the (scoped) param value, or `null` if absent.
+ * - `getScopedSearch(params)` — merges `params` into the existing search string and returns the result.
+ *   Pass `undefined` as a value to delete that param.
  *
  * @example
  * ```tsx
- * // Usage with scope
- * const searchString = "filters:status=active&filters:category=tech&page=1";
- * const { getParam, getScopedSearch } = useScopedParams(searchString, 'filters');
- *
- * // Get a scoped parameter value
- * const status = getParam('status'); // Gets 'filters:status' from URL, returns "active"
- * const category = getParam('category'); // Gets 'filters:category' from URL, returns "tech"
- *
- * // Generate search string with scoped parameters
- * const newSearch = getScopedSearch({
- *   status: 'inactive',
- *   category: 'sports',
- *   price: 100,
- *   discount: undefined // This will remove 'filters:discount' from URL if it exists
- * });
- * // Result: "?filters:status=inactive&filters:category=sports&filters:price=100&page=1"
+ * // Without scope — plain key/value params
+ * const { getParam, getScopedSearch } = useScopedParams(location.search);
+ * getParam('page');                          // "1"
+ * getScopedSearch({ page: 2, sort: 'name' }); // "?page=2&sort=name"
  * ```
  *
  * @example
  * ```tsx
- * // Real-world usage with React Router
- * import { useLocation, useNavigate } from 'react-router-dom';
- *
- * function ProductFilter() {
- *   const location = useLocation();
- *   const navigate = useNavigate();
- *   const { getParam, getScopedSearch } = useScopedParams(location.search, 'product');
- *
- *   const handleFilterChange = (newFilters: Record<string, any>) => {
- *     const searchString = getScopedSearch(newFilters);
- *     navigate({ search: searchString });
- *   };
- *
- *   const currentCategory = getParam('category');
- *   const currentPrice = getParam('price');
- *
- *   return (
- *     <div>
- *       <p>Current category: {currentCategory || 'All'}</p>
- *       <p>Current price filter: {currentPrice || 'None'}</p>
- *
- *       <button onClick={() => handleFilterChange({ category: 'electronics' })}>
- *         Electronics
- *       </button>
- *
- *       <button onClick={() => handleFilterChange({ category: undefined, price: undefined })}>
- *         Clear Filters
- *       </button>
- *     </div>
- *   );
- * }
+ * // With scope — all keys prefixed as "filters:key"
+ * const { getParam, getScopedSearch } = useScopedParams(location.search, 'filters');
+ * getParam('status');                                       // reads "filters:status"
+ * getScopedSearch({ status: 'active', category: undefined }); // removes "filters:category"
  * ```
  */
 declare function useScopedParams(searchString: string, scope?: string): {

package/dist/hooks/useScopedParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useScopedParams.d.ts","sourceRoot":"","sources":["../../src/hooks/useScopedParams.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AAEH,iBAAS,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;oBAe7C,MAAM;8BACI,UAAU;EAOvC;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"useScopedParams.d.ts","sourceRoot":"","sources":["../../src/hooks/useScopedParams.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iBAAS,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;oBAe7C,MAAM;8BACI,UAAU;EAOvC;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/hooks/useScopedParams.js

@@ -1,83 +1,31 @@
 /**
- * Utility function to manage URL search parameters with optional scoping.
- * Provides functionality to get parameters and generate updated search strings
- * while maintaining existing parameters.
+ * useScopedParams — reads and writes URL search parameters with an optional namespace prefix.
  *
- * @param searchString - The current URL search parameters string (e.g., "page=1&filter=active")
- * @param scope - Optional scope prefix for parameters. When provided, parameters will be prefixed with "scope:". Default: ""
+ * When `scope` is provided, every key is namespaced as `scope:key`, so multiple features
+ * can share the same URL without collisions (e.g. `filters:status` and `table:page`).
  *
- * @returns Object containing parameter management functions:
- * @returns getParam - Function to get a parameter value by key (considers scope if provided)
- * @returns getScopedSearch - Function to generate search string with updated parameters while preserving existing ones
+ * @param searchString - Current URL search string (e.g. `location.search`).
+ * @param scope - Namespace prefix. Default: `""` (no prefix).
  *
- * @example
- * ```tsx
- * // Basic usage without scope
- * const searchString = "page=1&filter=active";
- * const { getParam, getScopedSearch } = useScopedParams(searchString);
- *
- * // Get a parameter value
- * const page = getParam('page'); // Returns "1"
- * const filter = getParam('filter'); // Returns "active"
- *
- * // Generate search string with new/updated parameters
- * const newSearch = getScopedSearch({ page: 2, sort: 'name' });
- * // Result: "?page=2&filter=active&sort=name"
- * ```
+ * @returns
+ * - `getParam(key)` — returns the (scoped) param value, or `null` if absent.
+ * - `getScopedSearch(params)` — merges `params` into the existing search string and returns the result.
+ *   Pass `undefined` as a value to delete that param.
  *
  * @example
  * ```tsx
- * // Usage with scope
- * const searchString = "filters:status=active&filters:category=tech&page=1";
- * const { getParam, getScopedSearch } = useScopedParams(searchString, 'filters');
- *
- * // Get a scoped parameter value
- * const status = getParam('status'); // Gets 'filters:status' from URL, returns "active"
- * const category = getParam('category'); // Gets 'filters:category' from URL, returns "tech"
- *
- * // Generate search string with scoped parameters
- * const newSearch = getScopedSearch({
- *   status: 'inactive',
- *   category: 'sports',
- *   price: 100,
- *   discount: undefined // This will remove 'filters:discount' from URL if it exists
- * });
- * // Result: "?filters:status=inactive&filters:category=sports&filters:price=100&page=1"
+ * // Without scope — plain key/value params
+ * const { getParam, getScopedSearch } = useScopedParams(location.search);
+ * getParam('page');                          // "1"
+ * getScopedSearch({ page: 2, sort: 'name' }); // "?page=2&sort=name"
  * ```
  *
  * @example
  * ```tsx
- * // Real-world usage with React Router
- * import { useLocation, useNavigate } from 'react-router-dom';
- *
- * function ProductFilter() {
- *   const location = useLocation();
- *   const navigate = useNavigate();
- *   const { getParam, getScopedSearch } = useScopedParams(location.search, 'product');
- *
- *   const handleFilterChange = (newFilters: Record<string, any>) => {
- *     const searchString = getScopedSearch(newFilters);
- *     navigate({ search: searchString });
- *   };
- *
- *   const currentCategory = getParam('category');
- *   const currentPrice = getParam('price');
- *
- *   return (
- *     <div>
- *       <p>Current category: {currentCategory || 'All'}</p>
- *       <p>Current price filter: {currentPrice || 'None'}</p>
- *
- *       <button onClick={() => handleFilterChange({ category: 'electronics' })}>
- *         Electronics
- *       </button>
- *
- *       <button onClick={() => handleFilterChange({ category: undefined, price: undefined })}>
- *         Clear Filters
- *       </button>
- *     </div>
- *   );
- * }
+ * // With scope — all keys prefixed as "filters:key"
+ * const { getParam, getScopedSearch } = useScopedParams(location.search, 'filters');
+ * getParam('status');                                       // reads "filters:status"
+ * getScopedSearch({ status: 'active', category: undefined }); // removes "filters:category"
  * ```
  */
 function useScopedParams(searchString, scope = "") {

package/dist/hooks/useScrollLock.d.ts

@@ -1,36 +1,20 @@
 /**
- * useScrollLock hook - manages body scroll blocking for overlays
+ * useScrollLock — locks `document.body` scroll while an overlay is open.
  *
- * @param isLocked - Whether the body scroll should be locked
+ * Compensates for the scrollbar width by adding equivalent `paddingRight`,
+ * preventing layout shift when the scrollbar disappears.
+ * Restores the original `overflow` and `paddingRight` when `isLocked` becomes `false`.
  *
- * @example
- * ```tsx
- * // Basic usage
- * const [isModalOpen, setIsModalOpen] = useState(false);
- * useScrollLock(isModalOpen);
+ * Used internally by `Modal` and `Drawer` — you usually don't need this directly
+ * unless building a custom overlay.
  *
- * // In a modal component
- * function Modal({ isVisible }) {
- *   useScrollLock(isVisible);
- *
- *   return isVisible ? (
- *     <div className="modal">
- *       <div className="modal-content">
- *         Modal content
- *       </div>
- *     </div>
- *   ) : null;
- * }
+ * @param isLocked - When `true`, body scroll is disabled.
  *
- * // In a drawer component
- * function Drawer({ isOpen }) {
+ * @example
+ * ```tsx
+ * function CustomOverlay({ isOpen }) {
  *   useScrollLock(isOpen);
- *
- *   return (
- *     <aside className={`drawer ${isOpen ? 'open' : 'closed'}`}>
- *       Drawer content
- *     </aside>
- *   );
+ *   return isOpen ? <div className="overlay">...</div> : null;
  * }
  * ```
  */

package/dist/hooks/useScrollLock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useScrollLock.d.ts","sourceRoot":"","sources":["../../src/hooks/useScrollLock.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,iBAAS,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAyB9C;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"useScrollLock.d.ts","sourceRoot":"","sources":["../../src/hooks/useScrollLock.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,iBAAS,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAyB9C;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/hooks/useScrollLock.js

@@ -1,48 +1,26 @@
 import { useEffect } from "react";
-/**
- * Calculates the width of the scrollbar
- * @returns The scrollbar width in pixels
- */
 function getScrollbarWidth() {
-    // Check if we're in a browser environment
     if (typeof window === "undefined")
         return 0;
-    // Calculate the difference between window width and document width
     return window.innerWidth - document.documentElement.clientWidth;
 }
 /**
- * useScrollLock hook - manages body scroll blocking for overlays
+ * useScrollLock — locks `document.body` scroll while an overlay is open.
  *
- * @param isLocked - Whether the body scroll should be locked
+ * Compensates for the scrollbar width by adding equivalent `paddingRight`,
+ * preventing layout shift when the scrollbar disappears.
+ * Restores the original `overflow` and `paddingRight` when `isLocked` becomes `false`.
  *
- * @example
- * ```tsx
- * // Basic usage
- * const [isModalOpen, setIsModalOpen] = useState(false);
- * useScrollLock(isModalOpen);
+ * Used internally by `Modal` and `Drawer` — you usually don't need this directly
+ * unless building a custom overlay.
  *
- * // In a modal component
- * function Modal({ isVisible }) {
- *   useScrollLock(isVisible);
+ * @param isLocked - When `true`, body scroll is disabled.
  *
- *   return isVisible ? (
- *     <div className="modal">
- *       <div className="modal-content">
- *         Modal content
- *       </div>
- *     </div>
- *   ) : null;
- * }
- *
- * // In a drawer component
- * function Drawer({ isOpen }) {
+ * @example
+ * ```tsx
+ * function CustomOverlay({ isOpen }) {
  *   useScrollLock(isOpen);
- *
- *   return (
- *     <aside className={`drawer ${isOpen ? 'open' : 'closed'}`}>
- *       Drawer content
- *     </aside>
- *   );
+ *   return isOpen ? <div className="overlay">...</div> : null;
  * }
  * ```
  */

package/dist/hooks/useSearchAutomation.d.ts

@@ -1,48 +1,30 @@
 /**
- * Hook for automating actions based on form response data.
+ * useSearchAutomation — URL-driven version of `useAutomation`. Reads automation params from a
+ * URL search string and executes the same side-effects (close modals, toast) on every change.
  *
- * This hook automates the closing of modals and the display of toast notifications
- * based on the properties provided in the form response data object.
+ * Reads the following params (optionally prefixed by `scope:`):
+ * - `closeModal=true` — closes all open modals.
+ * - `message` — text for the toast notification.
+ * - `type` — `"success"` or `"danger"` toast style.
+ * - `name` — response identifier matched against `successResponses`/`badResponses` lists.
  *
- * @param {string} searchString - Raw search parameters string containing automation data
- * properties (e.g., "closeModal=true&message=Success!&type=success"). This string is typically obtained from the URL's search parameters.
- * @param {string} [scope=""] - Optional scope prefix for parameters. When provided, parameters will be prefixed with "scope:". Default: ""
+ * @param searchString - Raw URL search string (e.g. `location.search`).
+ * @param scope - Optional prefix for all params. Default: `""` (no prefix).
  *
  * @example
  * ```tsx
- * // Complete usage with success notification
- * const responseData = "closeModal=true&message=Operation%20completed%20successfully!&type=success";
- * useSearchAutomation(responseData);
+ * // Remix / Next.js Server Action that redirects with search params
+ * // redirect("?closeModal=true&message=Saved!&type=success")
+ * const [searchParams] = useSearchParams();
+ * useSearchAutomation(searchParams.toString());
  * ```
  *
  * @example
  * ```tsx
- * // Close modal only
- * const responseData = "closeModal=true";
- * useSearchAutomation(responseData);
+ * // Scoped params — avoids collisions when multiple features share the URL
+ * // redirect("?filters:closeModal=true&filters:message=Applied!&filters:type=success")
+ * useSearchAutomation(location.search, "filters");
  * ```
- *
- * @example
- * ```tsx
- * // Display error notification
- * const responseData = "message=Error%20processing%20request&type=danger";
- * useSearchAutomation(responseData);
- * ```
- *
- * @example
- * ```tsx
- * // Using scope for parameters
- * const responseData = "filters:closeModal=true&filters:message=Filtered%20successfully!&filters:type=success";
- * useSearchAutomation(responseData, 'filters');
- * ```
- *
- * @remarks
- * - The `closeModal` parameter should be set to "true" to trigger modal closing.
- * - The `message` parameter contains the text to be displayed in the toast notification.
- * - The `type` parameter determines the style of the toast and can be either "success" or "danger".
- * - If the `name` parameter matches any entry in the `badResponses` template, a danger toast will be shown regardless of the `type` parameter.
- * - If the `name` parameter matches any entry in the `successResponses` template, a success toast will be shown regardless of the `type` parameter.
- * - This hook relies on URL search parameters, so it is typically used in conjunction with React Router or similar routing libraries that manage URL state.
  */
 declare function useSearchAutomation(searchString: string, scope?: string): void;
 export { useSearchAutomation };

package/dist/hooks/useSearchAutomation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSearchAutomation.d.ts","sourceRoot":"","sources":["../../src/hooks/useSearchAutomation.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AAEH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,QAkCpE;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"useSearchAutomation.d.ts","sourceRoot":"","sources":["../../src/hooks/useSearchAutomation.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,QAkCpE;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/hooks/useSearchAutomation.js

@@ -5,50 +5,32 @@ import { badResponses } from "../templates/badResponses";
 import { successResponses } from "../templates/successResponses";
 import { useScopedParams } from "./useScopedParams";
 /**
- * Hook for automating actions based on form response data.
+ * useSearchAutomation — URL-driven version of `useAutomation`. Reads automation params from a
+ * URL search string and executes the same side-effects (close modals, toast) on every change.
  *
- * This hook automates the closing of modals and the display of toast notifications
- * based on the properties provided in the form response data object.
+ * Reads the following params (optionally prefixed by `scope:`):
+ * - `closeModal=true` — closes all open modals.
+ * - `message` — text for the toast notification.
+ * - `type` — `"success"` or `"danger"` toast style.
+ * - `name` — response identifier matched against `successResponses`/`badResponses` lists.
  *
- * @param {string} searchString - Raw search parameters string containing automation data
- * properties (e.g., "closeModal=true&message=Success!&type=success"). This string is typically obtained from the URL's search parameters.
- * @param {string} [scope=""] - Optional scope prefix for parameters. When provided, parameters will be prefixed with "scope:". Default: ""
+ * @param searchString - Raw URL search string (e.g. `location.search`).
+ * @param scope - Optional prefix for all params. Default: `""` (no prefix).
  *
  * @example
  * ```tsx
- * // Complete usage with success notification
- * const responseData = "closeModal=true&message=Operation%20completed%20successfully!&type=success";
- * useSearchAutomation(responseData);
+ * // Remix / Next.js Server Action that redirects with search params
+ * // redirect("?closeModal=true&message=Saved!&type=success")
+ * const [searchParams] = useSearchParams();
+ * useSearchAutomation(searchParams.toString());
  * ```
  *
  * @example
  * ```tsx
- * // Close modal only
- * const responseData = "closeModal=true";
- * useSearchAutomation(responseData);
+ * // Scoped params — avoids collisions when multiple features share the URL
+ * // redirect("?filters:closeModal=true&filters:message=Applied!&filters:type=success")
+ * useSearchAutomation(location.search, "filters");
  * ```
- *
- * @example
- * ```tsx
- * // Display error notification
- * const responseData = "message=Error%20processing%20request&type=danger";
- * useSearchAutomation(responseData);
- * ```
- *
- * @example
- * ```tsx
- * // Using scope for parameters
- * const responseData = "filters:closeModal=true&filters:message=Filtered%20successfully!&filters:type=success";
- * useSearchAutomation(responseData, 'filters');
- * ```
- *
- * @remarks
- * - The `closeModal` parameter should be set to "true" to trigger modal closing.
- * - The `message` parameter contains the text to be displayed in the toast notification.
- * - The `type` parameter determines the style of the toast and can be either "success" or "danger".
- * - If the `name` parameter matches any entry in the `badResponses` template, a danger toast will be shown regardless of the `type` parameter.
- * - If the `name` parameter matches any entry in the `successResponses` template, a success toast will be shown regardless of the `type` parameter.
- * - This hook relies on URL search parameters, so it is typically used in conjunction with React Router or similar routing libraries that manage URL state.
  */
 function useSearchAutomation(searchString, scope = "") {
     const { closeAll } = useModal();

package/dist/hooks/useSlider.d.ts

@@ -1,29 +1,15 @@
 type UseSliderReturnProps = [number, (number: number) => void];
 /**
- * useSlider hook - manages slider value state with boundary validation
+ * useSlider — state manager for the `Slider` component. Clamps values to `[0, 100]`.
  *
- * @param defaultValue - Initial value for the slider (0-100). Default: 0
+ * @param defaultValue - Initial percentage value (0–100). Default: 0
  *
- * @returns Array containing current slider value and setter function
- * - [0]: Current slider value (number between 0-100)
- * - [1]: Function to update slider value with boundary validation
+ * @returns `[value, setValue]` — current percentage and a setter that clamps at the boundaries.
  *
  * @example
  * ```tsx
- * // Basic usage
- * const [value, setValue] = useSlider();
- *
- * // With default value
- * const [value, setValue] = useSlider(50);
- *
- * // Usage in component
- * function SliderComponent() {
- *   const [sliderValue, changeSliderValue] = useSlider(25);
- *
- *   return (
- *     <Slider value={sliderValue} onChange={changeSliderValue} />
- *   );
- * }
+ * const [volume, setVolume] = useSlider(50);
+ * return <Slider value={volume} onChange={setVolume} />;
  * ```
  */
 declare function useSlider(defaultValue?: number): UseSliderReturnProps;

package/dist/hooks/useSlider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSlider.d.ts","sourceRoot":"","sources":["../../src/hooks/useSlider.ts"],"names":[],"mappings":"AAEA,KAAK,oBAAoB,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,iBAAS,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAiB9D;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"useSlider.d.ts","sourceRoot":"","sources":["../../src/hooks/useSlider.ts"],"names":[],"mappings":"AAEA,KAAK,oBAAoB,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;AAE/D;;;;;;;;;;;;GAYG;AAEH,iBAAS,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAiB9D;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/hooks/useSlider.js

@@ -1,29 +1,15 @@
 import { useState } from "react";
 /**
- * useSlider hook - manages slider value state with boundary validation
+ * useSlider — state manager for the `Slider` component. Clamps values to `[0, 100]`.
  *
- * @param defaultValue - Initial value for the slider (0-100). Default: 0
+ * @param defaultValue - Initial percentage value (0–100). Default: 0
  *
- * @returns Array containing current slider value and setter function
- * - [0]: Current slider value (number between 0-100)
- * - [1]: Function to update slider value with boundary validation
+ * @returns `[value, setValue]` — current percentage and a setter that clamps at the boundaries.
  *
  * @example
  * ```tsx
- * // Basic usage
- * const [value, setValue] = useSlider();
- *
- * // With default value
- * const [value, setValue] = useSlider(50);
- *
- * // Usage in component
- * function SliderComponent() {
- *   const [sliderValue, changeSliderValue] = useSlider(25);
- *
- *   return (
- *     <Slider value={sliderValue} onChange={changeSliderValue} />
- *   );
- * }
+ * const [volume, setVolume] = useSlider(50);
+ * return <Slider value={volume} onChange={setVolume} />;
  * ```
  */
 function useSlider(defaultValue) {

package/dist/hooks/useToast.d.ts

@@ -1,63 +1,19 @@
 /**
- * Custom hook to access toast functionality from ToastProvider context
+ * useToast — reads `ToastProvider` context to display toast notifications.
  *
- * @returns Object containing toast methods and state
- * @returns {function} showToast - Function to display toast notifications
+ * @returns Context containing `showToast(options)`.
  *
- * @throws {Error} Throws an error if used outside of ToastProvider
+ * @throws If called outside a `ToastProvider`.
  *
  * @example
- * Basic usage:
  * ```tsx
- * function MyComponent() {
- *   const { showToast } = useToast();
+ * const { showToast } = useToast();
  *
- *   const handleSuccess = () => {
- *     showToast({
- *       message: 'Operation completed successfully!',
- *       type: 'success'
- *     });
- *   };
+ * // After a successful save
+ * showToast({ message: "Changes saved!", type: "success" });
  *
- *   const handleError = () => {
- *     showToast({
- *       message: 'Something went wrong!',
- *       type: 'danger'
- *     });
- *   };
- *
- *   return (
- *     <div>
- *       <button onClick={handleSuccess}>Success Toast</button>
- *       <button onClick={handleError}>Error Toast</button>
- *     </div>
- *   );
- * }
- * ```
- *
- * @example
- * Using in async operations:
- * ```tsx
- * function FormComponent() {
- *   const { showToast } = useToast();
- *
- *   const handleSubmit = async (data) => {
- *     try {
- *       await submitForm(data);
- *       showToast({
- *         message: 'Form submitted successfully!',
- *         type: 'success'
- *       });
- *     } catch (error) {
- *       showToast({
- *         message: 'Failed to submit form',
- *         type: 'danger'
- *       });
- *     }
- *   };
- *
- *   return <form onSubmit={handleSubmit}>...</form>;
- * }
+ * // After a failed request
+ * showToast({ message: "Failed to save changes.", type: "danger" });
  * ```
  */
 declare function useToast(): {

package/dist/hooks/useToast.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useToast.d.ts","sourceRoot":"","sources":["../../src/hooks/useToast.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AAEH,iBAAS,QAAQ;;;;;EAQhB;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"useToast.d.ts","sourceRoot":"","sources":["../../src/hooks/useToast.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAS,QAAQ;;;;;EAQhB;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}