@arkyn/components 3.0.1-beta.2 → 3.0.1-beta.200

package/dist/components/tab/tabContainer/index.d.ts

@@ -0,0 +1,41 @@
+import { type HTMLAttributes, type ReactNode } from "react";
+import "./styles.css";
+type TabContainerProps = Omit<HTMLAttributes<HTMLElement>, "onChange" | "children" | "ref" | "onClick"> & {
+    /** `TabButton` components to render as tabs. Required. */
+    children: ReactNode;
+    /** Disables all tab buttons at once. @default false */
+    disabled?: boolean;
+    /** Initially selected tab value. */
+    defaultValue?: string;
+    /** Callback fired when the active tab changes, receiving the new value. */
+    onChange?: (index: string) => void;
+};
+/**
+ * TabContainer — wrapper that manages active state for a group of `TabButton` components.
+ *
+ * Renders as a `<nav>` element. Provides context consumed by each `TabButton`.
+ *
+ * @param props.children - `TabButton` elements. Required.
+ * @param props.defaultValue - Initially selected tab value.
+ * @param props.disabled - Disables all buttons. Default: false
+ * @param props.onChange - Called with the new value whenever the active tab changes.
+ *
+ * **...Other valid HTML `<nav>` properties**
+ *
+ * @returns TabContainer JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TabContainer defaultValue="overview" onChange={setActiveTab}>
+ *   <TabButton value="overview">Overview</TabButton>
+ *   <TabButton value="analytics">Analytics</TabButton>
+ *   <TabButton value="settings">Settings</TabButton>
+ * </TabContainer>
+ *
+ * {activeTab === 'overview' && <OverviewPanel />}
+ * {activeTab === 'analytics' && <AnalyticsPanel />}
+ * ```
+ */
+declare function TabContainer(props: TabContainerProps): import("react").JSX.Element;
+export { TabContainer };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/tab/tabContainer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/tab/tabContainer/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAY,MAAM,OAAO,CAAC;AAGtE,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,IAAI,CAC5B,cAAc,CAAC,WAAW,CAAC,EAC3B,UAAU,GAAG,UAAU,GAAG,KAAK,GAAG,SAAS,CAC3C,GAAG;IACH,0DAA0D;IAC1D,QAAQ,EAAE,SAAS,CAAC;IACpB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,+BA8B7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/components/tab/tabContext.d.ts

@@ -0,0 +1,16 @@
+import { type ReactNode } from "react";
+type TabContextProps = {
+    disabled: boolean;
+    currentTab: string;
+    changeCurrentTab: (tab: string) => void;
+};
+type TabProviderProps = {
+    children: ReactNode;
+    disabled: boolean;
+    currentTab: string;
+    changeCurrentTab: (tab: string) => void;
+};
+declare function useTab(): TabContextProps;
+declare function TabProvider(props: TabProviderProps): import("react").JSX.Element;
+export { TabProvider, useTab };
+//# sourceMappingURL=tabContext.d.ts.map

package/dist/components/tab/tabContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabContext.d.ts","sourceRoot":"","sources":["../../../src/components/tab/tabContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAAc,MAAM,OAAO,CAAC;AAElE,KAAK,eAAe,GAAG;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAIF,iBAAS,MAAM,oBAEd;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,gBAAgB,+BAI3C;AAED,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC"}

package/dist/components/table/tableBody/index.d.ts

@@ -0,0 +1,33 @@
+import { type HTMLAttributes } from "react";
+import "./styles.css";
+type TableBodyProps = HTMLAttributes<HTMLTableSectionElement> & {
+    /** Text displayed in a full-width row when no children are present. @default "Nenhum dado adicionado." */
+    emptyMessage?: string;
+};
+/**
+ * TableBody — `<tbody>` section with built-in empty state handling.
+ *
+ * When `children` is empty, renders a full-width row with `emptyMessage`.
+ * Accepts all standard HTML `<tbody>` attributes.
+ *
+ * @param props.emptyMessage - Empty state text. Default: `"Nenhum dado adicionado."`
+ *
+ * **...Other valid HTML `<tbody>` properties**
+ *
+ * @returns TableBody JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TableBody emptyMessage="No orders found">
+ *   {orders.map(o => (
+ *     <tr key={o.id}>
+ *       <td>{o.number}</td>
+ *       <td>{o.status}</td>
+ *     </tr>
+ *   ))}
+ * </TableBody>
+ * ```
+ */
+declare function TableBody(props: TableBodyProps): import("react").JSX.Element;
+export { TableBody };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/table/tableBody/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/table/tableBody/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,cAAc,CAAC;AAEtB,KAAK,cAAc,GAAG,cAAc,CAAC,uBAAuB,CAAC,GAAG;IAC/D,0GAA0G;IAC1G,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,iBAAS,SAAS,CAAC,KAAK,EAAE,cAAc,+BAyBvC;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/components/table/tableCaption/index.d.ts

