@allxsmith/bestax-bulma 5.8.0 → 5.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/README.md +20 -0
  2. package/dist/index.cjs.js +205 -367
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.esm.js +205 -367
  5. package/dist/index.esm.js.map +1 -1
  6. package/dist/types/columns/Column.d.ts +25 -30
  7. package/dist/types/columns/Columns.d.ts +23 -30
  8. package/dist/types/components/Avatar.d.ts +15 -20
  9. package/dist/types/components/Avatars.d.ts +8 -9
  10. package/dist/types/components/Badge.d.ts +13 -21
  11. package/dist/types/components/Breadcrumb.d.ts +6 -9
  12. package/dist/types/components/Card.d.ts +34 -36
  13. package/dist/types/components/Carousel.d.ts +29 -29
  14. package/dist/types/components/Collapse.d.ts +17 -18
  15. package/dist/types/components/Dialog.d.ts +24 -29
  16. package/dist/types/components/Dropdown.d.ts +16 -18
  17. package/dist/types/components/Loading.d.ts +13 -18
  18. package/dist/types/components/Menu.d.ts +11 -15
  19. package/dist/types/components/Message.d.ts +11 -14
  20. package/dist/types/components/Modal.d.ts +23 -29
  21. package/dist/types/components/Navbar.d.ts +60 -72
  22. package/dist/types/components/Pagination.d.ts +39 -35
  23. package/dist/types/components/Panel.d.ts +26 -33
  24. package/dist/types/components/Reveal.d.ts +11 -17
  25. package/dist/types/components/Sidebar.d.ts +17 -20
  26. package/dist/types/components/Steps.d.ts +28 -37
  27. package/dist/types/components/Tabs.d.ts +44 -43
  28. package/dist/types/components/Toast.d.ts +23 -28
  29. package/dist/types/components/Tooltip.d.ts +16 -20
  30. package/dist/types/elements/Block.d.ts +11 -10
  31. package/dist/types/elements/Box.d.ts +12 -10
  32. package/dist/types/elements/Button.d.ts +30 -23
  33. package/dist/types/elements/Buttons.d.ts +13 -9
  34. package/dist/types/elements/Code.d.ts +5 -10
  35. package/dist/types/elements/Content.d.ts +12 -11
  36. package/dist/types/elements/Delete.d.ts +14 -12
  37. package/dist/types/elements/Divider.d.ts +3 -7
  38. package/dist/types/elements/Emphasis.d.ts +5 -10
  39. package/dist/types/elements/Figure.d.ts +8 -10
  40. package/dist/types/elements/Icon.d.ts +18 -18
  41. package/dist/types/elements/IconText.d.ts +14 -11
  42. package/dist/types/elements/Image.d.ts +17 -17
  43. package/dist/types/elements/Link.d.ts +10 -14
  44. package/dist/types/elements/LinkButton.d.ts +3 -9
  45. package/dist/types/elements/ListItem.d.ts +6 -11
  46. package/dist/types/elements/Notification.d.ts +33 -24
  47. package/dist/types/elements/OrderedList.d.ts +7 -8
  48. package/dist/types/elements/Paragraph.d.ts +5 -10
  49. package/dist/types/elements/Pre.d.ts +5 -10
  50. package/dist/types/elements/Progress.d.ts +16 -10
  51. package/dist/types/elements/Skeleton.d.ts +4 -13
  52. package/dist/types/elements/Span.d.ts +5 -9
  53. package/dist/types/elements/Strong.d.ts +5 -10
  54. package/dist/types/elements/SubTitle.d.ts +9 -11
  55. package/dist/types/elements/Table.d.ts +8 -9
  56. package/dist/types/elements/Tag.d.ts +9 -12
  57. package/dist/types/elements/Tags.d.ts +4 -5
  58. package/dist/types/elements/Tbody.d.ts +2 -3
  59. package/dist/types/elements/Td.d.ts +3 -4
  60. package/dist/types/elements/Tfoot.d.ts +2 -3
  61. package/dist/types/elements/Th.d.ts +5 -6
  62. package/dist/types/elements/Thead.d.ts +2 -3
  63. package/dist/types/elements/Title.d.ts +10 -12
  64. package/dist/types/elements/Tr.d.ts +4 -5
  65. package/dist/types/elements/UnorderedList.d.ts +4 -5
  66. package/dist/types/form/Autocomplete.d.ts +35 -38
  67. package/dist/types/form/Checkbox.d.ts +7 -18
  68. package/dist/types/form/Checkboxes.d.ts +6 -7
  69. package/dist/types/form/Control.d.ts +21 -20
  70. package/dist/types/form/DateInput.d.ts +24 -24
  71. package/dist/types/form/DateInputBase.d.ts +36 -34
  72. package/dist/types/form/DateTimeInput.d.ts +22 -22
  73. package/dist/types/form/DateTimeInputBase.d.ts +44 -42
  74. package/dist/types/form/Field.d.ts +23 -26
  75. package/dist/types/form/File.d.ts +14 -16
  76. package/dist/types/form/Input.d.ts +20 -24
  77. package/dist/types/form/InputBase.d.ts +10 -11
  78. package/dist/types/form/Numberinput.d.ts +21 -24
  79. package/dist/types/form/Radio.d.ts +7 -18
  80. package/dist/types/form/Radios.d.ts +6 -7
  81. package/dist/types/form/Rate.d.ts +21 -37
  82. package/dist/types/form/Select.d.ts +16 -20
  83. package/dist/types/form/SelectBase.d.ts +13 -14
  84. package/dist/types/form/Slider.d.ts +56 -41
  85. package/dist/types/form/Switch.d.ts +16 -19
  86. package/dist/types/form/Taginput.d.ts +45 -48
  87. package/dist/types/form/TextArea.d.ts +11 -15
  88. package/dist/types/form/TextAreaBase.d.ts +13 -14
  89. package/dist/types/form/TimeInput.d.ts +24 -23
  90. package/dist/types/form/TimeInputBase.d.ts +38 -59
  91. package/dist/types/form/fieldProps.d.ts +1 -1
  92. package/dist/types/grid/Cell.d.ts +12 -13
  93. package/dist/types/grid/Grid.d.ts +16 -17
  94. package/dist/types/helpers/colorDeprecations.d.ts +17 -0
  95. package/dist/types/layout/Container.d.ts +16 -13
  96. package/dist/types/layout/Footer.d.ts +7 -8
  97. package/dist/types/layout/Hero.d.ts +34 -28
  98. package/dist/types/layout/Level.d.ts +30 -33
  99. package/dist/types/layout/Media.d.ts +25 -29
  100. package/dist/types/layout/Section.d.ts +7 -8
  101. package/package.json +18 -18
