torch-glare 2.5.6 → 2.6.0

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 (362) hide show
  1. package/README.md +4 -3
  2. package/dist/bin/index.js +9 -24
  3. package/dist/bin/index.js.map +1 -1
  4. package/dist/src/commands/add.d.ts +2 -2
  5. package/dist/src/commands/add.d.ts.map +1 -1
  6. package/dist/src/commands/add.js +4 -70
  7. package/dist/src/commands/add.js.map +1 -1
  8. package/dist/src/commands/hook.d.ts +5 -4
  9. package/dist/src/commands/hook.d.ts.map +1 -1
  10. package/dist/src/commands/hook.js +7 -75
  11. package/dist/src/commands/hook.js.map +1 -1
  12. package/dist/src/commands/init.js +1 -1
  13. package/dist/src/commands/init.js.map +1 -1
  14. package/dist/src/commands/layout.d.ts +5 -4
  15. package/dist/src/commands/layout.d.ts.map +1 -1
  16. package/dist/src/commands/layout.js +7 -75
  17. package/dist/src/commands/layout.js.map +1 -1
  18. package/dist/src/commands/provider.d.ts +5 -4
  19. package/dist/src/commands/provider.d.ts.map +1 -1
  20. package/dist/src/commands/provider.js +7 -75
  21. package/dist/src/commands/provider.js.map +1 -1
  22. package/dist/src/commands/update.d.ts.map +1 -1
  23. package/dist/src/commands/update.js +78 -43
  24. package/dist/src/commands/update.js.map +1 -1
  25. package/dist/src/commands/utils.d.ts +5 -4
  26. package/dist/src/commands/utils.d.ts.map +1 -1
  27. package/dist/src/commands/utils.js +7 -80
  28. package/dist/src/commands/utils.js.map +1 -1
  29. package/dist/src/shared/addFromRegistry.d.ts +16 -0
  30. package/dist/src/shared/addFromRegistry.d.ts.map +1 -0
  31. package/dist/src/shared/addFromRegistry.js +88 -0
  32. package/dist/src/shared/addFromRegistry.js.map +1 -0
  33. package/dist/src/shared/getInstallCommand.d.ts.map +1 -1
  34. package/dist/src/shared/getInstallCommand.js +5 -0
  35. package/dist/src/shared/getInstallCommand.js.map +1 -1
  36. package/dist/src/shared/installDependencies.d.ts +0 -10
  37. package/dist/src/shared/installDependencies.d.ts.map +1 -1
  38. package/dist/src/shared/installDependencies.js +0 -17
  39. package/dist/src/shared/installDependencies.js.map +1 -1
  40. package/dist/src/shared/installFromPlan.d.ts +7 -5
  41. package/dist/src/shared/installFromPlan.d.ts.map +1 -1
  42. package/dist/src/shared/installFromPlan.js +103 -36
  43. package/dist/src/shared/installFromPlan.js.map +1 -1
  44. package/dist/src/shared/loadRegistry.d.ts +12 -3
  45. package/dist/src/shared/loadRegistry.d.ts.map +1 -1
  46. package/dist/src/shared/loadRegistry.js +19 -20
  47. package/dist/src/shared/loadRegistry.js.map +1 -1
  48. package/dist/src/shared/registryClient.d.ts +19 -0
  49. package/dist/src/shared/registryClient.d.ts.map +1 -0
  50. package/dist/src/shared/registryClient.js +128 -0
  51. package/dist/src/shared/registryClient.js.map +1 -0
  52. package/dist/src/shared/resolveEntry.d.ts +10 -7
  53. package/dist/src/shared/resolveEntry.d.ts.map +1 -1
  54. package/dist/src/shared/resolveEntry.js +18 -13
  55. package/dist/src/shared/resolveEntry.js.map +1 -1
  56. package/dist/src/shared/suggestOtherCommand.d.ts +7 -1
  57. package/dist/src/shared/suggestOtherCommand.d.ts.map +1 -1
  58. package/dist/src/shared/suggestOtherCommand.js +29 -23
  59. package/dist/src/shared/suggestOtherCommand.js.map +1 -1
  60. package/dist/src/types/main.d.ts +31 -2
  61. package/dist/src/types/main.d.ts.map +1 -1
  62. package/package.json +6 -11
  63. package/apps/lib/components/ActionButton.tsx +0 -93
  64. package/apps/lib/components/ActionsGroup.tsx +0 -27
  65. package/apps/lib/components/AlertDialog.tsx +0 -204
  66. package/apps/lib/components/Avatar.tsx +0 -46
  67. package/apps/lib/components/Badge.tsx +0 -250
  68. package/apps/lib/components/BadgeField.tsx +0 -403
  69. package/apps/lib/components/Breadcrumb.tsx +0 -280
  70. package/apps/lib/components/Button.tsx +0 -325
  71. package/apps/lib/components/ButtonGroup.tsx +0 -190
  72. package/apps/lib/components/Calendar.tsx +0 -115
  73. package/apps/lib/components/Card.tsx +0 -95
  74. package/apps/lib/components/Checkbox.tsx +0 -42
  75. package/apps/lib/components/ColorPicker.tsx +0 -441
  76. package/apps/lib/components/ConclusionHeader.tsx +0 -148
  77. package/apps/lib/components/ContextMenu.tsx +0 -571
  78. package/apps/lib/components/CountBadge.tsx +0 -52
  79. package/apps/lib/components/DataTable.tsx +0 -213
  80. package/apps/lib/components/DataViews/badge.ts +0 -49
  81. package/apps/lib/components/DataViews/cell.tsx +0 -324
  82. package/apps/lib/components/DataViews/context.ts +0 -144
  83. package/apps/lib/components/DataViews/data-views.tsx +0 -395
  84. package/apps/lib/components/DataViews/filters/children.tsx +0 -98
  85. package/apps/lib/components/DataViews/filters/custom.tsx +0 -34
  86. package/apps/lib/components/DataViews/filters/filters.tsx +0 -157
  87. package/apps/lib/components/DataViews/filters/index.ts +0 -4
  88. package/apps/lib/components/DataViews/filters/labelled.tsx +0 -20
  89. package/apps/lib/components/DataViews/filters/presets.tsx +0 -65
  90. package/apps/lib/components/DataViews/filters/sync.tsx +0 -35
  91. package/apps/lib/components/DataViews/filters/values.ts +0 -173
  92. package/apps/lib/components/DataViews/header.tsx +0 -220
  93. package/apps/lib/components/DataViews/hooks/index.ts +0 -5
  94. package/apps/lib/components/DataViews/hooks/useActiveRow.ts +0 -22
  95. package/apps/lib/components/DataViews/hooks/useControllable.ts +0 -52
  96. package/apps/lib/components/DataViews/index.ts +0 -88
  97. package/apps/lib/components/DataViews/panel/columns.tsx +0 -153
  98. package/apps/lib/components/DataViews/panel/controls.tsx +0 -106
  99. package/apps/lib/components/DataViews/panel/index.ts +0 -3
  100. package/apps/lib/components/DataViews/panel/panel.tsx +0 -164
  101. package/apps/lib/components/DataViews/panel/saved-views.tsx +0 -67
  102. package/apps/lib/components/DataViews/panel/section.tsx +0 -81
  103. package/apps/lib/components/DataViews/panel/sort.tsx +0 -42
  104. package/apps/lib/components/DataViews/panel/tab.tsx +0 -31
  105. package/apps/lib/components/DataViews/slots.ts +0 -72
  106. package/apps/lib/components/DataViews/states.tsx +0 -73
  107. package/apps/lib/components/DataViews/types.ts +0 -510
  108. package/apps/lib/components/DataViews/views/board-view.tsx +0 -381
  109. package/apps/lib/components/DataViews/views/card-rows.tsx +0 -36
  110. package/apps/lib/components/DataViews/views/inbox-view.tsx +0 -260
  111. package/apps/lib/components/DataViews/views/pane-views.tsx +0 -196
  112. package/apps/lib/components/DataViews/views/table-view.tsx +0 -493
  113. package/apps/lib/components/DataViews/views/tree-view.tsx +0 -367
  114. package/apps/lib/components/DatePicker.tsx +0 -232
  115. package/apps/lib/components/Dialog.tsx +0 -116
  116. package/apps/lib/components/Divider.tsx +0 -28
  117. package/apps/lib/components/Drawer.tsx +0 -451
  118. package/apps/lib/components/DropdownMenu.tsx +0 -554
  119. package/apps/lib/components/FieldHint.tsx +0 -69
  120. package/apps/lib/components/Form.tsx +0 -182
  121. package/apps/lib/components/FormBuilder/context.ts +0 -85
  122. package/apps/lib/components/FormBuilder/field-kind.ts +0 -28
  123. package/apps/lib/components/FormBuilder/fields/ChoiceFields.tsx +0 -60
  124. package/apps/lib/components/FormBuilder/fields/ColorField.tsx +0 -59
  125. package/apps/lib/components/FormBuilder/fields/CustomField.tsx +0 -11
  126. package/apps/lib/components/FormBuilder/fields/DateField.tsx +0 -32
  127. package/apps/lib/components/FormBuilder/fields/FieldArray.tsx +0 -74
  128. package/apps/lib/components/FormBuilder/fields/FieldShell.tsx +0 -168
  129. package/apps/lib/components/FormBuilder/fields/FileField.tsx +0 -39
  130. package/apps/lib/components/FormBuilder/fields/OptionListFields.tsx +0 -132
  131. package/apps/lib/components/FormBuilder/fields/OtpField.tsx +0 -31
  132. package/apps/lib/components/FormBuilder/fields/PhoneField.tsx +0 -109
  133. package/apps/lib/components/FormBuilder/fields/RichTextEditorField.tsx +0 -31
  134. package/apps/lib/components/FormBuilder/fields/SelectField.tsx +0 -114
  135. package/apps/lib/components/FormBuilder/fields/SignatureField.tsx +0 -157
  136. package/apps/lib/components/FormBuilder/fields/SliderField.tsx +0 -67
  137. package/apps/lib/components/FormBuilder/fields/SwitchBoxField.tsx +0 -41
  138. package/apps/lib/components/FormBuilder/fields/TableField.tsx +0 -336
  139. package/apps/lib/components/FormBuilder/fields/TextField.tsx +0 -213
  140. package/apps/lib/components/FormBuilder/fields/TreeSelectField.tsx +0 -43
  141. package/apps/lib/components/FormBuilder/fields/countries.ts +0 -303
  142. package/apps/lib/components/FormBuilder/fields/index.ts +0 -25
  143. package/apps/lib/components/FormBuilder/form-builder.tsx +0 -198
  144. package/apps/lib/components/FormBuilder/index.ts +0 -31
  145. package/apps/lib/components/FormBuilder/numberFormat.ts +0 -16
  146. package/apps/lib/components/FormBuilder/submit.tsx +0 -67
  147. package/apps/lib/components/FormBuilder/types.ts +0 -316
  148. package/apps/lib/components/FormRenderer/FormDrawer.tsx +0 -250
  149. package/apps/lib/components/FormRenderer/detail.tsx +0 -256
  150. package/apps/lib/components/FormRenderer/form-renderer.tsx +0 -358
  151. package/apps/lib/components/FormRenderer/header.tsx +0 -88
  152. package/apps/lib/components/FormRenderer/index.ts +0 -17
  153. package/apps/lib/components/FormRenderer/notch-action.tsx +0 -64
  154. package/apps/lib/components/FormRenderer/section.tsx +0 -39
  155. package/apps/lib/components/FormRenderer/stepper.tsx +0 -393
  156. package/apps/lib/components/FormRenderer/types.ts +0 -115
  157. package/apps/lib/components/FormSummary.tsx +0 -282
  158. package/apps/lib/components/HeaderBar.tsx +0 -117
  159. package/apps/lib/components/ImageAttachment.tsx +0 -209
  160. package/apps/lib/components/InnerLabelField.tsx +0 -154
  161. package/apps/lib/components/Input.tsx +0 -224
  162. package/apps/lib/components/InputField.tsx +0 -147
  163. package/apps/lib/components/InputOTP.tsx +0 -84
  164. package/apps/lib/components/Label.tsx +0 -129
  165. package/apps/lib/components/LabelField.tsx +0 -76
  166. package/apps/lib/components/LabeledCheckBox.tsx +0 -51
  167. package/apps/lib/components/LabeledRadio.tsx +0 -51
  168. package/apps/lib/components/LinkButton.tsx +0 -94
  169. package/apps/lib/components/LoginButton.tsx +0 -51
  170. package/apps/lib/components/PasswordLevel.tsx +0 -58
  171. package/apps/lib/components/Popover.tsx +0 -312
  172. package/apps/lib/components/ProfileMenu.tsx +0 -85
  173. package/apps/lib/components/Radio.tsx +0 -59
  174. package/apps/lib/components/RadioCard.tsx +0 -50
  175. package/apps/lib/components/ScrollArea.tsx +0 -54
  176. package/apps/lib/components/SearchField.tsx +0 -62
  177. package/apps/lib/components/SearchableSelect.tsx +0 -318
  178. package/apps/lib/components/SearchableTable.tsx +0 -344
  179. package/apps/lib/components/SearchableTree.tsx +0 -485
  180. package/apps/lib/components/SearchableTreeDialog.tsx +0 -502
  181. package/apps/lib/components/SectionBlock.tsx +0 -168
  182. package/apps/lib/components/Select.tsx +0 -347
  183. package/apps/lib/components/SimpleSelect.tsx +0 -225
  184. package/apps/lib/components/Skeleton.tsx +0 -12
  185. package/apps/lib/components/SlideDatePicker.tsx +0 -255
  186. package/apps/lib/components/SpinLoading.tsx +0 -174
  187. package/apps/lib/components/Stepper.tsx +0 -480
  188. package/apps/lib/components/Switch.tsx +0 -82
  189. package/apps/lib/components/TabFormItem.tsx +0 -153
  190. package/apps/lib/components/TabSwitch.tsx +0 -172
  191. package/apps/lib/components/Table.tsx +0 -597
  192. package/apps/lib/components/TextEditor/ChartBlockTool.ts +0 -676
  193. package/apps/lib/components/TextEditor/RichTextField.tsx +0 -46
  194. package/apps/lib/components/TextEditor/TableDnDWrapper.ts +0 -462
  195. package/apps/lib/components/TextEditor/TextEditor.tsx +0 -1164
  196. package/apps/lib/components/TextEditor/TextEditorToolbar.tsx +0 -429
  197. package/apps/lib/components/TextEditor/editor-tools/AlignmentTune.ts +0 -70
  198. package/apps/lib/components/TextEditor/editor-tools/ColorInlineTool.ts +0 -50
  199. package/apps/lib/components/TextEditor/editor-tools/StrikethroughInlineTool.ts +0 -48
  200. package/apps/lib/components/TextEditor/editor-tools/inlineFormat.ts +0 -98
  201. package/apps/lib/components/TextEditor/editorjs.d.ts +0 -60
  202. package/apps/lib/components/TextEditor/index.ts +0 -7
  203. package/apps/lib/components/TextEditor/markdownParser.ts +0 -346
  204. package/apps/lib/components/Textarea.tsx +0 -117
  205. package/apps/lib/components/Timeline.tsx +0 -263
  206. package/apps/lib/components/Toast.tsx +0 -87
  207. package/apps/lib/components/Toggle.tsx +0 -125
  208. package/apps/lib/components/ToggleButton.tsx +0 -140
  209. package/apps/lib/components/Tooltip.tsx +0 -116
  210. package/apps/lib/components/TransparentLabel.tsx +0 -71
  211. package/apps/lib/components/TreeDropDown.tsx +0 -115
  212. package/apps/lib/components/TreeFolder/TreeFolder.tsx +0 -380
  213. package/apps/lib/components/TreeFolder/TreeFolderBreadcrumb.tsx +0 -75
  214. package/apps/lib/components/TreeFolder/TreeFolderRow.tsx +0 -354
  215. package/apps/lib/components/TreeFolder/TreeFolderStyles.tsx +0 -60
  216. package/apps/lib/components/TreeFolder/icons.tsx +0 -60
  217. package/apps/lib/components/TreeFolder/index.ts +0 -24
  218. package/apps/lib/components/TreeFolder/treeFolderUtils.ts +0 -109
  219. package/apps/lib/components/TreeFolder/types.ts +0 -77
  220. package/apps/lib/components/TreeFolder/useTreeFolderDnD.ts +0 -118
  221. package/apps/lib/hooks/useActiveTreeItem.ts +0 -61
  222. package/apps/lib/hooks/useClickOutside.ts +0 -27
  223. package/apps/lib/hooks/useDragDrop.tsx +0 -365
  224. package/apps/lib/hooks/useHtmlDir.ts +0 -31
  225. package/apps/lib/hooks/useInfiniteScroll.ts +0 -108
  226. package/apps/lib/hooks/useIsMobile.ts +0 -21
  227. package/apps/lib/hooks/useResize.ts +0 -67
  228. package/apps/lib/hooks/useTagSelection.ts +0 -300
  229. package/apps/lib/layouts/CNLayout.tsx +0 -372
  230. package/apps/lib/layouts/DataViewCard.tsx +0 -62
  231. package/apps/lib/layouts/FieldSection.tsx +0 -91
  232. package/apps/lib/layouts/TreeSubLayout.tsx +0 -173
  233. package/apps/lib/providers/ThemeProvider.tsx +0 -84
  234. package/apps/lib/registry.json +0 -1217
  235. package/apps/lib/tsconfig.json +0 -9
  236. package/apps/lib/tsconfig.tsbuildinfo +0 -1
  237. package/apps/lib/utils/cn.ts +0 -6
  238. package/apps/lib/utils/color.ts +0 -175
  239. package/apps/lib/utils/dataViews/path.ts +0 -67
  240. package/apps/lib/utils/dataViews/query.ts +0 -73
  241. package/apps/lib/utils/dataViews/types.ts +0 -187
  242. package/apps/lib/utils/dateFormat.ts +0 -108
  243. package/apps/lib/utils/resize.ts +0 -31
  244. package/apps/lib/utils/scroller.ts +0 -26
  245. package/apps/lib/utils/types.ts +0 -16
  246. package/docs/BLOCKS.md +0 -129
  247. package/docs/CHANGELOG-1.1.16.md +0 -108
  248. package/docs/Cover.png +0 -0
  249. package/docs/README.md +0 -215
  250. package/docs/components/action-button.md +0 -638
  251. package/docs/components/actions-group.md +0 -708
  252. package/docs/components/alert-dialog.md +0 -920
  253. package/docs/components/avatar.md +0 -709
  254. package/docs/components/badge-field.md +0 -738
  255. package/docs/components/badge.md +0 -301
  256. package/docs/components/breadcrumb.md +0 -930
  257. package/docs/components/button-group.md +0 -650
  258. package/docs/components/button.md +0 -639
  259. package/docs/components/calendar.md +0 -555
  260. package/docs/components/card.md +0 -622
  261. package/docs/components/chart-block-tool.md +0 -129
  262. package/docs/components/checkbox.md +0 -699
  263. package/docs/components/cn-layout.md +0 -854
  264. package/docs/components/color-picker.md +0 -101
  265. package/docs/components/conclusion-header.md +0 -80
  266. package/docs/components/context-menu.md +0 -483
  267. package/docs/components/count-badge.md +0 -560
  268. package/docs/components/data-table.md +0 -854
  269. package/docs/components/data-views/backend-response.md +0 -324
  270. package/docs/components/data-views/examples/a11y-rtl.md +0 -250
  271. package/docs/components/data-views/examples/api-orders-route.md +0 -130
  272. package/docs/components/data-views/examples/fields.md +0 -362
  273. package/docs/components/data-views/examples/filters.md +0 -307
  274. package/docs/components/data-views/examples/inbox-routing.md +0 -218
  275. package/docs/components/data-views/examples/index.md +0 -29
  276. package/docs/components/data-views/examples/overview.md +0 -244
  277. package/docs/components/data-views/examples/panel.md +0 -212
  278. package/docs/components/data-views/examples/scale.md +0 -231
  279. package/docs/components/data-views/examples/server-side.md +0 -210
  280. package/docs/components/data-views/examples/state.md +0 -250
  281. package/docs/components/data-views/examples/tree-custom.md +0 -388
  282. package/docs/components/data-views/examples/view-registry.md +0 -313
  283. package/docs/components/data-views/examples/views.md +0 -534
  284. package/docs/components/data-views/guide.md +0 -405
  285. package/docs/components/data-views/index.md +0 -1521
  286. package/docs/components/data-views/migration.md +0 -81
  287. package/docs/components/date-picker.md +0 -857
  288. package/docs/components/dialog.md +0 -929
  289. package/docs/components/divider.md +0 -766
  290. package/docs/components/drawer.md +0 -654
  291. package/docs/components/dropdown-menu.md +0 -668
  292. package/docs/components/field-hint.md +0 -898
  293. package/docs/components/field-section.md +0 -781
  294. package/docs/components/form-builder.md +0 -284
  295. package/docs/components/form-renderer.md +0 -396
  296. package/docs/components/form-summary.md +0 -138
  297. package/docs/components/form.md +0 -785
  298. package/docs/components/header-bar.md +0 -188
  299. package/docs/components/image-attachment.md +0 -906
  300. package/docs/components/inner-label-field.md +0 -819
  301. package/docs/components/input-field.md +0 -623
  302. package/docs/components/input-otp.md +0 -756
  303. package/docs/components/input.md +0 -634
  304. package/docs/components/label-field.md +0 -770
  305. package/docs/components/label.md +0 -761
  306. package/docs/components/labeled-check-box.md +0 -642
  307. package/docs/components/labeled-radio.md +0 -796
  308. package/docs/components/link-button.md +0 -685
  309. package/docs/components/login-button.md +0 -872
  310. package/docs/components/password-level.md +0 -803
  311. package/docs/components/popover.md +0 -649
  312. package/docs/components/profile-menu.md +0 -656
  313. package/docs/components/radio-card.md +0 -801
  314. package/docs/components/radio.md +0 -735
  315. package/docs/components/scroll-area.md +0 -691
  316. package/docs/components/search-field.md +0 -702
  317. package/docs/components/searchable-select.md +0 -368
  318. package/docs/components/searchable-table.md +0 -438
  319. package/docs/components/searchable-tree-dialog.md +0 -190
  320. package/docs/components/searchable-tree.md +0 -200
  321. package/docs/components/section-block.md +0 -483
  322. package/docs/components/select.md +0 -709
  323. package/docs/components/simple-select.md +0 -741
  324. package/docs/components/skeleton.md +0 -706
  325. package/docs/components/slide-date-picker.md +0 -837
  326. package/docs/components/spin-loading.md +0 -696
  327. package/docs/components/stepper.md +0 -316
  328. package/docs/components/switch.md +0 -770
  329. package/docs/components/tab-form-item.md +0 -773
  330. package/docs/components/tab-switch.md +0 -170
  331. package/docs/components/table-dnd-wrapper.md +0 -107
  332. package/docs/components/table.md +0 -1088
  333. package/docs/components/text-editor.md +0 -735
  334. package/docs/components/textarea.md +0 -681
  335. package/docs/components/timeline.md +0 -254
  336. package/docs/components/toast.md +0 -773
  337. package/docs/components/toggle-button.md +0 -643
  338. package/docs/components/toggle.md +0 -882
  339. package/docs/components/tooltip.md +0 -513
  340. package/docs/components/transparent-label.md +0 -721
  341. package/docs/components/tree-drop-down.md +0 -740
  342. package/docs/components/tree-folder.md +0 -110
  343. package/docs/components/tree-sub-layout.md +0 -707
  344. package/docs/explanation/architecture.md +0 -54
  345. package/docs/explanation/design-system.md +0 -52
  346. package/docs/how-to/form-and-list-recipes.md +0 -386
  347. package/docs/how-to/forms-with-form-builder.md +0 -472
  348. package/docs/how-to/guides.md +0 -1027
  349. package/docs/migration/changelog.md +0 -60
  350. package/docs/migration/form-builder-2.5.2.md +0 -113
  351. package/docs/reference/cli.md +0 -112
  352. package/docs/reference/components.md +0 -572
  353. package/docs/reference/hooks.md +0 -1523
  354. package/docs/reference/providers.md +0 -866
  355. package/docs/reference/tailwind-plugins.md +0 -942
  356. package/docs/reference/theme.md +0 -85
  357. package/docs/reference/types.md +0 -1016
  358. package/docs/reference/utilities.md +0 -726
  359. package/docs/tutorials/building-first-form.md +0 -846
  360. package/docs/tutorials/component-composition.md +0 -882
  361. package/docs/tutorials/getting-started.md +0 -302
  362. package/docs/tutorials/theming-basics.md +0 -785
