@allxsmith/bestax-bulma 5.6.2 → 5.8.0

package/dist/types/helpers/Config.d.ts

@@ -1,17 +1,67 @@
 import React, { ReactNode } from 'react';
+/** Supported icon library identifiers. */
 type IconLibrary = 'fa' | 'mdi' | 'ion' | 'material-icons' | 'material-symbols';
+/**
+ * Shape of the configuration context value.
+ *
+ * @property {string} [classPrefix] - Prefix applied to all Bulma class names.
+ * @property {IconLibrary} [iconLibrary] - Default icon library for Icon components.
+ */
 export interface ConfigContextProps {
     classPrefix?: string;
     iconLibrary?: IconLibrary;
 }
+/**
+ * Hook to access the bulma-ui configuration context.
+ *
+ * @function
+ * @returns {ConfigContextProps} The current configuration values.
+ */
 export declare const useConfig: () => ConfigContextProps;
+/**
+ * Props for the ConfigProvider component.
+ *
+ * @property {React.ReactNode} children - Child components to receive configuration.
+ * @property {string} [classPrefix] - Prefix applied to all Bulma class names.
+ * @property {IconLibrary} [iconLibrary] - Default icon library for Icon components.
+ */
 export interface ConfigProviderProps {
     children: ReactNode;
     classPrefix?: string;
     iconLibrary?: IconLibrary;
 }
+/**
+ * ConfigProvider injects configuration into all child components via React context.
+ *
+ * @function
+ * @param {ConfigProviderProps} props - Provider props.
+ * @returns {JSX.Element} The context provider wrapping children.
+ *
+ * @example
+ * <ConfigProvider classPrefix="my-" iconLibrary="mdi">
+ *   <App />
+ * </ConfigProvider>
+ */
 export declare const ConfigProvider: React.FC<ConfigProviderProps>;
+/**
+ * Utility hook to get the configured class prefix string.
+ *
+ * @function
+ * @returns {string} The class prefix, or empty string if none configured.
+ */
 export declare const useClassPrefix: () => string;
+/**
+ * Hook that returns a function to prefix a class name with the configured prefix.
+ *
+ * @function
+ * @returns {(className: string) => string} A function that applies the class prefix.
+ */
 export declare const usePrefixedClass: () => (className: string) => string;
+/**
+ * Hook to get the default icon library from configuration.
+ *
+ * @function
+ * @returns {IconLibrary | undefined} The configured icon library, or undefined.
+ */
 export declare const useIconLibrary: () => IconLibrary | undefined;
 export {};

package/dist/types/helpers/Theme.d.ts

