@brightlocal/ui-components 0.1.1 → 0.1.3

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 (244) hide show
  1. package/dist/accordion.cjs +1 -1
  2. package/dist/accordion.d.ts +74 -4
  3. package/dist/accordion.d.ts.map +1 -1
  4. package/dist/accordion.js +100 -105
  5. package/dist/alert-dialog.cjs +1 -1
  6. package/dist/alert-dialog.d.ts +30 -10
  7. package/dist/alert-dialog.d.ts.map +1 -1
  8. package/dist/alert-dialog.js +129 -132
  9. package/dist/alert.d.ts +22 -1
  10. package/dist/alert.d.ts.map +1 -1
  11. package/dist/aspect-ratio.cjs +1 -1
  12. package/dist/aspect-ratio.d.ts +11 -1
  13. package/dist/aspect-ratio.d.ts.map +1 -1
  14. package/dist/aspect-ratio.js +16 -20
  15. package/dist/avatar.cjs +1 -1
  16. package/dist/avatar.d.ts +43 -3
  17. package/dist/avatar.d.ts.map +1 -1
  18. package/dist/avatar.js +18 -16
  19. package/dist/badge.cjs +1 -1
  20. package/dist/badge.d.ts +24 -9
  21. package/dist/badge.d.ts.map +1 -1
  22. package/dist/badge.js +34 -32
  23. package/dist/blocks/data-table.cjs +1 -1
  24. package/dist/blocks/data-table.d.ts.map +1 -1
  25. package/dist/blocks/data-table.js +209 -202
  26. package/dist/blocks/sidebar.cjs +1 -1
  27. package/dist/blocks/sidebar.d.ts +1 -1
  28. package/dist/blocks/sidebar.d.ts.map +1 -1
  29. package/dist/blocks/sidebar.js +154 -154
  30. package/dist/breadcrumb.cjs +1 -1
  31. package/dist/breadcrumb.d.ts +63 -8
  32. package/dist/breadcrumb.d.ts.map +1 -1
  33. package/dist/breadcrumb.js +97 -93
  34. package/dist/button.cjs +1 -1
  35. package/dist/button.d.ts +17 -45
  36. package/dist/button.d.ts.map +1 -1
  37. package/dist/button.js +49 -50
  38. package/dist/calendar.cjs +1 -1
  39. package/dist/calendar.d.ts +12 -0
  40. package/dist/calendar.d.ts.map +1 -1
  41. package/dist/calendar.js +10 -8
  42. package/dist/card.cjs +1 -1
  43. package/dist/card.d.ts +58 -18
  44. package/dist/card.d.ts.map +1 -1
  45. package/dist/card.js +60 -51
  46. package/dist/carousel.cjs +1 -1
  47. package/dist/carousel.d.ts +99 -9
  48. package/dist/carousel.d.ts.map +1 -1
  49. package/dist/carousel.js +142 -128
  50. package/dist/centred-layout.cjs +1 -1
  51. package/dist/centred-layout.d.ts +18 -2
  52. package/dist/centred-layout.d.ts.map +1 -1
  53. package/dist/centred-layout.js +46 -33
  54. package/dist/chart.cjs +4 -4
  55. package/dist/chart.d.ts +70 -7
  56. package/dist/chart.d.ts.map +1 -1
  57. package/dist/chart.js +71 -66
  58. package/dist/checkbox.cjs +1 -1
  59. package/dist/checkbox.d.ts +9 -5
  60. package/dist/checkbox.d.ts.map +1 -1
  61. package/dist/checkbox.js +61 -82
  62. package/dist/collapsible.cjs +1 -1
  63. package/dist/collapsible.d.ts +65 -8
  64. package/dist/collapsible.d.ts.map +1 -1
  65. package/dist/collapsible.js +41 -55
  66. package/dist/combobox.cjs +1 -1
  67. package/dist/combobox.d.ts +29 -11
  68. package/dist/combobox.d.ts.map +1 -1
  69. package/dist/combobox.js +193 -159
  70. package/dist/command.cjs +1 -1
  71. package/dist/command.d.ts +115 -9
  72. package/dist/command.d.ts.map +1 -1
  73. package/dist/command.js +176 -152
  74. package/dist/context-menu.cjs +1 -1
  75. package/dist/context-menu.d.ts +188 -20
  76. package/dist/context-menu.d.ts.map +1 -1
  77. package/dist/context-menu.js +119 -121
  78. package/dist/date-picker.cjs +1 -1
  79. package/dist/date-picker.d.ts +75 -9
  80. package/dist/date-picker.d.ts.map +1 -1
  81. package/dist/date-picker.js +220 -81
  82. package/dist/description.cjs +1 -0
  83. package/dist/description.d.ts +37 -0
  84. package/dist/description.d.ts.map +1 -0
  85. package/dist/description.js +25 -0
  86. package/dist/dialog.cjs +1 -1
  87. package/dist/dialog.d.ts +73 -9
  88. package/dist/dialog.d.ts.map +1 -1
  89. package/dist/dialog.js +103 -112
  90. package/dist/drawer.cjs +1 -1
  91. package/dist/drawer.d.ts +92 -0
  92. package/dist/drawer.d.ts.map +1 -1
  93. package/dist/drawer.js +67 -52
  94. package/dist/dropdown-menu.cjs +1 -1
  95. package/dist/dropdown-menu.d.ts +95 -11
  96. package/dist/dropdown-menu.d.ts.map +1 -1
  97. package/dist/dropdown-menu.js +146 -106
  98. package/dist/field.cjs +1 -1
  99. package/dist/field.d.ts +23 -6
  100. package/dist/field.d.ts.map +1 -1
  101. package/dist/field.js +54 -53
  102. package/dist/global-layout.cjs +1 -1
  103. package/dist/global-layout.d.ts +27 -17
  104. package/dist/global-layout.d.ts.map +1 -1
  105. package/dist/global-layout.js +86 -79
  106. package/dist/hover-card.cjs +1 -1
  107. package/dist/hover-card.d.ts +36 -6
  108. package/dist/hover-card.d.ts.map +1 -1
  109. package/dist/hover-card.js +44 -42
  110. package/dist/index.cjs +1 -1
  111. package/dist/index.d.ts +1 -1
  112. package/dist/index.d.ts.map +1 -1
  113. package/dist/index.js +383 -387
  114. package/dist/input-group.cjs +1 -1
  115. package/dist/input-group.d.ts +21 -2
  116. package/dist/input-group.d.ts.map +1 -1
  117. package/dist/input-group.js +51 -41
  118. package/dist/input-password.cjs +1 -1
  119. package/dist/input-password.d.ts.map +1 -1
  120. package/dist/input-password.js +24 -25
  121. package/dist/input.cjs +1 -1
  122. package/dist/input.d.ts +38 -24
  123. package/dist/input.d.ts.map +1 -1
  124. package/dist/input.js +68 -136
  125. package/dist/label.cjs +1 -1
  126. package/dist/label.d.ts +20 -1
  127. package/dist/label.d.ts.map +1 -1
  128. package/dist/label.js +31 -18
  129. package/dist/logo.cjs +1 -1
  130. package/dist/logo.d.ts +3 -0
  131. package/dist/logo.d.ts.map +1 -1
  132. package/dist/logo.js +12 -10
  133. package/dist/menubar.cjs +1 -1
  134. package/dist/menubar.d.ts +40 -6
  135. package/dist/menubar.d.ts.map +1 -1
  136. package/dist/menubar.js +97 -76
  137. package/dist/popover.cjs +1 -1
  138. package/dist/popover.d.ts +59 -4
  139. package/dist/popover.d.ts.map +1 -1
  140. package/dist/popover.js +42 -34
  141. package/dist/progress.cjs +1 -1
  142. package/dist/progress.d.ts +9 -2
  143. package/dist/progress.d.ts.map +1 -1
  144. package/dist/progress.js +71 -59
  145. package/dist/radio-group.d.ts +40 -0
  146. package/dist/radio-group.d.ts.map +1 -1
  147. package/dist/rating.d.ts +4 -0
  148. package/dist/rating.d.ts.map +1 -1
  149. package/dist/resizable.cjs +1 -1
  150. package/dist/resizable.d.ts +65 -4
  151. package/dist/resizable.d.ts.map +1 -1
  152. package/dist/resizable.js +53 -36
  153. package/dist/scroll-area.cjs +1 -1
  154. package/dist/scroll-area.d.ts +46 -5
  155. package/dist/scroll-area.d.ts.map +1 -1
  156. package/dist/scroll-area.js +42 -38
  157. package/dist/select.cjs +1 -1
  158. package/dist/select.d.ts +30 -0
  159. package/dist/select.d.ts.map +1 -1
  160. package/dist/select.js +64 -54
  161. package/dist/separator.cjs +1 -1
  162. package/dist/separator.d.ts +49 -2
  163. package/dist/separator.d.ts.map +1 -1
  164. package/dist/separator.js +48 -36
  165. package/dist/sheet.cjs +1 -1
  166. package/dist/sheet.d.ts +80 -9
  167. package/dist/sheet.d.ts.map +1 -1
  168. package/dist/sheet.js +117 -113
  169. package/dist/skeleton.cjs +1 -1
  170. package/dist/skeleton.d.ts +24 -2
  171. package/dist/skeleton.d.ts.map +1 -1
  172. package/dist/skeleton.js +15 -9
  173. package/dist/slider.cjs +1 -1
  174. package/dist/slider.d.ts +18 -4
  175. package/dist/slider.d.ts.map +1 -1
  176. package/dist/slider.js +72 -66
  177. package/dist/sonner.cjs +1 -1
  178. package/dist/sonner.d.ts +4 -2
  179. package/dist/sonner.d.ts.map +1 -1
  180. package/dist/sonner.js +29 -28
  181. package/dist/split-layout.d.ts +4 -1
  182. package/dist/split-layout.d.ts.map +1 -1
  183. package/dist/table.cjs +1 -1
  184. package/dist/table.js +1 -1
  185. package/dist/toggle-group.cjs +1 -1
  186. package/dist/toggle-group.d.ts +3 -1
  187. package/dist/toggle-group.d.ts.map +1 -1
  188. package/dist/toggle-group.js +38 -36
  189. package/package.json +8 -2
  190. package/src/blocks/data-table.tsx +42 -32
  191. package/src/blocks/sidebar.tsx +4 -12
  192. package/src/components/accordion.tsx +163 -77
  193. package/src/components/alert-dialog.tsx +156 -111
  194. package/src/components/alert.tsx +26 -13
  195. package/src/components/aspect-ratio.tsx +25 -16
  196. package/src/components/avatar.tsx +56 -8
  197. package/src/components/badge.tsx +65 -42
  198. package/src/components/breadcrumb.tsx +158 -82
  199. package/src/components/button.tsx +41 -62
  200. package/src/components/calendar.tsx +16 -2
  201. package/src/components/card.tsx +92 -40
  202. package/src/components/carousel.tsx +240 -115
  203. package/src/components/centred-layout.tsx +67 -35
  204. package/src/components/chart.tsx +118 -47
  205. package/src/components/checkbox.tsx +42 -78
  206. package/src/components/collapsible.tsx +95 -26
  207. package/src/components/combobox.tsx +242 -144
  208. package/src/components/command.tsx +295 -121
  209. package/src/components/context-menu.tsx +278 -81
  210. package/src/components/date-picker.tsx +281 -30
  211. package/src/components/description.tsx +60 -0
  212. package/src/components/dialog.tsx +162 -86
  213. package/src/components/drawer.tsx +76 -2
  214. package/src/components/dropdown-menu.tsx +143 -37
  215. package/src/components/field.tsx +36 -11
  216. package/src/components/global-layout.tsx +116 -77
  217. package/src/components/hover-card.tsx +54 -14
  218. package/src/components/input-group.tsx +56 -18
  219. package/src/components/input-password.tsx +3 -4
  220. package/src/components/input.tsx +93 -186
  221. package/src/components/label.tsx +56 -15
  222. package/src/components/logo.tsx +3 -0
  223. package/src/components/menubar.tsx +58 -4
  224. package/src/components/popover.tsx +103 -20
  225. package/src/components/progress.tsx +82 -60
  226. package/src/components/radio-group.tsx +40 -0
  227. package/src/components/rating.tsx +4 -1
  228. package/src/components/resizable.tsx +119 -31
  229. package/src/components/scroll-area.tsx +123 -56
  230. package/src/components/select.tsx +21 -1
  231. package/src/components/separator.tsx +97 -20
  232. package/src/components/sheet.tsx +180 -79
  233. package/src/components/skeleton.tsx +40 -10
  234. package/src/components/slider.tsx +83 -57
  235. package/src/components/sonner.tsx +10 -7
  236. package/src/components/split-layout.tsx +4 -1
  237. package/src/components/table.tsx +1 -1
  238. package/src/components/toggle-group.tsx +4 -0
  239. package/src/index.ts +1 -1
  240. package/dist/input-base.cjs +0 -1
  241. package/dist/input-base.d.ts +0 -28
  242. package/dist/input-base.d.ts.map +0 -1
  243. package/dist/input-base.js +0 -56
  244. package/src/components/input-base.tsx +0 -86