@@ -1,930 +0,0 @@
1
- ---
2
- name: Breadcrumb
3
- version: 2.4.5
4
- status: stable
5
- category: components/navigation
6
- tags: [navigation, breadcrumb, wayfinding, compound, accessible, rtl]
7
- last-reviewed: 2024-11-05
8
- bundle-size: 2.2kb
9
- dependencies:
10
- - "@radix-ui/react-slot": "^1.0.0"
11
- - "class-variance-authority": "^0.7.0"
12
- ---
13
-
14
- # Breadcrumb
15
-
16
- > A compound breadcrumb navigation component with seven sub-components for building flexible, accessible breadcrumb trails. Supports multiple sizes, two style variants, the asChild pattern for custom link components, and collapsible ellipsis for long paths.
17
-
18
- ## Installation
19
-
20
- TORCH Glare is a copy-in library: the CLI copies this component's source into your project
21
- (you do **not** install it from the npm package). Run `init` once, then `add`:
22
-
23
- ```bash
24
- npx torch-glare@latest init
25
- npx torch-glare@latest add Breadcrumb
26
- ```
27
-
28
- `add` also copies any components, hooks, and utilities that `Breadcrumb` depends on.
29
-
30
- ## Import
31
-
32
- Import from your project's local path — the alias configured in `glare.json` (e.g. `@/*`):
33
-
34
- ```tsx
35
- import { Breadcrumb } from "@/components/Breadcrumb";
36
- ```
37
-
38
- ## Quick Examples
39
-
40
- ### Basic Usage
41
-
42
- ```typescript
43
- import { Breadcrumb, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator } from "@/components/Breadcrumb";
44
-
45
- function Example() {
46
- return (
47
- <Breadcrumb>
48
- <BreadcrumbList>
49
- <BreadcrumbItem>
50
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
51
- </BreadcrumbItem>
52
- <BreadcrumbSeparator />
53
- <BreadcrumbItem>
54
- <BreadcrumbLink href="/products">Products</BreadcrumbLink>
55
- </BreadcrumbItem>
56
- <BreadcrumbSeparator />
57
- <BreadcrumbItem>
58
- <BreadcrumbPage>Current Product</BreadcrumbPage>
59
- </BreadcrumbItem>
60
- </BreadcrumbList>
61
- </Breadcrumb>
62
- )
63
- }
64
- ```
65
-
66
- ### With Different Sizes
67
-
68
- ```typescript
69
- // Small
70
- <Breadcrumb>
71
- <BreadcrumbList size="S">
72
- <BreadcrumbItem>
73
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
74
- </BreadcrumbItem>
75
- <BreadcrumbSeparator />
76
- <BreadcrumbItem>
77
- <BreadcrumbPage>Page</BreadcrumbPage>
78
- </BreadcrumbItem>
79
- </BreadcrumbList>
80
- </Breadcrumb>
81
-
82
- // Medium (default)
83
- <Breadcrumb>
84
- <BreadcrumbList size="M">
85
- <BreadcrumbItem>
86
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
87
- </BreadcrumbItem>
88
- <BreadcrumbSeparator />
89
- <BreadcrumbItem>
90
- <BreadcrumbPage>Page</BreadcrumbPage>
91
- </BreadcrumbItem>
92
- </BreadcrumbList>
93
- </Breadcrumb>
94
-
95
- // Large
96
- <Breadcrumb>
97
- <BreadcrumbList size="L">
98
- <BreadcrumbItem>
99
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
100
- </BreadcrumbItem>
101
- <BreadcrumbSeparator />
102
- <BreadcrumbItem>
103
- <BreadcrumbPage>Page</BreadcrumbPage>
104
- </BreadcrumbItem>
105
- </BreadcrumbList>
106
- </Breadcrumb>
107
- ```
108
-
109
- ### With SystemStyle Variant
110
-
111
- ```typescript
112
- <Breadcrumb>
113
- <BreadcrumbList>
114
- <BreadcrumbItem>
115
- <BreadcrumbLink variant="SystemStyle" href="/">Home</BreadcrumbLink>
116
- </BreadcrumbItem>
117
- <BreadcrumbSeparator variant="SystemStyle" />
118
- <BreadcrumbItem>
119
- <BreadcrumbLink variant="SystemStyle" href="/docs">Docs</BreadcrumbLink>
120
- </BreadcrumbItem>
121
- <BreadcrumbSeparator variant="SystemStyle" />
122
- <BreadcrumbItem>
123
- <BreadcrumbPage variant="SystemStyle">API</BreadcrumbPage>
124
- </BreadcrumbItem>
125
- </BreadcrumbList>
126
- </Breadcrumb>
127
- ```
128
-
129
- ### With Ellipsis (Collapsed Items)
130
-
131
- ```typescript
132
- <Breadcrumb>
133
- <BreadcrumbList>
134
- <BreadcrumbItem>
135
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
136
- </BreadcrumbItem>
137
- <BreadcrumbSeparator />
138
- <BreadcrumbItem>
139
- <BreadcrumbEllipsis />
140
- </BreadcrumbItem>
141
- <BreadcrumbSeparator />
142
- <BreadcrumbItem>
143
- <BreadcrumbLink href="/category/subcategory">Subcategory</BreadcrumbLink>
144
- </BreadcrumbItem>
145
- <BreadcrumbSeparator />
146
- <BreadcrumbItem>
147
- <BreadcrumbPage>Current Page</BreadcrumbPage>
148
- </BreadcrumbItem>
149
- </BreadcrumbList>
150
- </Breadcrumb>
151
- ```
152
-
153
- ### With Custom Separator
154
-
155
- ```typescript
156
- <Breadcrumb>
157
- <BreadcrumbList>
158
- <BreadcrumbItem>
159
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
160
- </BreadcrumbItem>
161
- <BreadcrumbSeparator>
162
- <i className="ri-arrow-right-s-line" />
163
- </BreadcrumbSeparator>
164
- <BreadcrumbItem>
165
- <BreadcrumbLink href="/docs">Docs</BreadcrumbLink>
166
- </BreadcrumbItem>
167
- <BreadcrumbSeparator>
168
- /
169
- </BreadcrumbSeparator>
170
- <BreadcrumbItem>
171
- <BreadcrumbPage>Guide</BreadcrumbPage>
172
- </BreadcrumbItem>
173
- </BreadcrumbList>
174
- </Breadcrumb>
175
- ```
176
-
177
- ### With asChild (Custom Link Component)
178
-
179
- ```typescript
180
- import Link from 'next/link'
181
-
182
- <Breadcrumb>
183
- <BreadcrumbList>
184
- <BreadcrumbItem>
185
- <BreadcrumbLink asChild>
186
- <Link href="/">Home</Link>
187
- </BreadcrumbLink>
188
- </BreadcrumbItem>
189
- <BreadcrumbSeparator />
190
- <BreadcrumbItem>
191
- <BreadcrumbLink asChild>
192
- <Link href="/products">Products</Link>
193
- </BreadcrumbLink>
194
- </BreadcrumbItem>
195
- <BreadcrumbSeparator />
196
- <BreadcrumbItem>
197
- <BreadcrumbPage>Details</BreadcrumbPage>
198
- </BreadcrumbItem>
199
- </BreadcrumbList>
200
- </Breadcrumb>
201
- ```
202
-
203
- ### With Theme Override
204
-
205
- ```typescript
206
- <Breadcrumb theme="dark">
207
- <BreadcrumbList>
208
- <BreadcrumbItem>
209
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
210
- </BreadcrumbItem>
211
- <BreadcrumbSeparator />
212
- <BreadcrumbItem>
213
- <BreadcrumbPage>Dark Page</BreadcrumbPage>
214
- </BreadcrumbItem>
215
- </BreadcrumbList>
216
- </Breadcrumb>
217
- ```
218
-
219
- ### With Icons
220
-
221
- ```typescript
222
- <Breadcrumb>
223
- <BreadcrumbList>
224
- <BreadcrumbItem>
225
- <BreadcrumbLink href="/">
226
- <i className="ri-home-line mr-1" />
227
- Home
228
- </BreadcrumbLink>
229
- </BreadcrumbItem>
230
- <BreadcrumbSeparator />
231
- <BreadcrumbItem>
232
- <BreadcrumbLink href="/settings">
233
- <i className="ri-settings-line mr-1" />
234
- Settings
235
- </BreadcrumbLink>
236
- </BreadcrumbItem>
237
- <BreadcrumbSeparator />
238
- <BreadcrumbItem>
239
- <BreadcrumbPage>
240
- <i className="ri-user-line mr-1" />
241
- Profile
242
- </BreadcrumbPage>
243
- </BreadcrumbItem>
244
- </BreadcrumbList>
245
- </Breadcrumb>
246
- ```
247
-
248
- ## API Reference
249
-
250
- ### Breadcrumb (Root)
251
-
252
- | Prop | Type | Default | Description |
253
- |------|------|---------|-------------|
254
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme for the breadcrumb |
255
- | `className` | `string` | - | Additional CSS classes |
256
-
257
- Renders a `<nav>` element with `aria-label="breadcrumb"`.
258
-
259
- ### BreadcrumbList
260
-
261
- | Prop | Type | Default | Description |
262
- |------|------|---------|-------------|
263
- | `size` | `'S' \| 'M' \| 'L'` | `'M'` | Text size and gap spacing |
264
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme |
265
- | `className` | `string` | - | Additional CSS classes |
266
-
267
- Renders an `<ol>` element with flex-wrap layout.
268
-
269
- ### BreadcrumbItem
270
-
271
- | Prop | Type | Default | Description |
272
- |------|------|---------|-------------|
273
- | `className` | `string` | - | Additional CSS classes |
274
-
275
- Renders an `<li>` element with inline-flex alignment.
276
-
277
- ### BreadcrumbLink
278
-
279
- | Prop | Type | Default | Description |
280
- |------|------|---------|-------------|
281
- | `variant` | `'PresentationStyle' \| 'SystemStyle'` | `'PresentationStyle'` | Visual style variant |
282
- | `asChild` | `boolean` | `false` | Merge props onto child element (Slot pattern) |
283
- | `href` | `string` | - | Link destination URL |
284
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme |
285
- | `className` | `string` | - | Additional CSS classes |
286
-
287
- Renders an `<a>` element (or child via Slot when `asChild` is true).
288
-
289
- ### BreadcrumbPage
290
-
291
- | Prop | Type | Default | Description |
292
- |------|------|---------|-------------|
293
- | `variant` | `'PresentationStyle' \| 'SystemStyle'` | `'PresentationStyle'` | Visual style variant |
294
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme |
295
- | `className` | `string` | - | Additional CSS classes |
296
-
297
- Renders a `<span>` with `aria-current="page"` and `aria-disabled="true"`.
298
-
299
- ### BreadcrumbSeparator
300
-
301
- | Prop | Type | Default | Description |
302
- |------|------|---------|-------------|
303
- | `variant` | `'PresentationStyle' \| 'SystemStyle'` | `'PresentationStyle'` | Visual style variant |
304
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme |
305
- | `children` | `React.ReactNode` | `<i className="ri-arrow-right-s-line" />` | Custom separator content |
306
- | `className` | `string` | - | Additional CSS classes |
307
-
308
- Renders an `<li>` with `role="presentation"` and `aria-hidden="true"`. Defaults to a right-arrow icon.
309
-
310
- ### BreadcrumbEllipsis
311
-
312
- | Prop | Type | Default | Description |
313
- |------|------|---------|-------------|
314
- | `variant` | `'PresentationStyle' \| 'SystemStyle'` | `'PresentationStyle'` | Visual style variant |
315
- | `theme` | `'light' \| 'dark' \| 'default'` | - | Override theme |
316
- | `className` | `string` | - | Additional CSS classes |
317
-
318
- Renders a `<span>` with `role="presentation"`, `aria-hidden="true"`, and a "More" screen-reader label. Displays a `ri-more-line` icon.
319
-
320
- ### Size Variants (BreadcrumbList)
321
-
322
- | Size | Text Size | Gap |
323
- |------|-----------|-----|
324
- | S | 12px | 4px (gap-1) |
325
- | M | 14px | 6px (gap-1.5) |
326
- | L | 16px | 8px (gap-2) |
327
-
328
- ### TypeScript
329
-
330
- ```typescript
331
- import { ComponentPropsWithoutRef } from 'react'
332
- import { VariantProps } from 'class-variance-authority'
333
-
334
- type Themes = 'light' | 'dark' | 'default'
335
-
336
- interface BreadcrumbProps extends ComponentPropsWithoutRef<'nav'> {
337
- theme?: Themes
338
- separator?: React.ReactNode
339
- }
340
-
341
- interface BreadcrumbListProps
342
- extends ComponentPropsWithoutRef<'ol'>,
343
- VariantProps<typeof breadcrumbListStyles> {
344
- theme?: Themes
345
- }
346
-
347
- interface BreadcrumbLinkProps
348
- extends ComponentPropsWithoutRef<'a'>,
349
- VariantProps<typeof breadcrumbLinkStyles> {
350
- asChild?: boolean
351
- theme?: Themes
352
- }
353
-
354
- interface BreadcrumbPageProps
355
- extends ComponentPropsWithoutRef<'span'>,
356
- VariantProps<typeof breadcrumbPageStyles> {
357
- theme?: Themes
358
- }
359
-
360
- interface BreadcrumbSeparatorProps
361
- extends ComponentPropsWithoutRef<'li'>,
362
- VariantProps<typeof breadcrumbSeparatorStyles> {
363
- theme?: Themes
364
- }
365
-
366
- interface BreadcrumbEllipsisProps
367
- extends ComponentPropsWithoutRef<'span'>,
368
- VariantProps<typeof breadcrumbEllipsisStyles> {
369
- theme?: Themes
370
- }
371
-
372
- export const Breadcrumb: React.ForwardRefExoticComponent<
373
- BreadcrumbProps & React.RefAttributes<HTMLElement>
374
- >
375
- export const BreadcrumbList: React.ForwardRefExoticComponent<
376
- BreadcrumbListProps & React.RefAttributes<HTMLOListElement>
377
- >
378
- export const BreadcrumbItem: React.ForwardRefExoticComponent<
379
- ComponentPropsWithoutRef<'li'> & React.RefAttributes<HTMLLIElement>
380
- >
381
- export const BreadcrumbLink: React.ForwardRefExoticComponent<
382
- BreadcrumbLinkProps & React.RefAttributes<HTMLAnchorElement>
383
- >
384
- export const BreadcrumbPage: React.ForwardRefExoticComponent<
385
- BreadcrumbPageProps & React.RefAttributes<HTMLSpanElement>
386
- >
387
- export const BreadcrumbSeparator: React.ForwardRefExoticComponent<
388
- BreadcrumbSeparatorProps & React.RefAttributes<HTMLLIElement>
389
- >
390
- export const BreadcrumbEllipsis: React.ForwardRefExoticComponent<
391
- BreadcrumbEllipsisProps & React.RefAttributes<HTMLSpanElement>
392
- >
393
-
394
- export {
395
- breadcrumbListStyles,
396
- breadcrumbLinkStyles,
397
- breadcrumbPageStyles,
398
- breadcrumbSeparatorStyles,
399
- breadcrumbEllipsisStyles,
400
- }
401
- ```
402
-
403
- ## Common Patterns
404
-
405
- ### Dynamic Breadcrumb from Route
406
-
407
- ```typescript
408
- function DynamicBreadcrumb({ segments }: { segments: { label: string; href: string }[] }) {
409
- return (
410
- <Breadcrumb>
411
- <BreadcrumbList>
412
- {segments.map((segment, index) => {
413
- const isLast = index === segments.length - 1
414
-
415
- return (
416
- <React.Fragment key={segment.href}>
417
- <BreadcrumbItem>
418
- {isLast ? (
419
- <BreadcrumbPage>{segment.label}</BreadcrumbPage>
420
- ) : (
421
- <BreadcrumbLink href={segment.href}>
422
- {segment.label}
423
- </BreadcrumbLink>
424
- )}
425
- </BreadcrumbItem>
426
- {!isLast && <BreadcrumbSeparator />}
427
- </React.Fragment>
428
- )
429
- })}
430
- </BreadcrumbList>
431
- </Breadcrumb>
432
- )
433
- }
434
-
435
- // Usage
436
- <DynamicBreadcrumb
437
- segments={[
438
- { label: 'Home', href: '/' },
439
- { label: 'Products', href: '/products' },
440
- { label: 'Electronics', href: '/products/electronics' },
441
- { label: 'Laptops', href: '/products/electronics/laptops' },
442
- ]}
443
- />
444
- ```
445
-
446
- ### Collapsible Breadcrumb with Dropdown
447
-
448
- ```typescript
449
- import { DropdownMenu } from "@/components/DropdownMenu";
450
-
451
- function CollapsibleBreadcrumb({
452
- items,
453
- maxVisible = 3
454
- }: {
455
- items: { label: string; href: string }[]
456
- maxVisible?: number
457
- }) {
458
- const shouldCollapse = items.length > maxVisible
459
- const visibleStart = items.slice(0, 1)
460
- const collapsed = shouldCollapse ? items.slice(1, items.length - (maxVisible - 1)) : []
461
- const visibleEnd = shouldCollapse ? items.slice(items.length - (maxVisible - 1)) : items.slice(1)
462
-
463
- return (
464
- <Breadcrumb>
465
- <BreadcrumbList>
466
- {/* First item always visible */}
467
- {visibleStart.map((item) => (
468
- <React.Fragment key={item.href}>
469
- <BreadcrumbItem>
470
- <BreadcrumbLink href={item.href}>{item.label}</BreadcrumbLink>
471
- </BreadcrumbItem>
472
- <BreadcrumbSeparator />
473
- </React.Fragment>
474
- ))}
475
-
476
- {/* Collapsed items shown as ellipsis */}
477
- {collapsed.length > 0 && (
478
- <>
479
- <BreadcrumbItem>
480
- <DropdownMenu>
481
- <DropdownMenu.Trigger asChild>
482
- <BreadcrumbEllipsis />
483
- </DropdownMenu.Trigger>
484
- <DropdownMenu.Content>
485
- {collapsed.map((item) => (
486
- <DropdownMenu.Item key={item.href} asChild>
487
- <a href={item.href}>{item.label}</a>
488
- </DropdownMenu.Item>
489
- ))}
490
- </DropdownMenu.Content>
491
- </DropdownMenu>
492
- </BreadcrumbItem>
493
- <BreadcrumbSeparator />
494
- </>
495
- )}
496
-
497
- {/* Remaining visible items */}
498
- {visibleEnd.map((item, index) => {
499
- const isLast = index === visibleEnd.length - 1
500
- return (
501
- <React.Fragment key={item.href}>
502
- <BreadcrumbItem>
503
- {isLast ? (
504
- <BreadcrumbPage>{item.label}</BreadcrumbPage>
505
- ) : (
506
- <BreadcrumbLink href={item.href}>{item.label}</BreadcrumbLink>
507
- )}
508
- </BreadcrumbItem>
509
- {!isLast && <BreadcrumbSeparator />}
510
- </React.Fragment>
511
- )
512
- })}
513
- </BreadcrumbList>
514
- </Breadcrumb>
515
- )
516
- }
517
- ```
518
-
519
- ### Next.js App Router Integration
520
-
521
- ```typescript
522
- 'use client'
523
-
524
- import { usePathname } from 'next/navigation'
525
- import Link from 'next/link'
526
-
527
- function AppBreadcrumb() {
528
- const pathname = usePathname()
529
- const segments = pathname.split('/').filter(Boolean)
530
-
531
- return (
532
- <Breadcrumb>
533
- <BreadcrumbList>
534
- <BreadcrumbItem>
535
- <BreadcrumbLink asChild>
536
- <Link href="/">Home</Link>
537
- </BreadcrumbLink>
538
- </BreadcrumbItem>
539
-
540
- {segments.map((segment, index) => {
541
- const href = '/' + segments.slice(0, index + 1).join('/')
542
- const isLast = index === segments.length - 1
543
- const label = segment.charAt(0).toUpperCase() + segment.slice(1).replace(/-/g, ' ')
544
-
545
- return (
546
- <React.Fragment key={href}>
547
- <BreadcrumbSeparator />
548
- <BreadcrumbItem>
549
- {isLast ? (
550
- <BreadcrumbPage>{label}</BreadcrumbPage>
551
- ) : (
552
- <BreadcrumbLink asChild>
553
- <Link href={href}>{label}</Link>
554
- </BreadcrumbLink>
555
- )}
556
- </BreadcrumbItem>
557
- </React.Fragment>
558
- )
559
- })}
560
- </BreadcrumbList>
561
- </Breadcrumb>
562
- )
563
- }
564
- ```
565
-
566
- ### File Explorer Breadcrumb
567
-
568
- ```typescript
569
- function FileExplorerBreadcrumb({
570
- path,
571
- onNavigate
572
- }: {
573
- path: string[]
574
- onNavigate: (index: number) => void
575
- }) {
576
- return (
577
- <Breadcrumb>
578
- <BreadcrumbList size="S">
579
- <BreadcrumbItem>
580
- <BreadcrumbLink
581
- href="#"
582
- onClick={(e) => { e.preventDefault(); onNavigate(-1) }}
583
- >
584
- <i className="ri-folder-line mr-1" />
585
- Root
586
- </BreadcrumbLink>
587
- </BreadcrumbItem>
588
-
589
- {path.map((folder, index) => {
590
- const isLast = index === path.length - 1
591
- return (
592
- <React.Fragment key={index}>
593
- <BreadcrumbSeparator />
594
- <BreadcrumbItem>
595
- {isLast ? (
596
- <BreadcrumbPage>
597
- <i className="ri-folder-open-line mr-1" />
598
- {folder}
599
- </BreadcrumbPage>
600
- ) : (
601
- <BreadcrumbLink
602
- href="#"
603
- onClick={(e) => { e.preventDefault(); onNavigate(index) }}
604
- >
605
- <i className="ri-folder-line mr-1" />
606
- {folder}
607
- </BreadcrumbLink>
608
- )}
609
- </BreadcrumbItem>
610
- </React.Fragment>
611
- )
612
- })}
613
- </BreadcrumbList>
614
- </Breadcrumb>
615
- )
616
- }
617
- ```
618
-
619
- ## Testing
620
-
621
- ### Unit Test Example
622
-
623
- ```typescript
624
- import { render, screen } from '@testing-library/react'
625
- import { Breadcrumb, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis } from "@/components/Breadcrumb";
626
-
627
- describe('Breadcrumb', () => {
628
- it('renders navigation landmark', () => {
629
- render(
630
- <Breadcrumb>
631
- <BreadcrumbList>
632
- <BreadcrumbItem>
633
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
634
- </BreadcrumbItem>
635
- </BreadcrumbList>
636
- </Breadcrumb>
637
- )
638
-
639
- expect(screen.getByRole('navigation')).toHaveAttribute('aria-label', 'breadcrumb')
640
- })
641
-
642
- it('renders links as anchors', () => {
643
- render(
644
- <Breadcrumb>
645
- <BreadcrumbList>
646
- <BreadcrumbItem>
647
- <BreadcrumbLink href="/test">Test</BreadcrumbLink>
648
- </BreadcrumbItem>
649
- </BreadcrumbList>
650
- </Breadcrumb>
651
- )
652
-
653
- const link = screen.getByText('Test')
654
- expect(link.tagName).toBe('A')
655
- expect(link).toHaveAttribute('href', '/test')
656
- })
657
-
658
- it('marks current page with aria-current', () => {
659
- render(
660
- <Breadcrumb>
661
- <BreadcrumbList>
662
- <BreadcrumbItem>
663
- <BreadcrumbPage>Current</BreadcrumbPage>
664
- </BreadcrumbItem>
665
- </BreadcrumbList>
666
- </Breadcrumb>
667
- )
668
-
669
- const page = screen.getByText('Current')
670
- expect(page).toHaveAttribute('aria-current', 'page')
671
- expect(page).toHaveAttribute('aria-disabled', 'true')
672
- })
673
-
674
- it('hides separators from accessibility tree', () => {
675
- const { container } = render(
676
- <Breadcrumb>
677
- <BreadcrumbList>
678
- <BreadcrumbItem>
679
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
680
- </BreadcrumbItem>
681
- <BreadcrumbSeparator />
682
- <BreadcrumbItem>
683
- <BreadcrumbPage>Page</BreadcrumbPage>
684
- </BreadcrumbItem>
685
- </BreadcrumbList>
686
- </Breadcrumb>
687
- )
688
-
689
- const separator = container.querySelector('[role="presentation"]')
690
- expect(separator).toHaveAttribute('aria-hidden', 'true')
691
- })
692
-
693
- it('renders ellipsis with screen reader text', () => {
694
- render(
695
- <Breadcrumb>
696
- <BreadcrumbList>
697
- <BreadcrumbItem>
698
- <BreadcrumbEllipsis />
699
- </BreadcrumbItem>
700
- </BreadcrumbList>
701
- </Breadcrumb>
702
- )
703
-
704
- expect(screen.getByText('More')).toHaveClass('sr-only')
705
- })
706
-
707
- it('applies size variant to list', () => {
708
- const { container } = render(
709
- <Breadcrumb>
710
- <BreadcrumbList size="L">
711
- <BreadcrumbItem>
712
- <BreadcrumbPage>Page</BreadcrumbPage>
713
- </BreadcrumbItem>
714
- </BreadcrumbList>
715
- </Breadcrumb>
716
- )
717
-
718
- const list = container.querySelector('ol')
719
- expect(list).toHaveClass('text-[16px]', 'gap-2')
720
- })
721
- })
722
- ```
723
-
724
- ### Accessibility Test
725
-
726
- ```typescript
727
- import { axe } from '@axe-core/react'
728
-
729
- test('Breadcrumb meets WCAG standards', async () => {
730
- const { container } = render(
731
- <Breadcrumb>
732
- <BreadcrumbList>
733
- <BreadcrumbItem>
734
- <BreadcrumbLink href="/">Home</BreadcrumbLink>
735
- </BreadcrumbItem>
736
- <BreadcrumbSeparator />
737
- <BreadcrumbItem>
738
- <BreadcrumbPage>Current Page</BreadcrumbPage>
739
- </BreadcrumbItem>
740
- </BreadcrumbList>
741
- </Breadcrumb>
742
- )
743
-
744
- const results = await axe(container)
745
- expect(results).toHaveNoViolations()
746
- })
747
- ```
748
-
749
- ## Accessibility
750
-
751
- ### Semantic HTML
752
-
753
- The Breadcrumb component renders proper semantic structure:
754
-
755
- ```html
756
- <nav aria-label="breadcrumb">
757
- <ol>
758
- <li>
759
- <a href="/">Home</a>
760
- </li>
761
- <li role="presentation" aria-hidden="true">
762
- <!-- separator icon -->
763
- </li>
764
- <li>
765
- <span role="link" aria-disabled="true" aria-current="page">
766
- Current Page
767
- </span>
768
- </li>
769
- </ol>
770
- </nav>
771
- ```
772
-
773
- ### ARIA Attributes
774
-
775
- - `<nav aria-label="breadcrumb">`: Identifies the navigation landmark
776
- - `<span aria-current="page">`: Marks the current page in the trail
777
- - `<span aria-disabled="true">`: Indicates the current page is not interactive
778
- - `<li role="presentation" aria-hidden="true">`: Hides decorative separators
779
- - `<span role="presentation" aria-hidden="true">`: Hides decorative ellipsis
780
-
781
- ### Keyboard Support
782
-
783
- - **Tab**: Navigate between breadcrumb links
784
- - **Enter**: Activate focused link
785
- - **Space**: Activate focused link
786
-
787
- ### Screen Reader Support
788
-
789
- - Navigation landmark announced as "breadcrumb"
790
- - Links are announced with their text content
791
- - Current page announced with "current page" semantics
792
- - Separators and ellipsis hidden from screen readers
793
- - "More" label provided for ellipsis via `sr-only` text
794
-
795
- ### Best Practices
796
-
797
- ```typescript
798
- // Use BreadcrumbPage for the current/last item (not a link)
799
- <BreadcrumbPage>Current Page</BreadcrumbPage>
800
-
801
- // Use BreadcrumbLink for navigable items
802
- <BreadcrumbLink href="/path">Navigable</BreadcrumbLink>
803
-
804
- // Use asChild with framework routing components
805
- <BreadcrumbLink asChild>
806
- <Link href="/path">Next.js Link</Link>
807
- </BreadcrumbLink>
808
- ```
809
-
810
- ## Styling
811
-
812
- ### Variant Styles
813
-
814
- #### PresentationStyle (Default)
815
-
816
- - **Links**: `text-content-presentation-global-secondary`, hover to `text-content-presentation-global-primary`
817
- - **Current Page**: `text-content-presentation-global-primary`
818
- - **Separator**: `text-content-presentation-global-secondary`
819
- - **Ellipsis**: hover `bg-background-presentation-action-hover`
820
-
821
- #### SystemStyle
822
-
823
- - **Links**: `text-content-system-global-secondary`, hover to `text-content-system-global-primary`
824
- - **Current Page**: `text-content-system-global-primary`
825
- - **Separator**: `text-content-system-global-secondary`
826
- - **Ellipsis**: hover `bg-background-system-action-secondary-hover`
827
-
828
- ### Link Interactions
829
-
830
- ```css
831
- /* Links have hover underline and focus ring */
832
- hover:underline
833
- focus-visible:ring-2
834
- focus-visible:ring-border-presentation-state-focus
835
- focus-visible:rounded-[2px]
836
- ```
837
-
838
- ### Ellipsis Dimensions
839
-
840
- ```css
841
- /* Fixed 24x24px clickable area with rounded corners */
842
- w-6 h-6
843
- rounded-[4px]
844
- cursor-pointer
845
- ```
846
-
847
- ### Custom Styles
848
-
849
- ```typescript
850
- <Breadcrumb className="bg-gray-50 px-4 py-2 rounded-lg">
851
- <BreadcrumbList>
852
- <BreadcrumbItem>
853
- <BreadcrumbLink href="/" className="text-blue-600">Home</BreadcrumbLink>
854
- </BreadcrumbItem>
855
- <BreadcrumbSeparator className="text-gray-400" />
856
- <BreadcrumbItem>
857
- <BreadcrumbPage className="font-bold">Page</BreadcrumbPage>
858
- </BreadcrumbItem>
859
- </BreadcrumbList>
860
- </Breadcrumb>
861
- ```
862
-
863
- ## Performance
864
-
865
- | Metric | Value |
866
- |--------|-------|
867
- | Bundle size (gzip) | 2.2kb |
868
- | First render | <5ms |
869
- | Re-render | <2ms |
870
- | Tree-shakeable | Yes |
871
-
872
- ### Optimization Tips
873
-
874
- 1. Use `React.Fragment` with keys for dynamic breadcrumb generation
875
- 2. Memoize breadcrumb segments if derived from expensive computations
876
- 3. Use `asChild` pattern to avoid extra DOM nodes when integrating with routers
877
-
878
- ## Troubleshooting
879
-
880
- ### Links not navigating with Next.js
881
-
882
- **Solution:** Use the `asChild` prop to pass props to your framework's Link component:
883
-
884
- ```typescript
885
- <BreadcrumbLink asChild>
886
- <Link href="/path">Page</Link>
887
- </BreadcrumbLink>
888
- ```
889
-
890
- ### Separator icon not showing
891
-
892
- **Solution:** Ensure Remix Icon CSS is loaded. The default separator uses `ri-arrow-right-s-line`. Alternatively, provide custom separator content:
893
-
894
- ```typescript
895
- <BreadcrumbSeparator>/</BreadcrumbSeparator>
896
- ```
897
-
898
- ### Breadcrumb wrapping on small screens
899
-
900
- **Solution:** The BreadcrumbList uses `flex-wrap` by default. To prevent wrapping, add `flex-nowrap` and `overflow-hidden`:
901
-
902
- ```typescript
903
- <BreadcrumbList className="flex-nowrap overflow-hidden">
904
- {/* items */}
905
- </BreadcrumbList>
906
- ```
907
-
908
- ## Related Components
909
-
910
- - [DropdownMenu](/docs/components/dropdown-menu.md) - Combine with BreadcrumbEllipsis for collapsed items
911
- - [LinkButton](/docs/components/link-button.md) - Styled link actions
912
- - [Button](/docs/components/button.md) - Action buttons
913
-
914
- ## Browser Support
915
-
916
- - Chrome 90+
917
- - Firefox 88+
918
- - Safari 14+
919
- - Edge 90+
920
- - Mobile browsers
921
-
922
- ## Changelog
923
-
924
- ### v1.1.15
925
- - Initial stable release
926
- - 7 sub-components (Breadcrumb, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis)
927
- - 2 style variants (PresentationStyle, SystemStyle)
928
- - 3 list size variants (S, M, L)
929
- - asChild pattern for custom link components
930
- - Full accessibility with ARIA attributes and semantic HTML