@@ -2,42 +2,40 @@ import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
3
  /**
4
4
  * Props for the Media component.
5
- *
6
- * @property {'article'|'div'} [as] - Element type to render.
7
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
8
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
9
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
10
- * @property {string} [className] - Additional CSS classes.
11
- * @property {React.ReactNode} [children] - Content.
12
5
  */
13
6
  export interface MediaProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
7
+ /** Element type for the root Media container. */
14
8
  as?: 'article' | 'div';
9
+ /** Bulma color modifier. */
15
10
  color?: (typeof validColors)[number] | 'inherit' | 'current';
11
+ /** Bulma background color helper. */
16
12
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
13
+ /** Bulma text color helper. */
17
14
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
15
+ /** Additional CSS classes. */
18
16
  className?: string;
17
+ /** Content inside the media container. */
19
18
  children?: React.ReactNode;
20
19
  }
21
20
  /**
22
21
  * Props for the MediaLeft component.
23
- *
24
- * @property {'figure'|'div'} [as] - Element type to render.
25
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
26
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
27
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
28
- * @property {string} [className] - Additional CSS classes.
29
- * @property {React.ReactNode} [children] - Content.
30
22
  */
31
23
  export interface MediaLeftProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
24
+ /** Element type to render. */
32
25
  as?: 'figure' | 'div';
