@allxsmith/bestax-bulma 1.0.5 → 1.0.6

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 (61) hide show
  1. package/README.md +10 -1
  2. package/dist/index.cjs.js +357 -2154
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.esm.js +357 -2154
  5. package/dist/index.esm.js.map +1 -1
  6. package/dist/types/columns/Column.d.ts +0 -43
  7. package/dist/types/columns/Columns.d.ts +0 -32
  8. package/dist/types/components/Breadcrumb.d.ts +0 -28
  9. package/dist/types/components/Card.d.ts +0 -24
  10. package/dist/types/components/Dropdown.d.ts +0 -42
  11. package/dist/types/components/Menu.d.ts +0 -48
  12. package/dist/types/components/Message.d.ts +0 -21
  13. package/dist/types/components/Modal.d.ts +0 -21
  14. package/dist/types/components/Navbar.d.ts +0 -146
  15. package/dist/types/components/Pagination.d.ts +0 -68
  16. package/dist/types/components/Panel.d.ts +0 -81
  17. package/dist/types/components/Tab.d.ts +0 -49
  18. package/dist/types/components/Tabs.d.ts +0 -49
  19. package/dist/types/elements/Block.d.ts +0 -20
  20. package/dist/types/elements/Box.d.ts +1 -23
  21. package/dist/types/elements/Button.d.ts +0 -36
  22. package/dist/types/elements/Buttons.d.ts +0 -22
  23. package/dist/types/elements/Content.d.ts +0 -21
  24. package/dist/types/elements/Delete.d.ts +0 -22
  25. package/dist/types/elements/Icon.d.ts +0 -24
  26. package/dist/types/elements/IconText.d.ts +0 -27
  27. package/dist/types/elements/Image.d.ts +0 -27
  28. package/dist/types/elements/Notification.d.ts +0 -20
  29. package/dist/types/elements/Progress.d.ts +0 -20
  30. package/dist/types/elements/SubTitle.d.ts +0 -24
  31. package/dist/types/elements/Table.d.ts +0 -25
  32. package/dist/types/elements/Tag.d.ts +0 -28
  33. package/dist/types/elements/Tags.d.ts +0 -18
  34. package/dist/types/elements/Tbody.d.ts +0 -19
  35. package/dist/types/elements/Td.d.ts +0 -23
  36. package/dist/types/elements/Tfoot.d.ts +0 -19
  37. package/dist/types/elements/Th.d.ts +0 -25
  38. package/dist/types/elements/Thead.d.ts +0 -19
  39. package/dist/types/elements/Title.d.ts +0 -25
  40. package/dist/types/elements/Tr.d.ts +0 -21
  41. package/dist/types/form/Checkbox.d.ts +0 -16
  42. package/dist/types/form/Checkboxes.d.ts +0 -15
  43. package/dist/types/form/Control.d.ts +0 -30
  44. package/dist/types/form/Field.d.ts +0 -57
  45. package/dist/types/form/File.d.ts +0 -26
  46. package/dist/types/form/Input.d.ts +0 -22
  47. package/dist/types/form/Radio.d.ts +0 -16
  48. package/dist/types/form/Radios.d.ts +0 -15
  49. package/dist/types/form/Select.d.ts +0 -22
  50. package/dist/types/form/TextArea.d.ts +0 -25
  51. package/dist/types/grid/Cell.d.ts +0 -26
  52. package/dist/types/grid/Grid.d.ts +0 -40
  53. package/dist/types/helpers/classNames.d.ts +0 -14
  54. package/dist/types/helpers/useBulmaClasses.d.ts +0 -130
  55. package/dist/types/layout/Container.d.ts +0 -26
  56. package/dist/types/layout/Footer.d.ts +0 -19
  57. package/dist/types/layout/Hero.d.ts +0 -57
  58. package/dist/types/layout/Level.d.ts +0 -59
  59. package/dist/types/layout/Media.d.ts +0 -55
  60. package/dist/types/layout/Section.d.ts +0 -21
  61. package/package.json +3 -3
