@allxsmith/bestax-bulma 5.8.0 → 5.8.2

package/dist/types/components/Collapse.d.ts

@@ -2,39 +2,38 @@ import React from 'react';
 import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 /**
  * Props for the Collapse component.
- *
- * @property {boolean} [open] - Controlled open state. If provided, component is controlled.
- * @property {boolean} [defaultOpen] - Initial open state for uncontrolled usage.
- * @property {() => void} [onOpen] - Callback when collapse opens.
- * @property {() => void} [onClose] - Callback when collapse closes.
- * @property {React.ReactNode} [trigger] - The clickable trigger element (usually a header/button).
- * @property {'fade'|'slide'|false} [animation] - Animation type. 'fade' for opacity transition, 'slide' for height transition, false to disable. Default: 'fade'.
- * @property {'top'|'bottom'} [position] - Position of trigger relative to content. Default: 'top'.
- * @property {string} [ariaId] - Custom aria id for accessibility.
- * @property {boolean} [bordered] - Whether to show a border around the collapse.
- * @property {React.ReactNode} [children] - The collapsible content.
- * @property {string} [className] - Additional CSS classes.
- * @property {string} [triggerClassName] - Additional classes for the trigger wrapper.
- * @property {string} [contentClassName] - Additional classes for the content wrapper.
+ * @extraProp {React.ReactNode} [children] - The collapsible content.
+ * @extraProp {string} [className] - Additional CSS classes.
  */
 export interface CollapseProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Controlled open state. If provided, component is controlled. */
     open?: boolean;
+    /** Initial open state for uncontrolled usage. */
     defaultOpen?: boolean;
+    /** Callback when collapse opens. */
     onOpen?: () => void;
+    /** Callback when collapse closes. */
     onClose?: () => void;
+    /** The clickable trigger element (header/button). */
     trigger?: React.ReactNode;
+    /** Animation style, or `false` to disable. */
     animation?: 'fade' | 'slide' | false;
+    /** Position of the trigger relative to content. */
     position?: 'top' | 'bottom';
+    /**
+     * Custom aria id for accessibility.
+     * @defaultValue auto
+     */
     ariaId?: string;
+    /** Adds a border around the collapse. */
     bordered?: boolean;
+    /** Additional classes for the trigger wrapper. */
     triggerClassName?: string;
+    /** Additional classes for the content wrapper. */
     contentClassName?: string;
 }
 /**
- * Collapse component for expandable/collapsible content panels.
- *
- * Can be used in controlled or uncontrolled mode. Supports animation
- * and accessibility features for screen readers.
+ * The `Collapse` component provides an expandable/collapsible content panel.
  *
  * @function
  * @param {CollapseProps} props - Props for the Collapse component.

package/dist/types/components/Dialog.d.ts

@@ -4,39 +4,37 @@ import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 export type DialogType = 'default' | 'success' | 'danger' | 'warning' | 'info';
 /**
  * Props for the Dialog component.
- *
- * @property {boolean} isOpen - Whether the dialog is open.
- * @property {string} [title] - Dialog title.
- * @property {string | React.ReactNode} message - Dialog message/content.
- * @property {DialogType} [type] - The type/color of the dialog. Default: 'default'.
- * @property {string} [confirmText] - Text for confirm button. Default: 'OK'.
- * @property {string} [cancelText] - Text for cancel button. Default: 'Cancel'.
- * @property {() => void} [onConfirm] - Callback when confirm button is clicked.
- * @property {() => void} [onCancel] - Callback when cancel button is clicked or dialog is dismissed.
- * @property {boolean} [showCancel] - Whether to show cancel button. Default: true for confirm dialogs.
- * @property {boolean} [canCancel] - Whether the dialog can be dismissed. Default: true.
- * @property {boolean} [focusCancel] - Focus cancel button instead of confirm. Default: false.
- * @property {React.ReactNode} [icon] - Custom icon to display.
+ * @extraProp {string} [className] - Additional CSS classes.
+ * @extraProp {React.Ref<HTMLElement>} [ref] - Ref forwarded to the dialog element.
  */
 export interface DialogProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>, Omit<BulmaClassesProps, 'color'> {
+    /** Whether the dialog is open (required). */
     isOpen: boolean;
+    /** Dialog title. */
     title?: string;
+    /** Dialog message/content (required). */
     message: string | React.ReactNode;
+    /** The type/color of the dialog. Default: 'default'. */
     type?: DialogType;
+    /** Text for confirm button. Default: 'OK'. */
     confirmText?: string;
+    /** Text for cancel button. Default: 'Cancel'. */
     cancelText?: string;
+    /** Callback when confirm button is clicked. */
     onConfirm?: () => void;
+    /** Callback when cancel button is clicked or dismissed. */
     onCancel?: () => void;
+    /** Whether to show cancel button. Default: true for confirm dialogs. */
     showCancel?: boolean;
+    /** Whether the dialog can be dismissed. Default: true. */
     canCancel?: boolean;
+    /** Focus cancel button instead of confirm. Default: false. */
     focusCancel?: boolean;
+    /** Custom icon to display. */
     icon?: React.ReactNode;
 }
 /**
- * Dialog component for confirmation and alert dialogs.
- *
- * Provides a modal dialog with confirm/cancel actions, customizable
- * appearance, and keyboard support.
+ * The `Dialog` component provides confirmation and alert dialogs with customizable actions.
  *
  * @function
  * @param {DialogProps} props - Props for the Dialog component.
@@ -69,38 +67,35 @@ export interface DialogProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 export declare const Dialog: React.ForwardRefExoticComponent<DialogProps & React.RefAttributes<HTMLDivElement>>;
 /**
  * Options for showing a programmatic alert dialog.
- *
- * @property {string} [title] - Dialog title.
- * @property {string | React.ReactNode} message - Dialog message/content.
- * @property {DialogType} [type] - Dialog type/color.
- * @property {string} [confirmText] - Text for the confirm button.
- * @property {React.ReactNode} [icon] - Custom icon to display.
  */
 export interface AlertOptions {
+    /** Dialog title. */
     title?: string;
+    /** Dialog message/content. */
     message: string | React.ReactNode;
+    /** Dialog type/color. */
     type?: DialogType;
+    /** Text for the confirm button. */
     confirmText?: string;
+    /** Custom icon to display. */
     icon?: React.ReactNode;
 }
 /**
  * Options for showing a programmatic confirm dialog.
- *
- * @property {string} [cancelText] - Text for the cancel button.
- * @property {boolean} [focusCancel] - Focus cancel button instead of confirm.
  */
 export interface ConfirmOptions extends AlertOptions {
+    /** Text for the cancel button. */
     cancelText?: string;
+    /** Focus cancel button instead of confirm. */
     focusCancel?: boolean;
 }
 /**
  * Options for showing a programmatic prompt dialog.
- *
- * @property {string} [placeholder] - Input placeholder text.
- * @property {string} [defaultValue] - Default input value.
  */
 export interface PromptOptions extends ConfirmOptions {
+    /** Input placeholder text. */
     placeholder?: string;
+    /** Default input value. */
     defaultValue?: string;
 }
 type DialogResolve = (value?: void | boolean | string) => void;