26
+ /** Bulma color modifier. */
33
27
  color?: (typeof validColors)[number] | 'inherit' | 'current';
28
+ /** Background color. */
34
29
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
30
+ /** Text color. */
35
31
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
32
+ /** Additional CSS classes. */
36
33
  className?: string;
34
+ /** Content. */
37
35
  children?: React.ReactNode;
38
36
  }
39
37
  /**
40
- * Bulma Media left section.
38
+ * For avatars, thumbnails, icons (renders as `figure` or `div`)
41
39
  *
42
40
  * @function
43
41
  * @param {MediaLeftProps} props - Props for the MediaLeft component.
@@ -46,22 +44,21 @@ export interface MediaLeftProps extends React.HTMLAttributes<HTMLElement>, Omit<
46
44
  export declare const MediaLeft: React.FC<MediaLeftProps>;
47
45
  /**
48
46
  * Props for the MediaContent component.
49
- *
50
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
51
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
52
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
53
- * @property {string} [className] - Additional CSS classes.
54
- * @property {React.ReactNode} [children] - Content.
55
47
  */
56
48
  export interface MediaContentProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
49
+ /** Bulma color modifier. */
57
50
  color?: (typeof validColors)[number] | 'inherit' | 'current';
51
+ /** Background color. */
58
52
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
53
+ /** Text color. */
59
54
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
55
+ /** Additional CSS classes. */
60
56
  className?: string;
57
+ /** Content. */
61
58
  children?: React.ReactNode;
62
59
  }
63
60
  /**
64
- * Bulma Media content section.
61
+ * Main content (renders as `div`)
65
62
  *
66
63
  * @function
67
64
  * @param {MediaContentProps} props - Props for the MediaContent component.
@@ -70,22 +67,21 @@ export interface MediaContentProps extends React.HTMLAttributes<HTMLDivElement>,
70
67
  export declare const MediaContent: React.FC<MediaContentProps>;
71
68
  /**
72
69
  * Props for the MediaRight component.
73
- *
74
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
75
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
76
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
77
- * @property {string} [className] - Additional CSS classes.
78
- * @property {React.ReactNode} [children] - Content.
79
70
  */
80
71
  export interface MediaRightProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
72
+ /** Bulma color modifier. */
81
73
  color?: (typeof validColors)[number] | 'inherit' | 'current';
74
+ /** Background color. */
82
75
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
76
+ /** Text color. */
83
77
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
78
+ /** Additional CSS classes. */
84
79
  className?: string;
80
+ /** Content. */
85
81
  children?: React.ReactNode;
86
82
  }
87
83
  /**
88
- * Bulma Media right section.
84
+ * Actions or controls (renders as `div`)
89
85
  *
90
86
  * @function
91
87
  * @param {MediaRightProps} props - Props for the MediaRight component.
@@ -6,24 +6,23 @@ import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
6
6
  type SectionSize = 'medium' | 'large';
7
7
  /**
8
8
  * Props for the Section component.
9
- *
10
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [color] - Bulma color modifier.
11
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color.
12
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
13
- * @property {'medium'|'large'} [size] - Section size.
14
- * @property {string} [className] - Additional CSS classes.
15
- * @property {React.ReactNode} [children] - Section content.
16
9
  */
17
10
  export interface SectionProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'backgroundColor' | 'color'> {
11
+ /** Bulma color modifier for text. */
18
12
  color?: (typeof validColors)[number] | 'inherit' | 'current';
13
+ /** Bulma background color helper. */
19
14
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
15
+ /** Bulma text color helper. */
20
16
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
17
+ /** Section size for extra vertical spacing. */
21
18
  size?: SectionSize;
19
+ /** Additional CSS classes. */
22
20
  className?: string;
21
+ /** Section content. */
23
22
  children?: React.ReactNode;
24
23
  }