@@ -1,41 +1,6 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Possible values for Bulma column size.
5
- */
6
3
  export type BulmaColumnSize = number | 'full' | 'half' | 'one-third' | 'two-thirds' | 'one-quarter' | 'three-quarters' | 'one-fifth' | 'two-fifths' | 'three-fifths' | 'four-fifths';
7
- /**
8
- * Props for the Column component.
9
- *
10
- * @property {string} [className] - Additional CSS classes to apply.
11
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color (Bulma color, 'inherit', or 'current').
12
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier for the column.
13
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color (Bulma color, 'inherit', or 'current').
14
- *
15
- * @property {BulmaColumnSize} [size] - Column size.
16
- * @property {BulmaColumnSize} [sizeMobile] - Mobile column size.
17
- * @property {BulmaColumnSize} [sizeTablet] - Tablet column size.
18
- * @property {BulmaColumnSize} [sizeDesktop] - Desktop column size.
19
- * @property {BulmaColumnSize} [sizeWidescreen] - Widescreen column size.
20
- * @property {BulmaColumnSize} [sizeFullhd] - FullHD column size.
21
- *
22
- * @property {BulmaColumnSize} [offset] - Column offset.
23
- * @property {BulmaColumnSize} [offsetMobile] - Mobile column offset.
24
- * @property {BulmaColumnSize} [offsetTablet] - Tablet column offset.
25
- * @property {BulmaColumnSize} [offsetDesktop] - Desktop column offset.
26
- * @property {BulmaColumnSize} [offsetWidescreen] - Widescreen column offset.
27
- * @property {BulmaColumnSize} [offsetFullhd] - FullHD column offset.
28
- *
29
- * @property {boolean} [isNarrow] - The column is narrow.
30
- * @property {boolean} [isNarrowMobile] - The column is narrow on mobile.
31
- * @property {boolean} [isNarrowTablet] - The column is narrow on tablet.
32
- * @property {boolean} [isNarrowTouch] - The column is narrow on touch devices.
33
- * @property {boolean} [isNarrowDesktop] - The column is narrow on desktop.
34
- * @property {boolean} [isNarrowWidescreen] - The column is narrow on widescreen.
35
- * @property {boolean} [isNarrowFullhd] - The column is narrow on fullhd.
36
- *
37
- * @property {React.ReactNode} [children] - Children to render inside the column.
38
- */
39
4
  export interface ColumnProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
40
5
  className?: string;
41
6
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -62,12 +27,4 @@ export interface ColumnProps extends React.HTMLAttributes<HTMLDivElement>, Omit<
62
27
  isNarrowFullhd?: boolean;
63
28
  children?: React.ReactNode;
64
29
  }
65
- /**
66
- * Bulma Column component for responsive grid layouts.
67
- *
68
- * @function
69
- * @param {ColumnProps} props - Props for the Column component.
70
- * @returns {JSX.Element} The rendered column.
71
- * @see {@link https://bulma.io/documentation/columns/ | Bulma Columns documentation}
72
- */
73
30
  export declare const Column: React.FC<ColumnProps>;
@@ -1,30 +1,6 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Possible values for the Bulma columns gap size.
5
- */
6
3
  export type BulmaGapSize = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8';
7
- /**
8
- * Props for the Columns component.
9
- *
10
- * @property {string} [className] - Additional CSS classes to apply.
11
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color (Bulma color, 'inherit', or 'current').
12
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier for columns.
13
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color (Bulma color, 'inherit', or 'current').
14
- * @property {boolean} [isCentered] - Center the columns container.
15
- * @property {boolean} [isGapless] - Remove all column gaps.
16
- * @property {boolean} [isMultiline] - Allow columns to wrap to multiple lines.
17
- * @property {boolean} [isVCentered] - Vertically center columns.
18
- * @property {boolean} [isMobile] - Only apply columns styles on mobile.
19
- * @property {boolean} [isDesktop] - Only apply columns styles on desktop.
20
- * @property {BulmaGapSize} [gapSize] - Gap size for all breakpoints.
21
- * @property {BulmaGapSize} [gapSizeMobile] - Gap size for mobile.
22
- * @property {BulmaGapSize} [gapSizeTablet] - Gap size for tablet.
23
- * @property {BulmaGapSize} [gapSizeDesktop] - Gap size for desktop.
24
- * @property {BulmaGapSize} [gapSizeWidescreen] - Gap size for widescreen.
25
- * @property {BulmaGapSize} [gapSizeFullhd] - Gap size for fullhd.
26
- * @property {React.ReactNode} [children] - Columns to render within the container.
27
- */
28
4
  export interface ColumnsProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