@@ -1,29 +1,38 @@
1
+ import * as React from "react";
1
2
  import * as AspectRatioPrimitive from "@radix-ui/react-aspect-ratio";
2
3
 
3
4
  interface AspectRatioProps extends React.ComponentProps<
4
5
  typeof AspectRatioPrimitive.Root
5
6
  > {
7
+ /**
8
+ * Data hook for automated testing (REQUIRED)
9
+ */
6
10
  dataHook: string;
11
+ /**
12
+ * Tracking element identifier for analytics
13
+ */
7
14
  trackingEl?: string;
15
+ /**
16
+ * Tracking label for analytics context
17
+ */
8
18
  trackingLabel?: string;
9
19
  }
10
20
 
11
- function AspectRatio({
12
- dataHook,
13
- trackingEl,
14
- trackingLabel,
15
- ...props
16
- }: AspectRatioProps) {
17
- return (
18
- <AspectRatioPrimitive.Root
19
- data-hook={dataHook}
20
- data-slot="aspect-ratio"
21
- data-tracking-el={trackingEl}
22
- data-tracking-label={trackingLabel}
23
- {...props}
24
- />
25
- );
26
- }
21
+ const AspectRatio = React.forwardRef<
22
+ React.ComponentRef<typeof AspectRatioPrimitive.Root>,
23
+ AspectRatioProps
24
+ >(({ dataHook, trackingEl, trackingLabel, ...props }, ref) => (
25
+ <AspectRatioPrimitive.Root
26
+ ref={ref}
27
+ data-hook={dataHook}
28
+ data-slot="aspect-ratio"
29
+ data-tracking-el={trackingEl}
30
+ data-tracking-label={trackingLabel}
31
+ {...props}
32
+ />
33
+ ));
34
+
35
+ AspectRatio.displayName = "AspectRatio";
27
36
 