@@ -1,8 +1,58 @@
 import React, { ReactNode } from 'react';
 import { BulmaClassesProps } from './useBulmaClasses';
 declare const bulmaCssVars: readonly ["--bulma-scheme-h", "--bulma-scheme-s", "--bulma-light-l", "--bulma-light-invert-l", "--bulma-dark-l", "--bulma-dark-invert-l", "--bulma-soft-l", "--bulma-bold-l", "--bulma-soft-invert-l", "--bulma-bold-invert-l", "--bulma-hover-background-l-delta", "--bulma-active-background-l-delta", "--bulma-hover-border-l-delta", "--bulma-active-border-l-delta", "--bulma-hover-color-l-delta", "--bulma-active-color-l-delta", "--bulma-hover-shadow-a-delta", "--bulma-active-shadow-a-delta", "--bulma-primary-h", "--bulma-primary-s", "--bulma-primary-l", "--bulma-link-h", "--bulma-link-s", "--bulma-link-l", "--bulma-info-h", "--bulma-info-s", "--bulma-info-l", "--bulma-success-h", "--bulma-success-s", "--bulma-success-l", "--bulma-warning-h", "--bulma-warning-s", "--bulma-warning-l", "--bulma-danger-h", "--bulma-danger-s", "--bulma-danger-l", "--bulma-family-primary", "--bulma-family-secondary", "--bulma-family-code", "--bulma-size-small", "--bulma-size-normal", "--bulma-size-medium", "--bulma-size-large", "--bulma-weight-light", "--bulma-weight-normal", "--bulma-weight-medium", "--bulma-weight-semibold", "--bulma-weight-bold", "--bulma-weight-extrabold", "--bulma-block-spacing", "--bulma-duration", "--bulma-easing", "--bulma-radius-small", "--bulma-radius", "--bulma-radius-medium", "--bulma-radius-large", "--bulma-radius-rounded", "--bulma-speed", "--bulma-arrow-color", "--bulma-loading-color", "--bulma-burger-h", "--bulma-burger-s", "--bulma-burger-l", "--bulma-burger-border-radius", "--bulma-burger-gap", "--bulma-burger-item-height", "--bulma-burger-item-width", "--bulma-body-background-color", "--bulma-body-size", "--bulma-body-min-width", "--bulma-body-rendering", "--bulma-body-family", "--bulma-body-overflow-x", "--bulma-body-overflow-y", "--bulma-body-color", "--bulma-body-font-size", "--bulma-body-weight", "--bulma-body-line-height", "--bulma-code-family", "--bulma-code-padding", "--bulma-code-weight", "--bulma-code-size", "--bulma-small-font-size", "--bulma-hr-background-color", "--bulma-hr-height", "--bulma-hr-margin", "--bulma-strong-color", "--bulma-strong-weight", "--bulma-pre-font-size", "--bulma-pre-padding", "--bulma-pre-code-font-size", "--bulma-skeleton-background", "--bulma-skeleton-radius", "--bulma-skeleton-block-min-height", "--bulma-skeleton-lines-gap", "--bulma-skeleton-line-height", "--bulma-breadcrumb-item-color", "--bulma-breadcrumb-item-hover-color", "--bulma-breadcrumb-item-active-color", "--bulma-breadcrumb-item-padding-vertical", "--bulma-breadcrumb-item-padding-horizontal", "--bulma-breadcrumb-item-separator-color", "--bulma-card-color", "--bulma-card-background-color", "--bulma-card-shadow", "--bulma-card-radius", "--bulma-card-header-background-color", "--bulma-card-header-color", "--bulma-card-header-padding", "--bulma-card-header-shadow", "--bulma-card-header-weight", "--bulma-card-content-background-color", "--bulma-card-content-padding", "--bulma-card-footer-background-color", "--bulma-card-footer-border-top", "--bulma-card-footer-padding", "--bulma-card-media-margin", "--bulma-dropdown-menu-min-width", "--bulma-dropdown-content-background-color", "--bulma-dropdown-content-offset", "--bulma-dropdown-content-padding-bottom", "--bulma-dropdown-content-padding-top", "--bulma-dropdown-content-radius", "--bulma-dropdown-content-shadow", "--bulma-dropdown-content-z", "--bulma-dropdown-item-h", "--bulma-dropdown-item-s", "--bulma-dropdown-item-l", "--bulma-dropdown-item-background-l", "--bulma-dropdown-item-background-l-delta", "--bulma-dropdown-item-hover-background-l-delta", "--bulma-dropdown-item-active-background-l-delta", "--bulma-dropdown-item-color-l", "--bulma-dropdown-item-selected-h", "--bulma-dropdown-item-selected-s", "--bulma-dropdown-item-selected-l", "--bulma-dropdown-item-selected-background-l", "--bulma-dropdown-item-selected-color-l", "--bulma-dropdown-divider-background-color", "--bulma-menu-item-h", "--bulma-menu-item-s", "--bulma-menu-item-l", "--bulma-menu-item-background-l", "--bulma-menu-item-background-l-delta", "--bulma-menu-item-hover-background-l-delta", "--bulma-menu-item-active-background-l-delta", "--bulma-menu-item-color-l", "--bulma-menu-item-radius", "--bulma-menu-item-selected-h", "--bulma-menu-item-selected-s", "--bulma-menu-item-selected-l", "--bulma-menu-item-selected-background-l", "--bulma-menu-item-selected-color-l", "--bulma-menu-list-border-left", "--bulma-menu-list-line-height", "--bulma-menu-list-link-padding", "--bulma-menu-nested-list-margin", "--bulma-menu-nested-list-padding-left", "--bulma-menu-label-color", "--bulma-menu-label-font-size", "--bulma-menu-label-letter-spacing", "--bulma-menu-label-spacing", "--bulma-message-h", "--bulma-message-s", "--bulma-message-background-l", "--bulma-message-border-l", "--bulma-message-border-l-delta", "--bulma-message-border-style", "--bulma-message-border-width", "--bulma-message-color-l", "--bulma-message-radius", "--bulma-message-header-weight", "--bulma-message-header-padding", "--bulma-message-header-radius", "--bulma-message-header-body-border-width", "--bulma-message-header-background-l", "--bulma-message-header-color-l", "--bulma-message-body-border-width", "--bulma-message-body-color", "--bulma-message-body-padding", "--bulma-message-body-radius", "--bulma-message-body-pre-code-background-color", "--bulma-modal-z", "--bulma-modal-background-background-color", "--bulma-modal-content-width", "--bulma-modal-content-margin-mobile", "--bulma-modal-content-spacing-mobile", "--bulma-modal-content-spacing-tablet", "--bulma-modal-close-dimensions", "--bulma-modal-close-right", "--bulma-modal-close-top", "--bulma-modal-card-spacing", "--bulma-modal-card-head-background-color", "--bulma-modal-card-head-padding", "--bulma-modal-card-head-radius", "--bulma-modal-card-title-color", "--bulma-modal-card-title-line-height", "--bulma-modal-card-title-size", "--bulma-modal-card-foot-background-color", "--bulma-modal-card-foot-radius", "--bulma-modal-card-body-background-color", "--bulma-modal-card-body-padding", "--bulma-navbar-h", "--bulma-navbar-s", "--bulma-navbar-l", "--bulma-navbar-background-color", "--bulma-navbar-box-shadow-size", "--bulma-navbar-box-shadow-color", "--bulma-navbar-padding-vertical", "--bulma-navbar-padding-horizontal", "--bulma-navbar-z", "--bulma-navbar-fixed-z", "--bulma-navbar-item-background-a", "--bulma-navbar-item-background-l", "--bulma-navbar-item-background-l-delta", "--bulma-navbar-item-hover-background-l-delta", "--bulma-navbar-item-active-background-l-delta", "--bulma-navbar-item-color-l", "--bulma-navbar-item-selected-h", "--bulma-navbar-item-selected-s", "--bulma-navbar-item-selected-l", "--bulma-navbar-item-selected-background-l", "--bulma-navbar-item-selected-color-l", "--bulma-navbar-item-img-max-height", "--bulma-navbar-burger-color", "--bulma-navbar-tab-hover-background-color", "--bulma-navbar-tab-hover-border-bottom-color", "--bulma-navbar-tab-active-color", "--bulma-navbar-tab-active-background-color", "--bulma-navbar-tab-active-border-bottom-color", "--bulma-navbar-tab-active-border-bottom-style", "--bulma-navbar-tab-active-border-bottom-width", "--bulma-navbar-dropdown-background-color", "--bulma-navbar-dropdown-border-l", "--bulma-navbar-dropdown-border-color", "--bulma-navbar-dropdown-border-style", "--bulma-navbar-dropdown-border-width", "--bulma-navbar-dropdown-offset", "--bulma-navbar-dropdown-arrow", "--bulma-navbar-dropdown-radius", "--bulma-navbar-dropdown-z", "--bulma-navbar-dropdown-boxed-radius", "--bulma-navbar-dropdown-boxed-shadow", "--bulma-navbar-dropdown-item-h", "--bulma-navbar-dropdown-item-s", "--bulma-navbar-dropdown-item-l", "--bulma-navbar-dropdown-item-background-l", "--bulma-navbar-dropdown-item-color-l", "--bulma-navbar-divider-background-l", "--bulma-navbar-divider-height", "--bulma-navbar-bottom-box-shadow-size", "--bulma-pagination-margin", "--bulma-pagination-min-width", "--bulma-pagination-item-h", "--bulma-pagination-item-s", "--bulma-pagination-item-l", "--bulma-pagination-item-background-l-delta", "--bulma-pagination-item-hover-background-l-delta", "--bulma-pagination-item-active-background-l-delta", "--bulma-pagination-item-border-style", "--bulma-pagination-item-border-width", "--bulma-pagination-item-border-l", "--bulma-pagination-item-border-l-delta", "--bulma-pagination-item-hover-border-l-delta", "--bulma-pagination-item-active-border-l-delta", "--bulma-pagination-item-focus-border-l-delta", "--bulma-pagination-item-color-l", "--bulma-pagination-item-font-size", "--bulma-pagination-item-margin", "--bulma-pagination-item-padding-left", "--bulma-pagination-item-padding-right", "--bulma-pagination-item-outer-shadow-h", "--bulma-pagination-item-outer-shadow-s", "--bulma-pagination-item-outer-shadow-l", "--bulma-pagination-item-outer-shadow-a", "--bulma-pagination-nav-padding-left", "--bulma-pagination-nav-padding-right", "--bulma-pagination-disabled-color", "--bulma-pagination-disabled-background-color", "--bulma-pagination-disabled-border-color", "--bulma-pagination-current-color", "--bulma-pagination-current-background-color", "--bulma-pagination-current-border-color", "--bulma-pagination-ellipsis-color", "--bulma-pagination-shadow-inset", "--bulma-pagination-selected-item-h", "--bulma-pagination-selected-item-s", "--bulma-pagination-selected-item-l", "--bulma-pagination-selected-item-background-l", "--bulma-pagination-selected-item-border-l", "--bulma-pagination-selected-item-color-l", "--bulma-panel-margin", "--bulma-panel-item-border", "--bulma-panel-radius", "--bulma-panel-shadow", "--bulma-panel-heading-line-height", "--bulma-panel-heading-padding", "--bulma-panel-heading-radius", "--bulma-panel-heading-size", "--bulma-panel-heading-weight", "--bulma-panel-tabs-font-size", "--bulma-panel-tab-border-bottom-color", "--bulma-panel-tab-border-bottom-style", "--bulma-panel-tab-border-bottom-width", "--bulma-panel-tab-active-color", "--bulma-panel-list-item-color", "--bulma-panel-list-item-hover-color", "--bulma-panel-block-color", "--bulma-panel-block-hover-background-color", "--bulma-panel-block-active-border-left-color", "--bulma-panel-block-active-color", "--bulma-panel-block-active-icon-color", "--bulma-panel-icon-color", "--bulma-tabs-border-bottom-color", "--bulma-tabs-border-bottom-style", "--bulma-tabs-border-bottom-width", "--bulma-tabs-link-color", "--bulma-tabs-link-hover-border-bottom-color", "--bulma-tabs-link-hover-color", "--bulma-tabs-link-active-border-bottom-color", "--bulma-tabs-link-active-color", "--bulma-tabs-link-padding", "--bulma-tabs-boxed-link-radius", "--bulma-tabs-boxed-link-hover-background-color", "--bulma-tabs-boxed-link-hover-border-bottom-color", "--bulma-tabs-boxed-link-active-background-color", "--bulma-tabs-boxed-link-active-border-color", "--bulma-tabs-boxed-link-active-border-bottom-color", "--bulma-tabs-toggle-link-border-color", "--bulma-tabs-toggle-link-border-style", "--bulma-tabs-toggle-link-border-width", "--bulma-tabs-toggle-link-hover-background-color", "--bulma-tabs-toggle-link-hover-border-color", "--bulma-tabs-toggle-link-radius", "--bulma-tabs-toggle-link-active-background-color", "--bulma-tabs-toggle-link-active-border-color", "--bulma-tabs-toggle-link-active-color", "--bulma-box-background-color", "--bulma-box-color", "--bulma-box-radius", "--bulma-box-shadow", "--bulma-box-padding", "--bulma-box-link-hover-shadow", "--bulma-box-link-active-shadow", "--bulma-content-heading-color", "--bulma-content-heading-weight", "--bulma-content-heading-line-height", "--bulma-content-block-margin-bottom", "--bulma-content-blockquote-background-color", "--bulma-content-blockquote-border-left", "--bulma-content-blockquote-padding", "--bulma-content-pre-padding", "--bulma-content-table-cell-border", "--bulma-content-table-cell-border-width", "--bulma-content-table-cell-padding", "--bulma-content-table-cell-heading-color", "--bulma-content-table-head-cell-border-width", "--bulma-content-table-head-cell-color", "--bulma-content-table-body-last-row-cell-border-bottom-width", "--bulma-content-table-foot-cell-border-width", "--bulma-content-table-foot-cell-color", "--bulma-delete-dimensions", "--bulma-delete-background-l", "--bulma-delete-background-alpha", "--bulma-delete-color", "--bulma-icon-dimensions", "--bulma-icon-dimensions-small", "--bulma-icon-dimensions-medium", "--bulma-icon-dimensions-large", "--bulma-icon-text-spacing", "--bulma-notification-h", "--bulma-notification-s", "--bulma-notification-background-l", "--bulma-notification-color-l", "--bulma-notification-code-background-color", "--bulma-notification-radius", "--bulma-notification-padding", "--bulma-progress-border-radius", "--bulma-progress-bar-background-color", "--bulma-progress-value-background-color", "--bulma-progress-indeterminate-duration", "--bulma-table-color", "--bulma-table-background-color", "--bulma-table-cell-border-color", "--bulma-table-cell-border-style", "--bulma-table-cell-border-width", "--bulma-table-cell-padding", "--bulma-table-cell-heading-color", "--bulma-table-cell-text-align", "--bulma-table-head-cell-border-width", "--bulma-table-head-cell-color", "--bulma-table-foot-cell-border-width", "--bulma-table-foot-cell-color", "--bulma-table-head-background-color", "--bulma-table-body-background-color", "--bulma-table-foot-background-color", "--bulma-table-row-hover-background-color", "--bulma-table-row-active-background-color", "--bulma-table-row-active-color", "--bulma-table-striped-row-even-background-color", "--bulma-table-striped-row-even-hover-background-color", "--bulma-tag-h", "--bulma-tag-s", "--bulma-tag-background-l", "--bulma-tag-background-l-delta", "--bulma-tag-hover-background-l-delta", "--bulma-tag-active-background-l-delta", "--bulma-tag-color-l", "--bulma-tag-radius", "--bulma-tag-delete-margin", "--bulma-title-color", "--bulma-title-family", "--bulma-title-size", "--bulma-title-weight", "--bulma-title-line-height", "--bulma-title-strong-color", "--bulma-title-strong-weight", "--bulma-title-sub-size", "--bulma-title-sup-size", "--bulma-subtitle-color", "--bulma-subtitle-family", "--bulma-subtitle-size", "--bulma-subtitle-weight", "--bulma-subtitle-line-height", "--bulma-subtitle-strong-color", "--bulma-subtitle-strong-weight", "--bulma-control-radius", "--bulma-control-radius-small", "--bulma-control-border-width", "--bulma-control-height", "--bulma-control-line-height", "--bulma-control-padding-vertical", "--bulma-control-padding-horizontal", "--bulma-control-size", "--bulma-control-focus-shadow-l", "--bulma-file-radius", "--bulma-file-name-border-color", "--bulma-file-name-border-style", "--bulma-file-name-border-width", "--bulma-file-name-max-width", "--bulma-file-h", "--bulma-file-s", "--bulma-file-background-l", "--bulma-file-background-l-delta", "--bulma-file-hover-background-l-delta", "--bulma-file-active-background-l-delta", "--bulma-file-border-l", "--bulma-file-border-l-delta", "--bulma-file-hover-border-l-delta", "--bulma-file-active-border-l-delta", "--bulma-file-cta-color-l", "--bulma-file-name-color-l", "--bulma-file-color-l-delta", "--bulma-file-hover-color-l-delta", "--bulma-file-active-color-l-delta", "--bulma-input-h", "--bulma-input-s", "--bulma-input-l", "--bulma-input-border-style", "--bulma-input-border-l", "--bulma-input-border-l-delta", "--bulma-input-hover-border-l-delta", "--bulma-input-active-border-l-delta", "--bulma-input-focus-h", "--bulma-input-focus-s", "--bulma-input-focus-l", "--bulma-input-focus-shadow-size", "--bulma-input-focus-shadow-alpha", "--bulma-input-color-l", "--bulma-input-background-l", "--bulma-input-background-l-delta", "--bulma-input-height", "--bulma-input-shadow", "--bulma-input-placeholder-color", "--bulma-input-disabled-color", "--bulma-input-disabled-background-color", "--bulma-input-disabled-border-color", "--bulma-input-disabled-placeholder-color", "--bulma-input-arrow", "--bulma-input-icon-color", "--bulma-input-icon-hover-color", "--bulma-input-icon-focus-color", "--bulma-input-radius", "--bulma-column-gap", "--bulma-grid-gap", "--bulma-grid-column-count", "--bulma-grid-column-min", "--bulma-grid-cell-column-span", "--bulma-grid-cell-column-start", "--bulma-footer-background-color", "--bulma-footer-color", "--bulma-footer-padding", "--bulma-hero-body-padding", "--bulma-hero-body-padding-tablet", "--bulma-hero-body-padding-small", "--bulma-hero-body-padding-medium", "--bulma-hero-body-padding-large", "--bulma-media-border-color", "--bulma-media-border-size", "--bulma-media-spacing", "--bulma-media-spacing-large", "--bulma-media-content-spacing", "--bulma-media-level-1-spacing", "--bulma-media-level-1-content-spacing", "--bulma-media-level-2-spacing", "--bulma-section-padding", "--bulma-section-padding-desktop", "--bulma-section-padding-medium", "--bulma-section-padding-large"];