29
5
  className?: string;
30
6
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -44,12 +20,4 @@ export interface ColumnsProps extends React.HTMLAttributes<HTMLDivElement>, Omit
44
20
  gapSizeFullhd?: BulmaGapSize;
45
21
  children?: React.ReactNode;
46
22
  }
47
- /**
48
- * Bulma Columns container for flexible, responsive layouts.
49
- *
50
- * @function
51
- * @param {ColumnsProps} props - Props for the Columns component.
52
- * @returns {JSX.Element} The rendered columns container.
53
- * @see {@link https://bulma.io/documentation/columns/ | Bulma Columns documentation}
54
- */
55
23
  export declare const Columns: React.FC<ColumnsProps>;
@@ -1,29 +1,11 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps } from '../helpers/useBulmaClasses';
3
3
  declare const validBreadcrumbAlignments: readonly ["centered", "right"];
4
- /**
5
- * Valid alignment values for the Breadcrumb component.
6
- */
7
4
  export type BreadcrumbAlignment = (typeof validBreadcrumbAlignments)[number];
8
5
  declare const validBreadcrumbSeparators: readonly ["arrow", "bullet", "dot", "succeeds"];
9
- /**
10
- * Valid separator values for the Breadcrumb component.
11
- */
12
6
  export type BreadcrumbSeparator = (typeof validBreadcrumbSeparators)[number];
13
7
  declare const validBreadcrumbSizes: readonly ["small", "medium", "large"];
14
- /**
15
- * Valid size values for the Breadcrumb component.
16
- */
17
8
  export type BreadcrumbSize = (typeof validBreadcrumbSizes)[number];
18
- /**
19
- * Props for the Breadcrumb component.
20
- *
21
- * @property {string} [className] - Additional CSS classes to apply.
22
- * @property {BreadcrumbAlignment} [alignment] - Alignment modifier for the breadcrumb.
23
- * @property {BreadcrumbSeparator} [separator] - Separator style for the breadcrumb.
24
- * @property {BreadcrumbSize} [size] - Size modifier for the breadcrumb.
25
- * @property {React.ReactNode} [children] - Breadcrumb items (e.g., "a" or "span" html elements).
26
- */
27
9
  export interface BreadcrumbProps extends Omit<React.HTMLAttributes<HTMLElement>, 'color'>, Omit<BulmaClassesProps, 'backgroundColor' | 'color'> {
28
10
  className?: string;
29
11
  alignment?: BreadcrumbAlignment;
@@ -31,15 +13,5 @@ export interface BreadcrumbProps extends Omit<React.HTMLAttributes<HTMLElement>,
31
13
  size?: BreadcrumbSize;
32
14
  children?: React.ReactNode;
33
15
  }
34
- /**
35
- * Breadcrumb component for rendering a styled Bulma breadcrumb navigation.
36
- *
37
- * Supports alignment, separator styles, and sizes.
38
- *
39
- * @function
40
- * @param {BreadcrumbProps} props - Props for the Breadcrumb component.
41
- * @returns {JSX.Element} The rendered breadcrumb element.
42
- * @see {@link https://bulma.io/documentation/components/breadcrumb/ | Bulma Breadcrumb documentation}
43
- */
44
16
  export declare const Breadcrumb: React.FC<BreadcrumbProps>;
45
17
  export {};
@@ -1,21 +1,5 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Props for the Card component.
5
- *
6
- * @property {string} [className] - Additional CSS classes to apply.
7
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for the card.
8
- * @property {'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger'} [color] - Bulma color modifier for the card.
9
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color for the card.
10
- * @property {boolean} [hasShadow] - Whether the card has a shadow (default: true).
11
- * @property {React.ReactNode} [header] - Card header content, rendered inside `.card-header-title`.
12
- * @property {boolean} [headerCentered] - If true, centers the header title.
13
- * @property {React.ReactNode} [headerIcon] - Card header icon, rendered as a sibling to the header title.
14
- * @property {React.ReactNode|React.ReactNode[]} [footer] - Card footer content, each wrapped in `.card-footer-item`.
15
- * @property {React.ReactNode|string} [image] - Card image node or image src string.
16
- * @property {string} [imageAlt] - Alternate text for the card image.
17
- * @property {React.ReactNode} [children] - Card content.
18
- */
19
3
  export interface CardProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
