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

package/dist/components/drawer/drawerContainer/index.d.ts

@@ -1,69 +1,35 @@
 import { HTMLAttributes } from "react";
 import "./styles.css";
 type DrawerContainerProps = HTMLAttributes<HTMLElement> & {
+    /** Controls whether the drawer is visible. */
     isVisible: boolean;
+    /** Callback invoked when the overlay is clicked to close the drawer. */
     makeInvisible: () => void;
+    /** Side from which the drawer slides in. @default "left" */
     orientation?: "left" | "right";
 };
-/**O
- * DrawerContainer component - animated slide-out panel for navigation or content
+/**
+ * DrawerContainer — animated slide-in panel rendered over an overlay backdrop.
  *
- * @param props - DrawerContainer component properties
- * @param props.isVisible - Controls drawer visibility state
- * @param props.makeInvisible - Callback function to hide the drawer
- * @param props.orientation - Side from which drawer slides (left, right). Default: "left"
+ * Locks body scroll while open. Closes when the overlay is clicked.
+ * Provides context consumed by `DrawerHeader` (close button).
  *
- * **...Other valid HTML properties for aside element**
+ * @param props.isVisible - Whether the drawer is open. Required.
+ * @param props.makeInvisible - Called when the overlay or close button is clicked. Required.
+ * @param props.orientation - Slide direction. Default: `"left"`
  *
- * @returns DrawerContainer JSX element
+ * **...Other valid HTML `<aside>` properties**
+ *
+ * @returns DrawerContainer JSX element.
  *
  * @example
  * ```tsx
- * // Basic drawer from left
  * const [isOpen, setIsOpen] = useState(false);
- * <DrawerContainer
- *   isVisible={isOpen}
- *   makeInvisible={setIsOpen}
- * >
- *   <p>Drawer content</p>
- * </DrawerContainer>
  *
- * // Right-side drawer
- * <DrawerContainer
- *   isVisible={isOpen}
- *   makeInvisible={setIsOpen}
- *   orientation="right"
- * >
- *   <nav>Navigation items</nav>
+ * <DrawerContainer isVisible={isOpen} makeInvisible={() => setIsOpen(false)} orientation="right">
+ *   <DrawerHeader><h2>Navigation</h2></DrawerHeader>
+ *   <nav>...</nav>
  * </DrawerContainer>
- *
- * // Complete drawer example
- * function DrawerExample() {
- *   const [isDrawerOpen, setIsDrawerOpen] = useState(false);
- *
- *   return (
- *     <>
- *       <button onClick={() => setIsDrawerOpen(true)}>
- *         Open Menu
- *       </button>
- *
- *       <DrawerContainer
- *         isVisible={isDrawerOpen}
- *         makeInvisible={setIsDrawerOpen}
- *         orientation="right"
- *       >
- *         <div className="drawer-content">
- *           <h2>Menu</h2>
- *           <ul>
- *             <li>Home</li>
- *             <li>About</li>
- *             <li>Contact</li>
- *           </ul>
- *         </div>
- *       </DrawerContainer>
- *     </>
- *   );
- * }
  * ```
  */
 declare function DrawerContainer(props: DrawerContainerProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/drawer/drawerContainer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/drawer/drawerContainer/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAIvC,OAAO,cAAc,CAAC;AAEtB,KAAK,oBAAoB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACxD,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AAEH,iBAAS,eAAe,CAAC,KAAK,EAAE,oBAAoB,2CA6CnD;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/drawer/drawerContainer/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAIvC,OAAO,cAAc,CAAC;AAEtB,KAAK,oBAAoB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACxD,8CAA8C;IAC9C,SAAS,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,iBAAS,eAAe,CAAC,KAAK,EAAE,oBAAoB,2CA6CnD;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/components/drawer/drawerContainer/index.js

@@ -3,65 +3,28 @@ import { AnimatePresence, motion } from "framer-motion";
 import { useScrollLock } from "../../../hooks/useScrollLock";
 import { DrawerProvider } from "../drawerContext";
 import "./styles.css";
-/**O
- * DrawerContainer component - animated slide-out panel for navigation or content
+/**
+ * DrawerContainer — animated slide-in panel rendered over an overlay backdrop.
  *
- * @param props - DrawerContainer component properties
- * @param props.isVisible - Controls drawer visibility state
- * @param props.makeInvisible - Callback function to hide the drawer
- * @param props.orientation - Side from which drawer slides (left, right). Default: "left"
+ * Locks body scroll while open. Closes when the overlay is clicked.
+ * Provides context consumed by `DrawerHeader` (close button).
  *
- * **...Other valid HTML properties for aside element**
+ * @param props.isVisible - Whether the drawer is open. Required.
+ * @param props.makeInvisible - Called when the overlay or close button is clicked. Required.
+ * @param props.orientation - Slide direction. Default: `"left"`
  *
- * @returns DrawerContainer JSX element
+ * **...Other valid HTML `<aside>` properties**
+ *
+ * @returns DrawerContainer JSX element.
  *
  * @example
  * ```tsx
- * // Basic drawer from left
  * const [isOpen, setIsOpen] = useState(false);
- * <DrawerContainer
- *   isVisible={isOpen}
- *   makeInvisible={setIsOpen}
- * >
- *   <p>Drawer content</p>
- * </DrawerContainer>
  *
- * // Right-side drawer
- * <DrawerContainer
- *   isVisible={isOpen}
- *   makeInvisible={setIsOpen}
- *   orientation="right"
- * >
- *   <nav>Navigation items</nav>
+ * <DrawerContainer isVisible={isOpen} makeInvisible={() => setIsOpen(false)} orientation="right">
+ *   <DrawerHeader><h2>Navigation</h2></DrawerHeader>
+ *   <nav>...</nav>
  * </DrawerContainer>
- *
- * // Complete drawer example
- * function DrawerExample() {
- *   const [isDrawerOpen, setIsDrawerOpen] = useState(false);
- *
- *   return (
- *     <>
- *       <button onClick={() => setIsDrawerOpen(true)}>
- *         Open Menu
- *       </button>
- *
- *       <DrawerContainer
- *         isVisible={isDrawerOpen}
- *         makeInvisible={setIsDrawerOpen}
- *         orientation="right"
- *       >
- *         <div className="drawer-content">
- *           <h2>Menu</h2>
- *           <ul>
- *             <li>Home</li>
- *             <li>About</li>
- *             <li>Contact</li>
- *           </ul>
- *         </div>
- *       </DrawerContainer>
- *     </>
- *   );
- * }
  * ```
  */
 function DrawerContainer(props) {

package/dist/components/drawer/drawerHeader/index.d.ts

@@ -1,53 +1,29 @@
 import { HTMLAttributes } from "react";
 import "./styles.css";
 type DrawerHeaderProps = HTMLAttributes<HTMLElement> & {
+    /** Whether to render the X close button. @default true */
     showCloseButton?: boolean;
 };
 /**
- * DrawerHeader component - header section for drawer with optional close button
+ * DrawerHeader — header section for a `DrawerContainer`, with an optional close button.
  *
- * @param props - DrawerHeader component properties
- * @param props.showCloseButton - Shows close button in header. Default: true
+ * The close button calls `makeInvisible` from the nearest `DrawerContainer` context.
+ * Must be rendered inside a `DrawerContainer`.
  *
- * **...Other valid HTML properties for header element**
+ * @param props.showCloseButton - Renders the X close button. Default: true
  *
- * @returns DrawerHeader JSX element
+ * **...Other valid HTML `<header>` properties**
+ *
+ * @returns DrawerHeader JSX element.
  *
  * @example
  * ```tsx
- * // Basic drawer header with close button
- * <DrawerHeader>
- *   <h2>Menu</h2>
- * </DrawerHeader>
- *
- * // Header without close button
- * <DrawerHeader showCloseButton={false}>
- *   <h2>Settings</h2>
- * </DrawerHeader>
- *
- * // Complete drawer example
  * <DrawerContainer isVisible={isOpen} makeInvisible={() => setIsOpen(false)}>
  *   <DrawerHeader>
  *     <h2>Navigation</h2>
- *     <p>Welcome to our app</p>
  *   </DrawerHeader>
- *
- *   <div className="drawer-content">
- *     <nav>
- *       <a href="/home">Home</a>
- *       <a href="/about">About</a>
- *       <a href="/contact">Contact</a>
- *     </nav>
- *   </div>
+ *   <nav>...</nav>
  * </DrawerContainer>
- *
- * // Custom styled header
- * <DrawerHeader className="custom-header">
- *   <div className="header-content">
- *     <img src="/logo.png" alt="Logo" />
- *     <h1>My App</h1>
- *   </div>
- * </DrawerHeader>
  * ```
  */
 declare function DrawerHeader(props: DrawerHeaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/drawer/drawerHeader/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/drawer/drawerHeader/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACrD,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,2CA2B7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/drawer/drawerHeader/index.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAGvC,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACrD,0DAA0D;IAC1D,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,2CA2B7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/components/drawer/drawerHeader/index.js

@@ -3,50 +3,25 @@ import { X } from "lucide-react";
 import { useDrawer } from "../drawerContext";
 import "./styles.css";
 /**
- * DrawerHeader component - header section for drawer with optional close button
+ * DrawerHeader — header section for a `DrawerContainer`, with an optional close button.
  *
- * @param props - DrawerHeader component properties
- * @param props.showCloseButton - Shows close button in header. Default: true
+ * The close button calls `makeInvisible` from the nearest `DrawerContainer` context.
+ * Must be rendered inside a `DrawerContainer`.
  *
- * **...Other valid HTML properties for header element**
+ * @param props.showCloseButton - Renders the X close button. Default: true
  *
- * @returns DrawerHeader JSX element
+ * **...Other valid HTML `<header>` properties**
+ *
+ * @returns DrawerHeader JSX element.
  *
  * @example
  * ```tsx
- * // Basic drawer header with close button
- * <DrawerHeader>
- *   <h2>Menu</h2>
- * </DrawerHeader>
- *
- * // Header without close button
- * <DrawerHeader showCloseButton={false}>
- *   <h2>Settings</h2>
- * </DrawerHeader>
- *
- * // Complete drawer example
  * <DrawerContainer isVisible={isOpen} makeInvisible={() => setIsOpen(false)}>
  *   <DrawerHeader>
  *     <h2>Navigation</h2>
- *     <p>Welcome to our app</p>
  *   </DrawerHeader>
- *
- *   <div className="drawer-content">
- *     <nav>
- *       <a href="/home">Home</a>
- *       <a href="/about">About</a>
- *       <a href="/contact">Contact</a>
- *     </nav>
- *   </div>
+ *   <nav>...</nav>
  * </DrawerContainer>
- *
- * // Custom styled header
- * <DrawerHeader className="custom-header">
- *   <div className="header-content">
- *     <img src="/logo.png" alt="Logo" />
- *     <h1>My App</h1>
- *   </div>
- * </DrawerHeader>
  * ```
  */
 function DrawerHeader(props) {

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

@@ -1,18 +1,65 @@
 type FacebookPixelProps = {
+    /** Facebook Pixel ID from your Ads Manager account. Required. */
     pixelId: string;
+    /** When true, renders the pixel in development mode (bypasses the production check). @default false */
     showInDevMode?: boolean;
+    /** Pixel initialization options. */
     options?: {
+        /** Enables automatic configuration. @default true */
         autoConfig?: boolean;
+        /** Enables debug logging in the browser console. @default false */
         debug?: boolean;
     };
+    /** When true, fires a standard `PageView` event on mount. */
     pageView?: boolean;
+    /** When true, grants cookie/tracking consent via `fbq("consent", "grant")`. */
     grantConsent?: boolean;
+    /** When true, revokes cookie/tracking consent via `fbq("consent", "revoke")`. */
     revokeConsent?: boolean;
+    /** Standard event to track: `[eventName, eventData?]`. */
     track?: [string, any?];
+    /** Custom event to track: `[eventName, eventData?]`. */
     trackCustom?: [string, any?];
+    /** Single-pixel standard event: `[eventName, eventData?]`. */
     trackSingle?: [string, any?];
+    /** Single-pixel custom event: `[eventName, eventData?]`. */
     trackSingleCustom?: [string, any?];
 };
+/**
+ * FacebookPixel — injects the Facebook Pixel tracking script client-side.
+ *
+ * Renders nothing in development mode unless `showInDevMode` is `true`.
+ * Wrapped in `ClientOnly` to avoid SSR errors.
+ *
+ * @param props.pixelId - Facebook Pixel ID. Required.
+ * @param props.showInDevMode - Renders in development mode. Default: false
+ * @param props.pageView - Fires a `PageView` event on mount.
+ * @param props.grantConsent - Grants tracking consent.
+ * @param props.revokeConsent - Revokes tracking consent.
+ * @param props.track - Standard event to fire: `[eventName, params?]`.
+ * @param props.trackCustom - Custom event to fire: `[eventName, params?]`.
+ *
+ * @returns Empty fragment in dev mode; otherwise the pixel script component.
+ *
+ * @example
+ * ```tsx
+ * // Basic page view tracking in root layout
+ * <FacebookPixel pixelId="123456789012345" pageView />
+ *
+ * // With LGPD consent handling
+ * <FacebookPixel
+ *   pixelId="123456789012345"
+ *   pageView
+ *   grantConsent={userAcceptedCookies}
+ * />
+ *
+ * // Track a purchase event
+ * <FacebookPixel
+ *   pixelId="123456789012345"
+ *   track={["Purchase", { value: 99.90, currency: "BRL" }]}
+ * />
+ * ```
+ */
 declare function FacebookPixel(props: FacebookPixelProps): import("react/jsx-runtime").JSX.Element;
 export { FacebookPixel, type FacebookPixelProps };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/facebookPixel/index.tsx"],"names":[],"mappings":"AAGA,KAAK,kBAAkB,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7B,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC;AAEF,iBAAS,aAAa,CAAC,KAAK,EAAE,kBAAkB,2CAM/C;AAED,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/facebookPixel/index.tsx"],"names":[],"mappings":"AAGA,KAAK,kBAAkB,GAAG;IACxB,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB,uGAAuG;IACvG,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oCAAoC;IACpC,OAAO,CAAC,EAAE;QACR,qDAAqD;QACrD,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,mEAAmE;QACnE,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+EAA+E;IAC/E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iFAAiF;IACjF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACvB,wDAAwD;IACxD,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7B,8DAA8D;IAC9D,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7B,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,kBAAkB,2CAM/C;AAED,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,CAAC"}

package/dist/components/facebookPixel/index.js

@@ -1,6 +1,41 @@
 import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
 import { ClientOnly } from "../clientOnly";
 import { FacebookPixelClient } from "./facebookPixel.client";
+/**
+ * FacebookPixel — injects the Facebook Pixel tracking script client-side.
+ *
+ * Renders nothing in development mode unless `showInDevMode` is `true`.
+ * Wrapped in `ClientOnly` to avoid SSR errors.
+ *
+ * @param props.pixelId - Facebook Pixel ID. Required.
+ * @param props.showInDevMode - Renders in development mode. Default: false
+ * @param props.pageView - Fires a `PageView` event on mount.
+ * @param props.grantConsent - Grants tracking consent.
+ * @param props.revokeConsent - Revokes tracking consent.
+ * @param props.track - Standard event to fire: `[eventName, params?]`.
+ * @param props.trackCustom - Custom event to fire: `[eventName, params?]`.
+ *
+ * @returns Empty fragment in dev mode; otherwise the pixel script component.
+ *
+ * @example
+ * ```tsx
+ * // Basic page view tracking in root layout
+ * <FacebookPixel pixelId="123456789012345" pageView />
+ *
+ * // With LGPD consent handling
+ * <FacebookPixel
+ *   pixelId="123456789012345"
+ *   pageView
+ *   grantConsent={userAcceptedCookies}
+ * />
+ *
+ * // Track a purchase event
+ * <FacebookPixel
+ *   pixelId="123456789012345"
+ *   track={["Purchase", { value: 99.90, currency: "BRL" }]}
+ * />
+ * ```
+ */
 function FacebookPixel(props) {
     if (process.env.NODE_ENV !== "production" && !props.showInDevMode) {
         return _jsx(_Fragment, {});

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

@@ -2,25 +2,18 @@ import { HTMLAttributes } from "react";
 import "./styles.css";
 type FieldErrorProps = HTMLAttributes<HTMLElement>;
 /**
- * FieldError component - used to display error messages for form fields
+ * FieldError — displays a validation error message below a form field.
  *
- * @param props - FieldError component properties
+ * Renders nothing when `children` is empty or falsy.
  *
- * **...Other valid HTML properties for strong element**
+ * **...Other valid HTML properties for `<strong>`**
  *
- * @returns FieldError JSX element or empty fragment if no children
+ * @returns FieldError `<strong>` element, or an empty fragment when there is no message.
  *
  * @example
  * ```tsx
- * // Basic field error
  * <FieldError>This field is required</FieldError>
  *
- * // Field error with custom styling
- * <FieldError className="custom-error">
- *  Invalid email format
- * </FieldError>
- *
- * // Conditional field error
  * {error && <FieldError>{error}</FieldError>}
  * ```
  */

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldError/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CAWzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldError/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CAWzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/components/fieldError/index.js

@@ -1,25 +1,18 @@
 import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
 import "./styles.css";
 /**
- * FieldError component - used to display error messages for form fields
+ * FieldError — displays a validation error message below a form field.
  *
- * @param props - FieldError component properties
+ * Renders nothing when `children` is empty or falsy.
  *
- * **...Other valid HTML properties for strong element**
+ * **...Other valid HTML properties for `<strong>`**
  *
- * @returns FieldError JSX element or empty fragment if no children
+ * @returns FieldError `<strong>` element, or an empty fragment when there is no message.
  *
  * @example
  * ```tsx
- * // Basic field error
  * <FieldError>This field is required</FieldError>
  *
- * // Field error with custom styling
- * <FieldError className="custom-error">
- *  Invalid email format
- * </FieldError>
- *
- * // Conditional field error
  * {error && <FieldError>{error}</FieldError>}
  * ```
  */

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

@@ -1,36 +1,21 @@
 import { LabelHTMLAttributes } from "react";
 import "./styles.css";
 type FieldLabelProps = LabelHTMLAttributes<HTMLLabelElement> & {
+    /** When true, appends an asterisk (*) to signal a required field. @default false */
     showAsterisk?: boolean;
 };
 /**
- * FieldLabel component - used to display labels for form fields with optional required indicator
+ * FieldLabel — label for form fields, with an optional required-field asterisk.
  *
- * @param props - FieldLabel component properties
- * @param props.showAsterisk - Whether to display an asterisk (*) to indicate required field. Default: false
+ * @param props.showAsterisk - Appends `*` to the label. Default: false
  *
- * **...Other valid HTML properties for label element**
+ * **...Other valid HTML properties for `<label>`**
  *
- * @returns FieldLabel JSX element
+ * @returns FieldLabel JSX element.
  *
  * @example
  * ```tsx
- * // Basic field label
- * <FieldLabel htmlFor="username">Username</FieldLabel>
- *
- * // Required field label with asterisk
- * <FieldLabel htmlFor="email" showAsterisk>
- *   Email Address
- * </FieldLabel>
- *
- * // Label with custom styling
- * <FieldLabel
- *   htmlFor="password"
- *   className="custom-label"
- *   showAsterisk
- * >
- *   Password
- * </FieldLabel>
+ * <FieldLabel htmlFor="email" showAsterisk>Email Address</FieldLabel>
  * ```
  */
 declare function FieldLabel(props: FieldLabelProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldLabel/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,GAAG;IAC7D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CAWzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldLabel/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,GAAG;IAC7D,oFAAoF;IACpF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CAWzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/components/fieldLabel/index.js

@@ -1,33 +1,17 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import "./styles.css";
 /**
- * FieldLabel component - used to display labels for form fields with optional required indicator
+ * FieldLabel — label for form fields, with an optional required-field asterisk.
  *
- * @param props - FieldLabel component properties
- * @param props.showAsterisk - Whether to display an asterisk (*) to indicate required field. Default: false
+ * @param props.showAsterisk - Appends `*` to the label. Default: false
  *
- * **...Other valid HTML properties for label element**
+ * **...Other valid HTML properties for `<label>`**
  *
- * @returns FieldLabel JSX element
+ * @returns FieldLabel JSX element.
  *
  * @example
  * ```tsx
- * // Basic field label
- * <FieldLabel htmlFor="username">Username</FieldLabel>
- *
- * // Required field label with asterisk
- * <FieldLabel htmlFor="email" showAsterisk>
- *   Email Address
- * </FieldLabel>
- *
- * // Label with custom styling
- * <FieldLabel
- *   htmlFor="password"
- *   className="custom-label"
- *   showAsterisk
- * >
- *   Password
- * </FieldLabel>
+ * <FieldLabel htmlFor="email" showAsterisk>Email Address</FieldLabel>
  * ```
  */
 function FieldLabel(props) {

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

@@ -1,40 +1,30 @@
 import { HTMLAttributes, ReactNode } from "react";
 import "./styles.css";
 type FieldWrapperProps = HTMLAttributes<HTMLElement> & {
+    /** Field elements to render inside the wrapper (label, input, error, etc.). Required. */
     children: ReactNode;
+    /**
+     * Layout orientation of the wrapper.
+     * @default "vertical"
+     */
     orientation?: "vertical" | "horizontal" | "horizontalReverse";
 };
 /**
- * FieldWrapper component - used as a container wrapper for a single form field and its related elements
+ * FieldWrapper — `<section>` container that groups a form field with its label and error message.
  *
- * @param props - FieldWrapper component properties
- * @param props.children - React elements that compose a single field (label, input, error message, etc.)
- * @param props.orientation - Orientation of the field wrapper. Default: "vertical"
+ * @param props.children - Field elements (label, input, error, etc.).
+ * @param props.orientation - Layout direction. Default: "vertical"
  *
- * **...Other valid HTML properties for section element**
+ * **...Other valid HTML properties for `<section>`**
  *
- * @returns FieldWrapper JSX element
+ * @returns FieldWrapper JSX element.
  *
  * @example
  * ```tsx
- * // Basic field container
  * <FieldWrapper>
- *   <FieldLabel>Username</FieldLabel>
- *   <Input name="username" />
- *   <FieldError>This field is required</FieldError>
- * </FieldWrapper>
- *
- * // Field container with custom styling
- * <FieldWrapper className="custom-spacing">
- *   <FieldLabel>Email</FieldLabel>
+ *   <FieldLabel showAsterisk>Email</FieldLabel>
  *   <Input name="email" type="email" />
- * </FieldWrapper>
- *
- * // Complete field with all elements
- * <FieldWrapper>
- *   <FieldLabel showAsterisk>Password</FieldLabel>
- *   <Input name="password" type="password" />
- *   <FieldError>Password must be at least 8 characters</FieldError>
+ *   <FieldError>Invalid email address</FieldError>
  * </FieldWrapper>
  * ```
  */

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldWrapper/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACrD,QAAQ,EAAE,SAAS,CAAC;IACpB,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,mBAAmB,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,2CAe7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/fieldWrapper/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,cAAc,CAAC;AAEtB,KAAK,iBAAiB,GAAG,cAAc,CAAC,WAAW,CAAC,GAAG;IACrD,yFAAyF;IACzF,QAAQ,EAAE,SAAS,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,mBAAmB,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,iBAAiB,2CAe7C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}