25
24
  /**
26
- * Bulma Section component for general layout.
25
+ * The `Section` component provides vertical spacing and visual separation for your Bulma React UI.
27
26
  *
28
27
  * @function
29
28
  * @param {SectionProps} props - Props for the Section component.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allxsmith/bestax-bulma",
3
- "version": "5.8.0",
3
+ "version": "5.8.1",
4
4
  "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.",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
@@ -43,45 +43,45 @@
43
43
  },
44
44
  "devDependencies": {
45
45
  "@faker-js/faker": "^10.5.0",
46
- "@fortawesome/fontawesome-free": "^7.2.0",
46
+ "@fortawesome/fontawesome-free": "^7.3.1",
47
47
  "@mdi/font": "^7.4.47",
48
48
  "@rollup/plugin-commonjs": "^29.0.3",
49
49
  "@rollup/plugin-node-resolve": "^16.0.1",
50
50
  "@rollup/plugin-typescript": "^12.1.0",
51
- "@storybook/addon-docs": "^10.1.11",
52
- "@storybook/addon-onboarding": "^10.1.11",
53
- "@storybook/react-vite": "^10.1.11",
51
+ "@storybook/addon-docs": "^10.5.5",
52
+ "@storybook/addon-onboarding": "^10.5.5",
53
+ "@storybook/react-vite": "^10.5.5",
54
54
  "@storybook/test-runner": "^0.24.4",
55
- "@testing-library/jest-dom": "^6.5.0",
55
+ "@testing-library/jest-dom": "^7.0.0",
56
56
  "@testing-library/react": "^16.3.1",
57
57
  "@testing-library/user-event": "^14.5.2",
58
58
  "@types/jest": "^30.0.0",
59
59
  "@types/react": "^19.2.17",
60
60
  "@types/react-dom": "^19.2.3",
61
- "@typescript-eslint/eslint-plugin": "^8.8.1",
62
- "@typescript-eslint/parser": "^8.8.1",
63
- "eslint": "^10.5.0",
61
+ "@typescript-eslint/eslint-plugin": "^8.65.0",
62
+ "@typescript-eslint/parser": "^8.65.0",
63
+ "eslint": "^10.8.0",
64
64
  "eslint-config-prettier": "^10.1.5",
65
65
  "eslint-plugin-prettier": "^5.2.1",
66
66
  "eslint-plugin-react-hooks": "^7.1.1",
67
- "eslint-plugin-storybook": "^10.1.11",
67
+ "eslint-plugin-storybook": "^10.5.5",
68
68
  "ionicons": "^8.0.13",
69
69
  "jest": "^30.2.0",
70
70
  "jest-environment-jsdom": "^30.2.0",
71
71
  "material-icons": "^1.13.14",
72
- "material-symbols": "^0.45.2",
73
- "playwright": "^1.61.1",
74
- "prettier": "^3.9.4",
72
+ "material-symbols": "^0.45.9",
73
+ "playwright": "^1.62.0",
74
+ "prettier": "^3.9.6",
75
75
  "rimraf": "^6.0.1",
76
- "rollup": "^4.55.1",
76
+ "rollup": "^4.62.3",
77
77
  "rollup-plugin-scss": "^4.0.1",
78
78
  "rollup-plugin-visualizer": "^7.0.1",
79
- "sass": "^1.97.2",
80
- "storybook": "^10.1.11",
81
- "ts-jest": "^29.4.6",
79
+ "sass": "^1.102.0",
80
+ "storybook": "^10.5.5",
81
+ "ts-jest": "^29.4.12",
82
82
  "tslib": "^2.8.0",
83
83
  "typescript": "^6.0.3",
84
- "vite": "^8.1.0"
84
+ "vite": "^8.1.5"
85
85
  },
86
86
  "dependencies": {
87
87
  "bulma": "^1.0.4"