@allxsmith/bestax-bulma 5.7.0 → 5.8.1

package/dist/types/form/Control.d.ts

@@ -1,31 +1,68 @@
 import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 import { IconProps } from '../elements/Icon';
+/**
+ * Props for the Control component.
+ */
 export interface ControlBaseProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Adds left icon container. */
     hasIconsLeft?: boolean;
+    /** Adds right icon container. */
     hasIconsRight?: boolean;
+    /** Shows loading indicator. */
     isLoading?: boolean;
+    /** Makes the control expand to fill available space. */
     isExpanded?: boolean;
+    /** Sets the control size. */
     size?: 'small' | 'medium' | 'large';
+    /** Sets text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma color for the control. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Icon props for left icon. */
     iconLeft?: IconProps;
+    /** Icon props for right icon. */
     iconRight?: IconProps;
+    /** Shortcut for left icon name. */
     iconLeftName?: string;
+    /** Shortcut for left icon size. */
     iconLeftSize?: 'small' | 'medium' | 'large';
+    /** Shortcut for right icon name. */
     iconRightName?: string;
+    /** Shortcut for right icon size. */
     iconRightSize?: 'small' | 'medium' | 'large';
+    /** Additional CSS classes to apply. */
     className?: string;
+    /** Content inside the control. */
     children?: React.ReactNode;
 }
+/**
+ * The `Control` component is a Bulma-styled wrapper for form controls (`Input`, `Select`, `TextArea`, etc.), supporting icons (left/right), loading state, expansion, size, and Bulma helper props for layout and color.
+ *
+ * @function
+ * @param {ControlProps} props - Props for the Control component.
+ * @returns {JSX.Element} The rendered control container.
+ * @see {@link https://bulma.io/documentation/form/general/#control | Bulma Control documentation}
+ *
+ * @example
+ * // Control with left icon
+ * <Control iconLeftName="envelope" iconLeftSize="small">
+ *   <input className="input" type="email" placeholder="Email" />
+ * </Control>
+ */
 export declare const Control: React.ForwardRefExoticComponent<(Omit<{
+    /** Element type for the control (`div` by default). */
     as?: "div";
 } & ControlBaseProps & {
+    /** Ref for the control element. */
     ref?: React.Ref<HTMLDivElement>;
 }, "ref"> | Omit<{
+    /** Element type for the control (`div` by default). */
     as: "p";
 } & Omit<ControlBaseProps, keyof React.HTMLAttributes<HTMLDivElement>> & React.HTMLAttributes<HTMLParagraphElement> & {
+    /** Ref for the control element. */
     ref?: React.Ref<HTMLParagraphElement>;
 }, "ref">) & React.RefAttributes<HTMLDivElement | HTMLParagraphElement>>;
 export default Control;

package/dist/types/form/DateInput.d.ts

@@ -2,25 +2,69 @@ import React from 'react';
 import { FieldProps } from './Field';
 import { ControlBaseProps } from './Control';
 import { DateInputBaseProps } from './DateInputBase';
+/**
+ * Props for the DateInput convenience wrapper. Extends `DateInputBaseProps`
+ * with Field-level (label, horizontal) and Control-level (icons, loading) props.
+ * @extraProp {string} [name] - Form field name. Forwarded to a hidden ISO-formatted input.
+ * @extraProp {string} [form] - Form id the input belongs to.
+ * @extraProp {boolean} [required=false] - Marks the input as required.
+ * @extraProp {string} [className] - Additional CSS classes for the input.
+ * @extraProp {React.Ref<HTMLInputElement>} [ref] - Forwarded to the underlying `<input>`.
+ */
 export interface DateInputProps extends DateInputBaseProps {
+    /** Field label (component auto-wraps in a `Field` if not already inside). */
     label?: React.ReactNode;
+    /** Size for the label. */
     labelSize?: FieldProps['labelSize'];
+    /** Props for the label element. */
     labelProps?: FieldProps['labelProps'];
+    /** Render the field with horizontal layout. */
     horizontal?: boolean;
+    /** Icon props for the left icon. */
     iconLeft?: ControlBaseProps['iconLeft'];
+    /** Icon props for the right icon. */
     iconRight?: ControlBaseProps['iconRight'];
+    /** Shortcut for the right icon name. */
     iconRightName?: string;
+    /** Shortcut for left icon size. */
     iconLeftSize?: ControlBaseProps['iconLeftSize'];
+    /** Shortcut for right icon size. */
     iconRightSize?: ControlBaseProps['iconRightSize'];
+    /** Force the left icon container. */
     hasIconsLeft?: boolean;
+    /** Force the right icon container. */
     hasIconsRight?: boolean;
+    /** Show a loading indicator on the control. */
     isLoading?: boolean;
+    /** Expand the control to fill its container. */
     isExpanded?: boolean;
+    /** Size of the wrapping Control. */
     controlSize?: ControlBaseProps['size'];
+    /** Help/validation text below the input. */
     message?: React.ReactNode;
+    /** Color modifier for the help message. */
     messageColor?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Additional CSS classes for the Field wrapper. */
     fieldClassName?: string;
+    /** Additional CSS classes for the Control wrapper. */
     controlClassName?: string;
 }
