@react-fabric/core 1.0.0-beta.51 → 1.0.0-beta.53

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 (248) hide show
  1. package/css/components/_breadcrumbs.css +3 -3
  2. package/css/components/_menu.css +2 -0
  3. package/css/components/_modal.css +2 -2
  4. package/css/core/_aside.css +2 -2
  5. package/css/theme/_utilities.css +2 -2
  6. package/dist/cjs/components/actionLabel/ActionLabel.js +23 -5
  7. package/dist/cjs/components/animations/Animations.js +92 -9
  8. package/dist/cjs/components/avatar/Avatar.js +33 -3
  9. package/dist/cjs/components/avatar/AvatarGroup.js +19 -1
  10. package/dist/cjs/components/badge/Badge.js +31 -2
  11. package/dist/cjs/components/breadcrumbs/Breadcrumbs.js +30 -1
  12. package/dist/cjs/components/button/Button.js +25 -2
  13. package/dist/cjs/components/button/ButtonGroup.js +26 -0
  14. package/dist/cjs/components/button/ConfirmButton.js +22 -1
  15. package/dist/cjs/components/button/ToggleButtonGroup.js +38 -12
  16. package/dist/cjs/components/callout/Callout.js +28 -0
  17. package/dist/cjs/components/card/Card.js +34 -0
  18. package/dist/cjs/components/card/CardCover.js +26 -0
  19. package/dist/cjs/components/card/FlipContent.js +21 -0
  20. package/dist/cjs/components/chip/Chip.js +22 -1
  21. package/dist/cjs/components/collapsable/Collapsable.js +26 -0
  22. package/dist/cjs/components/divider/Divider.js +19 -0
  23. package/dist/cjs/components/dropdown/Dropdown.js +42 -0
  24. package/dist/cjs/components/empty/EmptyContent.js +27 -0
  25. package/dist/cjs/components/icon/Icon.js +27 -1
  26. package/dist/cjs/components/media/Media.js +56 -0
  27. package/dist/cjs/components/menu/ContextMenu.js +19 -0
  28. package/dist/cjs/components/menu/Menu.js +30 -0
  29. package/dist/cjs/components/menu/MenuItem.js +22 -1
  30. package/dist/cjs/components/meter/Meter.js +24 -0
  31. package/dist/cjs/components/navigator/Navigator.js +22 -0
  32. package/dist/cjs/components/panel/Panel.js +37 -0
  33. package/dist/cjs/components/panel/PanelGroup.js +24 -0
  34. package/dist/cjs/components/panel/PanelStack.js +31 -0
  35. package/dist/cjs/components/progress/ProgressBar.js +21 -0
  36. package/dist/cjs/components/progress/ProgressCircle.js +20 -0
  37. package/dist/cjs/components/tabpanel/Tab.js +31 -0
  38. package/dist/cjs/components/tabpanel/TabPanel.js +33 -0
  39. package/dist/cjs/context/Global.js +25 -1
  40. package/dist/cjs/core/aside/Aside.js +39 -2
  41. package/dist/cjs/core/boundary/ErrorBoundary.js +17 -1
  42. package/dist/cjs/core/content/Content.js +6 -1
  43. package/dist/cjs/core/headfoot/HeadFoot.js +42 -0
  44. package/dist/cjs/core/page/Page.js +26 -1
  45. package/dist/cjs/core/responsive/Responsive.js +55 -2
  46. package/dist/cjs/core/section/Section.js +11 -27
  47. package/dist/cjs/core/theme/ThemeProvider.js +21 -1
  48. package/dist/cjs/core/viewport/Viewport.js +15 -1
  49. package/dist/cjs/hooks/useControlledValue.js +12 -0
  50. package/dist/cjs/hooks/useDebounce.js +13 -0
  51. package/dist/cjs/hooks/useEffectDebugger.js +52 -0
  52. package/dist/cjs/hooks/useIsDark.js +8 -0
  53. package/dist/cjs/hooks/useIsRtl.js +12 -0
  54. package/dist/cjs/hooks/useOverlayService.js +24 -0
  55. package/dist/cjs/hooks/usePropToggle.js +16 -5
  56. package/dist/cjs/hooks/useResize.js +18 -0
  57. package/dist/cjs/hooks/useResizeObserver.js +19 -0
  58. package/dist/cjs/hooks/useStorage.js +39 -0
  59. package/dist/cjs/types/icons.js +4 -0
  60. package/dist/cjs/typography/Abbr.js +28 -1
  61. package/dist/cjs/typography/Anchor.js +18 -1
  62. package/dist/cjs/typography/Mark.js +20 -1
  63. package/dist/cjs/typography/Text.js +27 -1
  64. package/dist/cjs/typography/Title.js +16 -1
  65. package/dist/esm/components/actionLabel/ActionLabel.js +23 -5
  66. package/dist/esm/components/animations/Animations.js +92 -9
  67. package/dist/esm/components/avatar/Avatar.js +33 -3
  68. package/dist/esm/components/avatar/AvatarGroup.js +19 -1
  69. package/dist/esm/components/badge/Badge.js +32 -3
  70. package/dist/esm/components/breadcrumbs/Breadcrumbs.js +30 -1
  71. package/dist/esm/components/button/Button.js +25 -2
  72. package/dist/esm/components/button/ButtonGroup.js +26 -0
  73. package/dist/esm/components/button/ConfirmButton.js +22 -1
  74. package/dist/esm/components/button/ToggleButtonGroup.js +39 -13
  75. package/dist/esm/components/callout/Callout.js +28 -0
  76. package/dist/esm/components/card/Card.js +34 -0
  77. package/dist/esm/components/card/CardCover.js +26 -0
  78. package/dist/esm/components/card/FlipContent.js +21 -0
  79. package/dist/esm/components/chip/Chip.js +22 -1
  80. package/dist/esm/components/collapsable/Collapsable.js +26 -0
  81. package/dist/esm/components/divider/Divider.js +19 -0
  82. package/dist/esm/components/dropdown/Dropdown.js +42 -0
  83. package/dist/esm/components/empty/EmptyContent.js +27 -0
  84. package/dist/esm/components/icon/Icon.js +27 -1
  85. package/dist/esm/components/media/Media.js +56 -0
  86. package/dist/esm/components/menu/ContextMenu.js +19 -0
  87. package/dist/esm/components/menu/Menu.js +30 -0
  88. package/dist/esm/components/menu/MenuItem.js +22 -1
  89. package/dist/esm/components/meter/Meter.js +24 -0
  90. package/dist/esm/components/navigator/Navigator.js +22 -0
  91. package/dist/esm/components/panel/Panel.js +37 -0
  92. package/dist/esm/components/panel/PanelGroup.js +24 -0
  93. package/dist/esm/components/panel/PanelStack.js +31 -0
  94. package/dist/esm/components/progress/ProgressBar.js +21 -0
  95. package/dist/esm/components/progress/ProgressCircle.js +20 -0
  96. package/dist/esm/components/tabpanel/Tab.js +31 -0
  97. package/dist/esm/components/tabpanel/TabPanel.js +33 -0
  98. package/dist/esm/context/Global.js +25 -1
  99. package/dist/esm/core/aside/Aside.js +39 -2
  100. package/dist/esm/core/boundary/ErrorBoundary.js +17 -1
  101. package/dist/esm/core/content/Content.js +6 -1
  102. package/dist/esm/core/headfoot/HeadFoot.js +42 -0
  103. package/dist/esm/core/page/Page.js +26 -1
  104. package/dist/esm/core/responsive/Responsive.js +55 -2
  105. package/dist/esm/core/section/Section.js +11 -27
  106. package/dist/esm/core/theme/ThemeProvider.js +21 -1
  107. package/dist/esm/core/viewport/Viewport.js +15 -1
  108. package/dist/esm/hooks/useControlledValue.js +12 -0
  109. package/dist/esm/hooks/useDebounce.js +13 -0
  110. package/dist/esm/hooks/useEffectDebugger.js +52 -0
  111. package/dist/esm/hooks/useIsDark.js +8 -0
  112. package/dist/esm/hooks/useIsRtl.js +12 -0
  113. package/dist/esm/hooks/useOverlayService.js +24 -0
  114. package/dist/esm/hooks/usePropToggle.js +16 -5
  115. package/dist/esm/hooks/useResize.js +18 -0
  116. package/dist/esm/hooks/useResizeObserver.js +19 -0
  117. package/dist/esm/hooks/useStorage.js +39 -0
  118. package/dist/esm/types/icons.js +4 -0
  119. package/dist/esm/typography/Abbr.js +28 -1
  120. package/dist/esm/typography/Anchor.js +18 -1
  121. package/dist/esm/typography/Mark.js +20 -1
  122. package/dist/esm/typography/Text.js +27 -1
  123. package/dist/esm/typography/Title.js +16 -1
  124. package/dist/types/components/actionLabel/ActionLabel.d.ts +21 -2
  125. package/dist/types/components/animations/Animations.d.ts +80 -1
  126. package/dist/types/components/avatar/Avatar.d.ts +26 -2
  127. package/dist/types/components/avatar/AvatarGroup.d.ts +19 -1
  128. package/dist/types/components/badge/Badge.d.ts +25 -0
  129. package/dist/types/components/breadcrumbs/Breadcrumbs.d.ts +29 -0
  130. package/dist/types/components/button/Button.d.ts +23 -2
  131. package/dist/types/components/button/ButtonGroup.d.ts +26 -1
  132. package/dist/types/components/button/ConfirmButton.d.ts +23 -3
  133. package/dist/types/components/button/ToggleButtonGroup.d.ts +39 -11
  134. package/dist/types/components/callout/Callout.d.ts +26 -1
  135. package/dist/types/components/card/Card.d.ts +34 -0
  136. package/dist/types/components/card/CardCover.d.ts +25 -0
  137. package/dist/types/components/card/FlipContent.d.ts +21 -0
  138. package/dist/types/components/chip/Chip.d.ts +21 -1
  139. package/dist/types/components/collapsable/Collapsable.d.ts +26 -0
  140. package/dist/types/components/divider/Divider.d.ts +19 -0
  141. package/dist/types/components/dropdown/Dropdown.d.ts +40 -1
  142. package/dist/types/components/dropdown/DropdownTool.d.ts +25 -0
  143. package/dist/types/components/empty/EmptyContent.d.ts +26 -1
  144. package/dist/types/components/icon/Icon.d.ts +27 -2
  145. package/dist/types/components/media/Media.d.ts +54 -0
  146. package/dist/types/components/menu/ContextMenu.d.ts +19 -1
  147. package/dist/types/components/menu/Menu.d.ts +29 -0
  148. package/dist/types/components/menu/MenuItem.d.ts +22 -2
  149. package/dist/types/components/meter/Meter.d.ts +24 -0
  150. package/dist/types/components/navigator/Navigator.d.ts +22 -0
  151. package/dist/types/components/panel/Panel.d.ts +37 -0
  152. package/dist/types/components/panel/PanelGroup.d.ts +24 -0
  153. package/dist/types/components/panel/PanelStack.d.ts +31 -0
  154. package/dist/types/components/progress/ProgressBar.d.ts +20 -0
  155. package/dist/types/components/progress/ProgressCircle.d.ts +19 -0
  156. package/dist/types/components/tabpanel/Tab.d.ts +32 -1
  157. package/dist/types/components/tabpanel/TabPanel.d.ts +33 -0
  158. package/dist/types/context/Global.d.ts +24 -1
  159. package/dist/types/core/aside/Aside.d.ts +38 -1
  160. package/dist/types/core/boundary/ErrorBoundary.d.ts +17 -1
  161. package/dist/types/core/content/Content.d.ts +6 -1
  162. package/dist/types/core/headfoot/HeadFoot.d.ts +40 -0
  163. package/dist/types/core/page/Page.d.ts +26 -1
  164. package/dist/types/core/responsive/Responsive.d.ts +52 -1
  165. package/dist/types/core/section/Section.d.ts +18 -3
  166. package/dist/types/core/theme/ThemeProvider.d.ts +21 -1
  167. package/dist/types/core/viewport/Viewport.d.ts +15 -1
  168. package/dist/types/hooks/useControlledValue.d.ts +13 -2
  169. package/dist/types/hooks/useDebounce.d.ts +12 -0
  170. package/dist/types/hooks/useEffectDebugger.d.ts +49 -0
  171. package/dist/types/hooks/useIsDark.d.ts +8 -0
  172. package/dist/types/hooks/useIsRtl.d.ts +12 -0
  173. package/dist/types/hooks/useNavigator.d.ts +18 -1
  174. package/dist/types/hooks/useOverlayService.d.ts +25 -4
  175. package/dist/types/hooks/usePropToggle.d.ts +16 -5
  176. package/dist/types/hooks/useResize.d.ts +18 -0
  177. package/dist/types/hooks/useResizeObserver.d.ts +19 -0
  178. package/dist/types/hooks/useStorage.d.ts +38 -0
  179. package/dist/types/types/icons.d.ts +4 -0
  180. package/dist/types/typography/Abbr.d.ts +28 -1
  181. package/dist/types/typography/Anchor.d.ts +19 -2
  182. package/dist/types/typography/Copy.d.ts +15 -0
  183. package/dist/types/typography/Mark.d.ts +20 -1
  184. package/dist/types/typography/Text.d.ts +27 -1
  185. package/dist/types/typography/Title.d.ts +16 -1
  186. package/package.json +3 -3
  187. package/src/components/actionLabel/ActionLabel.tsx +23 -5
  188. package/src/components/animations/Animations.tsx +93 -14
  189. package/src/components/avatar/Avatar.tsx +32 -3
  190. package/src/components/avatar/AvatarGroup.tsx +19 -1
  191. package/src/components/badge/Badge.tsx +33 -3
  192. package/src/components/breadcrumbs/Breadcrumbs.tsx +30 -1
  193. package/src/components/button/Button.tsx +24 -2
  194. package/src/components/button/ButtonGroup.tsx +26 -0
  195. package/src/components/button/ConfirmButton.tsx +22 -1
  196. package/src/components/button/ToggleButtonGroup.tsx +70 -43
  197. package/src/components/callout/Callout.tsx +27 -0
  198. package/src/components/card/Card.tsx +34 -0
  199. package/src/components/card/CardCover.tsx +25 -0
  200. package/src/components/card/FlipContent.tsx +21 -0
  201. package/src/components/chip/Chip.tsx +21 -1
  202. package/src/components/collapsable/Collapsable.tsx +26 -0
  203. package/src/components/divider/Divider.tsx +19 -0
  204. package/src/components/dropdown/Dropdown.tsx +40 -0
  205. package/src/components/dropdown/DropdownTool.tsx +25 -0
  206. package/src/components/empty/EmptyContent.tsx +26 -0
  207. package/src/components/icon/Icon.tsx +27 -1
  208. package/src/components/media/Media.tsx +54 -0
  209. package/src/components/menu/ContextMenu.tsx +19 -0
  210. package/src/components/menu/Menu.tsx +29 -0
  211. package/src/components/menu/MenuItem.tsx +22 -1
  212. package/src/components/meter/Meter.tsx +24 -0
  213. package/src/components/navigator/Navigator.tsx +22 -0
  214. package/src/components/panel/Panel.tsx +37 -0
  215. package/src/components/panel/PanelGroup.tsx +24 -0
  216. package/src/components/panel/PanelStack.tsx +31 -0
  217. package/src/components/progress/ProgressBar.tsx +20 -0
  218. package/src/components/progress/ProgressCircle.tsx +19 -0
  219. package/src/components/tabpanel/Tab.tsx +31 -0
  220. package/src/components/tabpanel/TabPanel.tsx +33 -0
  221. package/src/context/Global.tsx +24 -1
  222. package/src/core/aside/Aside.tsx +39 -2
  223. package/src/core/boundary/ErrorBoundary.tsx +17 -1
  224. package/src/core/content/Content.tsx +6 -1
  225. package/src/core/headfoot/HeadFoot.tsx +40 -0
  226. package/src/core/page/Page.tsx +26 -1
  227. package/src/core/responsive/Responsive.tsx +53 -2
  228. package/src/core/section/Section.tsx +25 -2
  229. package/src/core/theme/ThemeProvider.tsx +21 -1
  230. package/src/core/viewport/Viewport.tsx +15 -1
  231. package/src/hooks/useControlledValue.tsx +12 -0
  232. package/src/hooks/useDebounce.ts +12 -0
  233. package/src/hooks/useEffectDebugger.ts +49 -0
  234. package/src/hooks/useIsDark.ts +8 -0
  235. package/src/hooks/useIsRtl.ts +12 -0
  236. package/src/hooks/useNavigator.tsx +18 -0
  237. package/src/hooks/useOverlayService.tsx +24 -0
  238. package/src/hooks/usePropToggle.ts +16 -5
  239. package/src/hooks/useResize.ts +18 -0
  240. package/src/hooks/useResizeObserver.ts +19 -0
  241. package/src/hooks/useStorage.ts +38 -0
  242. package/src/types/icons.ts +5 -1
  243. package/src/typography/Abbr.tsx +28 -1
  244. package/src/typography/Anchor.tsx +18 -1
  245. package/src/typography/Copy.tsx +15 -0
  246. package/src/typography/Mark.tsx +20 -1
  247. package/src/typography/Text.tsx +27 -1
  248. package/src/typography/Title.tsx +16 -1