package/dist/types/components/Dropdown.d.ts

@@ -9,46 +9,44 @@ import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 export declare const isBrowser: (win?: typeof window, doc?: typeof document) => boolean;
 /**
  * Props for the Dropdown component.
- *
- * @property {React.ReactNode} label - The dropdown button content.
- * @property {React.ReactNode} children - The menu items.
- * @property {string} [className] - Additional CSS classes to apply.
- * @property {string} [menuClassName] - Additional CSS classes for the dropdown menu.
- * @property {boolean} [active] - Whether the dropdown is open (controlled).
- * @property {boolean} [up] - Dropdown direction up.
- * @property {boolean} [right] - Dropdown aligned to the right.
- * @property {boolean} [hoverable] - Dropdown opens on hover.
- * @property {boolean} [disabled] - Disables the dropdown trigger.
- * @property {(active: boolean) => void} [onActiveChange] - Called when active state changes.
- * @property {boolean} [closeOnClick=true] - Close dropdown when clicking a menu item.
- * @property {string} [id] - ID for the root element.
  */
 export interface DropdownProps extends Omit<React.HTMLAttributes<HTMLDivElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** The dropdown button/trigger content. */
     label: React.ReactNode;
+    /** Dropdown menu items and dividers. */
     children: React.ReactNode;
+    /** Additional CSS classes for root. */
     className?: string;
+    /** Additional CSS classes for the dropdown menu. */
     menuClassName?: string;
+    /** Whether the dropdown is open (controlled). */
     active?: boolean;
+    /** Dropdown menu opens upward. */
     up?: boolean;
+    /** Menu is right-aligned. */
     right?: boolean;
+    /** Open on hover instead of click. */
     hoverable?: boolean;
+    /** Disables the dropdown trigger. */
     disabled?: boolean;
+    /** Callback when dropdown active state changes. */
     onActiveChange?: (active: boolean) => void;
+    /** Close dropdown when a menu item is clicked. */
     closeOnClick?: boolean;
+    /** Root element ID (for aria-controls, etc). */
     id?: string;
 }
 /**
  * Props for the DropdownItem component.
- *
- * @property {boolean} [active] - Whether the item is active.
- * @property {string} [className] - Additional CSS classes.
- * @property {'a'|'div'|'button'} [as] - The element type to render.
- * @property {React.ReactNode} [children] - Item content.
  */
 export interface DropdownItemProps extends Omit<React.HTMLAttributes<HTMLElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** Whether the item is active. */
     active?: boolean;