@@ -0,0 +1,22 @@
+import type { HTMLAttributes } from "react";
+import "./styles.css";
+type TableCaptionProps = HTMLAttributes<HTMLElement>;
+/**
+ * TableCaption — title / description placed above a table. Renders as a `<caption>` element.
+ *
+ * Accepts all standard HTML element attributes.
+ *
+ * @returns TableCaption JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TableContainer>
+ *   <TableCaption>Orders — Q2 2025</TableCaption>
+ *   <TableHeader>...</TableHeader>
+ *   <TableBody>...</TableBody>
+ * </TableContainer>
+ * ```
+ */
+declare function TableCaption(props: TableCaptionProps): import("react").JSX.Element;
+export { TableCaption };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/table/tableCaption/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/table/tableCaption/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;AAErD;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,+BAS7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/components/table/tableContainer/index.d.ts

@@ -0,0 +1,35 @@
+import type { TableHTMLAttributes } from "react";
+import "./styles.css";
+type TableContainerProps = TableHTMLAttributes<HTMLTableElement>;
+/**
+ * TableContainer — root wrapper for the Table component set. Renders a responsive scrollable container around a `<table>`.
+ *
+ * Accepts all standard HTML `<table>` attributes.
+ *
+ * @returns TableContainer JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TableContainer>
+ *   <TableCaption>Users</TableCaption>
+ *   <TableHeader>
+ *     <th>Name</th>
+ *     <th>Email</th>
+ *     <th>Status</th>
+ *   </TableHeader>
+ *   <TableBody emptyMessage="No users found">
+ *     {users.map(u => (
+ *       <tr key={u.id}>
+ *         <td>{u.name}</td>
+ *         <td>{u.email}</td>
+ *         <td>{u.status}</td>
+ *       </tr>
+ *     ))}
+ *   </TableBody>
+ *   <TableFooter><Pagination /></TableFooter>
+ * </TableContainer>
+ * ```
+ */
+declare function TableContainer(props: TableContainerProps): import("react").JSX.Element;
+export { TableContainer };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/table/tableContainer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/table/tableContainer/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,cAAc,CAAC;AAEtB,KAAK,mBAAmB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,iBAAS,cAAc,CAAC,KAAK,EAAE,mBAAmB,+BASjD;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/components/table/tableFooter/index.d.ts

@@ -0,0 +1,21 @@
+import type { HTMLAttributes } from "react";
+import "./styles.css";
+type TableFooterProps = HTMLAttributes<HTMLTableSectionElement>;
+/**
+ * TableFooter — `<tfoot>` section with an automatic spacing row above the content.
+ *
+ * Children span all columns via `colSpan={100}`. Commonly used for `Pagination`.
+ * Accepts all standard HTML `<tfoot>` attributes.
+ *
+ * @returns TableFooter JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TableFooter>
+ *   <Pagination currentPage={page} totalPages={totalPages} onChange={setPage} />
+ * </TableFooter>
+ * ```
+ */
+declare function TableFooter(props: TableFooterProps): import("react").JSX.Element;
+export { TableFooter };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/table/tableFooter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/table/tableFooter/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,cAAc,CAAC;AAEtB,KAAK,gBAAgB,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,gBAAgB,+BAc3C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/components/table/tableHeader/index.d.ts

