@ahrowe/ui 0.41.2 → 0.43.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 (328) hide show
  1. package/CHANGELOG.md +934 -0
  2. package/README.md +11 -10
  3. package/dist/cjs-types/common/accordion/accordion.types.d.ts +17 -2
  4. package/dist/cjs-types/common/actionButtons/actionButtons.types.d.ts +7 -1
  5. package/dist/cjs-types/common/actionIcon/actionIcon.d.ts +1 -1
  6. package/dist/cjs-types/common/actionIcon/actionIcon.types.d.ts +7 -9
  7. package/dist/cjs-types/common/alert/alert.types.d.ts +6 -8
  8. package/dist/cjs-types/common/animatedLogo/animatedLogo.types.d.ts +3 -2
  9. package/dist/cjs-types/common/badge/badge.types.d.ts +10 -6
  10. package/dist/cjs-types/common/button/button.types.d.ts +14 -4
  11. package/dist/cjs-types/common/calendar/calendar.types.d.ts +25 -10
  12. package/dist/cjs-types/common/calendar/components/agendaList/agendaList.d.ts +1 -1
  13. package/dist/cjs-types/common/calendar/components/agendaList/agendaList.types.d.ts +3 -0
  14. package/dist/cjs-types/common/calendar/components/calendarHeader/calendarHeader.d.ts +1 -1
  15. package/dist/cjs-types/common/calendar/components/calendarHeader/calendarHeader.types.d.ts +2 -0
  16. package/dist/cjs-types/common/calendar/components/compactMonth/compactMonth.d.ts +1 -1
  17. package/dist/cjs-types/common/calendar/components/monthView/monthView.d.ts +1 -1
  18. package/dist/cjs-types/common/calendar/components/monthView/monthView.types.d.ts +3 -2
  19. package/dist/cjs-types/common/calendar/components/timeGrid/timeGrid.d.ts +1 -1
  20. package/dist/cjs-types/common/calendar/components/timeGrid/timeGrid.types.d.ts +9 -1
  21. package/dist/cjs-types/common/calendar/dates.d.ts +21 -5
  22. package/dist/cjs-types/common/calendar/format.d.ts +3 -2
  23. package/dist/cjs-types/common/calendar/layout.d.ts +5 -0
  24. package/dist/cjs-types/common/calendar/useNow.d.ts +4 -0
  25. package/dist/cjs-types/common/calendar/view.types.d.ts +9 -2
  26. package/dist/cjs-types/common/card/card.types.d.ts +16 -2
  27. package/dist/cjs-types/common/chip/chip.types.d.ts +10 -5
  28. package/dist/cjs-types/common/copyButton/copyButton.types.d.ts +5 -4
  29. package/dist/cjs-types/common/fab/components/fabBase/fabBase.d.ts +1 -1
  30. package/dist/cjs-types/common/fab/components/fabBase/fabBase.types.d.ts +2 -1
  31. package/dist/cjs-types/common/floorPlan/floorPlan.graph.d.ts +10 -3
  32. package/dist/cjs-types/common/floorPlan/floorPlan.plan.d.ts +5 -0
  33. package/dist/cjs-types/common/floorPlan/floorPlan.rooms.d.ts +6 -2
  34. package/dist/cjs-types/common/floorPlan/floorPlan.snap.d.ts +1 -3
  35. package/dist/cjs-types/common/floorPlan/index.d.ts +1 -3
  36. package/dist/cjs-types/common/planCanvas/planCanvas.types.d.ts +1 -1
  37. package/dist/cjs-types/common/progressBar/progressBar.d.ts +0 -1
  38. package/dist/cjs-types/common/progressBar/progressBar.types.d.ts +3 -1
  39. package/dist/cjs-types/common/roomDrawer/roomDrawer.types.d.ts +29 -8
  40. package/dist/cjs-types/common/roomViewer/roomViewer.types.d.ts +4 -2
  41. package/dist/cjs-types/common/splitButton/splitButton.types.d.ts +4 -1
  42. package/dist/cjs-types/common/styles/tone.d.ts +11 -0
  43. package/dist/cjs-types/common/themeProvider/color.types.d.ts +20 -0
  44. package/dist/cjs-types/common/themeProvider/index.d.ts +2 -0
  45. package/dist/cjs-types/common/themeProvider/theme.types.d.ts +3 -6
  46. package/dist/cjs-types/common/timeline/timeline.types.d.ts +3 -10
  47. package/dist/cjs-types/common/toast/index.d.ts +1 -1
  48. package/dist/cjs-types/common/toast/toast.types.d.ts +7 -3
  49. package/dist/cjs-types/common/types/actions.types.d.ts +1 -1
  50. package/dist/cjs-types/common/utils/dismissClick.d.ts +4 -0
  51. package/dist/cjs-types/common/utils/isDev.d.ts +1 -0
  52. package/dist/esm/common/accordion/accordion.mjs +1 -1
  53. package/dist/esm/common/accordion/accordion.mjs.map +1 -1
  54. package/dist/esm/common/accordion/accordion.module.mjs +1 -1
  55. package/dist/esm/common/accordion/accordion.module.mjs.map +1 -1
  56. package/dist/esm/common/accordion/accordion.types.mjs +1 -1
  57. package/dist/esm/common/accordion/accordion.types.mjs.map +1 -1
  58. package/dist/esm/common/actionButtons/actionButtons.mjs +1 -1
  59. package/dist/esm/common/actionButtons/actionButtons.mjs.map +1 -1
  60. package/dist/esm/common/actionIcon/actionIcon.mjs +1 -1
  61. package/dist/esm/common/actionIcon/actionIcon.mjs.map +1 -1
  62. package/dist/esm/common/actionIcon/actionIcon.module.mjs +1 -1
  63. package/dist/esm/common/actionIcon/actionIcon.module.mjs.map +1 -1
  64. package/dist/esm/common/alert/alert.mjs +1 -1
  65. package/dist/esm/common/alert/alert.mjs.map +1 -1
  66. package/dist/esm/common/alert/alert.module.mjs +1 -1
  67. package/dist/esm/common/alert/alert.module.mjs.map +1 -1
  68. package/dist/esm/common/animatedLogo/animatedLogo.mjs +1 -1
  69. package/dist/esm/common/animatedLogo/animatedLogo.mjs.map +1 -1
  70. package/dist/esm/common/avatar/avatar.mjs +1 -1
  71. package/dist/esm/common/avatar/avatar.mjs.map +1 -1
  72. package/dist/esm/common/badge/badge.mjs +1 -1
  73. package/dist/esm/common/badge/badge.mjs.map +1 -1
  74. package/dist/esm/common/badge/badge.module.mjs +1 -1
  75. package/dist/esm/common/badge/badge.module.mjs.map +1 -1
  76. package/dist/esm/common/badge/badge.types.mjs +1 -1
  77. package/dist/esm/common/badge/badge.types.mjs.map +1 -1
  78. package/dist/esm/common/bodyEnd/bodyEnd.mjs +1 -1
  79. package/dist/esm/common/bodyEnd/bodyEnd.mjs.map +1 -1
  80. package/dist/esm/common/breadcrumb/breadcrumb.mjs +1 -1
  81. package/dist/esm/common/breadcrumb/breadcrumb.mjs.map +1 -1
  82. package/dist/esm/common/breadcrumb/breadcrumb.module.mjs.map +1 -1
  83. package/dist/esm/common/button/button.mjs +1 -1
  84. package/dist/esm/common/button/button.mjs.map +1 -1
  85. package/dist/esm/common/button/button.module.mjs +1 -1
  86. package/dist/esm/common/button/button.module.mjs.map +1 -1
  87. package/dist/esm/common/button/button.types.mjs +1 -1
  88. package/dist/esm/common/button/button.types.mjs.map +1 -1
  89. package/dist/esm/common/calendar/calendar.mjs +1 -1
  90. package/dist/esm/common/calendar/calendar.mjs.map +1 -1
  91. package/dist/esm/common/calendar/calendar.module.mjs.map +1 -1
  92. package/dist/esm/common/calendar/calendar.types.mjs.map +1 -1
  93. package/dist/esm/common/calendar/components/agendaList/agendaList.mjs +1 -1
  94. package/dist/esm/common/calendar/components/agendaList/agendaList.mjs.map +1 -1
  95. package/dist/esm/common/calendar/components/agendaList/agendaList.module.mjs.map +1 -1
  96. package/dist/esm/common/calendar/components/calendarHeader/calendarHeader.mjs +1 -1
  97. package/dist/esm/common/calendar/components/calendarHeader/calendarHeader.mjs.map +1 -1
  98. package/dist/esm/common/calendar/components/calendarHeader/calendarHeader.module.mjs +1 -1
  99. package/dist/esm/common/calendar/components/calendarHeader/calendarHeader.module.mjs.map +1 -1
  100. package/dist/esm/common/calendar/components/compactMonth/compactMonth.mjs +1 -1
  101. package/dist/esm/common/calendar/components/compactMonth/compactMonth.mjs.map +1 -1
  102. package/dist/esm/common/calendar/components/compactMonth/compactMonth.module.mjs +1 -1
  103. package/dist/esm/common/calendar/components/compactMonth/compactMonth.module.mjs.map +1 -1
  104. package/dist/esm/common/calendar/components/monthView/monthView.mjs +1 -1
  105. package/dist/esm/common/calendar/components/monthView/monthView.mjs.map +1 -1
  106. package/dist/esm/common/calendar/components/monthView/monthView.module.mjs +1 -1
  107. package/dist/esm/common/calendar/components/monthView/monthView.module.mjs.map +1 -1
  108. package/dist/esm/common/calendar/components/timeGrid/timeGrid.mjs +1 -1
  109. package/dist/esm/common/calendar/components/timeGrid/timeGrid.mjs.map +1 -1
  110. package/dist/esm/common/calendar/components/timeGrid/timeGrid.module.mjs +1 -1
  111. package/dist/esm/common/calendar/components/timeGrid/timeGrid.module.mjs.map +1 -1
  112. package/dist/esm/common/calendar/dates.mjs +1 -1
  113. package/dist/esm/common/calendar/dates.mjs.map +1 -1
  114. package/dist/esm/common/calendar/format.mjs +1 -1
  115. package/dist/esm/common/calendar/format.mjs.map +1 -1
  116. package/dist/esm/common/calendar/layout.mjs +1 -1
  117. package/dist/esm/common/calendar/layout.mjs.map +1 -1
  118. package/dist/esm/common/calendar/useNow.mjs +2 -0
  119. package/dist/esm/common/calendar/useNow.mjs.map +1 -0
  120. package/dist/esm/common/card/Card.mjs +1 -1
  121. package/dist/esm/common/card/Card.mjs.map +1 -1
  122. package/dist/esm/common/card/CardActions.mjs +1 -1
  123. package/dist/esm/common/card/CardActions.mjs.map +1 -1
  124. package/dist/esm/common/card/CardHeader.mjs.map +1 -1
  125. package/dist/esm/common/card/card.module.mjs +1 -1
  126. package/dist/esm/common/card/card.module.mjs.map +1 -1
  127. package/dist/esm/common/card/card.types.mjs +1 -1
  128. package/dist/esm/common/card/card.types.mjs.map +1 -1
  129. package/dist/esm/common/carousel/carousel.mjs +1 -1
  130. package/dist/esm/common/carousel/carousel.mjs.map +1 -1
  131. package/dist/esm/common/carousel/carousel.module.mjs.map +1 -1
  132. package/dist/esm/common/chip/chip.mjs +1 -1
  133. package/dist/esm/common/chip/chip.mjs.map +1 -1
  134. package/dist/esm/common/chip/chip.module.mjs +1 -1
  135. package/dist/esm/common/chip/chip.module.mjs.map +1 -1
  136. package/dist/esm/common/chip/chip.types.mjs +1 -1
  137. package/dist/esm/common/chip/chip.types.mjs.map +1 -1
  138. package/dist/esm/common/colorPicker/colorPicker.mjs +1 -1
  139. package/dist/esm/common/colorPicker/colorPicker.mjs.map +1 -1
  140. package/dist/esm/common/colorPicker/colorPicker.module.mjs.map +1 -1
  141. package/dist/esm/common/confirmModal/confirmModal.mjs +1 -1
  142. package/dist/esm/common/confirmModal/confirmModal.mjs.map +1 -1
  143. package/dist/esm/common/copyButton/copyButton.mjs +1 -1
  144. package/dist/esm/common/copyButton/copyButton.mjs.map +1 -1
  145. package/dist/esm/common/copyButton/copyButton.module.mjs +1 -1
  146. package/dist/esm/common/copyButton/copyButton.module.mjs.map +1 -1
  147. package/dist/esm/common/errorBoundary/errorBoundary.mjs +2 -2
  148. package/dist/esm/common/errorBoundary/errorBoundary.mjs.map +1 -1
  149. package/dist/esm/common/fab/components/fabBase/fabBase.mjs +1 -1
  150. package/dist/esm/common/fab/components/fabBase/fabBase.mjs.map +1 -1
  151. package/dist/esm/common/fab/fab.mjs +1 -1
  152. package/dist/esm/common/fab/fab.mjs.map +1 -1
  153. package/dist/esm/common/flip/flip.mjs +1 -1
  154. package/dist/esm/common/flip/flip.mjs.map +1 -1
  155. package/dist/esm/common/floorPlan/floorPlan.faces.mjs +1 -1
  156. package/dist/esm/common/floorPlan/floorPlan.faces.mjs.map +1 -1
  157. package/dist/esm/common/floorPlan/floorPlan.geometry.mjs +1 -1
  158. package/dist/esm/common/floorPlan/floorPlan.geometry.mjs.map +1 -1
  159. package/dist/esm/common/floorPlan/floorPlan.graph.mjs +1 -1
  160. package/dist/esm/common/floorPlan/floorPlan.graph.mjs.map +1 -1
  161. package/dist/esm/common/floorPlan/floorPlan.hit.mjs +1 -1
  162. package/dist/esm/common/floorPlan/floorPlan.hit.mjs.map +1 -1
  163. package/dist/esm/common/floorPlan/floorPlan.json.mjs +1 -1
  164. package/dist/esm/common/floorPlan/floorPlan.json.mjs.map +1 -1
  165. package/dist/esm/common/floorPlan/floorPlan.mesh.mjs +1 -1
  166. package/dist/esm/common/floorPlan/floorPlan.mesh.mjs.map +1 -1
  167. package/dist/esm/common/floorPlan/floorPlan.path.mjs +1 -1
  168. package/dist/esm/common/floorPlan/floorPlan.path.mjs.map +1 -1
  169. package/dist/esm/common/floorPlan/floorPlan.plan.mjs +1 -1
  170. package/dist/esm/common/floorPlan/floorPlan.plan.mjs.map +1 -1
  171. package/dist/esm/common/floorPlan/floorPlan.rooms.mjs +1 -1
  172. package/dist/esm/common/floorPlan/floorPlan.rooms.mjs.map +1 -1
  173. package/dist/esm/common/floorPlan/floorPlan.snap.mjs +1 -1
  174. package/dist/esm/common/floorPlan/floorPlan.snap.mjs.map +1 -1
  175. package/dist/esm/common/floorPlan/floorPlan.triangulate.mjs +1 -1
  176. package/dist/esm/common/floorPlan/floorPlan.triangulate.mjs.map +1 -1
  177. package/dist/esm/common/floorPlan/floorPlan.types.mjs +1 -1
  178. package/dist/esm/common/floorPlan/floorPlan.types.mjs.map +1 -1
  179. package/dist/esm/common/klipyPicker/klipyPicker.mjs +1 -1
  180. package/dist/esm/common/klipyPicker/klipyPicker.mjs.map +1 -1
  181. package/dist/esm/common/modal/modal.mjs +1 -1
  182. package/dist/esm/common/modal/modal.mjs.map +1 -1
  183. package/dist/esm/common/modal/modal.module.mjs.map +1 -1
  184. package/dist/esm/common/numberInput/numberInput.mjs +1 -1
  185. package/dist/esm/common/numberInput/numberInput.mjs.map +1 -1
  186. package/dist/esm/common/numberInput/numberInput.module.mjs.map +1 -1
  187. package/dist/esm/common/planCanvas/planCanvas.mjs +1 -1
  188. package/dist/esm/common/planCanvas/planCanvas.mjs.map +1 -1
  189. package/dist/esm/common/popover/popover.mjs +1 -1
  190. package/dist/esm/common/popover/popover.mjs.map +1 -1
  191. package/dist/esm/common/progressBar/progressBar.mjs +1 -1
  192. package/dist/esm/common/progressBar/progressBar.mjs.map +1 -1
  193. package/dist/esm/common/progressBar/progressBar.module.mjs +1 -1
  194. package/dist/esm/common/progressBar/progressBar.module.mjs.map +1 -1
  195. package/dist/esm/common/roomDrawer/roomDrawer.mjs +1 -1
  196. package/dist/esm/common/roomDrawer/roomDrawer.mjs.map +1 -1
  197. package/dist/esm/common/roomDrawer/roomDrawer.module.mjs.map +1 -1
  198. package/dist/esm/common/roomViewer/roomViewer.mjs +1 -1
  199. package/dist/esm/common/roomViewer/roomViewer.mjs.map +1 -1
  200. package/dist/esm/common/sectionHeader/sectionHeader.mjs.map +1 -1
  201. package/dist/esm/common/splitButton/splitButton.mjs +1 -1
  202. package/dist/esm/common/splitButton/splitButton.mjs.map +1 -1
  203. package/dist/esm/common/styles/tone.mjs +4 -0
  204. package/dist/esm/common/styles/tone.mjs.map +1 -0
  205. package/dist/esm/common/styles/tone.module.mjs +2 -0
  206. package/dist/esm/common/styles/tone.module.mjs.map +1 -0
  207. package/dist/esm/common/themeProvider/color.types.mjs +2 -0
  208. package/dist/esm/common/themeProvider/color.types.mjs.map +1 -0
  209. package/dist/esm/common/themeProvider/defaultTheme.mjs +1 -1
  210. package/dist/esm/common/themeProvider/defaultTheme.mjs.map +1 -1
  211. package/dist/esm/common/tilt/tilt.mjs +1 -1
  212. package/dist/esm/common/tilt/tilt.mjs.map +1 -1
  213. package/dist/esm/common/timeInput/timeInput.mjs +1 -1
  214. package/dist/esm/common/timeInput/timeInput.mjs.map +1 -1
  215. package/dist/esm/common/timeline/timeline.mjs +1 -1
  216. package/dist/esm/common/timeline/timeline.mjs.map +1 -1
  217. package/dist/esm/common/timeline/timeline.module.mjs +1 -1
  218. package/dist/esm/common/timeline/timeline.module.mjs.map +1 -1
  219. package/dist/esm/common/timeline/timeline.types.mjs +1 -1
  220. package/dist/esm/common/timeline/timeline.types.mjs.map +1 -1
  221. package/dist/esm/common/timer/timer.mjs +1 -1
  222. package/dist/esm/common/timer/timer.mjs.map +1 -1
  223. package/dist/esm/common/timer/timer.module.mjs +1 -1
  224. package/dist/esm/common/timer/timer.module.mjs.map +1 -1
  225. package/dist/esm/common/toast/toast.mjs +1 -1
  226. package/dist/esm/common/toast/toast.mjs.map +1 -1
  227. package/dist/esm/common/toast/toast.module.mjs +1 -1
  228. package/dist/esm/common/toast/toast.module.mjs.map +1 -1
  229. package/dist/esm/common/toast/toastHost.mjs +1 -1
  230. package/dist/esm/common/toast/toastHost.mjs.map +1 -1
  231. package/dist/esm/common/utils/dismissClick.mjs +2 -0
  232. package/dist/esm/common/utils/dismissClick.mjs.map +1 -0
  233. package/dist/esm/common/utils/isDev.mjs +2 -0
  234. package/dist/esm/common/utils/isDev.mjs.map +1 -0
  235. package/dist/esm/floor-plan.mjs +1 -0
  236. package/dist/esm/index.mjs +1 -1
  237. package/dist/esm/services/formValidation/FormValidatorGroupWithForm.mjs +1 -1
  238. package/dist/esm/services/formValidation/FormValidatorGroupWithForm.mjs.map +1 -1
  239. package/dist/floor-plan.cjs +1 -0
  240. package/dist/floorPlan-DLe5XAx6.cjs +2 -0
  241. package/dist/floorPlan-DLe5XAx6.cjs.map +1 -0
  242. package/dist/index.cjs +5 -3
  243. package/dist/index.cjs.map +1 -1
  244. package/dist/style.css +1 -1
  245. package/dist/types/common/accordion/accordion.types.d.ts +17 -2
  246. package/dist/types/common/actionButtons/actionButtons.types.d.ts +7 -1
  247. package/dist/types/common/actionIcon/actionIcon.d.ts +1 -1
  248. package/dist/types/common/actionIcon/actionIcon.types.d.ts +7 -9
  249. package/dist/types/common/alert/alert.types.d.ts +6 -8
  250. package/dist/types/common/animatedLogo/animatedLogo.types.d.ts +3 -2
  251. package/dist/types/common/badge/badge.types.d.ts +10 -6
  252. package/dist/types/common/button/button.types.d.ts +14 -4
  253. package/dist/types/common/calendar/calendar.types.d.ts +25 -10
  254. package/dist/types/common/calendar/components/agendaList/agendaList.d.ts +1 -1
  255. package/dist/types/common/calendar/components/agendaList/agendaList.types.d.ts +3 -0
  256. package/dist/types/common/calendar/components/calendarHeader/calendarHeader.d.ts +1 -1
  257. package/dist/types/common/calendar/components/calendarHeader/calendarHeader.types.d.ts +2 -0
  258. package/dist/types/common/calendar/components/compactMonth/compactMonth.d.ts +1 -1
  259. package/dist/types/common/calendar/components/monthView/monthView.d.ts +1 -1
  260. package/dist/types/common/calendar/components/monthView/monthView.types.d.ts +3 -2
  261. package/dist/types/common/calendar/components/timeGrid/timeGrid.d.ts +1 -1
  262. package/dist/types/common/calendar/components/timeGrid/timeGrid.types.d.ts +9 -1
  263. package/dist/types/common/calendar/dates.d.ts +21 -5
  264. package/dist/types/common/calendar/format.d.ts +3 -2
  265. package/dist/types/common/calendar/layout.d.ts +5 -0
  266. package/dist/types/common/calendar/useNow.d.ts +4 -0
  267. package/dist/types/common/calendar/view.types.d.ts +9 -2
  268. package/dist/types/common/card/card.types.d.ts +16 -2
  269. package/dist/types/common/chip/chip.types.d.ts +10 -5
  270. package/dist/types/common/copyButton/copyButton.types.d.ts +5 -4
  271. package/dist/types/common/fab/components/fabBase/fabBase.d.ts +1 -1
  272. package/dist/types/common/fab/components/fabBase/fabBase.types.d.ts +2 -1
  273. package/dist/types/common/floorPlan/floorPlan.graph.d.ts +10 -3
  274. package/dist/types/common/floorPlan/floorPlan.plan.d.ts +5 -0
  275. package/dist/types/common/floorPlan/floorPlan.rooms.d.ts +6 -2
  276. package/dist/types/common/floorPlan/floorPlan.snap.d.ts +1 -3
  277. package/dist/types/common/floorPlan/index.d.ts +1 -3
  278. package/dist/types/common/planCanvas/planCanvas.types.d.ts +1 -1
  279. package/dist/types/common/progressBar/progressBar.d.ts +0 -1
  280. package/dist/types/common/progressBar/progressBar.types.d.ts +3 -1
  281. package/dist/types/common/roomDrawer/roomDrawer.types.d.ts +29 -8
  282. package/dist/types/common/roomViewer/roomViewer.types.d.ts +4 -2
  283. package/dist/types/common/splitButton/splitButton.types.d.ts +4 -1
  284. package/dist/types/common/styles/tone.d.ts +11 -0
  285. package/dist/types/common/themeProvider/color.types.d.ts +20 -0
  286. package/dist/types/common/themeProvider/index.d.ts +2 -0
  287. package/dist/types/common/themeProvider/theme.types.d.ts +3 -6
  288. package/dist/types/common/timeline/timeline.types.d.ts +3 -10
  289. package/dist/types/common/toast/index.d.ts +1 -1
  290. package/dist/types/common/toast/toast.types.d.ts +7 -3
  291. package/dist/types/common/types/actions.types.d.ts +1 -1
  292. package/dist/types/common/utils/dismissClick.d.ts +4 -0
  293. package/dist/types/common/utils/isDev.d.ts +1 -0
  294. package/docs/Accordion.md +74 -5
  295. package/docs/ActionButtons.md +6 -3
  296. package/docs/ActionIcon.md +39 -14
  297. package/docs/Alert.md +27 -17
  298. package/docs/AnimatedLogo.md +1 -1
  299. package/docs/Badge.md +24 -7
  300. package/docs/Button.md +98 -40
  301. package/docs/ButtonGroup.md +18 -18
  302. package/docs/CLAUDE.md +24 -12
  303. package/docs/Calendar.md +35 -17
  304. package/docs/Card.md +53 -14
  305. package/docs/Chip.md +24 -9
  306. package/docs/ConfigProvider.md +3 -3
  307. package/docs/CopyButton.md +6 -5
  308. package/docs/FloorPlan.md +18 -14
  309. package/docs/ProgressBar.md +7 -4
  310. package/docs/RoomDrawer.md +42 -13
  311. package/docs/RoomViewer.md +1 -14
  312. package/docs/SectionHeader.md +1 -1
  313. package/docs/SplitButton.md +6 -5
  314. package/docs/ThemeColor.md +103 -0
  315. package/docs/ThemeProvider.md +5 -5
  316. package/docs/Timeline.md +18 -9
  317. package/docs/Toast.md +25 -11
  318. package/package.json +20 -2
  319. package/dist/cjs-types/common/floorPlan/legacySvg.d.ts +0 -27
  320. package/dist/esm/common/accordion/accordion.plain.module.mjs +0 -2
  321. package/dist/esm/common/accordion/accordion.plain.module.mjs.map +0 -1
  322. package/dist/esm/common/accordion/accordion.primary.module.mjs +0 -2
  323. package/dist/esm/common/accordion/accordion.primary.module.mjs.map +0 -1
  324. package/dist/esm/common/alert/alert.types.mjs +0 -2
  325. package/dist/esm/common/alert/alert.types.mjs.map +0 -1
  326. package/dist/esm/common/floorPlan/legacySvg.mjs +0 -2
  327. package/dist/esm/common/floorPlan/legacySvg.mjs.map +0 -1
  328. package/dist/types/common/floorPlan/legacySvg.d.ts +0 -27