28
37
  export { AspectRatio };
29
38
 
@@ -3,13 +3,34 @@ import * as AvatarPrimitive from "@radix-ui/react-avatar";
3
3
 
4
4
  import { cn } from "@brightlocal/ui-components/lib/utils";
5
5
 
6
+ /**
7
+ * Props for the Avatar component
8
+ */
9
+ interface AvatarProps extends React.ComponentPropsWithoutRef<
10
+ typeof AvatarPrimitive.Root
11
+ > {
12
+ /**
13
+ * Data hook for automated testing (required)
14
+ */
15
+ dataHook: string;
16
+ /**
17
+ * Tracking element identifier for analytics
18
+ */
19
+ trackingEl?: string;
20
+ /**
21
+ * Tracking label for analytics context
22
+ */
23
+ trackingLabel?: string;
24
+ }
25
+
26
+ /**
27
+ * An image element with a fallback for representing the user.
28
+ * Renders a circular container for user avatars with support for images
29
+ * and text fallbacks.
30
+ */
6
31
  const Avatar = React.forwardRef<
7
32
  React.ElementRef<typeof AvatarPrimitive.Root>,
8
- React.ComponentPropsWithoutRef<typeof AvatarPrimitive.Root> & {
9
- dataHook: string;
10
- trackingEl?: string;
11
- trackingLabel?: string;
12
- }
33
+ AvatarProps
13
34
  >(({ className, dataHook, trackingEl, trackingLabel, ...props }, ref) => (
14
35
  <AvatarPrimitive.Root
15
36
  ref={ref}
@@ -26,18 +47,43 @@ const Avatar = React.forwardRef<
26
47
  ));