@@ -0,0 +1,23 @@
+import type { HTMLAttributes } from "react";
+import "./styles.css";
+type TableHeaderProps = HTMLAttributes<HTMLTableSectionElement>;
+/**
+ * TableHeader — `<thead>` section with an automatic spacing row below the header row.
+ *
+ * Pass `<th>` elements as children — they are wrapped in a `<tr>` automatically.
+ * Accepts all standard HTML `<thead>` attributes.
+ *
+ * @returns TableHeader JSX element.
+ *
+ * @example
+ * ```tsx
+ * <TableHeader>
+ *   <th>Name</th>
+ *   <th>Email</th>
+ *   <th>Actions</th>
+ * </TableHeader>
+ * ```
+ */
+declare function TableHeader(props: TableHeaderProps): import("react").JSX.Element;
+export { TableHeader };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/table/tableHeader/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/table/tableHeader/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,cAAc,CAAC;AAEtB,KAAK,gBAAgB,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;GAgBG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,gBAAgB,+BAU3C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/components/textarea/index.d.ts

@@ -0,0 +1,73 @@
+import { type TextareaHTMLAttributes } from "react";
+import "./styles.css";
+type TextareaProps = Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, "name" | "value" | "defaultValue"> & {
+    /** Field name for form submission. Required. */
+    name: string;
+    /** Optional label text displayed above the textarea. */
+    label?: string;
+    /** Displays an asterisk on the label to signal a required field. */
+    showAsterisk?: boolean;
+    /** Validation error message displayed below the textarea. */
+    errorMessage?: string;
+    /**
+     * Textarea size.
+     * @default "md"
+     */
+    size?: "md" | "lg";
+    /**
+     * Visual style variant.
+     * - `solid`: filled background.
+     * - `outline`: bordered, transparent background.
+     * @default "solid"
+     */
+    variant?: "solid" | "outline";
+    /** Controlled value. */
+    value?: string;
+    /** Uncontrolled default value. */
+    defaultValue?: string;
+};
+/**
+ * Textarea — multi-line text input with label, validation, and form integration.
+ *
+ * Integrates with `useForm` to display validation errors by field name.
+ *
+ * @param props.name - Field name for form submission. Required.
+ * @param props.label - Label text displayed above the textarea.
+ * @param props.showAsterisk - Appends `*` to the label.
+ * @param props.errorMessage - Validation error message.
+ * @param props.size - Textarea size (`md` | `lg`). Default: "md"
+ * @param props.variant - Visual style variant. Default: "solid"
+ *
+ * **...Other valid HTML properties for `<textarea>`**
+ *
+ * @returns Textarea JSX element wrapped in `FieldWrapper`.
+ *
+ * @example
+ * ```tsx
+ * // Basic
+ * <Textarea name="description" placeholder="Enter description..." />
+ *
+ * // With label and validation
+ * <Textarea
+ *   name="bio"
+ *   label="Biography"
+ *   showAsterisk
+ *   placeholder="Tell us about yourself"
+ *   errorMessage="Biography is required"
+ * />
+ *
+ * // Controlled with custom rows
+ * <Textarea
+ *   name="message"
+ *   label="Message"
+ *   value={message}
+ *   onChange={(e) => setMessage(e.target.value)}
+ *   rows={5}
+ *   size="lg"
+ *   variant="outline"
+ * />
+ * ```
+ */
+declare function Textarea(props: TextareaProps): import("react").JSX.Element;
+export { Textarea };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/textarea/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/textarea/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,sBAAsB,EAI3B,MAAM,OAAO,CAAC;AAMf,OAAO,cAAc,CAAC;AAEtB,KAAK,aAAa,GAAG,IAAI,CACxB,sBAAsB,CAAC,mBAAmB,CAAC,EAC3C,MAAM,GAAG,OAAO,GAAG,cAAc,CACjC,GAAG;IACH,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,iBAAS,QAAQ,CAAC,KAAK,EAAE,aAAa,+BAqFrC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/components/tooltip/index.d.ts