+/** A single Bulma CSS variable key from the `bulmaCssVars` tuple. */
 type BulmaVarKey = (typeof bulmaCssVars)[number];
+/** A partial record mapping Bulma CSS variable keys to string values. */
 type BulmaVars = Partial<Record<BulmaVarKey, string>>;
+/**
+ * Props for the Theme component.
+ *
+ * @property {React.ReactNode} children - Content to render inside the theme scope.
+ * @property {string} [className] - Additional CSS classes (only when isRoot is false).
+ * @property {boolean} [isRoot] - Inject CSS variables globally at :root level. Default: false.
+ * @property {'light' | 'dark' | 'system'} [colorMode] - Set Bulma's light/dark scheme by writing
+ *   the `data-theme` attribute on the document root (`<html>`). This is always global, even on a
+ *   scoped Theme. `'system'` removes the attribute so Bulma follows the OS `prefers-color-scheme`.
+ *   Omit to leave the current setting untouched.
+ * @property {BulmaVars} [bulmaVars] - Object mapping Bulma CSS variable names to values.
+ * @property {string} [schemeH] - Scheme hue value.
+ * @property {string} [schemeS] - Scheme saturation value.
+ * @property {string} [lightL] - Light theme lightness value.
+ * @property {string} [lightInvertL] - Light theme inverted lightness value.
+ * @property {string} [darkL] - Dark theme lightness value.
+ * @property {string} [darkInvertL] - Dark theme inverted lightness value.
+ * @property {string} [softL] - Soft lightness value.
+ * @property {string} [boldL] - Bold lightness value.
+ * @property {string} [softInvertL] - Soft inverted lightness value.
+ * @property {string} [boldInvertL] - Bold inverted lightness value.
+ * @property {string} [hoverBackgroundLDelta] - Background lightness delta on hover.
+ * @property {string} [activeBackgroundLDelta] - Background lightness delta on active.
+ * @property {string} [hoverBorderLDelta] - Border lightness delta on hover.
+ * @property {string} [activeBorderLDelta] - Border lightness delta on active.
+ * @property {string} [hoverColorLDelta] - Text color lightness delta on hover.
+ * @property {string} [activeColorLDelta] - Text color lightness delta on active.
+ * @property {string} [hoverShadowADelta] - Shadow alpha delta on hover.
+ * @property {string} [activeShadowADelta] - Shadow alpha delta on active.
+ * @property {string} [primaryH] - Primary color hue.
+ * @property {string} [primaryS] - Primary color saturation.
+ * @property {string} [primaryL] - Primary color lightness.
+ * @property {string} [linkH] - Link color hue.
+ * @property {string} [linkS] - Link color saturation.
+ * @property {string} [linkL] - Link color lightness.
+ * @property {string} [infoH] - Info color hue.
+ * @property {string} [infoS] - Info color saturation.
+ * @property {string} [infoL] - Info color lightness.
+ * @property {string} [successH] - Success color hue.
+ * @property {string} [successS] - Success color saturation.
+ * @property {string} [successL] - Success color lightness.
+ * @property {string} [warningH] - Warning color hue.
+ * @property {string} [warningS] - Warning color saturation.
+ * @property {string} [warningL] - Warning color lightness.
+ * @property {string} [dangerH] - Danger color hue.
+ * @property {string} [dangerS] - Danger color saturation.
+ * @property {string} [dangerL] - Danger color lightness.
+ */
 export interface ThemeProps extends Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
     children: ReactNode;
     className?: string;