27
48
  Avatar.displayName = AvatarPrimitive.Root.displayName;
28
49
 
50
+ /**
51
+ * Props for the AvatarImage component
52
+ */
53
+ interface AvatarImageProps extends React.ComponentPropsWithoutRef<
54
+ typeof AvatarPrimitive.Image
55
+ > {
56
+ /**
57
+ * The image source URL
58
+ */
59
+ src?: string;
60
+ /**
61
+ * Alternative text for the image for accessibility
62
+ */
63
+ alt?: string;
64
+ }
65
+
66
+ /**
67
+ * The image element for the avatar.
68
+ * Falls back to AvatarFallback when image fails to load.
69
+ */
29
70
  const AvatarImage = React.forwardRef<
30
71
  React.ElementRef<typeof AvatarPrimitive.Image>,
31
- React.ComponentPropsWithoutRef<typeof AvatarPrimitive.Image>
72
+ AvatarImageProps
32
73
  >(({ className, ...props }, ref) => (
33
74
  <AvatarPrimitive.Image
34
75
  ref={ref}
35
76
  className={cn("aspect-square size-full", className)}
77
+ data-slot="avatar-image"
36
78
  {...props}
37
79
  />
38
80
  ));
39
- AvatarImage.displayName = AvatarPrimitive.Image.displayName;
81
+ AvatarImage.displayName = "AvatarImage";
40
82
 
