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

package/dist/components/radio/radioBox/index.d.ts

@@ -1,84 +1,36 @@
 import { ButtonHTMLAttributes } from "react";
 import "./styles.css";
 type RadioBoxProps = ButtonHTMLAttributes<HTMLButtonElement> & {
+    /** Value submitted to the form when this option is selected. Required. */
     value: string;
+    /** Applies error styling. Inherited from `RadioGroup` when not set. */
     isError?: boolean;
+    /** Size variant. Inherits from `RadioGroup` when not set. */
     size?: "sm" | "md" | "lg";
 };
 /**
- * RadioBox component - individual radio button option that must be used within a RadioGroup
+ * RadioBox — individual option inside a `RadioGroup`. Renders as a `<label>` + hidden `<button>` pair.
  *
- * @param props - RadioBox component properties
- * @param props.value - Required unique value for this radio option within the group
- * @param props.isError - Optional error state indicator for styling
- * @param props.size - Size variant for the radio box, inherits from RadioGroup if not specified
- * @param props.children - Content to display next to the radio button (label text, icons, etc.)
+ * Reads active value, size, error state, and disabled state from `RadioGroup` context.
+ * Must be used as a direct child of `RadioGroup`.
  *
- * **...Other valid HTML properties for button element**
+ * @param props.value - Option value. Required.
+ * @param props.children - Option label content (text, icons, or rich markup).
+ * @param props.disabled - Disables this option (group can also disable all options).
+ * @param props.size - Size override. Inherits from group by default.
  *
- * @returns RadioBox JSX element wrapped in a label for accessibility
+ * **...Other valid HTML `<button>` properties**
+ *
+ * @returns RadioBox JSX element.
  *
  * @example
  * ```tsx
- * // Basic radio boxes within a group
- * <RadioGroup name="gender">
- *   <RadioBox value="male">Male</RadioBox>
- *   <RadioBox value="female">Female</RadioBox>
- *   <RadioBox value="other">Other</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with rich content
- * <RadioGroup name="plan" label="Choose your plan">
- *   <RadioBox value="basic">
- *     <div>
- *       <h4>Basic Plan</h4>
- *       <p>$9.99/month - Perfect for individuals</p>
- *     </div>
- *   </RadioBox>
- *   <RadioBox value="premium">
- *     <div>
- *       <h4>Premium Plan</h4>
- *       <p>$19.99/month - Great for small teams</p>
- *     </div>
- *   </RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with custom size override
- * <RadioGroup name="priority" size="md">
- *   <RadioBox value="low" size="sm">Low Priority</RadioBox>
- *   <RadioBox value="medium">Medium Priority</RadioBox>
- *   <RadioBox value="high" size="lg">High Priority</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with disabled state
- * <RadioGroup name="options">
- *   <RadioBox value="option1">Available Option</RadioBox>
- *   <RadioBox value="option2" disabled>Disabled Option</RadioBox>
- *   <RadioBox value="option3">Another Available Option</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with custom styling
- * <RadioGroup name="theme">
- *   <RadioBox value="light" className="theme-option">
- *     🌞 Light Theme
- *   </RadioBox>
- *   <RadioBox value="dark" className="theme-option">
- *     🌙 Dark Theme
- *   </RadioBox>
- *   <RadioBox value="auto" className="theme-option">
- *     🔄 Auto Theme
- *   </RadioBox>
+ * <RadioGroup name="plan" label="Choose a plan" onChange={setPlan}>
+ *   <RadioBox value="basic">Basic — $9/mo</RadioBox>
+ *   <RadioBox value="pro">Pro — $29/mo</RadioBox>
+ *   <RadioBox value="enterprise" disabled>Enterprise — contact us</RadioBox>
  * </RadioGroup>
  * ```
- *
- * @remarks
- * This component must be used as a child of RadioGroup. It automatically inherits:
- * - Group name for form handling
- * - Size from parent RadioGroup (unless overridden)
- * - Change handlers and state management
- * - Error states from form validation
- *
- * The component handles both click and focus events for accessibility.
  */
 declare function RadioBox(props: RadioBoxProps): import("react/jsx-runtime").JSX.Element;
 export { RadioBox };