@@ -88,7 +88,32 @@ const SizeMap: KeyValue<string> = {
88
88
  };
89
89
 
90
90
  /**
91
- * An avatar is a graphical representation of a user's identity.
91
+ * A component that displays an avatar image or a fallback icon with customizable styles and properties.
92
+ * It supports various avatar types, including text-based avatars, and allows for customization of background color, icon color, size, and rounded corners.
93
+ * This component is useful for displaying user avatars in applications, providing a visual representation of users or entities.
94
+ * It can also handle cases where the avatar image fails to load by displaying a fallback icon or text.
95
+ * It uses the Boring Avatars library for generating fallback avatars based on the user's name.
96
+ *
97
+ * @param {AvatarProps} props - The properties for the Avatar component.
98
+ * @returns {JSX.Element} The rendered Avatar component.
99
+ *
100
+ * @example
101
+ * ```jsx
102
+ * <Avatar
103
+ * name="John Doe"
104
+ * avatar="https://example.com/avatar.jpg"
105
+ * fallbackIcon="fas fa-user"
106
+ * bg="bg-blue-500"
107
+ * color="text-white"
108
+ * size="md"
109
+ * rounded
110
+ * variant="beam"
111
+ * onClick={() => console.log("Avatar clicked")}
112
+ * />
113
+ * ```
114
+ *
115
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-avatar--docs} for more details.
116
+ * @see {@link https://boringavatars.com/} for more information on Boring Avatars.
92
117
  */