@@ -46,5 +96,21 @@ export interface ThemeProps extends Omit<BulmaClassesProps, 'color' | 'backgroun
     dangerS?: string;
     dangerL?: string;
 }
+/**
+ * Theme component that injects Bulma CSS variables either globally or locally.
+ *
+ * When `isRoot` is true, variables are injected at `:root`. Otherwise, a wrapping
+ * `<div>` scopes the variables to its children.
+ *
+ * @function
+ * @param {ThemeProps} props - Props for the Theme component.
+ * @returns {JSX.Element} The theme wrapper or fragment.
+ *
+ * @example
+ * // Local theme scope
+ * <Theme primaryH="171" primaryS="100%" primaryL="41%">
+ *   <Button color="primary">Themed</Button>
+ * </Theme>
+ */
 export declare const Theme: React.FC<ThemeProps>;
 export {};

package/dist/types/helpers/bulmaClassHelpers.d.ts

@@ -1,32 +1,129 @@
+/**
+ * Valid Bulma color classes.
+ * @example 'primary', 'link', 'info'
+ */
 export declare const validColors: readonly ["primary", "link", "info", "success", "warning", "danger", "black", "black-bis", "black-ter", "grey-darker", "grey-dark", "grey", "grey-light", "grey-lighter", "white", "light", "dark"];