+/**
+ * The `DateInput` component is a form input that opens a popover calendar for date selection.
+ *
+ * @function
+ * @param {DateInputProps} props - Props for the DateInput.
+ * @returns {JSX.Element}
+ *
+ * @example
+ * <DateInput label="Date of birth" defaultValue={new Date(1990, 0, 1)} />
+ *
+ * @example
+ * <DateInput
+ *   label="Booking"
+ *   min={new Date()}
+ *   shouldDisableDate={d => d.getDay() === 0 || d.getDay() === 6}
+ * />
+ */
 export declare const DateInput: React.ForwardRefExoticComponent<DateInputProps & React.RefAttributes<HTMLInputElement>>;
 export default DateInput;

package/dist/types/form/DateInputBase.d.ts

@@ -2,41 +2,90 @@ import React from 'react';
 import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 import { PickerPosition, DayOfWeek, PickerLabels } from './_pickerInternals/pickerTypes';
 import { DateFormatOption } from './_pickerInternals/formatters';
+/**
+ * Props for the raw DateInput base. Use the higher-level `DateInput` for
+ * Field/Control composition; `DateInputBase` is the input + popover only.
+ */
 export interface DateInputBaseProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' | 'defaultValue' | 'onChange' | 'size' | 'color' | 'min' | 'max' | 'type' | 'popover'>, Omit<BulmaClassesProps, 'color'> {
+    /** Controlled selected date. */
     value?: Date | null;
+    /** Initial date for uncontrolled usage. */
     defaultValue?: Date | null;
+    /** Fired when the value changes. */
     onChange?: (d: Date | null) => void;
+    /** Fired when the popover opens. */
     onOpen?: () => void;
+    /** Fired when the popover closes. */
     onClose?: () => void;
+    /** Earliest selectable date. */
     min?: Date;
+    /** Latest selectable date. */
     max?: Date;
+    /** Disable the input. */
     disabled?: boolean;
+    /** Make the input read-only. */
     readOnly?: boolean;
+    /** Placeholder text for the input. */
     placeholder?: string;
+    /**
+     * Token format string or `Intl.DateTimeFormat` options. Default `'YYYY-MM-DD'`.
+     * @defaultValue 'YYYY-MM-DD'
+     */
     format?: DateFormatOption;
+    /** Custom parser (use when `format` is `Intl.DateTimeFormatOptions`). */
     parse?: (s: string) => Date | null;
+    /** BCP-47 locale tag for day/month names and Intl formatting. */
     locale?: string;
+    /** Render the calendar inline (no popover). */
     inline?: boolean;
+    /** Use `<input type="date">` on coarse-pointer + small-viewport devices. */
     mobileNative?: boolean | 'auto';
+    /** Allow segmented keyboard typing in the input (type the date directly, auto-advancing across segments). `false` makes the field picker-only. */
     editable?: boolean;
+    /** Whether the calendar popover exists. `false` makes the field input-only (segmented typing, no popover). */
     popover?: boolean;
+    /** Open the popover when the input is focused. */
     openOnFocus?: boolean;
+    /** Close the popover after a date is selected. */
     closeOnSelect?: boolean;
+    /** Popover anchor position relative to the input. */
     position?: PickerPosition;
+    /** Render the popover into `document.body` via portal. */
     appendToBody?: boolean;
+    /** Bulma color modifier. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Size variant. */
     size?: 'small' | 'medium' | 'large';
+    /** Render the input with rounded corners. */
     isRounded?: boolean;