package/dist/components/radio/radioBox/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/radioBox/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAG7C,OAAO,cAAc,CAAC;AAEtB,KAAK,aAAa,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,GAAG;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AAEH,iBAAS,QAAQ,CAAC,KAAK,EAAE,aAAa,2CAqDrC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/radioBox/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAG7C,OAAO,cAAc,CAAC;AAEtB,KAAK,aAAa,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,GAAG;IAC7D,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,iBAAS,QAAQ,CAAC,KAAK,EAAE,aAAa,2CAqDrC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/components/radio/radioBox/index.js

@@ -2,79 +2,28 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useRadioGroup } from "../radioContext";
 import "./styles.css";
 /**
- * RadioBox component - individual radio button option that must be used within a RadioGroup
+ * RadioBox — individual option inside a `RadioGroup`. Renders as a `<label>` + hidden `<button>` pair.
  *
- * @param props - RadioBox component properties
- * @param props.value - Required unique value for this radio option within the group
- * @param props.isError - Optional error state indicator for styling
- * @param props.size - Size variant for the radio box, inherits from RadioGroup if not specified
- * @param props.children - Content to display next to the radio button (label text, icons, etc.)
+ * Reads active value, size, error state, and disabled state from `RadioGroup` context.
+ * Must be used as a direct child of `RadioGroup`.
  *
- * **...Other valid HTML properties for button element**
+ * @param props.value - Option value. Required.
+ * @param props.children - Option label content (text, icons, or rich markup).
+ * @param props.disabled - Disables this option (group can also disable all options).
+ * @param props.size - Size override. Inherits from group by default.
  *
- * @returns RadioBox JSX element wrapped in a label for accessibility
+ * **...Other valid HTML `<button>` properties**
+ *
+ * @returns RadioBox JSX element.
  *
  * @example
  * ```tsx
- * // Basic radio boxes within a group
- * <RadioGroup name="gender">
- *   <RadioBox value="male">Male</RadioBox>
- *   <RadioBox value="female">Female</RadioBox>
- *   <RadioBox value="other">Other</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with rich content
- * <RadioGroup name="plan" label="Choose your plan">
- *   <RadioBox value="basic">
- *     <div>
- *       <h4>Basic Plan</h4>
- *       <p>$9.99/month - Perfect for individuals</p>
- *     </div>
- *   </RadioBox>
- *   <RadioBox value="premium">
- *     <div>
- *       <h4>Premium Plan</h4>
- *       <p>$19.99/month - Great for small teams</p>
- *     </div>
- *   </RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with custom size override
- * <RadioGroup name="priority" size="md">
- *   <RadioBox value="low" size="sm">Low Priority</RadioBox>
- *   <RadioBox value="medium">Medium Priority</RadioBox>
- *   <RadioBox value="high" size="lg">High Priority</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with disabled state
- * <RadioGroup name="options">
- *   <RadioBox value="option1">Available Option</RadioBox>
- *   <RadioBox value="option2" disabled>Disabled Option</RadioBox>
- *   <RadioBox value="option3">Another Available Option</RadioBox>
- * </RadioGroup>
- *
- * // Radio boxes with custom styling
- * <RadioGroup name="theme">
- *   <RadioBox value="light" className="theme-option">
- *     🌞 Light Theme
- *   </RadioBox>
- *   <RadioBox value="dark" className="theme-option">
- *     🌙 Dark Theme
- *   </RadioBox>
- *   <RadioBox value="auto" className="theme-option">
- *     🔄 Auto Theme
- *   </RadioBox>
+ * <RadioGroup name="plan" label="Choose a plan" onChange={setPlan}>
+ *   <RadioBox value="basic">Basic — $9/mo</RadioBox>
+ *   <RadioBox value="pro">Pro — $29/mo</RadioBox>
+ *   <RadioBox value="enterprise" disabled>Enterprise — contact us</RadioBox>
  * </RadioGroup>
  * ```
- *
- * @remarks
- * This component must be used as a child of RadioGroup. It automatically inherits:
- * - Group name for form handling
- * - Size from parent RadioGroup (unless overridden)
- * - Change handlers and state management
- * - Error states from form validation
- *
- * The component handles both click and focus events for accessibility.
  */
 function RadioBox(props) {
     const { value: componentValue, size: componentSize, disabled, children, className: baseClassName = "", onClick, onFocus, ...rest } = props;

package/dist/components/radio/radioGroup/index.d.ts

@@ -1,94 +1,63 @@
 import { HTMLAttributes } from "react";
 import "./styles.css";
 type RadioGroupProps = Omit<HTMLAttributes<HTMLDivElement>, "onChange"> & {
+    /** Field name used for form submission. Required. */
     name: string;
+    /** Label displayed above the group. */
     label?: string;
+    /** Appends an asterisk to the label. @default false */
     showAsterisk?: boolean;
+    /** Error message shown below the group. Overrides `fieldErrors[name]` from `FormProvider`. */
     errorMessage?: string;
+    /** Controlled selected value. */
     value?: string;
+    /** Initial selected value (uncontrolled). @default "" */
     defaultValue?: string;
+    /** Callback fired when the selected option changes. */
     onChange?: (value: string) => void;
+    /** Size variant applied to all `RadioBox` children. @default "md" */
     size?: "sm" | "md" | "lg";
+    /** Disables all `RadioBox` children. @default false */
     disabled?: boolean;
+    /** When `true`, skips the `FieldTemplate` wrapper (label, error message). @default false */
     unShowFieldTemplate?: boolean;
+    /** Layout direction of the `FieldWrapper`. @default "horizontal" */
     orientation?: "horizontal" | "vertical" | "horizontalReverse";
 };
 /**
- * RadioGroup component - used for creating a group of radio button options with shared state management
+ * RadioGroup — managed group of `RadioBox` options with form integration.
  *
- * @param props - RadioGroup component properties
- * @param props.name - Required field name for form handling and radio button grouping
- * @param props.label - Optional label text to display above the radio group
- * @param props.showAsterisk - Whether to show asterisk on label for required fields
- * @param props.errorMessage - Error message to display below the radio group
- * @param props.value - Controlled value for the selected radio option
- * @param props.defaultValue - Default selected value for uncontrolled usage. Default: ""
- * @param props.onChange - Callback function called when radio selection changes, receives the selected value
- * @param props.size - Size variant for all radio buttons in the group. Default: "md"
- * @param props.unShowFieldTemplate - When true, skips `FieldTemplate` structure (wrapper, label and error text) and renders only the checkbox button content.
- * @param props.orientation - Layout direction forwarded to `FieldTemplate`/`FieldWrapper` (`horizontal`, `vertical`, `horizontalReverse`). Default: "horizontalReverse"
+ * Renders a hidden `<input>` for native form submission. Reads `fieldErrors[name]` from
+ * the nearest `FormProvider` when no `errorMessage` is explicitly provided.
  *
- * **...Other valid HTML properties for div element (except onChange)**
+ * @param props.name - Form field name. Required.
+ * @param props.label - Label displayed above the group.
+ * @param props.showAsterisk - Appends `*` to the label. Default: false
+ * @param props.value - Controlled selection.
+ * @param props.defaultValue - Initial selection (uncontrolled). Default: `""`
+ * @param props.onChange - Called with the newly selected value.
+ * @param props.size - Size for all child `RadioBox` elements. Default: `"md"`
+ * @param props.disabled - Disables all options. Default: false
+ * @param props.errorMessage - Validation error message.
+ * @param props.unShowFieldTemplate - Omit label/error wrapper. Default: false
  *
- * @returns RadioGroup JSX element wrapped in FieldWrapper with RadioProvider context for child Radio components
+ * **...Other valid HTML `<div>` properties**
+ *
+ * @returns RadioGroup JSX element.
  *
  * @example
  * ```tsx
- * // Basic radio group
- * <RadioGroup name="gender">
- *   <Radio value="male" label="Male" />
- *   <Radio value="female" label="Female" />
- *   <Radio value="other" label="Other" />
- * </RadioGroup>
- *
- * // Radio group with label and validation
- * <RadioGroup
- *   name="subscription"
- *   label="Choose your plan"
- *   showAsterisk
- *   errorMessage="Please select a subscription plan"
- * >
- *   <Radio value="basic" label="Basic Plan - $9.99/month" />
- *   <Radio value="premium" label="Premium Plan - $19.99/month" />
- *   <Radio value="enterprise" label="Enterprise Plan - $49.99/month" />
- * </RadioGroup>
- *
- * // Controlled radio group with callback
- * <RadioGroup
- *   name="theme"
- *   label="Select Theme"
- *   value={selectedTheme}
- *   onChange={(value) => setSelectedTheme(value)}
- *   size="lg"
- * >
- *   <Radio value="light" label="Light Theme" />
- *   <Radio value="dark" label="Dark Theme" />
- *   <Radio value="auto" label="Auto (System)" />
- * </RadioGroup>
- *
- * // Radio group with default selection
- * <RadioGroup
- *   name="language"
- *   label="Preferred Language"
- *   defaultValue="en"
- *   size="sm"
- * >
- *   <Radio value="en" label="English" />
- *   <Radio value="es" label="Spanish" />
- *   <Radio value="fr" label="French" />
- *   <Radio value="pt" label="Portuguese" />
+ * // Uncontrolled with label
+ * <RadioGroup name="gender" label="Gender" showAsterisk defaultValue="male">
+ *   <RadioBox value="male">Male</RadioBox>
+ *   <RadioBox value="female">Female</RadioBox>
+ *   <RadioBox value="other">Other</RadioBox>
  * </RadioGroup>
  *
- * // Radio group with custom styling and onChange handler
- * <RadioGroup
- *   name="difficulty"
- *   label="Select Difficulty Level"
- *   className="custom-radio-group"
- *   onChange={(value) => console.log('Selected difficulty:', value)}
- * >
- *   <Radio value="easy" label="Easy" />
- *   <Radio value="medium" label="Medium" />
- *   <Radio value="hard" label="Hard" />
+ * // Controlled with change handler
+ * <RadioGroup name="plan" label="Subscription plan" value={plan} onChange={setPlan}>
+ *   <RadioBox value="basic">Basic — $9/mo</RadioBox>
+ *   <RadioBox value="pro">Pro — $29/mo</RadioBox>
  * </RadioGroup>
  * ```
  */

package/dist/components/radio/radioGroup/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/radioGroup/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAY,MAAM,OAAO,CAAC;AAMjD,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,GAAG;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,GAAG,mBAAmB,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CA0DzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/radioGroup/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAY,MAAM,OAAO,CAAC;AAMjD,OAAO,cAAc,CAAC;AAEtB,KAAK,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,GAAG;IACxE,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,qEAAqE;IACrE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4FAA4F;IAC5F,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,oEAAoE;IACpE,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,GAAG,mBAAmB,CAAC;CAC/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,iBAAS,UAAU,CAAC,KAAK,EAAE,eAAe,2CA0DzC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/components/radio/radioGroup/index.js

@@ -5,81 +5,39 @@ import { FieldTemplate } from "../../../services/fieldTemplate";
 import { RadioProvider } from "../radioContext";
 import "./styles.css";
 /**
- * RadioGroup component - used for creating a group of radio button options with shared state management
+ * RadioGroup — managed group of `RadioBox` options with form integration.
  *
- * @param props - RadioGroup component properties
- * @param props.name - Required field name for form handling and radio button grouping
- * @param props.label - Optional label text to display above the radio group
- * @param props.showAsterisk - Whether to show asterisk on label for required fields
- * @param props.errorMessage - Error message to display below the radio group
- * @param props.value - Controlled value for the selected radio option
- * @param props.defaultValue - Default selected value for uncontrolled usage. Default: ""
- * @param props.onChange - Callback function called when radio selection changes, receives the selected value
- * @param props.size - Size variant for all radio buttons in the group. Default: "md"
- * @param props.unShowFieldTemplate - When true, skips `FieldTemplate` structure (wrapper, label and error text) and renders only the checkbox button content.
- * @param props.orientation - Layout direction forwarded to `FieldTemplate`/`FieldWrapper` (`horizontal`, `vertical`, `horizontalReverse`). Default: "horizontalReverse"
+ * Renders a hidden `<input>` for native form submission. Reads `fieldErrors[name]` from
+ * the nearest `FormProvider` when no `errorMessage` is explicitly provided.
  *
- * **...Other valid HTML properties for div element (except onChange)**
+ * @param props.name - Form field name. Required.
+ * @param props.label - Label displayed above the group.
+ * @param props.showAsterisk - Appends `*` to the label. Default: false
+ * @param props.value - Controlled selection.
+ * @param props.defaultValue - Initial selection (uncontrolled). Default: `""`
+ * @param props.onChange - Called with the newly selected value.
+ * @param props.size - Size for all child `RadioBox` elements. Default: `"md"`
+ * @param props.disabled - Disables all options. Default: false
+ * @param props.errorMessage - Validation error message.
+ * @param props.unShowFieldTemplate - Omit label/error wrapper. Default: false
  *
- * @returns RadioGroup JSX element wrapped in FieldWrapper with RadioProvider context for child Radio components
+ * **...Other valid HTML `<div>` properties**
+ *
+ * @returns RadioGroup JSX element.
  *
  * @example
  * ```tsx
- * // Basic radio group
- * <RadioGroup name="gender">
- *   <Radio value="male" label="Male" />
- *   <Radio value="female" label="Female" />
- *   <Radio value="other" label="Other" />
- * </RadioGroup>
- *
- * // Radio group with label and validation
- * <RadioGroup
- *   name="subscription"
- *   label="Choose your plan"
- *   showAsterisk
- *   errorMessage="Please select a subscription plan"
- * >
- *   <Radio value="basic" label="Basic Plan - $9.99/month" />
- *   <Radio value="premium" label="Premium Plan - $19.99/month" />
- *   <Radio value="enterprise" label="Enterprise Plan - $49.99/month" />
- * </RadioGroup>
- *
- * // Controlled radio group with callback
- * <RadioGroup
- *   name="theme"
- *   label="Select Theme"
- *   value={selectedTheme}
- *   onChange={(value) => setSelectedTheme(value)}
- *   size="lg"
- * >
- *   <Radio value="light" label="Light Theme" />
- *   <Radio value="dark" label="Dark Theme" />
- *   <Radio value="auto" label="Auto (System)" />
- * </RadioGroup>
- *
- * // Radio group with default selection
- * <RadioGroup
- *   name="language"
- *   label="Preferred Language"
- *   defaultValue="en"
- *   size="sm"
- * >
- *   <Radio value="en" label="English" />
- *   <Radio value="es" label="Spanish" />
- *   <Radio value="fr" label="French" />
- *   <Radio value="pt" label="Portuguese" />
+ * // Uncontrolled with label
+ * <RadioGroup name="gender" label="Gender" showAsterisk defaultValue="male">
+ *   <RadioBox value="male">Male</RadioBox>
+ *   <RadioBox value="female">Female</RadioBox>
+ *   <RadioBox value="other">Other</RadioBox>
  * </RadioGroup>
  *
- * // Radio group with custom styling and onChange handler
- * <RadioGroup
- *   name="difficulty"
- *   label="Select Difficulty Level"
- *   className="custom-radio-group"
- *   onChange={(value) => console.log('Selected difficulty:', value)}
- * >
- *   <Radio value="easy" label="Easy" />
- *   <Radio value="medium" label="Medium" />
- *   <Radio value="hard" label="Hard" />
+ * // Controlled with change handler
+ * <RadioGroup name="plan" label="Subscription plan" value={plan} onChange={setPlan}>
+ *   <RadioBox value="basic">Basic — $9/mo</RadioBox>
+ *   <RadioBox value="pro">Pro — $29/mo</RadioBox>
  * </RadioGroup>
  * ```
  */

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

@@ -1,67 +1,53 @@
 import { RichTextProps } from "../../types/richTextTypes";
 import "./styles.css";
 /**
- * RichText component provides a feature-rich text editor with formatting capabilities
- * including bold, italic, underline, code, headings, block quotes, alignment, and image insertion.
- *
- * Built on top of Slate.js, this component offers a customizable toolbar and supports
- * character limits, form integration, and error handling.
- *
- * @param props - Configuration object for the RichText component
- * @param props.name - The name attribute for the form field (required)
- * @param props.hiddenButtons - Array of button keys to hide from the toolbar
- * @param props.imageConfig - Configuration object for image insertion functionality
- * @param props.defaultValue - Initial JSON string value for the editor content (default: "[]")
- * @param props.enforceCharacterLimit - Whether to enforce the character limit strictly (default: false)
- * @param props.onChangeCharactersCount - Callback function triggered when character count changes
- * @param props.baseErrorMessage - Custom error message to display
- * @param props.maxLimit - Maximum number of characters allowed (default: 10000)
- * @param props.onChange - Callback function triggered when editor content changes
- * @param props.isError - Whether the component should display in error state
- * @param props.id - Custom ID for the editor element
- * @param props.unShowFieldTemplate - When true, skips `FieldTemplate` structure (wrapper, label and error text) and renders only the checkbox button content.
- * @param props.orientation - Layout direction forwarded to `FieldTemplate`/`FieldWrapper` (`horizontal`, `vertical`, `horizontalReverse`). Default: "horizontalReverse"
- *
- * @returns JSX element representing the rich text editor
+ * RichText — WYSIWYG rich-text editor built on Slate.js with a configurable toolbar.
+ *
+ * **Toolbar features:** bold, italic, underline, code, H1/H2, block quote, alignment (left/center/right/justify), image and video insertion.
+ *
+ * Editor content is stored as a Slate JSON string in a hidden `<input>` for form submission.
+ * 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 editor.
+ * @param props.hiddenButtons - Toolbar button keys to hide (e.g. `["image", "code"]`).
+ * @param props.imageConfig - Enables image insertion; contains the upload endpoint and modal labels.
+ * @param props.defaultValue - Initial editor content as a Slate JSON string. Default: "[]"
+ * @param props.maxLimit - Maximum character count. Default: 10000
+ * @param props.enforceCharacterLimit - Prevents typing past `maxLimit`. Default: false
+ * @param props.onChangeCharactersCount - Callback fired on every keystroke — receives the current character count.
+ * @param props.onChange - Callback fired when editor content changes — receives the Slate `Descendant[]`.
+ * @param props.baseErrorMessage - Custom error message (overrides `useForm` context error).
+ * @param props.isError - Forces the error visual state.
+ * @param props.id - Custom id for the editable area element.
+ * @param props.showAsterisk - Appends `*` to the label.
+ * @param props.orientation - Layout direction. Default: "horizontal"
+ * @param props.unShowFieldTemplate - Skips wrapper, label, and error rendering. Default: false
+ *
+ * @returns RichText JSX element wrapped in `FieldTemplate`.
  *
  * @example
  * ```tsx
- * // Basic usage
+ * // Basic
  * <RichText name="content" />
  *
- * // With character limit and custom buttons
+ * // With character limit and hidden toolbar buttons
  * <RichText
  *   name="description"
+ *   label="Description"
  *   maxLimit={500}
- *   enforceCharacterLimit={true}
- *   hiddenButtons={["image", "code"]}
- *   onChangeCharactersCount={(count) => console.log(count)}
+ *   enforceCharacterLimit
+ *   hiddenButtons={["image", "video", "code"]}
+ *   onChangeCharactersCount={(n) => setCharCount(n)}
  * />
  *
- * // With image upload configuration
+ * // With image upload support
  * <RichText
  *   name="article"
- *   imageConfig={{
- *     action: "/api/upload",
- *     modalTitle: "Insert Image",
- *     modalInputUrlLabel: "Image URL",
- *     modalInputImageLabel: "Upload Image"
- *   }}
+ *   label="Article Body"
+ *   imageConfig={{ action: "/api/upload" }}
  * />
  * ```
- *
- * @description
- * The component includes:
- * - **Formatting**: Bold, italic, underline, code, headings (H1, H2), block quotes
- * - **Alignment**: Left, center, right, justify
- * - **Image Support**: Upload and URL insertion (when imageConfig is provided)
- * - **Character Limits**: Configurable limits with visual feedback
- * - **Form Integration**: Works with form providers and validation
- * - **Keyboard Shortcuts**: Standard shortcuts for formatting (Ctrl+B, Ctrl+I, etc.)
- * - **Error Handling**: Visual error states and validation messages
- *
- * The editor outputs JSON data representing the document structure, which can be
- * converted to HTML using the provided utility functions.
  */
 declare function RichText(props: RichTextProps): import("react/jsx-runtime").JSX.Element;
 export { RichText };

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/richText/index.tsx"],"names":[],"mappings":"AAgCA,OAAO,EAEL,aAAa,EACd,MAAM,2BAA2B,CAAC;AACnC,OAAO,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AAEH,iBAAS,QAAQ,CAAC,KAAK,EAAE,aAAa,2CAuMrC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/richText/index.tsx"],"names":[],"mappings":"AAgCA,OAAO,EAEL,aAAa,EACd,MAAM,2BAA2B,CAAC;AACnC,OAAO,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAEH,iBAAS,QAAQ,CAAC,KAAK,EAAE,aAAa,2CAuMrC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}