20
4
  className?: string;
21
5
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -30,14 +14,6 @@ export interface CardProps extends React.HTMLAttributes<HTMLDivElement>, Omit<Bu
30
14
  imageAlt?: string;
31
15
  children?: React.ReactNode;
32
16
  }
33
- /**
34
- * Card component for rendering a styled Bulma card.
35
- *
36
- * @function
37
- * @param {CardProps} props - Props for the Card component.
38
- * @returns {JSX.Element} The rendered card element.
39
- * @see {@link https://bulma.io/documentation/components/card/ | Bulma Card documentation}
40
- */
41
17
  export declare const Card: React.FC<CardProps>;
42
18
  export declare const __test_exports__: {
43
19
  renderFooter: (footer: CardProps["footer"]) => import("react/jsx-runtime").JSX.Element[] | null;
@@ -1,28 +1,6 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps } from '../helpers/useBulmaClasses';
3
- /**
4
- * Checks if code is running in a browser environment.
5
- * @param win - Window object.
6
- * @param doc - Document object.
7
- * @returns {boolean} True if in browser, false otherwise.
8
- */
9
3
  export declare const isBrowser: (win?: typeof window, doc?: typeof document) => boolean;
10
- /**
11
- * Props for the Dropdown component.
12
- *
13
- * @property {React.ReactNode} label - The dropdown button content.
14
- * @property {React.ReactNode} children - The menu items.
15
- * @property {string} [className] - Additional CSS classes to apply.
16
- * @property {string} [menuClassName] - Additional CSS classes for the dropdown menu.
17
- * @property {boolean} [active] - Whether the dropdown is open (controlled).
18
- * @property {boolean} [up] - Dropdown direction up.
19
- * @property {boolean} [right] - Dropdown aligned to the right.
20
- * @property {boolean} [hoverable] - Dropdown opens on hover.
21
- * @property {boolean} [disabled] - Disables the dropdown trigger.
22
- * @property {(active: boolean) => void} [onActiveChange] - Called when active state changes.
23
- * @property {boolean} [closeOnClick=true] - Close dropdown when clicking a menu item.
24
- * @property {string} [id] - ID for the root element.
25
- */
26
4
  export interface DropdownProps extends Omit<React.HTMLAttributes<HTMLDivElement>, keyof BulmaClassesProps>, BulmaClassesProps {
27
5
  label: React.ReactNode;
28
6
  children: React.ReactNode;
@@ -37,33 +15,13 @@ export interface DropdownProps extends Omit<React.HTMLAttributes<HTMLDivElement>
37
15
  closeOnClick?: boolean;
38
16
  id?: string;
39
17
  }
40
- /**
41
- * Props for the DropdownItem component.
42
- *
43
- * @property {boolean} [active] - Whether the item is active.
44
- * @property {string} [className] - Additional CSS classes.
45
- * @property {'a'|'div'|'button'} [as] - The element type to render.
46
- * @property {React.ReactNode} [children] - Item content.
47
- */
48
18
  export interface DropdownItemProps extends Omit<React.HTMLAttributes<HTMLElement>, keyof BulmaClassesProps>, BulmaClassesProps {
49
19
  active?: boolean;
50
20
  className?: string;
51
21
  as?: 'a' | 'div' | 'button';
52
22
  children?: React.ReactNode;
53
23
  }
54
- /**
55
- * Bulma Dropdown item.
56
- *
57
- * @function
58
- * @param {DropdownItemProps} props - Props for the DropdownItem component.
59
- * @returns {JSX.Element} The rendered dropdown item.
60
- */
61
24
  export declare const DropdownItem: React.FC<DropdownItemProps>;