+    /** Predicate to disable specific dates (e.g. weekends). Blocked dates are also rejected during manual typing. */
     shouldDisableDate?: (d: Date) => boolean;
+    /** Convenience array of disabled dates; merged with `shouldDisableDate`. Matched by calendar day and also rejected during manual typing. */
     unselectableDates?: Date[];
+    /** Day the week starts on (0 = Sunday). */
     firstDayOfWeek?: DayOfWeek;
+    /** Override the 7 day-name labels (in calendar order, post-rotation). */
     dayNames?: string[];
+    /** Override the 12 month-name labels. */
     monthNames?: string[];
+    /** Show dimmed dates from adjacent months in the grid. */
     nearbyMonthDays?: boolean;
+    /** Decorative left icon glyph for the wrapping `Control` (shown by default). Set `''` to hide. */
     iconLeftName?: string;
+    /** Show a clickable launcher button on the right that toggles the popover. Default `true`. */
     triggerIcon?: boolean;
+    /** Glyph for the right launcher button. */
     triggerIconName?: string;
+    /** Optional translatable string overrides (ARIA labels, button text). */
     labels?: PickerLabels;
 }
+/**
+ * Raw DateInput — input + popover calendar without Field/Control wrapping.
+ * Use `DateInput` for the convenience wrapper.
+ *
+ * @function
+ * @param {DateInputBaseProps} props
+ * @returns {JSX.Element}
+ */
 export declare const DateInputBase: React.ForwardRefExoticComponent<DateInputBaseProps & React.RefAttributes<HTMLInputElement>>;
 export default DateInputBase;

package/dist/types/form/DateTimeInput.d.ts

@@ -2,25 +2,67 @@ import React from 'react';
 import { FieldProps } from './Field';
 import { ControlBaseProps } from './Control';
 import { DateTimeInputBaseProps } from './DateTimeInputBase';
+/**
+ * Props for the DateTimeInput convenience wrapper. Extends
+ * `DateTimeInputBaseProps` with Field-level and Control-level props.
+ * @extraProp {string} [name] - Form field name.
+ * @extraProp {string} [form] - Optional id of the form the input belongs to.
+ * @extraProp {boolean} [required=false] - Marks the field as required for native HTML form validation.
+ */
 export interface DateTimeInputProps extends DateTimeInputBaseProps {
+    /** Field label. */
     label?: React.ReactNode;
+    /** Size for the label. */
     labelSize?: FieldProps['labelSize'];
+    /** Props for the label element. */
     labelProps?: FieldProps['labelProps'];
+    /** Render the field with horizontal layout. */
     horizontal?: boolean;
+    /** Icon props for the left icon. */
     iconLeft?: ControlBaseProps['iconLeft'];
+    /** Icon props for the right icon. */
     iconRight?: ControlBaseProps['iconRight'];
+    /** Shortcut for the right icon name. */
     iconRightName?: string;
+    /** Shortcut for left icon size. */
     iconLeftSize?: ControlBaseProps['iconLeftSize'];
+    /** Shortcut for right icon size. */
     iconRightSize?: ControlBaseProps['iconRightSize'];
+    /** Force the left icon container. */
     hasIconsLeft?: boolean;
+    /** Force the right icon container. */
     hasIconsRight?: boolean;
+    /** Show a loading indicator on the control. */
     isLoading?: boolean;
+    /** Expand the control to fill its container. */
     isExpanded?: boolean;
+    /** Size of the wrapping Control. */
     controlSize?: ControlBaseProps['size'];
+    /** Help/validation text below the input. */
     message?: React.ReactNode;
+    /** Message color. */
     messageColor?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Additional CSS classes for the Field wrapper. */
     fieldClassName?: string;
+    /** Additional CSS classes for the Control wrapper. */
     controlClassName?: string;
 }
+/**
+ * The `DateTimeInput` combines a calendar and a time **wheel spinner** in a single popover — an iOS-style layout.
+ *
+ * @function
+ * @param {DateTimeInputProps} props
+ * @returns {JSX.Element}
+ *
+ * @example
+ * <DateTimeInput label="Appointment" defaultValue={new Date()} />
+ *
+ * @example
+ * <DateTimeInput
+ *   label="When"
+ *   hourFormat="12"
+ *   shouldDisableDate={d => d.getDay() === 0 || d.getDay() === 6}
+ * />
+ */
 export declare const DateTimeInput: React.ForwardRefExoticComponent<DateTimeInputProps & React.RefAttributes<HTMLInputElement>>;
 export default DateTimeInput;