@@ -0,0 +1,52 @@
+import { type HTMLAttributes, type ReactNode } from "react";
+import "./styles.css";
+type TooltipProps = Omit<HTMLAttributes<HTMLDivElement>, "children"> & {
+    /** Text rendered inside the tooltip bubble. Supports inline HTML. Required. */
+    text: string;
+    /** Element that triggers the tooltip on hover. Required. */
+    children: ReactNode;
+    /**
+     * Preferred position of the tooltip relative to the trigger element.
+     * Automatically flips to the opposite side if the tooltip would overflow the viewport.
+     * @default "top"
+     */
+    orientation?: "top" | "right" | "bottom" | "left";
+    /**
+     * Tooltip size.
+     * @default "lg"
+     */
+    size?: "md" | "lg";
+};
+/**
+ * Tooltip — shows a contextual text bubble on hover with smart viewport-aware positioning.
+ *
+ * The tooltip automatically flips to the opposite side when it would overflow the viewport.
+ *
+ * @param props.text - Text (or HTML) to display in the tooltip. Required.
+ * @param props.children - Trigger element. Required.
+ * @param props.orientation - Preferred position relative to the trigger. Default: "top"
+ * @param props.size - Tooltip size. Default: "lg"
+ *
+ * **...Other valid HTML properties for `<div>`**
+ *
+ * @returns Tooltip JSX element.
+ *
+ * @example
+ * ```tsx
+ * <Tooltip text="Save changes before leaving">
+ *   <IconButton icon={SaveIcon} aria-label="Save" />
+ * </Tooltip>
+ *
+ * // Toolbar with bottom-oriented tooltips
+ * <Tooltip text="Add item" orientation="bottom">
+ *   <IconButton icon={Plus} aria-label="Add" />
+ * </Tooltip>
+ *
+ * <Tooltip text="Delete" orientation="bottom" size="md">
+ *   <IconButton icon={Trash2} aria-label="Delete" scheme="danger" />
+ * </Tooltip>
+ * ```
+ */
+declare function Tooltip(props: TooltipProps): import("react").JSX.Element;
+export { Tooltip };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/tooltip/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/tooltip/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,SAAS,EAKd,MAAM,OAAO,CAAC;AACf,OAAO,cAAc,CAAC;AAEtB,KAAK,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,GAAG;IACtE,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,QAAQ,EAAE,SAAS,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAClD;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iBAAS,OAAO,CAAC,KAAK,EAAE,YAAY,+BAqFnC;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/hooks/__test__/useAutomation.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useAutomation.spec.d.ts.map

package/dist/hooks/__test__/useAutomation.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAutomation.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useAutomation.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useDrawer.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useDrawer.spec.d.ts.map

package/dist/hooks/__test__/useDrawer.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDrawer.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useDrawer.spec.tsx"],"names":[],"mappings":""}

package/dist/hooks/__test__/useForm.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useForm.spec.d.ts.map

package/dist/hooks/__test__/useForm.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useForm.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useForm.spec.tsx"],"names":[],"mappings":""}

package/dist/hooks/__test__/useHydrated.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useHydrated.spec.d.ts.map

package/dist/hooks/__test__/useHydrated.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHydrated.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useHydrated.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useModal.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useModal.spec.d.ts.map

package/dist/hooks/__test__/useModal.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useModal.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useModal.spec.tsx"],"names":[],"mappings":""}

package/dist/hooks/__test__/useScopedParams.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useScopedParams.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useScopedParams.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useScopedParams.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useScrollLock.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useScrollLock.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useScrollLock.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useScrollLock.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useSearchAutomation.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useSearchAutomation.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSearchAutomation.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useSearchAutomation.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useSlider.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useSlider.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSlider.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useSlider.spec.ts"],"names":[],"mappings":""}

package/dist/hooks/__test__/useToast.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useToast.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useToast.spec.d.ts","sourceRoot":"","sources":["../../../src/hooks/__test__/useToast.spec.tsx"],"names":[],"mappings":""}

package/dist/hooks/useAutomation.d.ts