62
- /**
63
- * Bulma Dropdown divider.
64
- *
65
- * @returns {JSX.Element} The divider element.
66
- */
67
25
  export declare const DropdownDivider: React.FC;
68
26
  export declare const Dropdown: React.FC<DropdownProps> & {
69
27
  Item: React.FC<DropdownItemProps>;
@@ -1,60 +1,19 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps } from '../helpers/useBulmaClasses';
3
- /**
4
- * Props for the Menu component.
5
- *
6
- * @property {string} [className] - Additional CSS classes.
7
- * @property {React.ReactNode} children - Menu content.
8
- */
9
3
  export interface MenuProps extends Omit<React.HTMLAttributes<HTMLElement>, keyof BulmaClassesProps>, BulmaClassesProps {
10
4
  className?: string;
11
5
  children: React.ReactNode;
12
6
  }
13
- /**
14
- * Props for the MenuLabel component.
15
- *
16
- * @property {string} [className] - Additional CSS classes.
17
- * @property {React.ReactNode} children - Label content.
18
- */
19
7
  export interface MenuLabelProps extends Omit<React.HTMLAttributes<HTMLParagraphElement>, keyof BulmaClassesProps>, BulmaClassesProps {
20
8
  className?: string;
21
9
  children: React.ReactNode;
22
10
  }
23
- /**
24
- * Bulma Menu label component.
25
- *
26
- * @function
27
- * @param {MenuLabelProps} props - Props for the MenuLabel component.
28
- * @returns {JSX.Element} The rendered menu label.
29
- */
30
11
  export declare const MenuLabel: React.FC<MenuLabelProps>;
31
- /**
32
- * Props for the MenuList component.
33
- *
34
- * @property {string} [className] - Additional CSS classes.
35
- * @property {React.ReactNode} children - List items.
36
- */
37
12
  export interface MenuListProps extends Omit<React.HTMLAttributes<HTMLUListElement>, keyof BulmaClassesProps>, BulmaClassesProps {
38
13
  className?: string;
39
14
  children: React.ReactNode;
40
15
  }
41
- /**
42
- * MenuList applies `menu-list` class only at the top level (not for nested lists).
43
- *
44
- * @function
45
- * @param {MenuListProps} props - Props for the MenuList component.
46
- * @returns {JSX.Element} The rendered menu list.
47
- */
48
16
  export declare const MenuList: React.FC<MenuListProps>;
49
- /**
50
- * Props for the MenuItem component.
51
- *
52
- * @property {string} [className] - Additional CSS classes.
53
- * @property {boolean} [active] - Whether the item is active.
54
- * @property {string} [href] - Href for link items.
55
- * @property {React.ElementType} [as] - Render as a custom component.
56
- * @property {React.ReactNode} children - Item content and optional nested MenuList.
57
- */
58
17
  export interface MenuItemProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, keyof BulmaClassesProps>, BulmaClassesProps {
59
18
  className?: string;
60
19
  children: React.ReactNode;
@@ -63,13 +22,6 @@ export interface MenuItemProps extends Omit<React.LiHTMLAttributes<HTMLLIElement
63
22
  as?: React.ElementType;
64
23
  [key: string]: unknown;
65
24
  }
66
- /**
67
- * MenuItem supports `as` prop for custom link components, e.g., react-router-dom Link.
68
- *
69
- * @function
70
- * @param {MenuItemProps} props - Props for the MenuItem component.
71
- * @returns {JSX.Element} The rendered menu item.
72
- */
73
25
  export declare const MenuItem: React.FC<MenuItemProps>;
74
26
  export declare const Menu: React.FC<MenuProps> & {
75
27
  Label: React.FC<MenuLabelProps>;
@@ -1,16 +1,5 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Props for the Message component.
5
- *
6
- * @property {string} [className] - Additional CSS classes.
7
- * @property {React.ReactNode} [title] - Title displayed in the message header.
8
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color (Bulma or 'inherit'/'current').
9
- * @property {'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger'} [color] - Bulma color modifier for the message.
10
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color (Bulma or 'inherit'/'current').
11
- * @property {() => void} [onClose] - Called when the close button is clicked.
12
- * @property {React.ReactNode} [children] - Message body content.
13
- */
14
3
  export interface MessageProps extends Omit<React.HTMLAttributes<HTMLElement>, 'title'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
15
4
  className?: string;
16
5
  title?: React.ReactNode;
@@ -20,15 +9,5 @@ export interface MessageProps extends Omit<React.HTMLAttributes<HTMLElement>, 't
20
9
  onClose?: () => void;
21
10
  children?: React.ReactNode;
22
11
  }