+    /** Additional CSS classes. */
     className?: string;
+    /** The element type to render. */
     as?: 'a' | 'div' | 'button';
+    /** Item content. */
     children?: React.ReactNode;
 }
 /**

package/dist/types/components/Loading.d.ts

@@ -10,38 +10,33 @@ export type LoadingOverlay = 'light' | 'dark' | 'opaque';
 export type LoadingColor = 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
 /**
  * Props for the Loading component.
- *
- * @property {boolean} [active] - Whether the loading overlay is visible.
- * @property {boolean} [isFullPage] - Cover the entire viewport.
- * @property {'small' | 'medium' | 'large'} [size] - Size of the loading spinner.
- * @property {LoadingColor} [color] - Color variant for the spinner. Default is light grey.
- * @property {boolean} [canCancel] - Show a cancel button/allow closing.
- * @property {() => void} [onCancel] - Callback when cancel is triggered.
- * @property {React.ReactNode} [children] - Content to display below the spinner.
- * @property {string} [className] - Additional CSS classes.
- * @property {string} [overlayClassName] - Additional classes for the overlay.
- * @property {string} [iconClassName] - Additional classes for the spinner icon.
- * @property {React.ReactNode} [indicator] - Custom content to replace the default CSS spinner. The Loading component wraps it in a spinning container.
- * @property {LoadingOverlay} [overlay] - Overlay opacity level: 'light', 'dark', or 'opaque'. Defaults to a medium opacity.
+ * @extraProp {React.ReactNode} [children] - Content to display below the spinner.
+ * @extraProp {string} [className] - Additional CSS classes.
  */
 export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor' | 'size' | 'overlay'> {
+    /** Whether the loading overlay is visible. */
     active?: boolean;
+    /** Cover the entire viewport. */
     isFullPage?: boolean;
+    /** Size of the loading spinner. */
     size?: 'small' | 'medium' | 'large';
+    /** Color variant for the spinner. Default is light grey. */
     color?: LoadingColor;
+    /** Show a cancel button and allow closing. */
     canCancel?: boolean;
+    /** Callback when cancel is triggered. */
     onCancel?: () => void;
+    /** Additional classes for the overlay. */
     overlayClassName?: string;
+    /** Additional classes for the spinner icon. */
     iconClassName?: string;
+    /** Custom loading indicator element. */
     indicator?: React.ReactNode;
+    /** Style of the loading overlay. */
     overlay?: LoadingOverlay;
 }
 /**
- * Loading component for displaying a loading overlay with spinner.
- *
- * Can be used as a full-page overlay or a container overlay to indicate
- * loading states. Supports different sizes, color variants, and optional
- * cancel functionality.
+ * The `Loading` component provides a loading overlay with a spinner animation.
  *
  * @function
  * @param {LoadingProps} props - Props for the Loading component.

package/dist/types/components/Menu.d.ts

@@ -2,22 +2,20 @@ import React from 'react';
 import { BulmaClassesProps } from '../helpers/useBulmaClasses';
 /**
  * Props for the Menu component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} children - Menu content.
  */
 export interface MenuProps extends Omit<React.HTMLAttributes<HTMLElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** Additional CSS classes. */
     className?: string;
+    /** Menu content (labels, lists, items, etc). */
     children: React.ReactNode;
 }
 /**
  * Props for the MenuLabel component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} children - Label content.
  */
 export interface MenuLabelProps extends Omit<React.HTMLAttributes<HTMLParagraphElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** Additional CSS classes. */
     className?: string;
+    /** Label content. */
     children: React.ReactNode;
 }
 /**
@@ -30,12 +28,11 @@ export interface MenuLabelProps extends Omit<React.HTMLAttributes<HTMLParagraphE
 export declare const MenuLabel: React.FC<MenuLabelProps>;
 /**
  * Props for the MenuList component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} children - List items.
  */
 export interface MenuListProps extends Omit<React.HTMLAttributes<HTMLUListElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** Additional CSS classes. */
     className?: string;
+    /** List items. */
     children: React.ReactNode;
 }
 /**
@@ -48,18 +45,17 @@ export interface MenuListProps extends Omit<React.HTMLAttributes<HTMLUListElemen
 export declare const MenuList: React.FC<MenuListProps>;
 /**
  * Props for the MenuItem component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {boolean} [active] - Whether the item is active.
- * @property {string} [href] - Href for link items.
- * @property {React.ElementType} [as] - Render as a custom component.
- * @property {React.ReactNode} children - Item content and optional nested MenuList.
  */
 export interface MenuItemProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, keyof BulmaClassesProps>, BulmaClassesProps {
+    /** Additional CSS classes. */
     className?: string;
+    /** Item content and optional nested MenuList. */
     children: React.ReactNode;
+    /** Highlight item as active. */
     active?: boolean;
+    /** Href for link items (if rendered as `<a>`). */
     href?: string;
+    /** Custom link component (e.g. `Link` from router). */
     as?: React.ElementType;
     [key: string]: unknown;
 }