package/dist/types/form/DateTimeInputBase.d.ts

@@ -2,49 +2,107 @@ import React from 'react';
 import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 import { PickerPosition, HourFormat, DayOfWeek, PickerLabels } from './_pickerInternals/pickerTypes';
 import { DateFormatOption } from './_pickerInternals/formatters';
+/**
+ * Props for the raw DateTimeInput base. Use the higher-level `DateTimeInput`
+ * for Field/Control composition. Combines the prop set of `DateInputBaseProps`
+ * and `TimeInputBaseProps`.
+ */
 export interface DateTimeInputBaseProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' | 'defaultValue' | 'onChange' | 'size' | 'color' | 'min' | 'max' | 'type' | 'popover'>, Omit<BulmaClassesProps, 'color'> {
+    /** Controlled selected date-time. */
     value?: Date | null;
+    /** Initial value for uncontrolled usage. */
     defaultValue?: Date | null;
+    /** Fired when either the date or time portion changes. */
     onChange?: (d: Date | null) => void;
+    /** Fired when the popover opens. */
     onOpen?: () => void;
+    /** Fired when the popover closes. */
     onClose?: () => void;
+    /** Lower bound for the combined date-time. */
     min?: Date;
+    /** Upper bound for the combined date-time. */
     max?: Date;
+    /** Disable the input. */
     disabled?: boolean;
+    /** Read-only input. */
     readOnly?: boolean;
+    /** Placeholder text. */
     placeholder?: string;
+    /**
+     * Token format string or `Intl.DateTimeFormat` options. Default `'YYYY-MM-DD HH:mm'`.
+     * @defaultValue 'YYYY-MM-DD HH:mm'
+     */
     format?: DateFormatOption;
+    /** Custom parser. */
     parse?: (s: string) => Date | null;
+    /** BCP-47 locale tag. */
     locale?: string;
+    /** Render the panel inline (no popover). */
     inline?: boolean;
+    /** Use `<input type="datetime-local">` on coarse-pointer devices. */
     mobileNative?: boolean | 'auto';
+    /** Allow segmented keyboard typing (type the date-time directly across all segments). `false` makes the field picker-only. */
     editable?: boolean;
+    /** Whether the calendar + time popover exists. `false` makes the field input-only (segmented typing with no popover). Default `true`. */
     popover?: boolean;
+    /** Open the popover on focus. Default `true`. */
     openOnFocus?: boolean;
+    /** Off by default — users typically tweak both halves before committing. */
     closeOnSelect?: boolean;
+    /** Popover anchor position. */
     position?: PickerPosition;
+    /** Render the popover into `document.body` via portal. */
     appendToBody?: boolean;
+    /** Bulma color modifier. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Size variant. */
     size?: 'small' | 'medium' | 'large';
+    /** Rounded input corners. */
     isRounded?: boolean;
+    /** Disable specific dates. Blocked dates are also rejected during manual typing (the predicate receives the full candidate date-time — prefer day-based checks). */
     shouldDisableDate?: (d: Date) => boolean;
+    /** Convenience array of disabled dates, matched by calendar day; also rejected by manual typing. */
     unselectableDates?: Date[];
+    /** Day the calendar week starts on. */
     firstDayOfWeek?: DayOfWeek;
+    /** Override the 7 day-name labels. */
     dayNames?: string[];
+    /** Override the 12 month-name labels. */
     monthNames?: string[];
+    /** Show dimmed dates from adjacent months. */
     nearbyMonthDays?: boolean;
+    /** Time format. */
     hourFormat?: HourFormat;
+    /** Show seconds column. Note: iOS Safari's native datetime-local picker UI does not include a seconds wheel; pass `mobileNative={false}` if you need one on iOS. */
     enableSeconds?: boolean;
+    /** Hour step. */
     incrementHours?: number;
+    /** Step between minute-wheel values (`1` = every minute, iOS-style). */
     incrementMinutes?: number;
+    /** Step between second-wheel values (only with `enableSeconds`). */
     incrementSeconds?: number;
+    /** Block specific times. Blocked times are also rejected during manual typing. */
     unselectableTimes?: (d: Date) => boolean;
+    /** Decorative left icon glyph for the wrapping `Control` (shown by default). Set `''` to hide. */
     iconLeftName?: string;