23
- /**
24
- * Bulma-styled Message component.
25
- *
26
- * Supports Bulma helper classes, color, and an optional close button.
27
- *
28
- * @function
29
- * @param {MessageProps} props - Props for the Message component.
30
- * @returns {JSX.Element} The rendered message.
31
- * @see {@link https://bulma.io/documentation/components/message/ | Bulma Message documentation}
32
- */
33
12
  export declare const Message: React.FC<MessageProps>;
34
13
  export default Message;
@@ -1,18 +1,5 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Props for the Modal component.
5
- *
6
- * @property {boolean} [active] - Whether the modal is open.
7
- * @property {() => void} [onClose] - Called when modal is closed.
8
- * @property {string} [className] - Additional CSS classes for the modal.
9
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for modal content.
10
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color for modal content.
11
- * @property {React.ReactNode} [modalCardTitle] - Title for modal card variant.
12
- * @property {React.ReactNode} [modalCardFoot] - Footer for modal card variant.
13
- * @property {'card'|'content'} [type] - Modal type ('card' for modal-card, 'content' for modal-content).
14
- * @property {React.ReactNode} [children] - Modal body/content.
15
- */
16
3
  export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color' | 'title'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
17
4
  active?: boolean;
18
5
  onClose?: () => void;
@@ -24,13 +11,5 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
24
11
  type?: 'card' | 'content';
25
12
  children?: React.ReactNode;
26
13
  }
27
- /**
28
- * Bulma Modal component, supporting both modal-card and modal-content variants.
29
- *
30
- * @function
31
- * @param {ModalProps} props - Props for the Modal component.
32
- * @returns {JSX.Element} The rendered modal.
33
- * @see {@link https://bulma.io/documentation/components/modal/ | Bulma Modal documentation}
34
- */
35
14
  export declare const Modal: React.FC<ModalProps>;
36
15
  export default Modal;
@@ -1,16 +1,5 @@
1
1
  import React from 'react';
2
2
  import { BulmaClassesProps, validColors } from '../helpers/useBulmaClasses';
3
- /**
4
- * Props for the Navbar component.
5
- *
6
- * @property {string} [className] - Additional CSS classes for the navbar.
7
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Color for text.
8
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'|'black'|'dark'|'light'|'white'} [color] - Bulma color modifier for the navbar.
9
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color for the navbar.
10
- * @property {boolean} [transparent] - Whether the navbar is transparent.
11
- * @property {'top'|'bottom'} [fixed] - Whether the navbar is fixed to the top or bottom.
12
- * @property {React.ReactNode} [children] - Navbar content.
13
- */
14
3
  export interface NavbarProps extends React.HTMLAttributes<HTMLElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
15
4
  className?: string;
16
5
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -20,14 +9,6 @@ export interface NavbarProps extends React.HTMLAttributes<HTMLElement>, Omit<Bul
20
9
  fixed?: 'top' | 'bottom';
21
10
  children?: React.ReactNode;
22
11
  }
23
- /**
24
- * Bulma Navbar component, supports subcomponents for structured navigation.
25
- *
26
- * @function
27
- * @param {NavbarProps} props - Props for the Navbar component.
28
- * @returns {JSX.Element} The rendered navbar.
29
- * @see {@link https://bulma.io/documentation/components/navbar/ | Bulma Navbar documentation}
30
- */
31
12
  export declare const Navbar: React.FC<NavbarProps> & {
32
13
  Brand: typeof NavbarBrand;
33
14
  Item: typeof NavbarItem;
@@ -39,38 +20,13 @@ export declare const Navbar: React.FC<NavbarProps> & {
39
20
  DropdownMenu: typeof NavbarDropdownMenu;
40
21
  Divider: typeof NavbarDivider;
41
22
  };
42
- /**
43
- * Props for the NavbarBrand component.
44
- *
45
- * @property {string} [className] - Additional CSS classes.
46
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for the brand.
47
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier for the brand.
48
- * @property {React.ReactNode} [children] - Brand content.
49
- */
50
23
  export interface NavbarBrandProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
51
24
  className?: string;
52
25
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
53
26
  color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
54
27
  children?: React.ReactNode;
55
28
  }