@@ -1,5 +1,5 @@
1
1
  import { CSSProperties, ReactNode } from 'react';
2
- import { ButtonStyleType } from '../../../button/button.types.js';
2
+ import { ButtonProps, ButtonStyleType } from '../../../button/button.types.js';
3
3
  export type FabBaseSize = 'default' | 'mini';
4
4
  export interface FabBaseProps {
5
5
  children?: ReactNode;
@@ -8,5 +8,6 @@ export interface FabBaseProps {
8
8
  /** Forwarded from Fab's `button` slot. */
9
9
  style?: CSSProperties;
10
10
  styleType?: ButtonStyleType;
11
+ color?: ButtonProps['color'];
11
12
  onClick?: () => void;
12
13
  }
@@ -5,6 +5,13 @@ import { PlanEdit, PlanFloor, PlanIssue, PlanNode, PlanOpening, PlanPoint, PlanW
5
5
  * reproducible.
6
6
  */
7
7
  export declare function newId(prefix: string): string;
8
+ /**
9
+ * The first of `nameFor(start)`, `nameFor(start + 1)`, … that `used` does not hold.
10
+ *
11
+ * Bounded because `nameFor` is the caller's: one that ignores its number would never reach a
12
+ * free name. An injective one always finds one within `used.size + 1` tries.
13
+ */
14
+ export declare function freshName(nameFor: (n: number) => string, start: number, used: ReadonlySet<string>): string;
8
15
  /** Test-only: makes generated ids reproducible within a single test. */
9
16
  export declare function __resetIdSeq(): void;
10
17
  declare function wallLength(floor: PlanFloor, wall: PlanWall): number;
@@ -157,9 +164,9 @@ export declare function transformPlan(floor: PlanFloor, dx: number, dy: number):
157
164
  /**
158
165
  * Multiplies every coordinate and dimension by `factor`.
159
166
  *
160
- * The one place a scale factor belongs: converting a unitless legacy plan into the
161
- * module's millimetre invariant, once, at the import boundary. The caller picks the
162
- * factor, because nothing in the old data says what it should be.
167
+ * The one place a scale factor belongs: converting geometry drawn in another unit into
168
+ * the module's millimetre invariant, once, where it enters. The caller picks the factor,
169
+ * because nothing in the data says what it should be.
163
170
  */
164
171
  export declare function scalePlan(floor: PlanFloor, factor: number): PlanFloor;
165
172
  export declare function addOpening(floor: PlanFloor, opening: Omit<PlanOpening, 'id'>): PlanEdit<{
@@ -34,6 +34,11 @@ export declare function floorIndex(plan: FloorPlan, floorId: string): number;
34
34
  export declare function floorBelow(plan: FloorPlan, floorId: string): PlanFloor | null;
35
35
  export interface AddFloorOptions {
36
36
  label?: string;
37
+ /**
38
+ * Names the floor when `label` is not given. `n` is the floor count plus one, moved past
39
+ * any number whose name is taken. Default `` (n) => `Floor ${n}` ``.
40
+ */
41
+ nameFor?: (n: number) => string;
37
42
  /** Millimetres. Defaults to the storey height of the floor it is added above. */
38
43
  height?: number;
39
44
  /** Where to put it. Defaults to directly above `aboveFloorId`, else on top. */
@@ -22,8 +22,12 @@ export declare function derivePlan(floor: PlanFloor): PlanDerivation;
22
22
  /** Test-only: makes the room sequence counter reproducible. */
23
23
  export declare function __resetRoomSeq(): void;
24
24
  export interface CommitDerivationOptions {
25
- /** Names new rooms. Receives the 1-based index among rooms created in this call. */
26
- nameFor?: (index: number, face: DerivedRoom) => string;
25
+ /**
26
+ * Names a new room. `n` is the floor's room count plus one, moved past any number whose
27
+ * name is taken, so `` (n) => `Raum ${n}` `` numbers rooms the way the default does.
28
+ * Default `` (n) => `Room ${n}` ``.
29
+ */
30
+ nameFor?: (n: number, face: DerivedRoom) => string;
27
31
  }
28
32
  /**
29
33
  * Mints a `PlanRoom` for every face that matched nothing.
@@ -35,7 +35,7 @@ export interface SnapOptions {
35
35
  export declare const DEFAULT_SNAP_OPTIONS: SnapOptions;
36
36
  export interface SnapContext {
37
37
  floor: PlanFloor;
38
- /** World units per screen pixel at the current zoom. See `screenScale`. */
38
+ /** World units per screen pixel at the current zoom: `1 / view.zoom`. */
39
39
  pxToWorld: number;
40
40
  /** The anchored point. Required for angle lock; also enables the length readout. */
41
41
  origin?: PlanPoint;
@@ -70,8 +70,6 @@ export interface SnapResult {
70
70
  */
71
71
  angleRelativeTo?: 'world' | 'reference';
72
72
  }
73
- /** World units per screen pixel, from the element's current transform. */
74
- export declare function screenScale(svg: SVGSVGElement): number;
75
73
  /**
76
74
  * Client (screen) coordinates to world coordinates. Pure conversion, no snapping.
77
75
  *
@@ -18,7 +18,7 @@ export { HIT_PX, HIT_PX_COARSE, hitTest, selectionsEqual, worldTolerances } from
18
18
  export type { HitTestOptions, HitTolerances } from './floorPlan.hit.js';
19
19
  export { DEFAULT_WALL_ATTRS, addOpening, addRect, addWall, cleanupPlan, detachWall, dissolveNode, mergeNodes, moveNode, removeOpening, removeWall, scalePlan, splitWall, transformPlan, updateOpening, validatePlan, wallLength, weldShortWalls, } from './floorPlan.graph.js';
20
20
  export type { DetachWallResult, DissolveNodeOptions, ResolveNodeResult, SplitWallResult, WallAttrs, } from './floorPlan.graph.js';
21
- export { DEFAULT_SNAP_OPTIONS, SnapKind, clientToWorld, resolveSnap, screenScale } from './floorPlan.snap.js';
21
+ export { DEFAULT_SNAP_OPTIONS, SnapKind, clientToWorld, resolveSnap } from './floorPlan.snap.js';
22
22
  export type { SnapContext, SnapGuide, SnapOptions, SnapResult } from './floorPlan.snap.js';
23
23
  export { buildWallPaths, openingGeometry, wallCentrelineSpans } from './floorPlan.path.js';
24
24
  export type { BuildWallPathsOptions, WallCapLine, WallCapReason, WallPathGroup, WallPathResult, } from './floorPlan.path.js';
@@ -26,5 +26,3 @@ export { PLAN_FORMAT_VERSION, planFromJson, planToJson } from './floorPlan.json.
26
26
  export type { PlanParseResult } from './floorPlan.json.js';
27
27
  export { buildPlanMesh } from './floorPlan.mesh.js';
28
28
  export type { BuildPlanMeshOptions, PlanMesh, PlanMeshGroup, PlanMeshPart } from './floorPlan.mesh.js';
29
- export { planFromLegacySvg } from './legacySvg.js';
30
- export type { LegacyImportOptions } from './legacySvg.js';
@@ -33,7 +33,7 @@ export interface PlanCanvasProps {
33
33
  area: number;
34
34
  faceId: string;
35
35
  }) => ReactNode;
36
- /** Accessible name for a room. */
36
+ /** Accessible name for an interactive room. RoomViewer supplies the default, from its labels. */
37
37
  getRoomLabel?: (room: PlanRoom | null, context: {
38
38
  area: number;
39
39
  }) => string;
@@ -1,5 +1,4 @@
1
1
  import { ReactElement } from 'react';
2
2
  import { ProgressBarProps } from './progressBar.types.js';
3
- export declare function getContrastColor(hexColor: string): string;
4
3
  declare function ProgressBar({ className, total, progress, style, classNames, styles: slotStyles, ...rest }: ProgressBarProps): ReactElement;
5
4
  export default ProgressBar;
@@ -1,8 +1,10 @@
1
1
  import { SlotClassNames, SlotStyles, HtmlProps } from '../types/slots.types.js';
2
+ import { ColorValue } from '../themeProvider/color.types.js';
2
3
  export interface Progress {
3
4
  amount: number;
4
5
  label?: string;
5
- color?: string;
6
+ /** A `ThemeColor` or any CSS colour; its label is black or white, whichever reads. Default `--primary-color`. */
7
+ color?: ColorValue;
6
8
  class?: string;
7
9
  }
8
10
  export type ProgressBarSlots = 'root' | 'fill' | 'label';
@@ -27,7 +27,10 @@ export interface RoomDrawerChangeMeta {
27
27
  /** Ids of whatever the change touched, for syncing an external selection. */
28
28
  targetIds: string[];
29
29
  }
30
- /** Every string the drawer's own chrome renders, for localisation. */
30
+ /**
31
+ * Every string the drawer produces of its own, for localisation: its chrome, and the names it
32
+ * gives the rooms and floors it creates, which are stored in the plan.
33
+ */
31
34
  export interface RoomDrawerLabels {
32
35
  /** The toolbar, read out by screen readers. */
33
36
  tools?: string;
@@ -54,12 +57,21 @@ export interface RoomDrawerLabels {
54
57
  floorHeight?: string;
55
58
  moveFloorUp?: string;
56
59
  moveFloorDown?: string;
60
+ /** Name of a new room. `n` counts the floor's rooms, skipping names already taken. */
61
+ newRoomName?: (n: number) => string;
62
+ /** Name of a floor added with the `+` button. `n` counts the floors, skipping names already taken. */
63
+ newFloorName?: (n: number) => string;
64
+ /** Name of a copied floor, from the name of the floor it copies. */
65
+ copiedFloorName?: (name: string) => string;
66
+ /** Name of the one floor an empty plan starts with, uncontrolled or after `clear()`. */
67
+ initialFloorName?: string;
57
68
  /** The inspector's noun for a floor, shown when nothing is selected. */
58
69
  selectedFloor?: string;
59
70
  /** Shown in the hint line when an opened file could not be read at all. */
60
71
  importFailed?: string;
61
72
  snap?: string;
62
- angleLock?: string;
73
+ /** The angle lock toggle, given `constrainAngle`. */
74
+ angleLock?: (angle: number) => string;
63
75
  grid?: string;
64
76
  zoomIn?: string;
65
77
  zoomOut?: string;
@@ -69,22 +81,27 @@ export interface RoomDrawerLabels {
69
81
  thickness?: string;
70
82
  width?: string;
71
83
  sill?: string;
72
- head?: string;
73
84
  deleteSelection?: string;
74
- /** Shown when several things are selected. `{count}` is replaced with the number. */
75
- selectedCount?: string;
85
+ /** What the inspector calls several things selected at once. */
86
+ selectedCount?: (count: number) => string;
76
87
  /** What the inspector calls the current selection. */
77
- selectedNothing?: string;
78
88
  selectedRoom?: string;
79
89
  selectedWall?: string;
80
90
  selectedCorner?: string;
81
- /** Overrides the opening's own kind, which is used by default. */
82
- selectedOpening?: string;
91
+ selectedDoor?: string;
92
+ selectedWindow?: string;
93
+ selectedArchway?: string;
94
+ selectedGap?: string;
95
+ /** Hint for the select tool with `multiSelect` on. */
83
96
  hintSelect?: string;
97
+ /** Hint for the select tool with `multiSelect` off. */
98
+ hintSelectSingle?: string;
84
99
  hintWall?: string;
85
100
  hintRect?: string;
86
101
  hintMeasure?: string;
87
102
  hintOpening?: string;
103
+ /** A drawing angle measured from the previous wall, given the formatted angle. */
104
+ relativeAngle?: (angle: string) => string;
88
105
  }
89
106
  /** Every icon in the chrome is overridable. */
90
107
  export interface RoomDrawerIcons {
@@ -259,6 +276,10 @@ export interface RoomDrawerProps extends Omit<HtmlProps<HTMLDivElement>, 'onChan
259
276
  showMeasurements?: boolean;
260
277
  formatLength?: (lengthMm: number) => string;
261
278
  formatArea?: (areaMm2: number) => string;
279
+ /** A drawing angle, in degrees from -180 to 180. */
280
+ formatAngle?: (degrees: number) => string;
281
+ /** The zoom readout. `zoom` is screen pixels per millimetre, so `1` reads as 100%. */
282
+ formatZoom?: (zoom: number) => string;
262
283
  showToolbar?: boolean;
263
284
  showInspector?: boolean;
264
285
  showHint?: boolean;
@@ -10,8 +10,10 @@ export interface RoomViewerLabels {
10
10
  zoomOut?: string;
11
11
  fit?: string;
12
12
  empty?: string;
13
- /** Announced when a room is selected. `{name}` and `{area}` are replaced. */
14
- selectedRoom?: string;
13
+ /** Stands in for the name of a room that has none. */
14
+ unnamedRoom?: string;
15
+ /** Announced when a room is selected, given its name and its formatted area. */
16
+ selectedRoom?: (name: string, area: string) => string;
15
17
  /** Announced when the selection is cleared. */
16
18
  noRoomSelected?: string;
17
19
  }
@@ -1,7 +1,7 @@
1
1
  import { PopoverAlign } from '../popover/popover.types.js';
2
2
  import { CSSProperties, ReactNode } from 'react';
3
3
  import { IconContent } from '../types/icon.types.js';
4
- import { ButtonStyleType, ButtonSize } from '../button/button.types.js';
4
+ import { ButtonProps, ButtonStyleType, ButtonSize } from '../button/button.types.js';
5
5
  import { SlotClassNames, SlotStyles, HtmlProps } from '../types/slots.types.js';
6
6
  export interface SplitButtonAction {
7
7
  id: string;
@@ -20,7 +20,10 @@ export interface SplitButtonProps extends HtmlProps {
20
20
  children?: ReactNode;
21
21
  onClick?: (event: React.MouseEvent<HTMLButtonElement>) => Promise<void> | void;
22
22
  actions: SplitButtonAction[];
23
+ /** Default `Filled`. */
23
24
  styleType?: ButtonStyleType;
25
+ /** A `ThemeColor` or any CSS colour, shared by both buttons (default `Primary`). */
26
+ color?: ButtonProps['color'];
24
27
  size?: ButtonSize;
25
28
  disabled?: boolean;
26
29
  isLoading?: boolean;
@@ -0,0 +1,11 @@
1
+ import { CSSProperties } from 'react';
2
+ import { ColorValue } from '../themeProvider/color.types.js';
3
+ /** The class, and for a colour of the caller's own the inline style, that set the --tone properties. */
4
+ export declare function toneProps(color: ColorValue): {
5
+ className: string;
6
+ style?: CSSProperties;
7
+ };
8
+ /** A colour as a CSS value, for a component that paints it itself rather than through --tone. */
9
+ export declare function cssColor(color: ColorValue): string;
10
+ /** Warns in development about a value that can never be a colour. A var() passes: it only resolves on screen. */
11
+ export declare function useToneCheck(component: string, colors: (ColorValue | undefined)[]): void;
@@ -0,0 +1,20 @@
1
+ /** The theme's named colours, shared by every component that takes a `color`. */
2
+ export declare enum ThemeColor {
3
+ /** `--primary-color`. */
4
+ Primary = "primary",
5
+ /** The surrounding text colour, with `--border-color` for an outline. */
6
+ Neutral = "neutral",
7
+ /** `--success-color`. */
8
+ Success = "success",
9
+ /** `--info-color`. */
10
+ Info = "info",
11
+ /** `--warn-color`. */
12
+ Warn = "warn",
13
+ /** `--error-color`. */
14
+ Error = "error"
15
+ }
16
+ /**
17
+ * A `ThemeColor`, or any CSS colour such as `'var(--brand)'` or `'#7c3aed'`.
18
+ * `string & {}` rather than `string`, which would swallow the enum into one plain string type.
19
+ */
20
+ export type ColorValue = ThemeColor | (string & {});
@@ -1,4 +1,6 @@
1
1
  export { default } from './themeProvider.js';
2
2
  export { defaultTheme } from './defaultTheme.js';
3
3
  export { lightTheme } from './lightTheme.js';
4
+ export { ThemeColor } from './color.types.js';
5
+ export type { ColorValue } from './color.types.js';
4
6
  export type { Theme, ThemeProviderProps, ThemeVariables } from './theme.types.js';
@@ -106,15 +106,10 @@ export interface ThemeVariables {
106
106
  * the device's own safe-area inset where that is larger. Modal sets --modal-padding on its own
107
107
  * panel, so this does not reach a Modal sheet. */
108
108
  '--sheet-safe-padding'?: string;
109
- /** Default-style button background. Falls back to transparent when unset. */
110
- '--button-default-background'?: string;
111
- /** Default-style button text colour. Falls back to --text-color when unset. */
112
- '--button-default-color'?: string;
113
- /** Default-style button border (full `border` shorthand, e.g. `1px solid var(--border-color)`). Falls back to a transparent 1px border when unset. */
114
- '--button-default-border'?: string;
115
109
  '--card-shadow'?: string;
116
110
  '--background-card-elevated'?: string;
117
111
  '--background-card-outlined'?: string;
112
+ /** Surface of a Neutral Light card, named after the old Filled style. Unset, it is the text-colour tint every Light uses; defaultTheme sets --background-accent. */
118
113
  '--background-card-filled'?: string;
119
114
  /** Slider track (unfilled) colour. Falls back to --background-accent-light. */
120
115
  '--slider-track-color'?: string;
@@ -214,6 +209,8 @@ export interface ThemeVariables {
214
209
  '--calendar-now-color'?: string;
215
210
  /** Corner radius of an event. Falls back to 6px. */
216
211
  '--calendar-event-radius'?: string;
212
+ /** The hours outside `workingHours` in the week and day views. Falls back to --background-accent. */
213
+ '--calendar-off-hours-color'?: string;
217
214
  /** Page button size. Falls back to 36px. */
218
215
  '--pagination-size'?: string;
219
216
  /** Gap between page buttons. Falls back to 4px. */
@@ -1,6 +1,7 @@
1
1
  import { default as React } from 'react';
2
2
  import { IconContent } from '../types/icon.types.js';
3
3
  import { SlotClassNames, SlotStyles, HtmlProps } from '../types/slots.types.js';
4
+ import { ColorValue } from '../themeProvider/color.types.js';
4
5
  /** Layout of entries relative to the connecting line. */
5
6
  export declare enum TimelineAlignment {
6
7
  /** Line and markers on the left, content to the right (the default). */
@@ -10,14 +11,6 @@ export declare enum TimelineAlignment {
10
11
  /** Line down the center, entries alternating left/right. */
11
12
  Alternate = "alternate"
12
13
  }
13
- /** Semantic colour for an entry's marker, matching the theme's status colours. */
14
- export declare enum TimelineItemStatus {
15
- Default = "default",
16
- Primary = "primary",
17
- Success = "success",
18
- Warn = "warn",
19
- Error = "error"
20
- }
21
14
  export type TimelineSlots = 'root' | 'item' | 'marker' | 'dot' | 'connector' | 'content' | 'title' | 'description' | 'timestamp';
22
15
  export interface TimelineItem {
23
16
  /** Stable identity for the entry, used as its React key. Falls back to its array index when omitted; pass one whenever `items` can be reordered or have entries prepended (e.g. a live "newest first" audit log), so React doesn't misattribute row state across the shift. */
@@ -30,8 +23,8 @@ export interface TimelineItem {
30
23
  timestamp?: React.ReactNode;
31
24
  /** Icon shown in the marker instead of a plain dot — a FontAwesome icon or any node. */
32
25
  icon?: IconContent;
33
- /** Semantic marker colour (default `Default`). */
34
- status?: TimelineItemStatus;
26
+ /** The marker's colour: a `ThemeColor` or any CSS colour. Unset, it is `--timeline-dot-color`. */
27
+ color?: ColorValue;
35
28
  /** Extra content rendered under the description, e.g. a diff, an attachment, an actor avatar. */
36
29
  content?: React.ReactNode;
37
30
  /** Makes the whole entry clickable (e.g. to open the full record), rendering it as an accessible button. */
@@ -1,2 +1,2 @@
1
1
  export { showToast } from './toastService.js';
2
- export type { ToastContextConfig, ToastLabels, ToastOptions, ToastType, ToastPosition, ToastSlots, } from './toast.types.js';
2
+ export type { ToastContextConfig, ToastLabels, ToastOptions, ToastPosition, ToastSlots } from './toast.types.js';
@@ -1,7 +1,7 @@
1
1
  import { ReactNode } from 'react';
2
2
  import { SlotClassNames, SlotStyles } from '../types/slots.types.js';
3
+ import { ColorValue } from '../themeProvider/color.types.js';
3
4
  export type ToastPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
4
- export type ToastType = 'default' | 'info' | 'success' | 'error' | 'warn';
5
5
  export type ToastSlots = 'root' | 'icon' | 'content' | 'closeButton' | 'progressBar';
6
6
  /** Text Toast renders of its own, for translating it. */
7
7
  export interface ToastLabels {
@@ -25,7 +25,11 @@ export interface ToastContextConfig {
25
25
  labels?: ToastLabels;
26
26
  }
27
27
  export interface ToastOptions extends Omit<ToastContextConfig, 'allowStacking'> {
28
- type?: ToastType;
28
+ /**
29
+ * A `ThemeColor` (default `Primary`) or any CSS colour. A ThemeColor also picks the icon; any
30
+ * other colour shows a bell.
31
+ */
32
+ color?: ColorValue;
29
33
  classNames?: SlotClassNames<ToastSlots>;
30
34
  styles?: SlotStyles<ToastSlots>;
31
35
  }
@@ -44,7 +48,7 @@ export interface ResolvedToastOptions {
44
48
  showRemainingTime: boolean;
45
49
  showCloseButton: boolean;
46
50
  pauseOnHover: boolean;
47
- type: ToastType;
51
+ color: ColorValue;
48
52
  classNames?: SlotClassNames<ToastSlots>;
49
53
  styles?: SlotStyles<ToastSlots>;
50
54
  }
@@ -2,6 +2,6 @@ import { IconContent } from './icon.types.js';
2
2
  /** A single icon-triggered action, rendered as an `ActionIcon` */
3
3
  export interface IconAction {
4
4
  title?: string;
5
- onClick?: (e: React.MouseEvent<HTMLDivElement>) => void;
5
+ onClick?: (e: React.MouseEvent<HTMLButtonElement>) => void;
6
6
  icon: IconContent;
7
7
  }
@@ -0,0 +1,4 @@
1
+ /** Records that the release just dispatched closed an overlay, which marks the click it raises. */
2
+ export declare function markDismiss(): void;
3
+ /** Whether the click `event` ends a press that closed an overlay. */
4
+ export declare function isDismissClick(event: Event): boolean;
@@ -0,0 +1 @@
1
+ export declare function isDev(): boolean;
package/docs/Accordion.md CHANGED
@@ -4,25 +4,60 @@
4
4
 
5
5
  **Keywords:** collapse, dropdown panel
6
6
 
7
- **Import:** `import { Accordion } from '@ahrowe/ui'`
7
+ **Import:** `import { Accordion, AccordionStyleType, ThemeColor } from '@ahrowe/ui'`
8
8
 
9
- **Style variants:** `AccordionStyleType.Default` | `AccordionStyleType.Primary` | `AccordionStyleType.Plain`
9
+ **Styles:** the library's own, meaning what they mean on Button, Badge and Chip, applied to the
10
+ header; `color` is the colour they use (a `ThemeColor`, default `Neutral`, or any CSS colour, see
11
+ [ThemeColor.md](ThemeColor.md)). The body is ordinary text on the page in every style. There is no
12
+ `Filled`: an accordion structures content, and a solid header would compete with the page's main
13
+ action.
14
+
15
+ - `AccordionStyleType.Outlined` (default): a border in the colour, the header's text in the colour
16
+ - `AccordionStyleType.Light`: the header in a light tint of the colour, its text in the colour
17
+ - `AccordionStyleType.Plain`: the header's text in the colour, no chrome and no padding, for a disclosure inside other content
18
+
19
+ Each accordion is one section; render several directly next to each other for a list, without a
20
+ wrapper around each one, and the arrow keys move between their headers. **Neighbours** keep a
21
+ small gap by default. With `joined` they make one block instead: one line between each, in the
22
+ border colour for Outlined and in the page colour for Light, open or closed. Two neighbours join
23
+ only when both are joined.
10
24
 
11
25
  ```tsx
12
- import { Accordion, AccordionStyleType } from '@ahrowe/ui';
26
+ import { Accordion, AccordionStyleType, ThemeColor } from '@ahrowe/ui';
13
27
 
14
28
  // Uncontrolled — manages its own open state
15
29
  <Accordion title="Section title">
16
30
  <p>Content goes here</p>
17
31
  </Accordion>
18
32
 
33
+ // A list of separate sections
34
+ {faqs.map((faq) => (
35
+ <Accordion key={faq.id} title={faq.question}>
36
+ {faq.answer}
37
+ </Accordion>
38
+ ))}
39
+
40
+ // The same list as one bordered control
41
+ {faqs.map((faq) => (
42
+ <Accordion key={faq.id} title={faq.question} joined>
43
+ {faq.answer}
44
+ </Accordion>
45
+ ))}
46
+
47
+ // Headers tinted in the primary colour
48
+ {steps.map((step) => (
49
+ <Accordion key={step.id} title={step.title} styleType={AccordionStyleType.Light} color={ThemeColor.Primary}>
50
+ {step.body}
51
+ </Accordion>
52
+ ))}
53
+
19
54
  // Controlled
20
55
  <Accordion
21
56
  id="section-1"
22
57
  title="Controlled section"
23
58
  expanded={isOpen}
24
59
  onHeaderClicked={(id, isExpanded) => setIsOpen(isExpanded)}
25
- styleType={AccordionStyleType.Primary}
60
+ styleType={AccordionStyleType.Light}
26
61
  >
27
62
  Content
28
63
  </Accordion>
@@ -36,7 +71,9 @@ import { Accordion, AccordionStyleType } from '@ahrowe/ui';
36
71
  | `expanded` | `boolean \| null` | Controlled open state |
37
72
  | `startOpen` | `boolean` | Uncontrolled initial state |
38
73
  | `onHeaderClicked` | `(id, isExpanded) => void` | Toggle callback |
39
- | `styleType` | `AccordionStyleType` | Visual variant |
74
+ | `styleType` | `AccordionStyleType` | `Outlined` (default), `Light` or `Plain` |
75
+ | `color` | `ColorValue` | A `ThemeColor` (default `Neutral`) or any CSS colour |
76
+ | `joined` | `boolean` | Joins the section to joined neighbours into one block. Default `false`: a small gap |
40
77
  | `hideHeader` | `boolean` | Hide the clickable header |
41
78
  | `id` | `string` | Passed back in `onHeaderClicked` |
42
79
 
@@ -49,8 +86,40 @@ a `role="region"` labelled by the header, so a screen reader can move between th
49
86
  An activation key pressed inside the body does not reach the header, so a Space typed into a
50
87
  field in an open section types a space instead of collapsing the section.
51
88
 
89
+ **Arrow keys**, the optional keys of the
90
+ [WAI-ARIA accordion pattern](https://www.w3.org/WAI/ARIA/apg/patterns/accordion/): Down and Up
91
+ move the focus to the next and previous header and wrap at the ends, Home and End to the first and
92
+ last. They move among the accordions rendered beside each other under one parent, so a list nested
93
+ inside a section's body is a set of its own, and a key pressed inside a body stays there.
94
+
95
+ The pattern also wraps each header in a `role="heading"` with an `aria-level` that fits the page;
96
+ this header is not, because only the page knows that level.
97
+
52
98
  **Slots:** `root` `header` `title` `icon` `body` `bodyInner`
53
99
 
54
100
  ## Sizing
55
101
 
56
102
  The header's font, padding and chevron follow `--default-font-size`, as does the body's padding. There is no fixed height: the header is that padding plus one line of text, so a larger base font simply makes it taller.
103
+
104
+ **Theming:** every colour comes from `color`, through the variables listed in
105
+ [ThemeColor.md](ThemeColor.md); in `Neutral` that is the surrounding text colour and a
106
+ `--border-color` outline. The header tints on hover in its own text colour and shows a
107
+ `--focus-border-color` ring inside its edge on keyboard focus.
108
+
109
+ ## Migration from `Default`, `Primary` and `Plain`
110
+
111
+ Before 0.43 the styles were `Default` (bordered sections that moved apart when one opened),
112
+ `Primary` (borderless until open, then framed in `--primary-color`) and `Plain`. The styles are
113
+ now the library's shared ones, and `Default` and `Primary` are gone, so TypeScript points at each
114
+ use:
115
+
116
+ | Before | After |
117
+ |--------|-------|
118
+ | `styleType={AccordionStyleType.Default}` | `joined`: `Outlined` is the default style, and `joined` keeps neighbours in one box |
119
+ | `styleType={AccordionStyleType.Primary}` | `color={ThemeColor.Primary}`: Outlined, bordered in the primary colour |
120
+ | `styleType={AccordionStyleType.Plain}` | unchanged, with a small gap added above its body |
121
+
122
+ An Accordion without `styleType` compiles unchanged and looks different in a list: neighbours
123
+ used to join into one box and now keep a small gap. Add `joined` to every one in the list to keep
124
+ the box, now with square corners at each join; an open one stays in the box instead of moving
125
+ apart from the others.
@@ -7,7 +7,7 @@
7
7
  **Import:** `import { ActionButtons } from '@ahrowe/ui'`
8
8
 
9
9
  ```tsx
10
- import { ActionButtons, ButtonStyleType } from '@ahrowe/ui';
10
+ import { ActionButtons, ThemeColor } from '@ahrowe/ui';
11
11
 
12
12
  <ActionButtons
13
13
  labels={{ submit: 'Save', cancel: 'Discard' }}
@@ -19,7 +19,7 @@ import { ActionButtons, ButtonStyleType } from '@ahrowe/ui';
19
19
  // Destructive action
20
20
  <ActionButtons
21
21
  labels={{ submit: 'Delete' }}
22
- submitButtonStyle={ButtonStyleType.Delete}
22
+ submitButtonColor={ThemeColor.Error}
23
23
  onSubmit={handleDelete}
24
24
  onClose={onClose}
25
25
  />
@@ -41,7 +41,10 @@ import { ActionButtons, ButtonStyleType } from '@ahrowe/ui';
41
41
  | `onClose` | `() => void` | Secondary button click |
42
42
  | `labels.submit` | `ReactNode \| string` | Primary button label |
43
43
  | `labels.cancel` | `ReactNode \| string` | Secondary button label |
44
- | `submitButtonStyle` | `ButtonStyleType` | `Primary` (default), `Delete`, `Default` |
44
+ | `submitButtonStyle` | `ButtonStyleType` | Default `Filled` |
45
+ | `submitButtonColor` | `ColorValue` | Default `Primary`; `Error` for a destructive confirm; or any CSS colour |
46
+ | `cancelButtonStyle` | `ButtonStyleType` | Default `Outlined` |
47
+ | `cancelButtonColor` | `ColorValue` | Default `Primary`; or any CSS colour |
45
48
  | `isSubmitButtonLoading` | `boolean` | Shows spinner on primary button |
46
49
  | `isSubmitButtonDisabled` | `boolean` | |
47
50
  | `isCancelButtonLoading` | `boolean` | |
@@ -1,22 +1,28 @@
1
1
  # ActionIcon
2
2
 
3
- **When to use:** Clickable icon button without a label — toolbar actions, table row actions, icon-only controls.
3
+ **When to use:** Clickable icon button without a label — toolbar actions, table row actions, close buttons, icon-only controls.
4
4
 
5
- **Keywords:** toolbar button
5
+ **Keywords:** toolbar button, icon button, close, ghost
6
6
 
7
7
  **Import:** `import { ActionIcon } from '@ahrowe/ui'`
8
8
 
9
9
  **Requires:** `@fortawesome/free-solid-svg-icons` peer dependency.
10
10
 
11
+ An ActionIcon is a [Button](Button.md) holding only an icon and sized by it: a real `<button>`
12
+ with Button's hover, focus ring and ripple. It takes Button's `styleType` and `color`, plain and
13
+ in the surrounding text colour by default, so it fits whatever it sits on.
14
+
11
15
  ```tsx
12
- import { ActionIcon } from '@ahrowe/ui';
13
- import { faTrash } from '@fortawesome/free-solid-svg-icons';
14
-
15
- <ActionIcon
16
- icon={faTrash}
17
- title="Delete item"
18
- onClick={(e) => handleDelete(e)}
19
- />
16
+ import { ActionIcon, ButtonStyleType, ThemeColor } from '@ahrowe/ui';
17
+ import { faTrash, faXmark } from '@fortawesome/free-solid-svg-icons';
18
+
19
+ <ActionIcon icon={faXmark} aria-label="Close" onClick={onClose} />
20
+
21
+ // A destructive row action
22
+ <ActionIcon icon={faTrash} color={ThemeColor.Error} title="Delete item" onClick={handleDelete} />
23
+
24
+ // Filled, for an action that should stand out
25
+ <ActionIcon icon={faTrash} styleType={ButtonStyleType.Filled} color={ThemeColor.Error} aria-label="Delete" />
20
26
  ```
21
27
 
22
28
  **Key props:**
@@ -24,9 +30,28 @@ import { faTrash } from '@fortawesome/free-solid-svg-icons';
24
30
  | Prop | Type | Description |
25
31
  |------|------|-------------|
26
32
  | `icon` | `IconDefinition \| ReactElement` | FontAwesome icon or any React element (required) |
27
- | `title` | `string` | Tooltip / accessible label |
28
- | `onClick` | `(event: MouseEvent) => void` | Click handler |
29
- | `className` | `string` | Root element class |
30
- | `ref` | `Ref<HTMLDivElement>` | Ref to the root element |
33
+ | `styleType` | `ButtonStyleType` | Default `Plain`; any of Button's styles |
34
+ | `color` | `ColorValue` | A `ThemeColor` (default `Neutral`) or any CSS colour, see [ThemeColor.md](ThemeColor.md) |
35
+ | `title` | `string` | Tooltip. Give an icon-only button an `aria-label` as well |
36
+ | `onClick` | `(event: MouseEvent<HTMLButtonElement>) => void \| Promise<void>` | Click handler |
37
+ | `disabled` | `boolean` | Fades it and blocks clicks |
38
+ | `ref` | `Ref<HTMLButtonElement>` | Ref to the button |
39
+
40
+ Every other Button prop and native `<button>` attribute passes through, except `size`,
41
+ `children` and `isLoading`. The box is the icon plus `4px` on each side; set `width` and `height`
42
+ for a different one.
31
43
 
32
44
  **Slots:** `root` `icon`
45
+
46
+ ## Migration from the div
47
+
48
+ Before 0.43 an ActionIcon was a `div` with a button role and no colour of its own.
49
+
50
+ - **Types:** `ref` is `Ref<HTMLButtonElement>` and `onClick` receives a
51
+ `MouseEvent<HTMLButtonElement>`. A handler annotated with `HTMLDivElement` no longer compiles;
52
+ drop the annotation or change it. The same goes for the `onClick` of Card and SectionHeader
53
+ `actions`, which render ActionIcons.
54
+ - **Layout:** it is inline, like a button, where the div was a block of its own width. In a flex
55
+ row nothing changes; on its own in a block it now sits in the line.
56
+ - **Look:** it has Button's hover tint, focus ring and ripple, where the div only darkened on
57
+ hover. It takes the surrounding text colour as before; a colour of its own is now `color`.