+    /** Show a clickable launcher button on the right that toggles the popover. Default `true`. */
     triggerIcon?: boolean;
+    /** Glyph for the right launcher button. */
     triggerIconName?: string;
+    /** Play a short audible tick on each time-wheel crossing. Default `false`. */
     audioTick?: boolean;
+    /** Auto-route tactile feedback per wheel tick (vibrate on Android, audio thunk on iOS). Default `false`. */
     haptics?: boolean;
+    /** Optional translatable string overrides. */
     labels?: PickerLabels;
 }
+/**
+ * Raw DateTimeInput — combined input + calendar + time spinner without
+ * Field/Control wrapping. Use `DateTimeInput` for the convenience wrapper.
+ *
+ * @function
+ * @param {DateTimeInputBaseProps} props
+ * @returns {JSX.Element}
+ */
 export declare const DateTimeInputBase: React.ForwardRefExoticComponent<DateTimeInputBaseProps & React.RefAttributes<HTMLInputElement>>;
 export default DateTimeInputBase;

package/dist/types/form/Field.d.ts

@@ -1,37 +1,89 @@
 import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
+/**
+ * Props for the Field component.
+ */
 export interface FieldProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Renders the field as horizontal (label and control side by side). */
     horizontal?: boolean;
+    /** Group controls in a row (optionally centered, right, or multiline). */
     grouped?: boolean | 'centered' | 'right' | 'multiline';
+    /** Group controls as addons (optionally centered or right-aligned). */
     hasAddons?: boolean | 'centered' | 'right';
+    /** Constrains the field to its content's width (used inside horizontal field bodies). */
     narrow?: boolean;
+    /** Field label, rendered above the widget. */
     label?: React.ReactNode;
+    /** Size for the label. */
     labelSize?: 'small' | 'normal' | 'medium' | 'large';
+    /** Props for the label element. */
     labelProps?: React.LabelHTMLAttributes<HTMLLabelElement> & {
         [key: string]: unknown;
     };
+    /** Text color for the field. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma color for the field. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Background color for the field. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Field content. */
     children?: React.ReactNode;
 }
+/**
+ * Props for the FieldLabel component.
+ */
 export interface FieldLabelProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Size for the field label. */
     size?: 'small' | 'normal' | 'medium' | 'large';
+    /** Text color for the label. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma color for the label. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Background color for the label. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Field label content. */
     children?: React.ReactNode;
 }
+/**
+ * Props for the FieldBody component.
+ */
 export interface FieldBodyProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Text color for the field body. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma color for the field body. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Background color for the field body. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Field body content. */
     children?: React.ReactNode;
 }
+/**
+ * FieldLabel component for rendering a Bulma field label.
+ *
+ * @function
+ * @param {FieldLabelProps} props - Props for the FieldLabel component.
+ * @returns {JSX.Element} The rendered field label.
+ *
+ * @example
+ * <FieldLabel size="normal">Name</FieldLabel>
+ */
 export declare const FieldLabel: React.FC<FieldLabelProps>;