56
- /**
57
- * Bulma Navbar brand area (usually left side).
58
- *
59
- * @function
60
- * @param {NavbarBrandProps} props - Props for the NavbarBrand component.
61
- * @returns {JSX.Element} The rendered brand area.
62
- */
63
29
  export declare const NavbarBrand: React.FC<NavbarBrandProps>;
64
- /**
65
- * Props for the NavbarItem component.
66
- *
67
- * @property {string} [className] - Additional CSS classes.
68
- * @property {React.ElementType} [as] - Render as a custom component.
69
- * @property {boolean} [active] - Whether the item is active.
70
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for the item.
71
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [bgColor] - Background color for the item.
72
- * @property {React.ReactNode} [children] - Navbar item content.
73
- */
74
30
  export interface NavbarItemProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'color'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
75
31
  className?: string;
76
32
  as?: React.ElementType;
@@ -79,26 +35,7 @@ export interface NavbarItemProps extends Omit<React.AnchorHTMLAttributes<HTMLAnc
79
35
  bgColor?: (typeof validColors)[number] | 'inherit' | 'current';
80
36
  children?: React.ReactNode;
81
37
  }
82
- /**
83
- * Bulma Navbar item (link, button, etc).
84
- *
85
- * @function
86
- * @param {NavbarItemProps} props - Props for the NavbarItem component.
87
- * @returns {JSX.Element} The rendered item.
88
- */
89
38
  export declare const NavbarItem: React.FC<NavbarItemProps>;
90
- /**
91
- * Props for the NavbarBurger component.
92
- *
93
- * @property {string} [className] - Additional CSS classes.
94
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for the burger.
95
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier for the burger.
96
- * @property {boolean} [active] - Whether the burger is active.
97
- * @property {React.ReactNode} [children] - Custom content inside the burger.
98
- * @property {string} ['aria-label'] - Aria label for accessibility.
99
- * @property {boolean} ['aria-expanded'] - Aria expanded state.
100
- * @property {React.MouseEventHandler<HTMLButtonElement>} [onClick] - Click handler.
101
- */
102
39
  export interface NavbarBurgerProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
103
40
  className?: string;
104
41
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -109,23 +46,7 @@ export interface NavbarBurgerProps extends React.ButtonHTMLAttributes<HTMLButton
109
46
  'aria-expanded'?: boolean;
110
47
  onClick?: React.MouseEventHandler<HTMLButtonElement>;
111
48
  }
112
- /**
113
- * Bulma Navbar burger (responsive menu toggle).
114
- *
115
- * @function
116
- * @param {NavbarBurgerProps} props - Props for the NavbarBurger component.
117
- * @returns {JSX.Element} The rendered burger.
118
- */
119
49
  export declare const NavbarBurger: React.FC<NavbarBurgerProps>;
120
- /**
121
- * Props for the NavbarMenu component.
122
- *
123
- * @property {string} [className] - Additional CSS classes.
124
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color for the menu.
125
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier for the menu.
126
- * @property {boolean} [active] - Whether the menu is active.
127
- * @property {React.ReactNode} [children] - Menu content.
128
- */
129
50
  export interface NavbarMenuProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
130
51
  className?: string;
131
52
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
@@ -133,54 +54,15 @@ export interface NavbarMenuProps extends React.HTMLAttributes<HTMLDivElement>, O
133
54
  active?: boolean;
134
55
  children?: React.ReactNode;
135
56
  }
136
- /**
137
- * Bulma Navbar menu area (collapsible content).
138
- *
139
- * @function
140
- * @param {NavbarMenuProps} props - Props for the NavbarMenu component.
141
- * @returns {JSX.Element} The rendered menu.
142
- */
143
57
  export declare const NavbarMenu: React.FC<NavbarMenuProps>;