93
118
  export const Avatar = ({
94
119
  ref,
@@ -107,7 +132,8 @@ export const Avatar = ({
107
132
  }: AvatarProps) => {
108
133
  const [fallback, setFallback] = useState(true);
109
134
 
110
- /** ***************** style map *******************/
135
+ // Memoize styles to avoid unnecessary recalculations
136
+ // and to ensure styles are only recalculated when dependencies change
111
137
  const styles = useMemo(() => {
112
138
  const s: KeyValue = {};
113
139
  if (bg) {
@@ -125,7 +151,8 @@ export const Avatar = ({
125
151
  return s;
126
152
  }, [bg, color, size]);
127
153
 
128
- /** ***************** render icon *******************/
154
+ // avatar image
155
+ // if avatar is not provided, fallback to icon or text
129
156
  const avatarImage = useMemo(() => {
130
157
  setFallback(!avatar);
131
158
  return (
@@ -149,6 +176,7 @@ export const Avatar = ({
149
176
  );
150
177
  }, [avatar]);
151
178
 
179
+ // render fallback icon or text
152
180
  const fallbackAvatar = useMemo(() => {
153
181
  if (fallbackIcon) {
154
182
  return isSvgPath(fallbackIcon) ? (
@@ -178,6 +206,7 @@ export const Avatar = ({
178
206
  </svg>
179
207
  );
180
208
  }
209
+ // Fallback to BoringAvatar
181
210
  return <BoringAvatar square size={64} variant={variant} name={name} />;
182
211
  }, [name, variant, fallbackIcon]);
183
212
 
@@ -62,7 +62,25 @@ const SizeMap: KeyValue<string> = {
62
62
  };
63
63
 
64
64
  /**
65
- * Group multiple avatars together
65
+ * A component that groups multiple avatars together, displaying a count of additional avatars if the total exceeds the visible ones.
66
+ * It allows customization of size, rounding, and additional aria attributes.
67
+ * This component is useful for displaying a collection of user avatars in a compact format, such as in a chat application or user list.
68
+ * It automatically calculates the number of additional avatars based on the `totalCount` prop and the number of children provided.
69
+ *
70
+ * @param {AvatarGroupProps} props - The properties for the AvatarGroup component.
71
+ * @returns {JSX.Element} The rendered AvatarGroup component.
72
+ *
73
+ * @example
74
+ * ```jsx
75
+ * <AvatarGroup totalCount={5} size="md" className="my-avatar-group">
76
+ * <Avatar name="John Doe" avatar="https://example.com/avatar1.jpg" />
77
+ * <Avatar name="Jane Smith" avatar="https://example.com/avatar2.jpg" />
78
+ * <Avatar name="Alice Johnson" avatar="https://example.com/avatar3.jpg" />
79
+ * <Avatar name="Bob Brown" avatar="https://example.com/avatar4.jpg" />
80
+ * </AvatarGroup>
81
+ * ```
82
+ *
83
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-avatar--docs} for more details.
66
84
  */
67
85
  export const AvatarGroup = ({
68
86
  ref,
@@ -23,7 +23,7 @@
23
23
 
24
24
  import { isNil, isNumber, isObject, mergeRefs } from "@react-fabric/utilities";
25
25
  import classNames from "classnames";
26
- import { cloneElement, useMemo } from "react";
26
+ import { cloneElement, isValidElement, useMemo } from "react";
27
27
  import {
28
28
  type BadgeType,
29
29
  type ChildProp,
@@ -72,10 +72,17 @@ export interface BadgeProps
72
72
  | "end";
73
73
  }
74
74
 
75
+ /**
76
+ * Utility function to get badge properties from a badge value or object.
77
+ * It checks if the badge is an object and returns its properties,
78
+ *
79
+ * @param {string | number | BadgeType} badge - The badge value or object.
80
+ * @returns {AnyObject} An object containing badge properties.
81
+ */
75
82
  export const getBadgeProps = (
76
83
  badge?: string | number | BadgeType,
77
84
  ): AnyObject => {
78
- if (isObject(badge)) {
85
+ if (isObject(badge) && !isValidElement(badge)) {
79
86
  return Object.assign({ forButton: true, placement: "" }, badge);
80
87
  } else {
81
88
  return {
@@ -86,6 +93,24 @@ export const getBadgeProps = (
86
93
  }
87
94
  };
88
95
 
96
+ /**
97
+ * A component that displays a badge with a value, icon, and optional ping animation.
98
+ * It can be used to indicate notifications, messages, or other important information.
99
+ * It supports various placements, inline or block display, and custom styling.
100
+ * It can also wrap children elements, allowing for flexible usage in buttons or other components.
101
+ *
102
+ * @param {BadgeProps} props - The properties for the Badge component.
103
+ * @returns {JSX.Element} The rendered Badge component.
104
+ *
105
+ * @example
106
+ * ```jsx
107
+ * <Badge value={5} max={10} ping>
108
+ * <button>Notifications</button>
109
+ * </Badge>
110
+ * ```
111
+ *
112
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-badge--docs} for more details.
113
+ */
89
114
  export const Badge = ({
90
115
  ref,
91
116
  className,
@@ -105,6 +130,9 @@ export const Badge = ({
105
130
  ...rest
106
131
  }: BadgeProps) => {
107
132
  const label = useMemo(() => {
133
+ if (isValidElement(value)) {
134
+ return value;
135
+ }
108
136
  if (!isNil(value)) {
109
137
  if (isNumber(value) && max && value > max) {
110
138
  return `${max}+`;
@@ -142,7 +170,9 @@ export const Badge = ({
142
170
  "fabric-badge",
143
171
  className,
144
172
  "inline-block p-px min-w-2 min-h-2 text-center select-none rounded-full leading-none z-2 pointer-events-none",
145
- (forButton && !placement) || inline ? "relative" : "absolute",
173
+ (forButton && !placement) || inline
174
+ ? "relative flex-content"
175
+ : "absolute",
146
176
  )}
147
177
  >
148
178
  {label && <span className="p-1">{label}</span>}
@@ -45,6 +45,35 @@ export interface BreadcrumbProps
45
45
  color?: "primary" | "accent";
46
46
  }
47
47
 
48
+ /**
49
+ * A navigation component that displays the current page's location within a hierarchy and allows users to navigate back to previous pages.
50
+ * It supports different styles, separators, and colors, and can handle a variable number of breadcrumb links.
51
+ * This component is useful for enhancing user navigation experience in applications with multiple levels of content hierarchy.
52
+ * It automatically manages the display of overflow items when there are too many links to fit in the available space, providing a dropdown for additional links.
53
+ *
54
+ * @param {BreadcrumbProps} props - The properties for the Breadcrumbs component.
55
+ * @returns {JSX.Element} The rendered Breadcrumbs component.
56
+ *
57
+ * @example
58
+ * ```jsx
59
+ * <Breadcrumbs
60
+ * variant="classic"
61
+ * separator=">"
62
+ * color="primary"
63
+ * className="my-custom-class"
64
+ * aria-label="Breadcrumbs"
65
+ * >
66
+ * <Anchor href="/">Home</Anchor>
67
+ * <Anchor href="/products">Products</Anchor>
68
+ * <Anchor href="/products/shoes">Shoes</Anchor>
69
+ * <Anchor href="/products/shoes/sneakers">Sneakers</Anchor>
70
+ * <Anchor href="/products/shoes/sneakers/nike">Nike</Anchor>
71
+ * <Anchor href="/products/shoes/sneakers/nike/airmax">Air Max</Anchor>
72
+ * </Breadcrumbs>
73
+ * ```
74
+ *
75
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-breadcrumbs--docs} for more details.
76
+ */
48
77
  export const Breadcrumbs = ({
49
78
  variant = "classic",
50
79
  className,
@@ -54,7 +83,7 @@ export const Breadcrumbs = ({
54
83
  ...aria
55
84
  }: BreadcrumbProps) => {
56
85
  const [start, overflow, end] = useMemo(() => {
57
- const nodeList = Children.toArray(children as AnyObject);
86
+ const nodeList = Children.toArray(children as AnyObject).filter(Boolean);
58
87
  if (nodeList.length > 7) {
59
88
  return [nodeList.slice(0, 3), nodeList.slice(3, -3), nodeList.slice(-3)];
60
89
  }
@@ -156,7 +156,28 @@ export type ButtonProps<Tag extends React.ElementType = "button"> = BaseProps &
156
156
  PolymorphicProps<Tag>;
157
157
 
158
158
  /**
159
- * Clickable action button
159
+ * A versatile button component that supports various styles, icons, and actions.
160
+ * It can be used as a primary action button, with options for loading states, action messages, and more.
161
+ * It supports polymorphic rendering, allowing it to be used as different HTML elements (e.g., button, a, div).
162
+ * It also includes features like after action tooltips, badges, and keyboard shortcuts.
163
+ *
164
+ * @param {ButtonProps} props - The properties for the Button component.
165
+ * @returns {JSX.Element} The rendered Button component.
166
+ *
167
+ * @example
168
+ * ```jsx
169
+ * <Button
170
+ * color="primary"
171
+ * size="md"
172
+ * variant="solid"
173
+ * icon="check"
174
+ * onClick={() => console.log("Button clicked!")}
175
+ * >
176
+ * Click Me
177
+ * </Button>
178
+ * ```
179
+ *
180
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-button--docs} for more details.
160
181
  */
161
182
  export const Button = <Tag extends React.ElementType = "button">({
162
183
  as,
@@ -195,6 +216,7 @@ export const Button = <Tag extends React.ElementType = "button">({
195
216
  const [busy, setBusy] = useState(false);
196
217
  const [actionDone, setActionDone] = useState(false);
197
218
 
219
+ // Handle click events
198
220
  const clickHandler = useCallback(
199
221
  (e: React.MouseEvent) => {
200
222
  setBusy(true);
@@ -307,7 +329,7 @@ export const Button = <Tag extends React.ElementType = "button">({
307
329
  </label>
308
330
  )}
309
331
  {!isNil(badge) && <Badge {...badgeProps} />}
310
- {hotKey && <HotKeyLabel keyCombo={hotKey} />}
332
+ {hotKey && children && <HotKeyLabel keyCombo={hotKey} />}
311
333
  {altIcon && (
312
334
  <Icon className={"fabric-altIcon"} icon={altIcon} rtlFlip />
313
335
  )}
@@ -71,6 +71,32 @@ export interface ButtonGroupProps
71
71
  fullWidth?: boolean;
72
72
  }
73
73
 
74
+ /**
75
+ * A component that groups buttons together, allowing for consistent styling and behavior across multiple buttons.
76
+ * It supports vertical orientation, various button styles, and can handle properties like size, color, and disabled state.
77
+ * This component is useful for creating button groups that maintain a uniform appearance and functionality,
78
+ * such as toolbars, action groups, or navigation buttons.
79
+ *
80
+ * @param {ButtonGroupProps} props - The properties for the ButtonGroup component.
81
+ * @returns {JSX.Element} The rendered ButtonGroup component.
82
+ *
83
+ * @example
84
+ * ```jsx
85
+ * <ButtonGroup
86
+ * variant="solid"
87
+ * color="primary"
88
+ * className="my-custom-class"
89
+ * aria-label="Button Group"
90
+ * vertical
91
+ * >
92
+ * <Button>Button 1</Button>
93
+ * <Button>Button 2</Button>
94
+ * <Button>Button 3</Button>
95
+ * </ButtonGroup>
96
+ * ```
97
+ *
98
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-buttongroup--docs} for more details.
99
+ */
74
100
  export const ButtonGroup = ({
75
101
  vertical,
76
102
  className,
@@ -80,7 +80,28 @@ interface ExtendedProps extends Omit<BaseProps, "onClick">, RefProp {
80
80
  export type ConfirmButtonProps = ExtendedProps & ButtonProps;
81
81
 
82
82
  /**
83
- * Button with confirmation dropdown
83
+ * A button that shows a confirmation dialog when clicked, allowing the user to confirm or cancel an action.
84
+ * It supports custom messages, labels, and loading states.
85
+ * This component is useful for actions that require user confirmation, such as deleting items or submitting forms.
86
+ * It uses the Floating UI library to manage the positioning of the confirmation dialog, ensuring it appears correctly relative to the button.
87
+ * It also supports custom placement of the dialog, and can display an action message when the action is completed.
88
+ *
89
+ * @param {ConfirmButtonProps} props - The properties for the ConfirmButton component.
90
+ * @returns {JSX.Element} The rendered ConfirmButton component.
91
+ *
92
+ * @example
93
+ * ```jsx
94
+ * <ConfirmButton
95
+ * message="Are you sure you want to delete this item?"
96
+ * onClick={(confirmed) => {
97
+ * if (confirmed) {
98
+ * // Perform action
99
+ * }
100
+ * }}
101
+ * />
102
+ * ```
103
+ *
104
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-confirmbutton--docs} for more details.
84
105
  */
85
106
  export const ConfirmButton = <Tag extends React.ElementType = "button">({
86
107
  ref,
@@ -23,7 +23,7 @@
23
23
 
24
24
  import { EMPTY_ARRAY, isArray } from "@react-fabric/utilities";
25
25
  import classNames from "classnames";
26
- import { cloneElement, useCallback, useMemo } from "react";
26
+ import { cloneElement, useCallback } from "react";
27
27
  import { useControlledValue } from "../../hooks/useControlledValue";
28
28
  import {
29
29
  type AriaProps,
@@ -35,10 +35,7 @@ import {
35
35
  import { cloneChildren } from "../../utils";
36
36
  import { type ButtonProps } from "./Button";
37
37
 
38
- interface BaseProps
39
- extends CssProp,
40
- AriaProps,
41
- ChildrenProp<React.ReactElement<ButtonProps & { value: string }>> {
38
+ interface BaseProps extends CssProp, AriaProps {
42
39
  /**
43
40
  * vertical orientation
44
41
  */
@@ -69,31 +66,61 @@ interface BaseProps
69
66
  fullWidth?: boolean;
70
67
  }
71
68
 
72
- export type ToggleButtonGroupProps = BaseProps &
73
- (
74
- | {
75
- /**
76
- *
77
- */
78
- value: string;
79
- /**
80
- * change handler
81
- */
82
- onChange?: (value: string) => void;
83
- }
84
- | {
85
- /**
86
- *
87
- */
88
- value: string[];
89
- /**
90
- * change handler
91
- */
92
- onChange?: (value: string[]) => void;
93
- }
94
- );
69
+ export type ToggleButtonGroupValueProps<T> =
70
+ | {
71
+ /**
72
+ *
73
+ */
74
+ value: T;
75
+ /**
76
+ * change handler
77
+ */
78
+ onChange?: (value: T | null) => void;
79
+ }
80
+ | {
81
+ /**
82
+ *
83
+ */
84
+ value: T[];
85
+ /**
86
+ * change handler
87
+ */
88
+ onChange?: (value: T[] | null) => void;
89
+ };
90
+
91
+ export type ToggleButtonGroupProps<T> = BaseProps &
92
+ ChildrenProp<React.ReactElement<ButtonProps & { value: T }>> &
93
+ ToggleButtonGroupValueProps<T>;
95
94
 
96
- export const ToggleButtonGroup = ({
95
+ /**
96
+ * A component that groups toggle buttons together, allowing for consistent styling and behavior across multiple toggle buttons.
97
+ * It supports vertical orientation, various button styles, and can handle properties like size, color, and disabled state.
98
+ * This component is useful for creating toggle button groups that maintain a uniform appearance and functionality,
99
+ * such as toggle switches, selection groups, or multi-select options.
100
+ *
101
+ * @param {ToggleButtonGroupProps} props - The properties for the ToggleButtonGroup component.
102
+ * @returns {JSX.Element} The rendered ToggleButtonGroup component.
103
+ *
104
+ * @example
105
+ * ```jsx
106
+ * <ToggleButtonGroup
107
+ * value={selectedValues}
108
+ * onChange={(newValues) => setSelectedValues(newValues)}
109
+ * variant="outline"
110
+ * color="primary"
111
+ * size="md"
112
+ * rounded
113
+ * fullWidth
114
+ * >
115
+ * <Button value="option1">Option 1</Button>
116
+ * <Button value="option2">Option 2</Button>
117
+ * <Button value="option3">Option 3</Button>
118
+ * </ToggleButtonGroup>
119
+ * ```
120
+ *
121
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-togglebuttongroup--docs} for more details.
122
+ */
123
+ export const ToggleButtonGroup = <T extends AnyObject = string>({
97
124
  vertical,
98
125
  className,
99
126
  children,
@@ -106,23 +133,24 @@ export const ToggleButtonGroup = ({
106
133
  value,
107
134
  onChange,
108
135
  ...aria
109
- }: ToggleButtonGroupProps) => {
110
- const isMultiple = useMemo(() => isArray(value), [value]);
111
- const { currentValue, updateValue } = useControlledValue<typeof value>(
136
+ }: ToggleButtonGroupProps<T>) => {
137
+ const { currentValue, updateValue } = useControlledValue(
112
138
  value,
113
- isArray(value) ? EMPTY_ARRAY : "",
139
+ isArray(value) ? EMPTY_ARRAY : null,
114
140
  );
115
141
 
116
142
  const clickHandler = useCallback(
117
- (cb: AnyObject) => (e: React.MouseEvent<HTMLElement>) => {
118
- let newValue: AnyObject = `${e.currentTarget.dataset.value}`;
143
+ (cb: AnyObject, childValue: T) => (e: React.MouseEvent<HTMLElement>) => {
144
+ let newValue;
119
145
  if (isArray(currentValue)) {
120
- if (currentValue.includes(newValue))
121
- newValue = currentValue.filter((v) => v !== newValue);
122
- else newValue = [...currentValue, newValue];
146
+ if (currentValue.includes(childValue))
147
+ newValue = currentValue.filter((v) => v !== childValue);
148
+ else newValue = [...currentValue, childValue];
149
+ } else {
150
+ newValue = childValue;
123
151
  }
124
152
  updateValue(newValue);
125
- onChange?.(newValue);
153
+ onChange?.(newValue as AnyObject);
126
154
  cb?.(e);
127
155
  },
128
156
  [currentValue, onChange],
@@ -149,10 +177,9 @@ export const ToggleButtonGroup = ({
149
177
  rounded,
150
178
  fullWidth,
151
179
  ...child.props,
152
- onClick: clickHandler(child.props.onClick),
153
- "data-value": child.props.value,
154
- "data-checked": isMultiple
155
- ? currentValue.includes(child.props.value)
180
+ onClick: clickHandler(child.props.onClick, child.props.value),
181
+ "data-checked": isArray(currentValue)
182
+ ? currentValue?.includes(child.props.value)
156
183
  : currentValue === child.props.value,
157
184
  }),
158
185
  )}
@@ -63,6 +63,7 @@ export interface CalloutProps
63
63
  onClose?: () => void;
64
64
  }
65
65
 
66
+ // colors for different callout types
66
67
  const colors = {
67
68
  none: "bg-base text-tint-900 border-tint-100",
68
69
  tint: "bg-tint-50/50 text-tint-800 border-tint-300",
@@ -74,6 +75,32 @@ const colors = {
74
75
  warning: "bg-warning-50/50 text-warning-800 border-warning-300",
75
76
  };
76
77
 
78
+ /**
79
+ * A component that displays a callout box with an optional title, icon, and legend.
80
+ * It can be used to highlight important information, warnings, or notices.
81
+ * The callout can be styled with different colors and border styles, and it supports a close action.
82
+ * This component is useful for drawing attention to specific content within a page or application,
83
+ * such as alerts, notifications, or important messages.
84
+ *
85
+ * @param {CalloutProps} props - The properties for the Callout component.
86
+ * @returns {JSX.Element} The rendered Callout component.
87
+ *
88
+ * @example
89
+ * ```jsx
90
+ * <Callout
91
+ * color="primary"
92
+ * legend="Important Notice"
93
+ * title="Attention Required"
94
+ * icon="info"
95
+ * onClose={() => console.log("Callout closed")}
96
+ * >
97
+ * This is an important message that requires your attention.
98
+ * </Callout>
99
+ * // Renders a callout box with a primary color, an icon, a title, and a close button.
100
+ * ```
101
+ *
102
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-callout--docs} for more details.
103
+ */
77
104
  export const Callout = ({
78
105
  children,
79
106
  // @ts-expect-error ignore
@@ -93,6 +93,40 @@ export interface CardProps
93
93
  dragData?: KeyValue;
94
94
  }
95
95
 
96
+ /**
97
+ * A component that displays a card with a header, body, and footer. It can be used to display content in a structured format.
98
+ * It supports various features such as click handling, drag-and-drop functionality, and customizable styles.
99
+ * The Card component is designed to be flexible and can be used in various contexts, such as displaying user profiles, product information, or any other content that benefits from a card layout.
100
+ * The component accepts children that can include a Header, body content, and a Footer.
101
+ * It also supports additional properties for styling, accessibility, and interaction.
102
+ * It can be styled with custom CSS classes and supports features like selection indication and drag-and-drop functionality.
103
+ *
104
+ * @param {CardProps} props - The properties for the Card component.
105
+ * @returns {JSX.Element} The rendered Card component.
106
+ *
107
+ * @example
108
+ * ```jsx
109
+ * <Card
110
+ * className="my-custom-class"
111
+ * bodyClassName="my-body-class"
112
+ * selected={true}
113
+ * selectedRibbon={true}
114
+ * onClick={() => console.log("Card clicked")}
115
+ * onDragStart={(event, key, data) => console.log("Drag started", key, data)}
116
+ * flex={true}
117
+ * draggable={true}
118
+ * dragKey="my-drag-key"
119
+ * dragData={{ id: 1, name: "Card Data" }}
120
+ * aria-label="My Card"
121
+ * >
122
+ * <Header>Card Header</Header>
123
+ * <div>Card Body Content</div>
124
+ * <Footer>Card Footer</Footer>
125
+ * </Card>
126
+ * ```
127
+ *
128
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-card--docs} for more details.
129
+ */
96
130
  export const Card = ({
97
131
  children,
98
132
  className,
@@ -48,6 +48,31 @@ const scheme = {
48
48
  dark: "dark",
49
49
  };
50
50
 
51
+ /**
52
+ * A cover component for cards that can contain media and content.
53
+ * It allows for flexible layout options and supports different color schemes.
54
+ * It can be used to create visually appealing card layouts with media content.
55
+ *
56
+ * @param {CardCoverProps} props - The properties for the CardCover component.
57
+ * @returns {JSX.Element} The rendered CardCover component.
58
+ *
59
+ * @example
60
+ * ```jsx
61
+ * <CardCover
62
+ * height={200}
63
+ * colorScheme="light"
64
+ * justify="center"
65
+ * className="my-custom-class"
66
+ * aria-label="Card Cover"
67
+ * >
68
+ * <Image src="image.jpg" alt="Card Image" />
69
+ * <div>Card Content</div>
70
+ * </CardCover>
71
+ * // Renders a card cover with a height of 200px, light color scheme, centered content, and a custom class name.
72
+ * ```
73
+ *
74
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-card--docs} for more details.
75
+ */
51
76
  export const CardCover = ({
52
77
  className,
53
78
  children,
@@ -39,6 +39,27 @@ export interface Props extends ChildrenProp, RefProp<FlipContentRef> {
39
39
  //
40
40
  }
41
41
 
42
+ /**
43
+ * A component that allows flipping between front and back content.
44
+ * It uses a ref to control the flipping action, which toggles the visibility of the front and back content.
45
+ * The component accepts children elements, which should be valid React elements representing the front and back content.
46
+ * The front content is expected to be the first child, and the back content is expected to be the second child.
47
+ * The component applies specific classes to the children based on their position (front or back) and manages the flipping state internally.
48
+ * The `flipCard` method can be called to toggle the visibility of the back content.
49
+ *
50
+ * @param {Props} props - The properties for the FlipContent component.
51
+ * @returns {JSX.Element} The rendered FlipContent component.
52
+ *
53
+ * @example
54
+ * ```jsx
55
+ * <FlipContent ref={flipRef}>
56
+ * <div className="front">Front Content</div>
57
+ * <div className="back">Back Content</div>
58
+ * </FlipContent>
59
+ * ```
60
+ *
61
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-flipcontent--docs}
62
+ */
42
63
  export const FlipContent = ({ ref, children }: Props) => {
43
64
  const [showBack, setShowBack] = useState(false);
44
65
 
@@ -92,6 +92,26 @@ const SizeMap: KeyValue<string> = {
92
92
  xl: "2rem",
93
93
  };
94
94
 
95
+ /**
96
+ * A component that represents a small block of information, often used for tags, categories, or actions.
97
+ * It allows customization of size, color, variant, and includes optional icon and remove functionality.
98
+ * It supports various properties for styling and interaction, including click handlers and disabled state.
99
+ * It can be used in various contexts, such as filtering options, displaying tags, or representing user actions.
100
+ * It can be styled with custom CSS classes and supports features like rounded edges and click handling.
101
+ * It can also include an icon and a remove button, making it versatile for different use cases.
102
+ *
103
+ * @param {ChipProps} props - The properties for the Chip component.
104
+ * @returns {JSX.Element} The rendered Chip component.
105
+ *
106
+ * @example
107
+ * ```jsx
108
+ * <Chip color="primary" size="md" className="my-chip">
109
+ * Example Chip
110
+ * </Chip>
111
+ * ```
112
+ *
113
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-chip--docs} for more details.
114
+ */
95
115
  export const Chip = <Tag extends React.ElementType = "div">({
96
116
  ref,
97
117
  children,
@@ -170,7 +190,7 @@ export const Chip = <Tag extends React.ElementType = "div">({
170
190
  {icon && (
171
191
  <Icon
172
192
  data-ref="chipIcon"
173
- className={classNames("fabric-chipIcon", "m-1")}
193
+ className={classNames("fabric-chipIcon", "m-1 flex-auto")}
174
194
  icon={icon}
175
195
  bg={iconBg}
176
196
  onClick={onIconClick}