@allxsmith/bestax-bulma 5.8.0 → 5.8.2

package/dist/types/layout/Level.d.ts

@@ -2,40 +2,39 @@ import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 /**
  * Props for the Level component.
- *
- * @property {boolean} [isMobile] - Enable mobile mode.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Level content.
  */
 export interface LevelProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Keeps the level horizontal on mobile (Bulma `is-mobile`). Without it
+     * the level stacks vertically below tablet. */
     isMobile?: boolean;
+    /** Bulma color modifier for the level. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma background color helper. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma text color helper. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Level content (`Level.Left`, `Level.Right`, `Level.Item`). */
     children?: React.ReactNode;
 }
 /**
  * Props for the LevelLeft component.
- *
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface LevelLeftProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Level left section.
+ * Left-aligned content.
  *
  * @function
  * @param {LevelLeftProps} props - Props for the LevelLeft component.
@@ -44,22 +43,21 @@ export interface LevelLeftProps extends React.HTMLAttributes<HTMLDivElement>, Om
 export declare const LevelLeft: React.FC<LevelLeftProps>;
 /**
  * Props for the LevelRight component.
- *
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface LevelRightProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Level right section.
+ * Right-aligned content.
  *
  * @function
  * @param {LevelRightProps} props - Props for the LevelRight component.
@@ -68,32 +66,31 @@ export interface LevelRightProps extends React.HTMLAttributes<HTMLDivElement>, O
 export declare const LevelRight: React.FC<LevelRightProps>;
 /**
  * Props for the LevelItem component.
- *
- * @property {'div'|'p'|'a'} [as] - Element type to render.
- * @property {boolean} [hasTextCentered] - Center the text in the item.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
- * @property {string} [href] - Href for "a" tag.
- * @property {string} [target] - Target for "a" tag
- * @property {string} [rel] - Rel for "a" tag
  */
 export interface LevelItemProps extends React.HTMLAttributes<HTMLDivElement | HTMLParagraphElement | HTMLAnchorElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Element type to render. */
     as?: 'div' | 'p' | 'a';
+    /** Center the text in the item. */
     hasTextCentered?: boolean;
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
+    /** Href for "a" tag. */
     href?: string;
+    /** Target for "a" tag */
     target?: string;
+    /** Rel for "a" tag */
     rel?: string;
 }
 /**
- * Bulma Level item section.
+ * Individual item, can be rendered as `div`, `p`, or `a`.
  *
  * @function
  * @param {LevelItemProps} props - Props for the LevelItem component.

package/dist/types/layout/Media.d.ts

@@ -2,42 +2,40 @@ import React from 'react';
 import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 /**
  * Props for the Media component.
- *
- * @property {'article'|'div'} [as] - Element type to render.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface MediaProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Element type for the root Media container. */
     as?: 'article' | 'div';
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma background color helper. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma text color helper. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content inside the media container. */
     children?: React.ReactNode;
 }
 /**
  * Props for the MediaLeft component.
- *
- * @property {'figure'|'div'} [as] - Element type to render.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface MediaLeftProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Element type to render. */
     as?: 'figure' | 'div';
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Media left section.
+ * For avatars, thumbnails, icons (renders as `figure` or `div`)
  *
  * @function
  * @param {MediaLeftProps} props - Props for the MediaLeft component.
@@ -46,22 +44,21 @@ export interface MediaLeftProps extends React.HTMLAttributes<HTMLElement>, Omit<
 export declare const MediaLeft: React.FC<MediaLeftProps>;
 /**
  * Props for the MediaContent component.
- *
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface MediaContentProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Media content section.
+ * Main content (renders as `div`)
  *
  * @function
  * @param {MediaContentProps} props - Props for the MediaContent component.
@@ -70,22 +67,21 @@ export interface MediaContentProps extends React.HTMLAttributes<HTMLDivElement>,
 export declare const MediaContent: React.FC<MediaContentProps>;
 /**
  * Props for the MediaRight component.
- *
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Content.
  */
 export interface MediaRightProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