144
- /**
145
- * Props for the NavbarStartEnd component.
146
- *
147
- * @property {string} [className] - Additional CSS classes.
148
- * @property {(typeof validColors)[number] | 'inherit' | 'current'} [textColor] - Text color.
149
- * @property {'primary'|'link'|'info'|'success'|'warning'|'danger'} [color] - Bulma color modifier.
150
- * @property {React.ReactNode} [children] - Content.
151
- */
152
58
  export interface NavbarStartEndProps extends React.HTMLAttributes<HTMLDivElement>, Omit<BulmaClassesProps, 'color' | 'backgroundColor'> {
153
59
  className?: string;
154
60
  textColor?: (typeof validColors)[number] | 'inherit' | 'current';
155
61
  color?: 'primary' | 'link' | 'info' | 'success' | 'warning' | 'danger';
156
62
  children?: React.ReactNode;
157
63
  }
158
- /**
159
- * Bulma Navbar start area (left-aligned).
160
- *
161
- * @function
162
- * @param {NavbarStartEndProps} props - Props for the NavbarStart component.
163
- * @returns {JSX.Element} The rendered start area.
164
- */
165
64
  export declare const NavbarStart: React.FC<NavbarStartEndProps>;
166
- /**
167
- * Bulma Navbar end area (right-aligned).
168
- *
169
- * @function
170
- * @param {NavbarStartEndProps} props - Props for the NavbarEnd component.
171
- * @returns {JSX.Element} The rendered end area.
172
- */
173
65
  export declare const NavbarEnd: React.FC<NavbarStartEndProps>;
174
- /**
175
- * Props for the NavbarDropdown component.
176
- *
177
- * @property {string} [className] - Additional CSS classes.
178
- * @property {boolean} [right] - Dropdown aligned right.
179
- * @property {boolean} [up] - Dropdown opens upwards.
180
- * @property {boolean} [hoverable] - Dropdown opens on hover.
181
- * @property {boolean} [active] - Dropdown is open.
182
- * @property {React.ReactNode} [children] - Dropdown content.
183
- */
184
66
  export interface NavbarDropdownProps extends React.HTMLAttributes<HTMLDivElement> {
185
67
  className?: string;
186
68
  right?: boolean;
@@ -189,41 +71,13 @@ export interface NavbarDropdownProps extends React.HTMLAttributes<HTMLDivElement
189
71
  active?: boolean;
190
72
  children?: React.ReactNode;
191
73
  }
192
- /**
193
- * Bulma Navbar dropdown (for nested dropdown menus).
194
- *
195
- * @function
196
- * @param {NavbarDropdownProps} props - Props for the NavbarDropdown component.
197
- * @returns {JSX.Element} The rendered dropdown.
198
- */
199
74
  export declare const NavbarDropdown: React.FC<NavbarDropdownProps>;
200
- /**
201
- * Props for the NavbarDropdownMenu component.
202
- *
203
- * @property {string} [className] - Additional CSS classes.
204
- * @property {boolean} [right] - Dropdown aligned right.
205
- * @property {boolean} [up] - Dropdown opens upwards.
206
- * @property {React.ReactNode} [children] - Dropdown menu content.
207
- */
208
75
  export interface NavbarDropdownMenuProps extends React.HTMLAttributes<HTMLDivElement> {
209
76
  className?: string;
210
77
  right?: boolean;
211
78
  up?: boolean;
212
79
  children?: React.ReactNode;
213
80
  }
214
- /**
215
- * Bulma Navbar dropdown menu container.
216
- *
217
- * @function
218
- * @param {NavbarDropdownMenuProps} props - Props for the NavbarDropdownMenu component.
219
- * @returns {JSX.Element} The rendered dropdown menu.
220
- */
221
81
  export declare const NavbarDropdownMenu: React.FC<NavbarDropdownMenuProps>;
222
- /**
223
- * Bulma Navbar divider.
224
- *
225
- * @param props - Standard hr props.
226
- * @returns {JSX.Element} The rendered divider.
227
- */
228
82
  export declare const NavbarDivider: React.FC<React.HTMLAttributes<HTMLHRElement>>;
229
83
  export default Navbar;