@@ -1,3 +1,39 @@
-declare function useAutomation(): void;
+/**
+ * useAutomation — runs UI side-effects (close modals, scroll, toast) in response to a server action payload.
+ *
+ * Pass the raw response from a form submission. On every change the hook:
+ * 1. Closes all open modals if `closeModal` is `true`.
+ * 2. Smooth-scrolls to a named element if `cause.data.scrollTo` is set.
+ * 3. Shows a toast based on `name` (matched against `successResponses`/`badResponses`) and `message`.
+ *    When `cause.fieldErrors` is present, the first field error takes priority in the toast.
+ *    The message `"Unprocessable entity"` is intentionally suppressed.
+ *
+ * @param formResponseData - Raw server response payload.
+ * @param formResponseData.closeModal - Closes all open modals when `true`.
+ * @param formResponseData.name - Response identifier matched against success/bad response lists.
+ * @param formResponseData.message - Text shown in the toast notification.
+ * @param formResponseData.cause.data.scrollTo - Element name to scroll to via `react-scroll`.
+ * @param formResponseData.cause.fieldErrors - Field-level errors; the first value is shown in the toast.
+ *
+ * @example
+ * ```tsx
+ * // After a successful create action
+ * useAutomation({ closeModal: true, name: "created", message: "Saved successfully" });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Validation error with field-level feedback and scroll
+ * useAutomation({
+ *   name: "validation_error",
+ *   message: "Invalid payload",
+ *   cause: {
+ *     data: { scrollTo: "email" },
+ *     fieldErrors: { email: "E-mail is required" },
+ *   },
+ * });
+ * ```
+ */
+declare function useAutomation(formResponseData: any): void;
 export { useAutomation };
 //# sourceMappingURL=useAutomation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useAutomation.d.ts","sourceRoot":"","sources":["../../src/hooks/useAutomation.ts"],"names":[],"mappings":"AAwBA,iBAAS,aAAa,SAqDrB;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"useAutomation.d.ts","sourceRoot":"","sources":["../../src/hooks/useAutomation.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAGH,iBAAS,aAAa,CAAC,gBAAgB,EAAE,GAAG,QA+B3C;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/hooks/useDrawer.d.ts

@@ -1,5 +1,35 @@
-import { DrawerContextProps } from "@arkyn/types";
+import { type DrawerContextProps } from "../providers/drawerProvider";
 type OpenDrawerProps<T = any> = (data?: T) => void;