+    /** Bulma color modifier. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Background color. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Text color. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Additional CSS classes. */
     className?: string;
+    /** Content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Media right section.
+ * Actions or controls (renders as `div`)
  *
  * @function
  * @param {MediaRightProps} props - Props for the MediaRight component.

package/dist/types/layout/Section.d.ts

@@ -6,24 +6,23 @@ import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
 type SectionSize = 'medium' | 'large';
 /**
  * Props for the Section component.
- *
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
- * @property {'medium'|'large'} [size] - Section size.
- * @property {string} [className] - Additional CSS classes.
- * @property {React.ReactNode} [children] - Section content.
  */
 export interface SectionProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'backgroundColor' | 'color'> {
+    /** Bulma color modifier for text. */
     color?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma background color helper. */
     bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Bulma text color helper. */
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
+    /** Section size for extra vertical spacing. */
     size?: SectionSize;
+    /** Additional CSS classes. */
     className?: string;
+    /** Section content. */
     children?: React.ReactNode;
 }
 /**
- * Bulma Section component for general layout.
+ * The `Section` component provides vertical spacing and visual separation for your Bulma React UI.
  *
  * @function
  * @param {SectionProps} props - Props for the Section component.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allxsmith/bestax-bulma",
-  "version": "5.8.0",
+  "version": "5.8.2",
   "description": "A fully-typed React component library for the Bulma CSS framework. Build modern UIs quickly with reusable, accessible, and customizable Bulma-based React components.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -43,45 +43,45 @@
   },
   "devDependencies": {
     "@faker-js/faker": "^10.5.0",
-    "@fortawesome/fontawesome-free": "^7.2.0",
+    "@fortawesome/fontawesome-free": "^7.3.1",
     "@mdi/font": "^7.4.47",
     "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-typescript": "^12.1.0",
-    "@storybook/addon-docs": "^10.1.11",
-    "@storybook/addon-onboarding": "^10.1.11",
-    "@storybook/react-vite": "^10.1.11",
+    "@storybook/addon-docs": "^10.5.5",
+    "@storybook/addon-onboarding": "^10.5.5",
+    "@storybook/react-vite": "^10.5.5",
     "@storybook/test-runner": "^0.24.4",
-    "@testing-library/jest-dom": "^6.5.0",
+    "@testing-library/jest-dom": "^7.0.0",
     "@testing-library/react": "^16.3.1",
     "@testing-library/user-event": "^14.5.2",
     "@types/jest": "^30.0.0",
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.8.1",
-    "@typescript-eslint/parser": "^8.8.1",
-    "eslint": "^10.5.0",
+    "@typescript-eslint/eslint-plugin": "^8.65.0",
+    "@typescript-eslint/parser": "^8.65.0",
+    "eslint": "^10.8.0",
     "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-react-hooks": "^7.1.1",
-    "eslint-plugin-storybook": "^10.1.11",
+    "eslint-plugin-storybook": "^10.5.5",
     "ionicons": "^8.0.13",
     "jest": "^30.2.0",
     "jest-environment-jsdom": "^30.2.0",
     "material-icons": "^1.13.14",
-    "material-symbols": "^0.45.2",
-    "playwright": "^1.61.1",
-    "prettier": "^3.9.4",
+    "material-symbols": "^0.45.9",
+    "playwright": "^1.62.0",
+    "prettier": "^3.9.6",
     "rimraf": "^6.0.1",
-    "rollup": "^4.55.1",
+    "rollup": "^4.62.3",
     "rollup-plugin-scss": "^4.0.1",
     "rollup-plugin-visualizer": "^7.0.1",
-    "sass": "^1.97.2",
-    "storybook": "^10.1.11",
-    "ts-jest": "^29.4.6",
+    "sass": "^1.102.0",
+    "storybook": "^10.5.5",
+    "ts-jest": "^29.4.12",
     "tslib": "^2.8.0",
     "typescript": "^6.0.3",
-    "vite": "^8.1.0"
+    "vite": "^8.1.5"
   },
   "dependencies": {
     "bulma": "^1.0.4"