+/**
+ * FieldBody component for rendering Bulma field body.
+ *
+ * @function
+ * @param {FieldBodyProps} props - Props for the FieldBody component.
+ * @returns {JSX.Element} The rendered field body.
+ *
+ * @example
+ * <FieldBody><input className="input" /></FieldBody>
+ */
 export declare const FieldBody: React.FC<FieldBodyProps>;
 export declare const Field: React.FC<FieldProps> & {
     Label: React.FC<FieldLabelProps>;

package/dist/types/form/File.d.ts

@@ -1,20 +1,44 @@
 import React from 'react';
 import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 import { FormFieldProps } from './fieldProps';
+/**
+ * Props for the File component.
+ */
 export interface FileProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'size' | 'color' | 'type'>, Omit<BulmaClassesProps, 'color'>, FormFieldProps {
+    /** Bulma color modifier for the file input. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger' | 'black' | 'dark' | 'light' | 'white';
+    /** Size modifier for the file input. */
     size?: 'small' | 'medium' | 'large';
+    /** Boxed file input. */
     isBoxed?: boolean;
+    /** Whether the file input expands to full width. */
     isFullwidth?: boolean;
+    /** Position the CTA on the right (with `hasName`). */
     isRight?: boolean;
+    /** Center the file input within its container. */
     isCentered?: boolean;
+    /** Show a file name indicator. */
     hasName?: boolean;
+    /** Text on the file CTA button (defaults to "Choose a file…"). */
     buttonLabel?: React.ReactNode;
+    /** Left icon element. */
     iconLeft?: React.ReactNode;
+    /** Right icon element. */
     iconRight?: React.ReactNode;
+    /** Additional CSS classes to apply. */
     className?: string;
+    /** Additional CSS classes for the `<input>`. */
     inputClassName?: string;
+    /** File name to display. */
     fileName?: string;
 }
+/**
+ * The `File` component provides a Bulma-styled file input, supporting color, size, boxed/fullwidth/align styles, icons, "has name", and filename display.
+ *
+ * @function
+ * @param {FileProps} props - Props for the File component.
+ * @returns {JSX.Element} The rendered file upload field.
+ * @see {@link https://bulma.io/documentation/form/file/ | Bulma File documentation}
+ */
 export declare const File: React.ForwardRefExoticComponent<FileProps & React.RefAttributes<HTMLInputElement>>;
 export default File;

package/dist/types/form/FormContext.d.ts

@@ -1,22 +1,68 @@
+/**
+ * Hook to detect if the component is inside a Field wrapper.
+ * Form components use this to skip rendering their own Field.
+ */
 export declare const useInsideField: () => boolean;
+/**
+ * Hook to detect if the component is inside a Control wrapper.
+ * Form components use this to skip rendering their own Control.
+ */
 export declare const useInsideControl: () => boolean;
+/** Provider for Field context — used internally by Field component. */
 export declare const FieldProvider: import("react").Provider<boolean>;
+/** Provider for Control context — used internally by Control component. */
 export declare const ControlProvider: import("react").Provider<boolean>;
+/**
+ * Shape of the Radios group context. The group provides:
+ * - `name`: shared form field name (Stage 1)
+ * - `value`: currently-selected radio value (Stage 2 — group-managed selection)
+ * - `onChange`: dispatched by child Radios when clicked (Stage 2)
+ *
+ * Group sets `value`/`onChange` only when actively managing selection
+ * (i.e., the user passed `value`, `defaultValue`, or `onChange` to `<Radios>`).
+ * When only `name` is provided, the group is in "name-only" mode and child
+ * Radios manage their own checked state independently.
+ */
 export interface RadiosGroupContextValue {
     name?: string;
     value?: string;
     onChange?: (value: string) => void;
 }
+/**
+ * Shape of the Checkboxes group context. Like Radios but with array semantics
+ * for multi-select.
+ */
 export interface CheckboxesGroupContextValue {
     name?: string;
     value?: string[];
     onChange?: (values: string[]) => void;
 }
+/**
+ * Hook to read the full surrounding `<Radios>` group context (name + selection).
+ * Returns `undefined` when not inside a `<Radios>` group.
+ */
 export declare const useRadiosGroup: () => RadiosGroupContextValue | undefined;
+/**
+ * Hook to read the full surrounding `<Checkboxes>` group context.
+ * Returns `undefined` when not inside a `<Checkboxes>` group.
+ */
 export declare const useCheckboxesGroup: () => CheckboxesGroupContextValue | undefined;
+/**
+ * Hook to read just the shared `name` from a surrounding `<Radios>` group.
+ * Child `<Radio>` components fall back to this when no local `name` prop is set.
+ * Returns `undefined` outside of a `<Radios>` group.
+ */
 export declare const useRadiosName: () => string | undefined;
+/**
+ * Hook to read just the shared `name` from a surrounding `<Checkboxes>` group.
+ * Returns `undefined` outside of a `<Checkboxes>` group.
+ */
 export declare const useCheckboxesName: () => string | undefined;
+/** Provider for the Radios group context — used internally by Radios. */
 export declare const RadiosProvider: import("react").Provider<RadiosGroupContextValue | undefined>;
+/** Provider for the Checkboxes group context — used internally by Checkboxes. */
 export declare const CheckboxesProvider: import("react").Provider<CheckboxesGroupContextValue | undefined>;
+/** @deprecated Use `RadiosProvider` (provides {name, value, onChange}). */
 export declare const RadiosNameProvider: import("react").Provider<RadiosGroupContextValue | undefined>;
+/** @deprecated Use `CheckboxesProvider` (provides {name, value, onChange}). */
 export declare const CheckboxesNameProvider: import("react").Provider<CheckboxesGroupContextValue | undefined>;