package/dist/types/components/Message.d.ts

@@ -2,42 +2,39 @@ import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 /**
  * Props for the Message component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [title] - Title displayed in the message header.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color (Bulma or 'inherit'/'current').
- * @property {'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger'} [color] - Bulma color modifier for the message.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color (Bulma or 'inherit'/'current').
- * @property {() => void} [onClose] - Called when the close button is clicked.
- * @property {React.ReactNode} [children] - Message body content.
  */
 export interface MessageProps extends Omit<React.HTMLAttributes<HTMLElement>, 'title'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Additional CSS classes. */
     className?: string;
+    /** Title string/node (renders header section). */
     title?: React.ReactNode;
+    /** Text color for the message (Bulma helper). */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma color modifier for the message. */
     color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
+    /** Background color for the message (Bulma helper). */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Callback for the close ("X") button. */
     onClose?: () => void;
+    /** Body content for the message. */
     children?: React.ReactNode;
 }
 /**
  * Props for the Message.Header compound component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Header content (title, close button, etc.).
  */
 export interface MessageHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Additional CSS classes. */
     className?: string;
+    /** Header content (title, close button, etc.). */
     children?: React.ReactNode;
 }
 /**
  * Props for the Message.Body compound component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Message body content.
  */
 export interface MessageBodyProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Additional CSS classes. */
     className?: string;
+    /** Message body content. */
     children?: React.ReactNode;
 }
 export declare const Message: React.FC<MessageProps> & {

package/dist/types/components/Modal.d.ts

@@ -2,96 +2,90 @@ import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 /**
  * Props for the Modal component.
- *
- * @property {boolean} [active] - Whether the modal is open/visible.
- * @property {boolean} [isActive] - Alias for `active`. Whether the modal is open/visible.
- * @property {() => void} [onClose] - Callback invoked when modal close is requested (background click or close button).
- * @property {string} [className] - Additional CSS classes for the modal.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for modal content.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color for modal content.
- * @property {React.ReactNode} [modalCardTitle] - Title for modal card variant (legacy API).
- * @property {React.ReactNode} [modalCardFoot] - Footer for modal card variant (legacy API).
- * @property {'card'|'content'} [type] - Modal type ('card' for modal-card, 'content' for modal-content). Legacy API only.
- * @property {React.ReactNode} [children] - Modal body/content or compound components.
  */
 export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color' | 'title'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Whether the modal is open/visible. */
     active?: boolean;
+    /** Alias for `active`. Whether the modal is open/visible. */
     isActive?: boolean;
+    /** Callback invoked to request modal close (background or close button). */
     onClose?: () => void;
+    /** Additional CSS classes for the modal. */
     className?: string;
+    /** Text color for modal content. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color for modal content. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Title/header for modal-card variant. (Legacy API only) */
     modalCardTitle?: React.ReactNode;
+    /** Footer for modal-card variant. (Legacy API only) */
     modalCardFoot?: React.ReactNode;
+    /**
+     * Modal style: `'card'` for modal-card, `'content'` for modal-content. (Legacy API only)
+     * @defaultValue auto
+     */
     type?: 'card' | 'content';
+    /** Modal body/content or compound components. */
     children?: React.ReactNode;
 }
 /**
  * Props for Modal.Background component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalBackgroundProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Content component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalContentProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Card component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalCardProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Card.Head component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalCardHeadProps extends React.HTMLAttributes<HTMLElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Card.Title component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalCardTitleProps extends React.HTMLAttributes<HTMLParagraphElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Card.Body component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalCardBodyProps extends React.HTMLAttributes<HTMLElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Card.Foot component.
- *
- * @property {string} [className] - Additional CSS classes.
  */
 export interface ModalCardFootProps extends React.HTMLAttributes<HTMLElement> {
+    /** Additional CSS classes. */
     className?: string;
 }
 /**
  * Props for Modal.Close component.
- *
- * @property {string} [className] - Additional CSS classes.
- * @property {'small' | 'medium' | 'large'} [size] - Size of the close button (only applies to 'floating' variant).
- * @property {'delete' | 'floating'} [variant] - Button variant. 'delete' (default) for modal card headers, 'floating' for overlay close button.
  */
 export interface ModalCloseProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    /** Additional CSS classes. */
     className?: string;
+    /** Size of the close button (only applies to 'floating' variant). */
     size?: 'small' | 'medium' | 'large';
+    /** Button variant. 'delete' (default) for modal card headers, 'floating' for overlay close button. */
     variant?: 'delete' | 'floating';
 }
 export declare const Modal: React.FC<ModalProps> & {