83
+ /**
84
+ * Fallback element shown when no image is available.
85
+ * Displays user initials or an icon as a placeholder.
86
+ */
41
87
  const AvatarFallback = React.forwardRef<
42
88
  React.ElementRef<typeof AvatarPrimitive.Fallback>,
43
89
  React.ComponentPropsWithoutRef<typeof AvatarPrimitive.Fallback>
@@ -48,9 +94,11 @@ const AvatarFallback = React.forwardRef<
48
94
  "bg-muted text-foreground flex size-full items-center justify-center rounded-full text-sm",
49
95
  className
50
96
  )}
97
+ data-slot="avatar-fallback"
51
98
  {...props}
52
99
  />
53
100
  ));
54
- AvatarFallback.displayName = AvatarPrimitive.Fallback.displayName;
101
+ AvatarFallback.displayName = "AvatarFallback";
55
102
 
56
103
  export { Avatar, AvatarImage, AvatarFallback };
104
+ export type { AvatarProps, AvatarImageProps };
@@ -4,13 +4,6 @@ import { cva, type VariantProps } from "class-variance-authority";
4
4
 
5
5
  import { cn } from "@brightlocal/ui-components/lib/utils";
6
6
 
7
- enum BadgeVariant {
8
- DEFAULT = "default",
9
- SECONDARY = "secondary",
10
- DESTRUCTIVE = "destructive",
11
- OUTLINE = "outline",
12
- }
13
-
14
7
  const badgeVariants = cva(
15
8
  "inline-flex items-center justify-center rounded-full border px-2 py-1 text-xs font-semibold w-fit whitespace-nowrap shrink-0 [&>svg]:size-3 gap-1 [&>svg]:pointer-events-none transition-[color,background-color,border-color,box-shadow] overflow-hidden leading-none data-[number=true]:size-5 data-[number=true]:p-0 data-[number=true]:aspect-square",
16
9
  {
@@ -32,41 +25,71 @@ const badgeVariants = cva(
32
25
  }
33
26
  );
34
27
 
35
- function Badge({
36
- className,
37
- variant,
38
- asChild = false,
39
- dataHook,
40
- trackingEl,
41
- trackingLabel,
42
- children,
43
- ...props
44
- }: React.ComponentProps<"span"> &
45
- VariantProps<typeof badgeVariants> & {
46
- asChild?: boolean;
47
- dataHook: string;
48
- trackingEl?: string;
49
- trackingLabel?: string;
50
- }) {
51
- const Comp = asChild ? Slot : "span";
28
+ /**
29
+ * Props for the Badge component
30
+ */
31
+ interface BadgeProps
32
+ extends React.ComponentProps<"span">, VariantProps<typeof badgeVariants> {
33
+ /**
34
+ * Render as a different element (Radix Slot pattern)
35
+ */
36
+ asChild?: boolean;
37
+ /**
38
+ * Data hook for automated testing (required)
39
+ */
40
+ dataHook: string;
41
+ /**
42
+ * Tracking element identifier for analytics
43
+ */
44
+ trackingEl?: string;
45
+ /**
46
+ * Tracking label for analytics context
47
+ */
48
+ trackingLabel?: string;
49
+ }
52
50
 
53
- // Check if children is a single digit number (0-9)
54
- const isNumberBadge =
55
- typeof children === "string" && /^[0-9]$/.test(children);
51
+ /**
52
+ * Displays a badge or a component that looks like a badge.
53
+ * Used for status indicators, labels, and counts.
54
+ */
55
+ const Badge = React.forwardRef<HTMLSpanElement, BadgeProps>(
56
+ (
57
+ {
58
+ className,
59
+ variant,
60
+ asChild = false,
61
+ dataHook,
62
+ trackingEl,
63
+ trackingLabel,
64
+ children,
65
+ ...props
66
+ },
67
+ ref
68
+ ) => {
69
+ const Comp = asChild ? Slot : "span";
56
70
 
57
- return (
58
- <Comp
59
- className={cn(badgeVariants({ variant }), className)}
60
- data-hook={dataHook}
61
- data-number={isNumberBadge}
62
- data-slot="badge"
63
- data-tracking-el={trackingEl}
64
- data-tracking-label={trackingLabel}
65
- {...props}
66
- >
67
- {children}
68
- </Comp>
69
- );
70
- }
71
+ // Check if children is a single digit number (0-9)
72
+ const isNumberBadge =
73
+ typeof children === "string" && /^[0-9]$/.test(children);
74
+
75
+ return (
76
+ <Comp
77
+ ref={ref}
78
+ className={cn(badgeVariants({ variant }), className)}
79
+ data-hook={dataHook}
80
+ data-number={isNumberBadge}
81
+ data-slot="badge"
82
+ data-tracking-el={trackingEl}
83
+ data-tracking-label={trackingLabel}
84
+ {...props}
85
+ >
86
+ {children}
87
+ </Comp>
88
+ );
89
+ }
90
+ );
91
+
92
+ Badge.displayName = "Badge";
71
93
 
72
- export { Badge, BadgeVariant };
94
+ export { Badge };
95
+ export type { BadgeProps };
@@ -4,99 +4,174 @@ import { ChevronRight, MoreHorizontal } from "lucide-react";
4
4
 
5
5
  import { cn } from "@brightlocal/ui-components/lib/utils";
6
6
 
7
- function Breadcrumb({ ...props }: React.ComponentProps<"nav">) {
8
- return <nav aria-label="breadcrumb" data-slot="breadcrumb" {...props} />;
7
+ /**
8
+ * Props for the Breadcrumb component
9
+ */
10
+ interface BreadcrumbProps extends React.ComponentProps<"nav"> {
11
+ /**
12
+ * Data hook for automated testing (required)
13
+ */
14
+ dataHook: string;
15
+ /**
16
+ * Tracking element identifier for analytics
17
+ */
18
+ trackingEl?: string;
19
+ /**
20
+ * Tracking label for analytics context
21
+ */
22
+ trackingLabel?: string;
9
23
  }
10
24
 
11
- function BreadcrumbList({ className, ...props }: React.ComponentProps<"ol">) {
12
- return (
13
- <ol
14
- className={cn(
15
- "text-muted-foreground flex flex-wrap items-center gap-1.5 text-sm break-words sm:gap-2.5",
16
- className
17
- )}
18
- data-slot="breadcrumb-list"
25
+ /**
26
+ * Displays the path to the current resource using a hierarchy of links.
27
+ * Provides navigation context and allows users to navigate back through the hierarchy.
28
+ */
29
+ const Breadcrumb = React.forwardRef<HTMLElement, BreadcrumbProps>(
30
+ ({ dataHook, trackingEl, trackingLabel, ...props }, ref) => (
31
+ <nav
32
+ ref={ref}
33
+ aria-label="breadcrumb"
34
+ data-hook={dataHook}
35
+ data-slot="breadcrumb"
36
+ data-tracking-el={trackingEl}
37
+ data-tracking-label={trackingLabel}
19
38
  {...props}
20
39
  />
21
- );
22
- }
40
+ )
41
+ );
42
+ Breadcrumb.displayName = "Breadcrumb";
23
43
 
24
- function BreadcrumbItem({ className, ...props }: React.ComponentProps<"li">) {
25
- return (
26
- <li
27
- className={cn("inline-flex items-center gap-1.5", className)}
28
- data-slot="breadcrumb-item"
29
- {...props}
30
- />
31
- );
32
- }
44
+ /**
45
+ * Container for breadcrumb items arranged in a horizontal list.
46
+ */
47
+ const BreadcrumbList = React.forwardRef<
48
+ HTMLOListElement,
49
+ React.ComponentProps<"ol">
50
+ >(({ className, ...props }, ref) => (
51
+ <ol
52
+ ref={ref}
53
+ className={cn(
54
+ "text-muted-foreground flex flex-wrap items-center gap-1.5 text-sm break-words sm:gap-2.5",
55
+ className
56
+ )}
57
+ data-slot="breadcrumb-list"
58
+ {...props}
59
+ />
60
+ ));
61
+ BreadcrumbList.displayName = "BreadcrumbList";
33
62
 
34
- function BreadcrumbLink({
35
- asChild,
36
- className,
37
- ...props
38
- }: React.ComponentProps<"a"> & {
39
- asChild?: boolean;
40
- }) {
41
- const Comp = asChild ? Slot : "a";
63
+ /**
64
+ * Individual breadcrumb item container.
65
+ */
66
+ const BreadcrumbItem = React.forwardRef<
67
+ HTMLLIElement,
68
+ React.ComponentProps<"li">
69
+ >(({ className, ...props }, ref) => (
70
+ <li
71
+ ref={ref}
72
+ className={cn("inline-flex items-center gap-1.5", className)}
73
+ data-slot="breadcrumb-item"
74
+ {...props}
75
+ />
76
+ ));
77
+ BreadcrumbItem.displayName = "BreadcrumbItem";
42
78
 
43
- return (
44
- <Comp
45
- className={cn("hover:text-foreground transition-colors", className)}
46
- data-slot="breadcrumb-link"
47
- {...props}
48
- />
49
- );
79
+ /**
80
+ * Props for the BreadcrumbLink component
81
+ */
82
+ interface BreadcrumbLinkProps extends React.ComponentProps<"a"> {
83
+ /**
84
+ * Render as a different element (Radix Slot pattern)
85
+ */
86
+ asChild?: boolean;
87
+ /**
88
+ * URL the breadcrumb link navigates to
89
+ */
90
+ href?: string;
50
91
  }
51
92
 
52
- function BreadcrumbPage({ className, ...props }: React.ComponentProps<"span">) {
53
- return (
54
- <span
55
- aria-current="page"
56
- aria-disabled="true"
57
- className={cn("text-foreground font-normal", className)}
58
- data-slot="breadcrumb-page"
59
- role="link"
60
- {...props}
61
- />
62
- );
63
- }
93
+ /**
94
+ * Navigational link within a breadcrumb trail.
95
+ * Links to parent pages in the navigation hierarchy.
96
+ */
97
+ const BreadcrumbLink = React.forwardRef<HTMLAnchorElement, BreadcrumbLinkProps>(
98
+ ({ asChild, className, ...props }, ref) => {
99
+ const Comp = asChild ? Slot : "a";
64
100
 
65
- function BreadcrumbSeparator({
66
- children,
67
- className,
68
- ...props
69
- }: React.ComponentProps<"li">) {
70
- return (
71
- <li
72
- aria-hidden="true"
73
- className={cn("[&>svg]:size-3.5", className)}
74
- data-slot="breadcrumb-separator"
75
- role="presentation"
76
- {...props}
77
- >
78
- {children ?? <ChevronRight />}
79
- </li>
80
- );
81
- }
101
+ return (
102
+ <Comp
103
+ ref={ref}
104
+ className={cn("hover:text-foreground transition-colors", className)}
105
+ data-slot="breadcrumb-link"
106
+ {...props}
107
+ />
108
+ );
109
+ }
110
+ );
111
+ BreadcrumbLink.displayName = "BreadcrumbLink";
82
112
 
83
- function BreadcrumbEllipsis({
84
- className,
85
- ...props
86
- }: React.ComponentProps<"span">) {
87
- return (
88
- <span
89
- aria-hidden="true"
90
- className={cn("flex size-9 items-center justify-center", className)}
91
- data-slot="breadcrumb-ellipsis"
92
- role="presentation"
93
- {...props}
94
- >
95
- <MoreHorizontal className="size-4" />
96
- <span className="sr-only">More</span>
97
- </span>
98
- );
99
- }
113
+ /**
114
+ * Represents the current page in the breadcrumb trail.
115
+ * Non-interactive element that indicates the user's current location.
116
+ */
117
+ const BreadcrumbPage = React.forwardRef<
118
+ HTMLSpanElement,
119
+ React.ComponentProps<"span">
120
+ >(({ className, ...props }, ref) => (
121
+ <span
122
+ ref={ref}
123
+ aria-current="page"
124
+ aria-disabled="true"
125
+ className={cn("text-foreground font-normal", className)}
126
+ data-slot="breadcrumb-page"
127
+ role="link"
128
+ {...props}
129
+ />
130
+ ));
131
+ BreadcrumbPage.displayName = "BreadcrumbPage";
132
+
133
+ /**
134
+ * Visual separator between breadcrumb items.
135
+ * Defaults to a chevron icon but can be customized.
136
+ */
137
+ const BreadcrumbSeparator = React.forwardRef<
138
+ HTMLLIElement,
139
+ React.ComponentProps<"li">
140
+ >(({ children, className, ...props }, ref) => (
141
+ <li
142
+ ref={ref}
143
+ aria-hidden="true"
144
+ className={cn("[&>svg]:size-3.5", className)}
145
+ data-slot="breadcrumb-separator"
146
+ role="presentation"
147
+ {...props}
148
+ >
149
+ {children ?? <ChevronRight />}
150
+ </li>
151
+ ));
152
+ BreadcrumbSeparator.displayName = "BreadcrumbSeparator";
153
+
154
+ /**
155
+ * Ellipsis indicator for collapsed breadcrumb sections.
156
+ * Used when the breadcrumb trail is too long to display fully.
157
+ */
158
+ const BreadcrumbEllipsis = React.forwardRef<
159
+ HTMLSpanElement,
160
+ React.ComponentProps<"span">
161
+ >(({ className, ...props }, ref) => (
162
+ <span
163
+ ref={ref}
164
+ aria-hidden="true"
165
+ className={cn("flex size-9 items-center justify-center", className)}
166
+ data-slot="breadcrumb-ellipsis"
167
+ role="presentation"
168
+ {...props}
169
+ >
170
+ <MoreHorizontal className="size-4" />
171
+ <span className="sr-only">More</span>
172
+ </span>
173
+ ));
174
+ BreadcrumbEllipsis.displayName = "BreadcrumbEllipsis";
100
175
 
101
176
  export {
102
177
  Breadcrumb,
@@ -107,3 +182,4 @@ export {
107
182
  BreadcrumbSeparator,
108
183
  BreadcrumbEllipsis,
109
184
  };
185
+ export type { BreadcrumbProps, BreadcrumbLinkProps };