+/**
+ * useDrawer — accesses the nearest `DrawerProvider` context.
+ *
+ * Two call signatures:
+ * - **Without `key`** — returns the raw context object (manage any drawer by name).
+ * - **With `key`** — returns a scoped object bound to one named drawer.
+ *
+ * @param key - Drawer identifier registered in `DrawerProvider`.
+ *
+ * @returns Without key: full `DrawerContextProps`. With key: `{ drawerIsOpen, drawerData, openDrawer, closeDrawer }`.
+ *
+ * @throws If called outside a `DrawerProvider`.
+ *
+ * @example
+ * ```tsx
+ * // Scoped to one drawer — the most common pattern
+ * const { drawerIsOpen, drawerData, openDrawer, closeDrawer } = useDrawer<{ section: string }>('navigation');
+ *
+ * openDrawer({ section: 'products' });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Full context — useful when triggering multiple different drawers from one place
+ * const { openDrawer } = useDrawer();
+ *
+ * openDrawer('navigation', { section: 'main' });
+ * openDrawer('filters', { category: 'electronics' });
+ * ```
+ */
 declare function useDrawer<T = any>(): DrawerContextProps<T>;
 declare function useDrawer<T = any>(key: string): {
     drawerIsOpen: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"useDrawer.d.ts","sourceRoot":"","sources":["../../src/hooks/useDrawer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAKlD,KAAK,eAAe,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAEnD,iBAAS,SAAS,CAAC,CAAC,GAAG,GAAG,KAAK,kBAAkB,CAAC,CAAC,CAAC,CAAC;AACrD,iBAAS,SAAS,CAAC,CAAC,GAAG,GAAG,EACxB,GAAG,EAAE,MAAM,GACV;IACD,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC/B,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC;AA6BF,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"useDrawer.d.ts","sourceRoot":"","sources":["../../src/hooks/useDrawer.ts"],"names":[],"mappings":"AACA,OAAO,EACN,KAAK,kBAAkB,EAEvB,MAAM,6BAA6B,CAAC;AAGrC,KAAK,eAAe,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAGH,iBAAS,SAAS,CAAC,CAAC,GAAG,GAAG,KAAK,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAErD,iBAAS,SAAS,CAAC,CAAC,GAAG,GAAG,EACzB,GAAG,EAAE,MAAM,GACT;IACF,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC/B,WAAW,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AA6BF,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/hooks/useForm.d.ts

@@ -0,0 +1,35 @@
+/**
+ * useForm — reads the nearest `FormProvider` context to access field-level validation errors.
+ *
+ * All form inputs (`Input`, `Select`, `Checkbox`, etc.) call this hook internally,
+ * so you rarely need it directly. Use it when you want to read errors outside of
+ * an input component, or build a custom input.
+ *
+ * @returns Form context containing:
+ * - `fieldErrors` — `Record<string, string>` mapping field names to error messages.
+ *
+ * @example
+ * ```tsx
+ * // Wrapping a form with FormProvider
+ * function App() {
+ *   return (
+ *     <FormProvider fieldErrors={{ email: "Invalid email" }}>
+ *       <MyForm />
+ *     </FormProvider>
+ *   );
+ * }
+ *
+ * // Reading errors manually
+ * function CustomField() {
+ *   const { fieldErrors } = useForm();
+ *   return <span>{fieldErrors?.username}</span>;
+ * }
+ * ```
+ */
+declare function useForm(): {
+    fieldErrors: {
+        [x: string]: any;
+    };
+};
+export { useForm };
+//# sourceMappingURL=useForm.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../src/hooks/useForm.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,iBAAS,OAAO;;;;EAGf;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/hooks/useHydrated.d.ts

@@ -1,3 +1,21 @@
+/**
+ * useHydrated — returns `true` once the component has hydrated on the client, `false` during SSR.
+ *
+ * Built on `useSyncExternalStore` so it is safe with React 18 concurrent rendering.
+ * Use this when you need to defer client-only rendering (e.g. browser APIs, `window`, `navigator`)
+ * without causing a hydration mismatch. For most cases, prefer the `ClientOnly` component.
+ *
+ * @returns `true` on the client after hydration; `false` on the server.
+ *
+ * @example
+ * ```tsx
+ * function Map() {
+ *   const isHydrated = useHydrated();
+ *   if (!isHydrated) return <Skeleton />;
+ *   return <MapView accessToken={token} coordinates={coords} />;
+ * }
+ * ```
+ */
 declare function useHydrated(): boolean;
 export { useHydrated };
 //# sourceMappingURL=useHydrated.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useHydrated.d.ts","sourceRoot":"","sources":["../../src/hooks/useHydrated.ts"],"names":[],"mappings":"AAMA,iBAAS,WAAW,YAMnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"useHydrated.d.ts","sourceRoot":"","sources":["../../src/hooks/useHydrated.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAS,WAAW,YAMnB;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/hooks/useModal.d.ts

@@ -1,5 +1,35 @@
-import { ModalContextProps } from "@arkyn/types";
+import { type ModalContextProps } from "../providers/modalProvider";
 type OpenModalProps<T = any> = (data?: T) => void;
+/**
+ * useModal — accesses the nearest `ModalProvider` context.
+ *
+ * Two call signatures:
+ * - **Without `key`** — returns the raw context object (manage any modal by name).
+ * - **With `key`** — returns a scoped object bound to one named modal.
+ *
+ * @param key - Modal identifier registered in `ModalProvider`.
+ *
+ * @returns Without key: full `ModalContextProps`. With key: `{ modalIsOpen, modalData, openModal, closeModal }`.
+ *
+ * @throws If called outside a `ModalProvider`.
+ *
+ * @example
+ * ```tsx
+ * // Scoped to one modal — the most common pattern
+ * const { modalIsOpen, modalData, openModal, closeModal } = useModal<{ id: number }>('confirm-delete');
+ *
+ * openModal({ id: user.id });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Full context — useful when triggering multiple different modals from one place
+ * const { openModal } = useModal();
+ *
+ * openModal('confirm-delete', { id: user.id });
+ * openModal('user-details', { id: user.id });
+ * ```
+ */
 declare function useModal<T = any>(): ModalContextProps<T>;
 declare function useModal<T = any>(key: string): {
     modalIsOpen: boolean;