+/**
+ * Valid Bulma color shade suffixes.
+ * @example '00', '05', 'invert', 'light', 'dark', 'soft', 'bold', 'on-scheme'
+ */
 export declare const validColorShades: readonly ["00", "05", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55", "60", "65", "70", "75", "80", "85", "90", "95", "invert", "light", "dark", "soft", "bold", "on-scheme"];
+/**
+ * Valid Bulma size classes for margins and paddings.
+ * @example '0', '1', 'auto'
+ */
 export declare const validSizes: readonly ["0", "1", "2", "3", "4", "5", "6", "auto"];
+/**
+ * Valid Bulma text size classes.
+ * @example '1', '2', '3'
+ */
 export declare const validTextSizes: readonly ["1", "2", "3", "4", "5", "6", "7"];
+/**
+ * Valid Bulma text alignment classes.
+ * @example 'centered', 'left', 'right'
+ */
 export declare const validAlignments: readonly ["centered", "justified", "left", "right"];
+/**
+ * Valid Bulma text transformation classes.
+ * @example 'capitalized', 'uppercase', 'italic'
+ */
 export declare const validTextTransforms: readonly ["capitalized", "lowercase", "uppercase", "italic"];
+/**
+ * Valid Bulma text weight classes.
+ * @example 'light', 'normal', 'bold'
+ */
 export declare const validTextWeights: readonly ["light", "normal", "medium", "semibold", "bold"];
+/**
+ * Valid Bulma font family classes.
+ * @example 'sans-serif', 'monospace', 'code'
+ */
 export declare const validFontFamilies: readonly ["sans-serif", "monospace", "primary", "secondary", "code"];
+/**
+ * Valid Bulma display classes.
+ * @example 'block', 'flex', 'inline'
+ */
 export declare const validDisplays: readonly ["block", "flex", "inline", "inline-block", "inline-flex"];
+/**
+ * Valid Bulma visibility classes.
+ * These are all the valid visibility options available in Bulma.
+ * @example 'hidden', 'sr-only', 'invisible'
+ */
 export declare const validVisibilities: readonly ["hidden", "sr-only", "invisible"];
+/**
+ * Valid Bulma flex direction classes.
+ * @example 'row', 'column', 'row-reverse'
+ */
 export declare const validFlexDirections: readonly ["row", "row-reverse", "column", "column-reverse"];
+/**
+ * Valid Bulma flex wrap classes.
+ * @example 'nowrap', 'wrap', 'wrap-reverse'
+ */
 export declare const validFlexWraps: readonly ["nowrap", "wrap", "wrap-reverse"];
+/**
+ * Valid Bulma justify-content classes.
+ * @example 'flex-start', 'center', 'space-between'
+ */
 export declare const validJustifyContents: readonly ["flex-start", "flex-end", "center", "space-between", "space-around", "space-evenly", "start", "end", "left", "right"];
+/**
+ * Valid Bulma align-content classes.
+ * @example 'flex-start', 'center', 'stretch'
+ */
 export declare const validAlignContents: readonly ["flex-start", "flex-end", "center", "space-between", "space-around", "space-evenly", "stretch"];
+/**
+ * Valid Bulma align-items classes.
+ * @example 'stretch', 'flex-start', 'center'
+ */
 export declare const validAlignItems: readonly ["stretch", "flex-start", "flex-end", "center", "baseline", "start", "end"];
+/**
+ * Valid Bulma align-self classes.
+ * @example 'auto', 'flex-start', 'center'
+ */
 export declare const validAlignSelfs: readonly ["auto", "flex-start", "flex-end", "center", "baseline", "stretch"];
+/**
+ * Valid Bulma flex grow and shrink values.
+ * @example '0', '1', '2', '3', '4', '5'
+ */
 export declare const validFlexGrowShrink: readonly ["0", "1", "2", "3", "4", "5"];
+/**
+ * Valid Bulma viewport classes for responsive design.
+ * @example 'mobile', 'tablet', 'desktop'
+ */
 export declare const validViewports: readonly ["mobile", "tablet", "desktop", "widescreen", "fullhd"];
+/**
+ * Props for applying a Bulma viewport modifier to viewport-aware helper classes.
+ */
 export interface BulmaViewportProps {
+    /** Viewport for responsive classes (e.g., 'mobile', 'desktop'). */
     viewport?: (typeof validViewports)[number];
 }
+/**
+ * Props for applying Bulma display helper classes, including viewport-specific
+ * display variants.
+ */
 export interface BulmaDisplayProps {
+    /** Display type (e.g., 'block', 'flex'). */
     display?: (typeof validDisplays)[number] | 'none';
+    /** Display type for mobile viewport (up to 768px). */
     displayMobile?: (typeof validDisplays)[number] | 'none';
+    /** Display type for tablet viewport (769px - 1023px). */
     displayTablet?: (typeof validDisplays)[number] | 'none';
+    /** Display type for desktop viewport (1024px - 1215px). */
     displayDesktop?: (typeof validDisplays)[number] | 'none';
+    /** Display type for widescreen viewport (1216px - 1407px). */
     displayWidescreen?: (typeof validDisplays)[number] | 'none';
+    /** Display type for fullhd viewport (1408px and above). */
     displayFullhd?: (typeof validDisplays)[number] | 'none';
 }
+/**
+ * Creates the shared class-building helpers used by the Bulma helper hooks.
+ *
+ * Returns a mutable `classes` array along with the helper functions that push
+ * (optionally prefixed, optionally viewport-suffixed) class names onto it.
+ *
+ * @internal
+ * @param classPrefix - Optional prefix applied to all generated class names.
+ * @param viewport - Optional viewport modifier for viewport-aware classes.
+ */
 export declare const createBulmaClassHelpers: (classPrefix?: string, viewport?: (typeof validViewports)[number]) => {
     classes: string[];
     addPrefixedClass: (className: string) => void;

package/dist/types/helpers/classNames.d.ts

@@ -1,5 +1,55 @@
+/**
+ * Returns a space-separated string of class names based on input arguments.
+ *
+ * Accepts any mix of strings, numbers, arrays, or objects. Falsy values are ignored.
+ * Array and object values are recursively flattened, and object keys are included
+ * if their value is truthy. Duplicate class names are removed.
+ *
+ * @param {...(string | number | undefined | null | false | Record<string, unknown> | unknown[])} args - Class values to join.
+ * @returns {string} A space-separated string of unique class names.
+ *
+ * @example
+ * classNames('foo', ['bar', { baz: true }], { qux: false, quux: true });
+ * // => 'foo bar baz quux'
+ */
 export declare function classNames(...args: (string | number | undefined | null | false | Record<string, unknown> | unknown[])[]): string;
+/**
+ * Creates a prefixed version of classNames that automatically applies a prefix to all class names.
+ *
+ * @param {string} classPrefix - The prefix to apply to all class names.
+ * @returns {Function} A classNames function that applies the prefix.
+ *
+ * @example
+ * const prefixedClassNames = createPrefixedClassNames('bulma-');
+ * prefixedClassNames('button', { 'is-primary': true });
+ * // => 'bulma-button bulma-is-primary'
+ */
 export declare function createPrefixedClassNames(classPrefix: string): (...args: (string | number | undefined | null | false | Record<string, unknown> | unknown[])[]) => string;
 export default classNames;
+/**
+ * A simple wrapper around classNames that applies an optional prefix to all class names.
+ *
+ * @param {string | undefined} prefix - The prefix to apply to all class names. If undefined, no prefix is applied.
+ * @param {...(string | number | undefined | null | false | Record<string, unknown> | unknown[])} args - Class values to join.
+ * @returns {string} A space-separated string of unique class names, with prefix applied if provided.
+ *
+ * @example
+ * prefixedClassNames('bulma-', 'button', { 'is-primary': true });
+ * // => 'bulma-button bulma-is-primary'
+ *
+ * prefixedClassNames(undefined, 'button', { 'is-primary': true });
+ * // => 'button is-primary'
+ */
 export declare function prefixedClassNames(prefix: string | undefined, ...args: (string | number | undefined | null | false | Record<string, unknown> | unknown[])[]): string;
+/**
+ * Hook that automatically applies the classPrefix from Config context to class names.
+ *
+ * @param {...(string | number | undefined | null | false | Record<string, unknown> | unknown[])} args - Class values to join.
+ * @returns {string} A space-separated string of unique class names with prefix applied from context.
+ *
+ * @example
+ * // With ConfigProvider providing classPrefix="bulma-"
+ * const classes = usePrefixedClassNames('button', { 'is-primary': true });
+ * // => 'bulma-button bulma-is-primary'
+ */
 export declare function usePrefixedClassNames(...args: (string | number | undefined | null | false | Record<string, unknown> | unknown[])[]): string;

package/dist/types/helpers/useBulmaClasses.d.ts

@@ -5,8 +5,30 @@ import { BulmaTypographyProps } from './useTypographyClasses';
 import { BulmaVisibilityProps } from './useVisibilityClasses';
 import { BulmaFlexboxProps } from './useFlexboxClasses';
 import { BulmaOtherProps } from './useOtherClasses';
+/**
+ * Props for applying Bulma helper classes to components.
+ */
 export interface BulmaClassesProps extends BulmaColorProps, BulmaSpacingProps, BulmaTypographyProps, BulmaVisibilityProps, BulmaFlexboxProps, BulmaOtherProps {
 }
+/**
+ * A hook that generates Bulma helper classes from props and separates unhandled props.
+ *
+ * Composed from the per-concern mini hooks (useColorClasses, useSpacingClasses,
+ * useTypographyClasses, useVisibilityClasses, useFlexboxClasses, and
+ * useOtherClasses), which can also be used individually.
+ *
+ * @function useBulmaClasses
+ * @param props - Combination of BulmaClassesProps and additional props.
+ * @returns An object containing the Bulma helper classes and unhandled props.
+ * @example
+ * const { bulmaHelperClasses, rest } = useBulmaClasses({
+ *   color: 'primary',
+ *   textSize: '3',
+ *   className: 'custom-class'
+ * });
+ * // bulmaHelperClasses: 'has-text-primary is-size-3'
+ * // rest: { className: 'custom-class' }
+ */
 export declare const useBulmaClasses: <T extends Record<string, unknown>>(props: BulmaClassesProps & T) => {
     bulmaHelperClasses: string;
     rest: Omit<T, keyof BulmaClassesProps>;

package/dist/types/helpers/useColorClasses.d.ts

@@ -1,8 +1,28 @@
 import { validColors, validColorShades } from './bulmaClassHelpers';
+/**
+ * Props for applying Bulma text and background color helper classes.
+ */
 export interface BulmaColorProps {
+    /** Text color class (e.g., 'primary', 'info'). */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color shade suffix (e.g., '00', 'invert'). */
     colorShade?: (typeof validColorShades)[number];
+    /** Background color class (e.g., 'primary', 'info'). */
     backgroundColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color shade suffix (e.g., '00', 'invert'). */
     backgroundColorShade?: (typeof validColorShades)[number];
 }
+/**
+ * A hook that generates Bulma text and background color helper classes.
+ *
+ * @function useColorClasses
+ * @param props - Color-related Bulma helper props.
+ * @returns A space-separated string of color helper classes.
+ * @example
+ * const colorClasses = useColorClasses({
+ *   color: 'primary',
+ *   backgroundColor: 'info',
+ * });
+ * // colorClasses: 'has-text-primary has-background-info'
+ */
 export declare const useColorClasses: (props: BulmaColorProps) => string;

package/dist/types/helpers/useFlexboxClasses.d.ts

@@ -1,12 +1,46 @@
 import { validFlexDirections, validFlexWraps, validJustifyContents, validAlignContents, validAlignItems, validAlignSelfs, validFlexGrowShrink, BulmaDisplayProps } from './bulmaClassHelpers';
+/**
+ * Props for applying Bulma flexbox helper classes. The display props are read
+ * only to gate the flex container helpers; this hook never emits display
+ * classes itself.
+ */
 export interface BulmaFlexboxProps extends BulmaDisplayProps {
+    /** Flex direction (e.g., 'row', 'column'). */
     flexDirection?: (typeof validFlexDirections)[number];
+    /** Flex wrap (e.g., 'wrap', 'nowrap'). */
     flexWrap?: (typeof validFlexWraps)[number];
+    /** Justify content (e.g., 'center', 'space-between'). */
     justifyContent?: (typeof validJustifyContents)[number];
+    /** Align content (e.g., 'center', 'stretch'). */
     alignContent?: (typeof validAlignContents)[number];
+    /** Align items (e.g., 'center', 'flex-start'). */
     alignItems?: (typeof validAlignItems)[number];
+    /** Align self (e.g., 'auto', 'center'). */
     alignSelf?: (typeof validAlignSelfs)[number];
+    /** Flex grow value (e.g., '0', '1', '2', '3', '4', '5'). */
     flexGrow?: (typeof validFlexGrowShrink)[number];
+    /** Flex shrink value (e.g., '0', '1', '2', '3', '4', '5'). */
     flexShrink?: (typeof validFlexGrowShrink)[number];
 }
+/**
+ * A hook that generates Bulma flexbox helper classes. Flex container helpers
+ * (direction, wrap, justify/align content, align items) are only emitted when
+ * one of the display props indicates a flex display; flex item helpers
+ * (align self, grow, shrink) are always emitted.
+ *
+ * Note: this hook reads the display props purely as a gate and never emits
+ * display classes — `is-flex` and friends come from useVisibilityClasses (or
+ * the useBulmaClasses aggregate).
+ *
+ * @function useFlexboxClasses
+ * @param props - Flexbox-related Bulma helper props.
+ * @returns A space-separated string of flexbox helper classes.
+ * @example
+ * const flexboxClasses = useFlexboxClasses({
+ *   display: 'flex', // gates the container helpers, but emits no 'is-flex'
+ *   justifyContent: 'center',
+ * });
+ * // flexboxClasses: 'is-justify-content-center'
+ * // ('is-flex' itself comes from useVisibilityClasses/useBulmaClasses)
+ */
 export declare const useFlexboxClasses: (props: BulmaFlexboxProps) => string;

package/dist/types/helpers/useOtherClasses.d.ts

@@ -1,15 +1,42 @@
+/**
+ * Props for applying miscellaneous Bulma helper classes.
+ */
 export interface BulmaOtherProps {
+    /** Float direction (e.g., 'left', 'right'). */
     float?: 'left' | 'right';
+    /** Overflow behavior (e.g., 'clipped'). */
     overflow?: 'clipped';
+    /** Applies overlay styling if true. */
     overlay?: boolean;
+    /** Interaction behavior (e.g., 'unselectable', 'clickable'). */
     interaction?: 'unselectable' | 'clickable';
+    /** Cursor style (e.g., 'pointer', 'help'). */
     cursor?: 'pointer' | 'help';
+    /** Border radius style (e.g., 'radiusless'). */
     radius?: 'radiusless';
+    /** Shadow style (e.g., 'shadowless'). */
     shadow?: 'shadowless';
+    /** Responsive behavior (e.g., 'mobile', 'narrow'). */
     responsive?: 'mobile' | 'narrow';
+    /** Add Bulma skeleton class if true. */
     skeleton?: boolean;
+    /** Applies clearfix to fix floating children if true. */
     clearfix?: boolean;
+    /** Applies position: relative if true. */
     relative?: boolean;
+    /** Applies height: 100% if true. */
     fullHeight?: boolean;
 }
+/**
+ * A hook that generates miscellaneous Bulma helper classes (float, overflow,
+ * overlay, interaction, cursor, radius, shadow, responsive, skeleton,
+ * clearfix, relative, and full height).
+ *
+ * @function useOtherClasses
+ * @param props - Miscellaneous Bulma helper props.
+ * @returns A space-separated string of helper classes.
+ * @example
+ * const otherClasses = useOtherClasses({ float: 'left', skeleton: true });
+ * // otherClasses: 'is-pulled-left is-skeleton'
+ */
 export declare const useOtherClasses: (props: BulmaOtherProps) => string;

package/dist/types/helpers/useSpacingClasses.d.ts

@@ -1,18 +1,45 @@
 import { validSizes } from './bulmaClassHelpers';
+/**
+ * Props for applying Bulma margin and padding helper classes.
+ */
 export interface BulmaSpacingProps {
+    /** Margin (e.g., '0', '1'). */
     m?: (typeof validSizes)[number];
+    /** Margin top. */
     mt?: (typeof validSizes)[number];
+    /** Margin right. */
     mr?: (typeof validSizes)[number];
+    /** Margin bottom. */
     mb?: (typeof validSizes)[number];
+    /** Margin left. */
     ml?: (typeof validSizes)[number];
+    /** Margin horizontal (left and right). */
     mx?: (typeof validSizes)[number];
+    /** Margin vertical (top and bottom). */
     my?: (typeof validSizes)[number];
+    /** Padding (e.g., '0', '1'). */
     p?: (typeof validSizes)[number];
+    /** Padding top. */
     pt?: (typeof validSizes)[number];
+    /** Padding right. */
     pr?: (typeof validSizes)[number];
+    /** Padding bottom. */
     pb?: (typeof validSizes)[number];
+    /** Padding left. */
     pl?: (typeof validSizes)[number];
+    /** Padding horizontal (left and right). */
     px?: (typeof validSizes)[number];
+    /** Padding vertical (top and bottom). */
     py?: (typeof validSizes)[number];
 }
+/**
+ * A hook that generates Bulma margin and padding helper classes.
+ *
+ * @function useSpacingClasses
+ * @param props - Spacing-related Bulma helper props.
+ * @returns A space-separated string of spacing helper classes.
+ * @example
+ * const spacingClasses = useSpacingClasses({ m: '2', px: '4' });
+ * // spacingClasses: 'm-2 px-4'
+ */
 export declare const useSpacingClasses: (props: BulmaSpacingProps) => string;

package/dist/types/helpers/useTypographyClasses.d.ts

@@ -1,19 +1,51 @@
 import { validTextSizes, validAlignments, validTextTransforms, validTextWeights, validFontFamilies, BulmaViewportProps } from './bulmaClassHelpers';
+/**
+ * Props for applying Bulma typography helper classes.
+ */
 export interface BulmaTypographyProps extends BulmaViewportProps {
+    /** Text size (e.g., '1', '2'). */
     textSize?: (typeof validTextSizes)[number];
+    /** Text alignment (e.g., 'centered', 'left'). */
     textAlign?: (typeof validAlignments)[number];
+    /** Text transformation (e.g., 'uppercase', 'italic'). */
     textTransform?: (typeof validTextTransforms)[number];
+    /** Text weight (e.g., 'light', 'bold'). */
     textWeight?: (typeof validTextWeights)[number];
+    /** Font family (e.g., 'sans-serif', 'code'). */
     fontFamily?: (typeof validFontFamilies)[number];
+    /** Text size for mobile viewport (up to 768px). */
     textSizeMobile?: (typeof validTextSizes)[number];
+    /** Text size for tablet viewport (769px - 1023px). */
     textSizeTablet?: (typeof validTextSizes)[number];
+    /** Text size for desktop viewport (1024px - 1215px). */
     textSizeDesktop?: (typeof validTextSizes)[number];
+    /** Text size for widescreen viewport (1216px - 1407px). */
     textSizeWidescreen?: (typeof validTextSizes)[number];
+    /** Text size for fullhd viewport (1408px and above). */
     textSizeFullhd?: (typeof validTextSizes)[number];
+    /** Text alignment for mobile viewport (up to 768px). */
     textAlignMobile?: (typeof validAlignments)[number];
+    /** Text alignment for tablet viewport (769px - 1023px). */
     textAlignTablet?: (typeof validAlignments)[number];
+    /** Text alignment for desktop viewport (1024px - 1215px). */
     textAlignDesktop?: (typeof validAlignments)[number];
+    /** Text alignment for widescreen viewport (1216px - 1407px). */
     textAlignWidescreen?: (typeof validAlignments)[number];
+    /** Text alignment for fullhd viewport (1408px and above). */
     textAlignFullhd?: (typeof validAlignments)[number];
 }
+/**
+ * A hook that generates Bulma typography helper classes, including
+ * viewport-specific text size and alignment variants.
+ *
+ * @function useTypographyClasses
+ * @param props - Typography-related Bulma helper props.
+ * @returns A space-separated string of typography helper classes.
+ * @example
+ * const typographyClasses = useTypographyClasses({
+ *   textSize: '3',
+ *   textWeight: 'bold',
+ * });
+ * // typographyClasses: 'is-size-3 has-text-weight-bold'
+ */
 export declare const useTypographyClasses: (props: BulmaTypographyProps) => string;