@primereact/mcp 11.0.0-rc.2

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 (546) hide show
  1. package/LICENSE.md +45 -0
  2. package/README.md +94 -0
  3. package/data/llms/headless/add-ons/introduction.md +16 -0
  4. package/data/llms/headless/components/accordion/api.json +252 -0
  5. package/data/llms/headless/components/accordion.md +196 -0
  6. package/data/llms/headless/components/animateonscroll/api.json +88 -0
  7. package/data/llms/headless/components/animateonscroll.md +141 -0
  8. package/data/llms/headless/components/autocomplete/api.json +787 -0
  9. package/data/llms/headless/components/autocomplete.md +249 -0
  10. package/data/llms/headless/components/avatar/api.json +154 -0
  11. package/data/llms/headless/components/avatar.md +149 -0
  12. package/data/llms/headless/components/badge/api.json +68 -0
  13. package/data/llms/headless/components/badge.md +150 -0
  14. package/data/llms/headless/components/breadcrumb/api.json +142 -0
  15. package/data/llms/headless/components/breadcrumb.md +149 -0
  16. package/data/llms/headless/components/button/api.json +62 -0
  17. package/data/llms/headless/components/button.md +73 -0
  18. package/data/llms/headless/components/card/api.json +36 -0
  19. package/data/llms/headless/components/card.md +96 -0
  20. package/data/llms/headless/components/carousel/api.json +793 -0
  21. package/data/llms/headless/components/carousel.md +196 -0
  22. package/data/llms/headless/components/checkbox/api.json +593 -0
  23. package/data/llms/headless/components/checkbox.md +184 -0
  24. package/data/llms/headless/components/chip/api.json +107 -0
  25. package/data/llms/headless/components/chip.md +141 -0
  26. package/data/llms/headless/components/collapsible/api.json +301 -0
  27. package/data/llms/headless/components/collapsible.md +136 -0
  28. package/data/llms/headless/components/compare/api.json +533 -0
  29. package/data/llms/headless/components/compare.md +142 -0
  30. package/data/llms/headless/components/contextmenu/api.json +495 -0
  31. package/data/llms/headless/components/contextmenu.md +282 -0
  32. package/data/llms/headless/components/datatable/api.json +1680 -0
  33. package/data/llms/headless/components/datatable.md +258 -0
  34. package/data/llms/headless/components/dataview/api.json +199 -0
  35. package/data/llms/headless/components/dataview.md +147 -0
  36. package/data/llms/headless/components/datepicker/api.json +2796 -0
  37. package/data/llms/headless/components/datepicker.md +456 -0
  38. package/data/llms/headless/components/dialog/api.json +626 -0
  39. package/data/llms/headless/components/dialog.md +280 -0
  40. package/data/llms/headless/components/divider/api.json +130 -0
  41. package/data/llms/headless/components/divider.md +92 -0
  42. package/data/llms/headless/components/drawer/api.json +425 -0
  43. package/data/llms/headless/components/drawer.md +220 -0
  44. package/data/llms/headless/components/fieldset/api.json +195 -0
  45. package/data/llms/headless/components/fieldset.md +154 -0
  46. package/data/llms/headless/components/fileupload/api.json +905 -0
  47. package/data/llms/headless/components/fileupload.md +323 -0
  48. package/data/llms/headless/components/floatlabel/api.json +36 -0
  49. package/data/llms/headless/components/floatlabel.md +19 -0
  50. package/data/llms/headless/components/fluid/api.json +36 -0
  51. package/data/llms/headless/components/fluid.md +19 -0
  52. package/data/llms/headless/components/focustrap/api.json +135 -0
  53. package/data/llms/headless/components/focustrap.md +125 -0
  54. package/data/llms/headless/components/gallery/api.json +1349 -0
  55. package/data/llms/headless/components/gallery.md +355 -0
  56. package/data/llms/headless/components/iconfield/api.json +62 -0
  57. package/data/llms/headless/components/iconfield.md +19 -0
  58. package/data/llms/headless/components/iftalabel/api.json +62 -0
  59. package/data/llms/headless/components/iftalabel.md +19 -0
  60. package/data/llms/headless/components/inplace/api.json +340 -0
  61. package/data/llms/headless/components/inplace.md +153 -0
  62. package/data/llms/headless/components/inputcolor/api.json +469 -0
  63. package/data/llms/headless/components/inputcolor.md +253 -0
  64. package/data/llms/headless/components/inputgroup/api.json +62 -0
  65. package/data/llms/headless/components/inputgroup.md +19 -0
  66. package/data/llms/headless/components/inputnumber/api.json +554 -0
  67. package/data/llms/headless/components/inputnumber.md +167 -0
  68. package/data/llms/headless/components/inputotp/api.json +276 -0
  69. package/data/llms/headless/components/inputotp.md +130 -0
  70. package/data/llms/headless/components/inputpassword/api.json +180 -0
  71. package/data/llms/headless/components/inputpassword.md +117 -0
  72. package/data/llms/headless/components/inputtags/api.json +497 -0
  73. package/data/llms/headless/components/inputtags.md +298 -0
  74. package/data/llms/headless/components/inputtext/api.json +81 -0
  75. package/data/llms/headless/components/inputtext.md +109 -0
  76. package/data/llms/headless/components/knob/api.json +429 -0
  77. package/data/llms/headless/components/knob.md +151 -0
  78. package/data/llms/headless/components/label/api.json +62 -0
  79. package/data/llms/headless/components/label.md +19 -0
  80. package/data/llms/headless/components/listbox/api.json +814 -0
  81. package/data/llms/headless/components/listbox.md +194 -0
  82. package/data/llms/headless/components/menu/api.json +1247 -0
  83. package/data/llms/headless/components/menu.md +283 -0
  84. package/data/llms/headless/components/message/api.json +131 -0
  85. package/data/llms/headless/components/message.md +143 -0
  86. package/data/llms/headless/components/metergroup/api.json +266 -0
  87. package/data/llms/headless/components/metergroup.md +129 -0
  88. package/data/llms/headless/components/motion/api.json +237 -0
  89. package/data/llms/headless/components/motion.md +160 -0
  90. package/data/llms/headless/components/navigationmenu/api.json +220 -0
  91. package/data/llms/headless/components/navigationmenu.md +166 -0
  92. package/data/llms/headless/components/orderlist/api.json +196 -0
  93. package/data/llms/headless/components/orderlist.md +221 -0
  94. package/data/llms/headless/components/organizationchart/api.json +372 -0
  95. package/data/llms/headless/components/organizationchart.md +254 -0
  96. package/data/llms/headless/components/paginator/api.json +311 -0
  97. package/data/llms/headless/components/paginator.md +187 -0
  98. package/data/llms/headless/components/panel/api.json +195 -0
  99. package/data/llms/headless/components/panel.md +150 -0
  100. package/data/llms/headless/components/picklist/api.json +293 -0
  101. package/data/llms/headless/components/picklist.md +270 -0
  102. package/data/llms/headless/components/popover/api.json +405 -0
  103. package/data/llms/headless/components/popover.md +301 -0
  104. package/data/llms/headless/components/portal/api.json +56 -0
  105. package/data/llms/headless/components/portal.md +102 -0
  106. package/data/llms/headless/components/positioner/api.json +165 -0
  107. package/data/llms/headless/components/positioner.md +181 -0
  108. package/data/llms/headless/components/progressbar/api.json +87 -0
  109. package/data/llms/headless/components/progressbar.md +122 -0
  110. package/data/llms/headless/components/progressspinner/api.json +337 -0
  111. package/data/llms/headless/components/progressspinner.md +128 -0
  112. package/data/llms/headless/components/radiobutton/api.json +569 -0
  113. package/data/llms/headless/components/radiobutton.md +195 -0
  114. package/data/llms/headless/components/rating/api.json +347 -0
  115. package/data/llms/headless/components/rating.md +181 -0
  116. package/data/llms/headless/components/scrollarea/api.json +730 -0
  117. package/data/llms/headless/components/scrollarea.md +232 -0
  118. package/data/llms/headless/components/select/api.json +829 -0
  119. package/data/llms/headless/components/select.md +262 -0
  120. package/data/llms/headless/components/sidebar/api.json +433 -0
  121. package/data/llms/headless/components/sidebar.md +266 -0
  122. package/data/llms/headless/components/skeleton/api.json +68 -0
  123. package/data/llms/headless/components/skeleton.md +95 -0
  124. package/data/llms/headless/components/slider/api.json +559 -0
  125. package/data/llms/headless/components/slider.md +158 -0
  126. package/data/llms/headless/components/speeddial/api.json +459 -0
  127. package/data/llms/headless/components/speeddial.md +181 -0
  128. package/data/llms/headless/components/splitter/api.json +582 -0
  129. package/data/llms/headless/components/splitter.md +159 -0
  130. package/data/llms/headless/components/stepper/api.json +385 -0
  131. package/data/llms/headless/components/stepper.md +183 -0
  132. package/data/llms/headless/components/styleclass/api.json +134 -0
  133. package/data/llms/headless/components/styleclass.md +129 -0
  134. package/data/llms/headless/components/tabs/api.json +336 -0
  135. package/data/llms/headless/components/tabs.md +158 -0
  136. package/data/llms/headless/components/tag/api.json +62 -0
  137. package/data/llms/headless/components/tag.md +121 -0
  138. package/data/llms/headless/components/terminal/api.json +117 -0
  139. package/data/llms/headless/components/terminal.md +183 -0
  140. package/data/llms/headless/components/textarea/api.json +81 -0
  141. package/data/llms/headless/components/textarea.md +110 -0
  142. package/data/llms/headless/components/timeline/api.json +270 -0
  143. package/data/llms/headless/components/timeline.md +117 -0
  144. package/data/llms/headless/components/toast/api.json +455 -0
  145. package/data/llms/headless/components/toast.md +277 -0
  146. package/data/llms/headless/components/togglebutton/api.json +357 -0
  147. package/data/llms/headless/components/togglebutton.md +183 -0
  148. package/data/llms/headless/components/toggleswitch/api.json +326 -0
  149. package/data/llms/headless/components/toggleswitch.md +164 -0
  150. package/data/llms/headless/components/toolbar/api.json +68 -0
  151. package/data/llms/headless/components/toolbar.md +96 -0
  152. package/data/llms/headless/components/tooltip/api.json +478 -0
  153. package/data/llms/headless/components/tooltip.md +233 -0
  154. package/data/llms/headless/components/tree/api.json +1297 -0
  155. package/data/llms/headless/components/tree.md +297 -0
  156. package/data/llms/headless/components/treetable/api.json +1680 -0
  157. package/data/llms/headless/components/treetable.md +177 -0
  158. package/data/llms/headless/guides/ai/llms.md +25 -0
  159. package/data/llms/headless/guides/installation.md +126 -0
  160. package/data/llms/headless/guides/introduction.md +20 -0
  161. package/data/llms/headless/guides/misc/accessibility.md +228 -0
  162. package/data/llms/headless/llms.md +25 -0
  163. package/data/llms/headless/resources/introduction.md +15 -0
  164. package/data/llms/hooks/gettingstarted/introduction.md +34 -0
  165. package/data/llms/hooks/gettingstarted/setup.md +54 -0
  166. package/data/llms/hooks/use-attr-selector.md +25 -0
  167. package/data/llms/hooks/use-controlled-state.md +31 -0
  168. package/data/llms/hooks/use-event-listener.md +37 -0
  169. package/data/llms/hooks/use-filter.md +312 -0
  170. package/data/llms/hooks/use-hot-key.md +40 -0
  171. package/data/llms/hooks/use-id.md +24 -0
  172. package/data/llms/hooks/use-intersection-observer.md +42 -0
  173. package/data/llms/hooks/use-is-mobile.md +24 -0
  174. package/data/llms/hooks/use-key-filter.md +139 -0
  175. package/data/llms/hooks/use-local-storage.md +28 -0
  176. package/data/llms/hooks/use-mask.md +53 -0
  177. package/data/llms/hooks/use-match-media.md +28 -0
  178. package/data/llms/hooks/use-mount-effect.md +25 -0
  179. package/data/llms/hooks/use-mounted.md +36 -0
  180. package/data/llms/hooks/use-number-formatter.md +48 -0
  181. package/data/llms/hooks/use-presence.md +44 -0
  182. package/data/llms/hooks/use-previous.md +28 -0
  183. package/data/llms/hooks/use-props.md +37 -0
  184. package/data/llms/hooks/use-queue-task.md +29 -0
  185. package/data/llms/hooks/use-scrolltop.md +87 -0
  186. package/data/llms/hooks/use-sortable-list.md +226 -0
  187. package/data/llms/hooks/use-tree-filter.md +216 -0
  188. package/data/llms/hooks/use-unmount-effect.md +23 -0
  189. package/data/llms/hooks/use-update-effect.md +27 -0
  190. package/data/llms/hooks/use-view-transition.md +31 -0
  191. package/data/llms/hooks/use-visibility-change.md +30 -0
  192. package/data/llms/llms-full.txt +125291 -0
  193. package/data/llms/llms.txt +379 -0
  194. package/data/llms/manifest.json +12409 -0
  195. package/data/llms/mcp-data.json +14481 -0
  196. package/data/llms/primitive/add-ons/introduction.md +16 -0
  197. package/data/llms/primitive/components/accordion/api.json +1411 -0
  198. package/data/llms/primitive/components/accordion.md +231 -0
  199. package/data/llms/primitive/components/animateonscroll/api.json +193 -0
  200. package/data/llms/primitive/components/animateonscroll.md +91 -0
  201. package/data/llms/primitive/components/autocomplete/api.json +3167 -0
  202. package/data/llms/primitive/components/autocomplete.md +344 -0
  203. package/data/llms/primitive/components/avatar/api.json +703 -0
  204. package/data/llms/primitive/components/avatar.md +134 -0
  205. package/data/llms/primitive/components/badge/api.json +363 -0
  206. package/data/llms/primitive/components/badge.md +118 -0
  207. package/data/llms/primitive/components/breadcrumb/api.json +1162 -0
  208. package/data/llms/primitive/components/breadcrumb.md +196 -0
  209. package/data/llms/primitive/components/button/api.json +246 -0
  210. package/data/llms/primitive/components/button.md +114 -0
  211. package/data/llms/primitive/components/buttongroup/api.json +168 -0
  212. package/data/llms/primitive/components/buttongroup.md +43 -0
  213. package/data/llms/primitive/components/card/api.json +1252 -0
  214. package/data/llms/primitive/components/card.md +159 -0
  215. package/data/llms/primitive/components/carousel/api.json +1374 -0
  216. package/data/llms/primitive/components/carousel.md +220 -0
  217. package/data/llms/primitive/components/checkbox/api.json +697 -0
  218. package/data/llms/primitive/components/checkbox.md +160 -0
  219. package/data/llms/primitive/components/checkboxgroup/api.json +252 -0
  220. package/data/llms/primitive/components/checkboxgroup.md +58 -0
  221. package/data/llms/primitive/components/chip/api.json +853 -0
  222. package/data/llms/primitive/components/chip.md +135 -0
  223. package/data/llms/primitive/components/collapsible/api.json +581 -0
  224. package/data/llms/primitive/components/collapsible.md +133 -0
  225. package/data/llms/primitive/components/compare/api.json +909 -0
  226. package/data/llms/primitive/components/compare.md +156 -0
  227. package/data/llms/primitive/components/contextmenu/api.json +3454 -0
  228. package/data/llms/primitive/components/contextmenu.md +483 -0
  229. package/data/llms/primitive/components/datatable/api.json +7832 -0
  230. package/data/llms/primitive/components/datatable.md +561 -0
  231. package/data/llms/primitive/components/dataview/api.json +819 -0
  232. package/data/llms/primitive/components/dataview.md +163 -0
  233. package/data/llms/primitive/components/datepicker/api.json +9055 -0
  234. package/data/llms/primitive/components/datepicker.md +760 -0
  235. package/data/llms/primitive/components/dialog/api.json +2491 -0
  236. package/data/llms/primitive/components/dialog.md +276 -0
  237. package/data/llms/primitive/components/divider/api.json +214 -0
  238. package/data/llms/primitive/components/divider.md +96 -0
  239. package/data/llms/primitive/components/drawer/api.json +1879 -0
  240. package/data/llms/primitive/components/drawer.md +220 -0
  241. package/data/llms/primitive/components/fieldset/api.json +1116 -0
  242. package/data/llms/primitive/components/fieldset.md +183 -0
  243. package/data/llms/primitive/components/fileupload/api.json +2445 -0
  244. package/data/llms/primitive/components/fileupload.md +282 -0
  245. package/data/llms/primitive/components/floatlabel/api.json +176 -0
  246. package/data/llms/primitive/components/floatlabel.md +47 -0
  247. package/data/llms/primitive/components/focustrap/api.json +241 -0
  248. package/data/llms/primitive/components/focustrap.md +93 -0
  249. package/data/llms/primitive/components/gallery/api.json +3622 -0
  250. package/data/llms/primitive/components/gallery.md +387 -0
  251. package/data/llms/primitive/components/iconfield/api.json +322 -0
  252. package/data/llms/primitive/components/iconfield.md +53 -0
  253. package/data/llms/primitive/components/iftalabel/api.json +177 -0
  254. package/data/llms/primitive/components/iftalabel.md +47 -0
  255. package/data/llms/primitive/components/inplace/api.json +783 -0
  256. package/data/llms/primitive/components/inplace.md +141 -0
  257. package/data/llms/primitive/components/inputcolor/api.json +2211 -0
  258. package/data/llms/primitive/components/inputcolor.md +295 -0
  259. package/data/llms/primitive/components/inputnumber/api.json +469 -0
  260. package/data/llms/primitive/components/inputnumber.md +99 -0
  261. package/data/llms/primitive/components/inputotp/api.json +469 -0
  262. package/data/llms/primitive/components/inputotp.md +121 -0
  263. package/data/llms/primitive/components/inputpassword/api.json +278 -0
  264. package/data/llms/primitive/components/inputpassword.md +84 -0
  265. package/data/llms/primitive/components/inputtags/api.json +407 -0
  266. package/data/llms/primitive/components/inputtags.md +243 -0
  267. package/data/llms/primitive/components/inputtext/api.json +207 -0
  268. package/data/llms/primitive/components/inputtext.md +81 -0
  269. package/data/llms/primitive/components/knob/api.json +841 -0
  270. package/data/llms/primitive/components/knob.md +148 -0
  271. package/data/llms/primitive/components/label/api.json +177 -0
  272. package/data/llms/primitive/components/label.md +44 -0
  273. package/data/llms/primitive/components/listbox/api.json +1741 -0
  274. package/data/llms/primitive/components/listbox.md +206 -0
  275. package/data/llms/primitive/components/menu/api.json +3836 -0
  276. package/data/llms/primitive/components/menu.md +479 -0
  277. package/data/llms/primitive/components/message/api.json +863 -0
  278. package/data/llms/primitive/components/message.md +151 -0
  279. package/data/llms/primitive/components/metergroup/api.json +1222 -0
  280. package/data/llms/primitive/components/metergroup.md +209 -0
  281. package/data/llms/primitive/components/motion.md +112 -0
  282. package/data/llms/primitive/components/navigationmenu/api.json +298 -0
  283. package/data/llms/primitive/components/navigationmenu.md +184 -0
  284. package/data/llms/primitive/components/organizationchart.md +133 -0
  285. package/data/llms/primitive/components/paginator/api.json +1637 -0
  286. package/data/llms/primitive/components/paginator.md +223 -0
  287. package/data/llms/primitive/components/panel/api.json +1270 -0
  288. package/data/llms/primitive/components/panel.md +186 -0
  289. package/data/llms/primitive/components/popover/api.json +2281 -0
  290. package/data/llms/primitive/components/popover.md +277 -0
  291. package/data/llms/primitive/components/portal/api.json +176 -0
  292. package/data/llms/primitive/components/portal.md +79 -0
  293. package/data/llms/primitive/components/progressbar/api.json +857 -0
  294. package/data/llms/primitive/components/progressbar.md +153 -0
  295. package/data/llms/primitive/components/progressspinner/api.json +725 -0
  296. package/data/llms/primitive/components/progressspinner.md +133 -0
  297. package/data/llms/primitive/components/radiobutton/api.json +929 -0
  298. package/data/llms/primitive/components/radiobutton.md +201 -0
  299. package/data/llms/primitive/components/rating/api.json +878 -0
  300. package/data/llms/primitive/components/rating.md +160 -0
  301. package/data/llms/primitive/components/scrollarea/api.json +1187 -0
  302. package/data/llms/primitive/components/scrollarea.md +255 -0
  303. package/data/llms/primitive/components/select/api.json +3167 -0
  304. package/data/llms/primitive/components/select.md +351 -0
  305. package/data/llms/primitive/components/sidebar/api.json +3699 -0
  306. package/data/llms/primitive/components/sidebar.md +444 -0
  307. package/data/llms/primitive/components/skeleton/api.json +213 -0
  308. package/data/llms/primitive/components/skeleton.md +80 -0
  309. package/data/llms/primitive/components/slider/api.json +1066 -0
  310. package/data/llms/primitive/components/slider.md +161 -0
  311. package/data/llms/primitive/components/speeddial/api.json +1002 -0
  312. package/data/llms/primitive/components/speeddial.md +197 -0
  313. package/data/llms/primitive/components/splitter/api.json +901 -0
  314. package/data/llms/primitive/components/splitter.md +137 -0
  315. package/data/llms/primitive/components/stepper/api.json +2102 -0
  316. package/data/llms/primitive/components/stepper.md +253 -0
  317. package/data/llms/primitive/components/styleclass.md +399 -0
  318. package/data/llms/primitive/components/tabs/api.json +1705 -0
  319. package/data/llms/primitive/components/tabs.md +200 -0
  320. package/data/llms/primitive/components/tag/api.json +189 -0
  321. package/data/llms/primitive/components/tag.md +100 -0
  322. package/data/llms/primitive/components/terminal/api.json +1709 -0
  323. package/data/llms/primitive/components/terminal.md +227 -0
  324. package/data/llms/primitive/components/textarea/api.json +213 -0
  325. package/data/llms/primitive/components/textarea.md +83 -0
  326. package/data/llms/primitive/components/timeline/api.json +1180 -0
  327. package/data/llms/primitive/components/timeline.md +185 -0
  328. package/data/llms/primitive/components/toast/api.json +2102 -0
  329. package/data/llms/primitive/components/toast.md +291 -0
  330. package/data/llms/primitive/components/togglebutton/api.json +433 -0
  331. package/data/llms/primitive/components/togglebutton.md +161 -0
  332. package/data/llms/primitive/components/togglebuttongroup/api.json +276 -0
  333. package/data/llms/primitive/components/togglebuttongroup.md +61 -0
  334. package/data/llms/primitive/components/toggleswitch/api.json +681 -0
  335. package/data/llms/primitive/components/toggleswitch.md +149 -0
  336. package/data/llms/primitive/components/toolbar/api.json +646 -0
  337. package/data/llms/primitive/components/toolbar.md +126 -0
  338. package/data/llms/primitive/components/tooltip/api.json +1534 -0
  339. package/data/llms/primitive/components/tooltip.md +202 -0
  340. package/data/llms/primitive/components/tree/api.json +2952 -0
  341. package/data/llms/primitive/components/tree.md +292 -0
  342. package/data/llms/primitive/components/treetable.md +187 -0
  343. package/data/llms/primitive/components/visuallyhidden/api.json +186 -0
  344. package/data/llms/primitive/components/visuallyhidden.md +87 -0
  345. package/data/llms/primitive/guides/ai/llms.md +25 -0
  346. package/data/llms/primitive/guides/icons/customicons.md +47 -0
  347. package/data/llms/primitive/guides/icons/primeicons.md +112 -0
  348. package/data/llms/primitive/guides/installation.md +115 -0
  349. package/data/llms/primitive/guides/introduction.md +20 -0
  350. package/data/llms/primitive/guides/misc/accessibility.md +215 -0
  351. package/data/llms/primitive/guides/misc/passthrough.md +95 -0
  352. package/data/llms/primitive/guides/misc/rtl.md +27 -0
  353. package/data/llms/primitive/llms.md +25 -0
  354. package/data/llms/primitive/resources/introduction.md +15 -0
  355. package/data/llms/styled/add-ons/introduction.md +16 -0
  356. package/data/llms/styled/components/accordion.md +735 -0
  357. package/data/llms/styled/components/animateonscroll.md +264 -0
  358. package/data/llms/styled/components/autocomplete.md +1597 -0
  359. package/data/llms/styled/components/avatar.md +313 -0
  360. package/data/llms/styled/components/badge.md +213 -0
  361. package/data/llms/styled/components/breadcrumb.md +461 -0
  362. package/data/llms/styled/components/button/api.json +246 -0
  363. package/data/llms/styled/components/button.md +641 -0
  364. package/data/llms/styled/components/buttongroup.md +614 -0
  365. package/data/llms/styled/components/card.md +228 -0
  366. package/data/llms/styled/components/carousel.md +388 -0
  367. package/data/llms/styled/components/checkbox.md +329 -0
  368. package/data/llms/styled/components/checkboxgroup.md +619 -0
  369. package/data/llms/styled/components/chip.md +300 -0
  370. package/data/llms/styled/components/compare.md +271 -0
  371. package/data/llms/styled/components/contextmenu.md +550 -0
  372. package/data/llms/styled/components/datatable.md +8259 -0
  373. package/data/llms/styled/components/dataview.md +907 -0
  374. package/data/llms/styled/components/datepicker.md +2807 -0
  375. package/data/llms/styled/components/dialog.md +1047 -0
  376. package/data/llms/styled/components/divider.md +207 -0
  377. package/data/llms/styled/components/drawer.md +470 -0
  378. package/data/llms/styled/components/fieldset.md +334 -0
  379. package/data/llms/styled/components/fileupload.md +747 -0
  380. package/data/llms/styled/components/floatlabel/api.json +210 -0
  381. package/data/llms/styled/components/floatlabel.md +231 -0
  382. package/data/llms/styled/components/fluid/api.json +204 -0
  383. package/data/llms/styled/components/fluid.md +177 -0
  384. package/data/llms/styled/components/focustrap.md +203 -0
  385. package/data/llms/styled/components/gallery.md +553 -0
  386. package/data/llms/styled/components/iconfield/api.json +382 -0
  387. package/data/llms/styled/components/iconfield.md +385 -0
  388. package/data/llms/styled/components/iftalabel/api.json +237 -0
  389. package/data/llms/styled/components/iftalabel.md +158 -0
  390. package/data/llms/styled/components/inplace.md +312 -0
  391. package/data/llms/styled/components/inputcolor.md +674 -0
  392. package/data/llms/styled/components/inputgroup/api.json +399 -0
  393. package/data/llms/styled/components/inputgroup.md +604 -0
  394. package/data/llms/styled/components/inputmask.md +282 -0
  395. package/data/llms/styled/components/inputnumber.md +563 -0
  396. package/data/llms/styled/components/inputotp.md +335 -0
  397. package/data/llms/styled/components/inputpassword.md +630 -0
  398. package/data/llms/styled/components/inputtags.md +727 -0
  399. package/data/llms/styled/components/inputtext.md +190 -0
  400. package/data/llms/styled/components/keyfilter.md +289 -0
  401. package/data/llms/styled/components/knob.md +305 -0
  402. package/data/llms/styled/components/label/api.json +237 -0
  403. package/data/llms/styled/components/label.md +224 -0
  404. package/data/llms/styled/components/listbox.md +807 -0
  405. package/data/llms/styled/components/menu.md +1175 -0
  406. package/data/llms/styled/components/message.md +570 -0
  407. package/data/llms/styled/components/metergroup.md +449 -0
  408. package/data/llms/styled/components/navigationmenu.md +926 -0
  409. package/data/llms/styled/components/orderlist.md +519 -0
  410. package/data/llms/styled/components/organizationchart/api.json +1457 -0
  411. package/data/llms/styled/components/organizationchart.md +791 -0
  412. package/data/llms/styled/components/overlaymanager.md +519 -0
  413. package/data/llms/styled/components/paginator.md +506 -0
  414. package/data/llms/styled/components/panel.md +394 -0
  415. package/data/llms/styled/components/picklist.md +1004 -0
  416. package/data/llms/styled/components/popover.md +372 -0
  417. package/data/llms/styled/components/progressbar.md +438 -0
  418. package/data/llms/styled/components/progressspinner.md +128 -0
  419. package/data/llms/styled/components/radiobutton.md +488 -0
  420. package/data/llms/styled/components/rating/api.json +766 -0
  421. package/data/llms/styled/components/rating.md +518 -0
  422. package/data/llms/styled/components/scrollarea.md +627 -0
  423. package/data/llms/styled/components/select.md +2122 -0
  424. package/data/llms/styled/components/sidebar.md +1587 -0
  425. package/data/llms/styled/components/skeleton.md +226 -0
  426. package/data/llms/styled/components/slider.md +453 -0
  427. package/data/llms/styled/components/speeddial.md +723 -0
  428. package/data/llms/styled/components/splitter.md +536 -0
  429. package/data/llms/styled/components/stepper.md +614 -0
  430. package/data/llms/styled/components/tabs.md +543 -0
  431. package/data/llms/styled/components/tag.md +263 -0
  432. package/data/llms/styled/components/terminal.md +543 -0
  433. package/data/llms/styled/components/textarea.md +257 -0
  434. package/data/llms/styled/components/timeline.md +620 -0
  435. package/data/llms/styled/components/toast.md +1013 -0
  436. package/data/llms/styled/components/togglebutton.md +287 -0
  437. package/data/llms/styled/components/togglebuttongroup.md +328 -0
  438. package/data/llms/styled/components/toggleswitch.md +262 -0
  439. package/data/llms/styled/components/toolbar.md +187 -0
  440. package/data/llms/styled/components/tooltip.md +430 -0
  441. package/data/llms/styled/components/tree.md +1386 -0
  442. package/data/llms/styled/components/treetable.md +6842 -0
  443. package/data/llms/styled/guides/ai/llms.md +25 -0
  444. package/data/llms/styled/guides/configuration.md +151 -0
  445. package/data/llms/styled/guides/icons/customicons.md +47 -0
  446. package/data/llms/styled/guides/icons/primeicons.md +112 -0
  447. package/data/llms/styled/guides/installation/astro.md +97 -0
  448. package/data/llms/styled/guides/installation/manual.md +3 -0
  449. package/data/llms/styled/guides/installation/nextjs.md +129 -0
  450. package/data/llms/styled/guides/installation/react-router.md +88 -0
  451. package/data/llms/styled/guides/installation/tanstack.md +92 -0
  452. package/data/llms/styled/guides/installation/vite.md +91 -0
  453. package/data/llms/styled/guides/installation.md +42 -0
  454. package/data/llms/styled/guides/introduction.md +20 -0
  455. package/data/llms/styled/guides/misc/accessibility.md +211 -0
  456. package/data/llms/styled/guides/misc/animations.md +389 -0
  457. package/data/llms/styled/guides/misc/passthrough.md +95 -0
  458. package/data/llms/styled/guides/misc/rtl.md +27 -0
  459. package/data/llms/styled/guides/theming/styled.md +779 -0
  460. package/data/llms/styled/guides/theming/tailwind.md +473 -0
  461. package/data/llms/styled/guides/theming/unstyled.md +115 -0
  462. package/data/llms/styled/resources/introduction.md +15 -0
  463. package/data/llms/tailwind/add-ons/introduction.md +16 -0
  464. package/data/llms/tailwind/components/accordion.md +383 -0
  465. package/data/llms/tailwind/components/autocomplete.md +1346 -0
  466. package/data/llms/tailwind/components/avatar.md +305 -0
  467. package/data/llms/tailwind/components/badge.md +207 -0
  468. package/data/llms/tailwind/components/breadcrumb.md +387 -0
  469. package/data/llms/tailwind/components/button/api.json +246 -0
  470. package/data/llms/tailwind/components/button.md +617 -0
  471. package/data/llms/tailwind/components/buttongroup.md +599 -0
  472. package/data/llms/tailwind/components/card.md +224 -0
  473. package/data/llms/tailwind/components/carousel.md +329 -0
  474. package/data/llms/tailwind/components/checkbox.md +179 -0
  475. package/data/llms/tailwind/components/checkboxgroup.md +279 -0
  476. package/data/llms/tailwind/components/chip.md +304 -0
  477. package/data/llms/tailwind/components/compare.md +295 -0
  478. package/data/llms/tailwind/components/contextmenu.md +415 -0
  479. package/data/llms/tailwind/components/datatable.md +4062 -0
  480. package/data/llms/tailwind/components/dataview.md +864 -0
  481. package/data/llms/tailwind/components/datepicker.md +823 -0
  482. package/data/llms/tailwind/components/dialog.md +1216 -0
  483. package/data/llms/tailwind/components/divider.md +205 -0
  484. package/data/llms/tailwind/components/drawer.md +500 -0
  485. package/data/llms/tailwind/components/fieldset.md +326 -0
  486. package/data/llms/tailwind/components/fluid.md +117 -0
  487. package/data/llms/tailwind/components/iconfield.md +197 -0
  488. package/data/llms/tailwind/components/inplace.md +324 -0
  489. package/data/llms/tailwind/components/inputcolor.md +493 -0
  490. package/data/llms/tailwind/components/inputgroup.md +375 -0
  491. package/data/llms/tailwind/components/inputnumber.md +463 -0
  492. package/data/llms/tailwind/components/inputotp.md +255 -0
  493. package/data/llms/tailwind/components/inputpassword.md +543 -0
  494. package/data/llms/tailwind/components/inputtext.md +141 -0
  495. package/data/llms/tailwind/components/label.md +100 -0
  496. package/data/llms/tailwind/components/listbox.md +886 -0
  497. package/data/llms/tailwind/components/menu.md +1049 -0
  498. package/data/llms/tailwind/components/message.md +575 -0
  499. package/data/llms/tailwind/components/metergroup.md +510 -0
  500. package/data/llms/tailwind/components/navigationmenu.md +528 -0
  501. package/data/llms/tailwind/components/overlaymanager.md +567 -0
  502. package/data/llms/tailwind/components/paginator.md +306 -0
  503. package/data/llms/tailwind/components/panel.md +395 -0
  504. package/data/llms/tailwind/components/popover.md +424 -0
  505. package/data/llms/tailwind/components/progressbar.md +313 -0
  506. package/data/llms/tailwind/components/radiobutton.md +366 -0
  507. package/data/llms/tailwind/components/rating.md +300 -0
  508. package/data/llms/tailwind/components/scrollarea.md +638 -0
  509. package/data/llms/tailwind/components/select.md +1220 -0
  510. package/data/llms/tailwind/components/sidebar.md +1511 -0
  511. package/data/llms/tailwind/components/skeleton.md +236 -0
  512. package/data/llms/tailwind/components/slider.md +291 -0
  513. package/data/llms/tailwind/components/splitter.md +546 -0
  514. package/data/llms/tailwind/components/tabs.md +462 -0
  515. package/data/llms/tailwind/components/tag.md +255 -0
  516. package/data/llms/tailwind/components/textarea.md +170 -0
  517. package/data/llms/tailwind/components/timeline.md +656 -0
  518. package/data/llms/tailwind/components/toast.md +246 -0
  519. package/data/llms/tailwind/components/togglebutton.md +264 -0
  520. package/data/llms/tailwind/components/togglebuttongroup.md +262 -0
  521. package/data/llms/tailwind/components/toggleswitch.md +203 -0
  522. package/data/llms/tailwind/components/toolbar.md +192 -0
  523. package/data/llms/tailwind/components/tooltip.md +449 -0
  524. package/data/llms/tailwind/guides/ai/llms.md +25 -0
  525. package/data/llms/tailwind/guides/icons/customicons.md +47 -0
  526. package/data/llms/tailwind/guides/icons/primeicons.md +112 -0
  527. package/data/llms/tailwind/guides/installation/astro.md +165 -0
  528. package/data/llms/tailwind/guides/installation/manual.md +3 -0
  529. package/data/llms/tailwind/guides/installation/nextjs.md +169 -0
  530. package/data/llms/tailwind/guides/installation/react-router.md +157 -0
  531. package/data/llms/tailwind/guides/installation/tanstack.md +161 -0
  532. package/data/llms/tailwind/guides/installation/vite.md +160 -0
  533. package/data/llms/tailwind/guides/installation.md +42 -0
  534. package/data/llms/tailwind/guides/introduction.md +20 -0
  535. package/data/llms/tailwind/guides/misc/accessibility.md +205 -0
  536. package/data/llms/tailwind/guides/misc/passthrough.md +95 -0
  537. package/data/llms/tailwind/guides/misc/rtl.md +27 -0
  538. package/data/llms/tailwind/guides/theming/guide.md +179 -0
  539. package/data/llms/tailwind/guides/theming.md +191 -0
  540. package/data/llms/tailwind/llms.md +25 -0
  541. package/data/llms/tailwind/resources/introduction.md +15 -0
  542. package/data/manifest.json +12409 -0
  543. package/data/mcp-data.json +14481 -0
  544. package/dist/index.d.ts +9 -0
  545. package/dist/index.js +2 -0
  546. package/package.json +61 -0
@@ -0,0 +1,1680 @@
1
+ [
2
+ {
3
+ "name": "useDataTable",
4
+ "source": "apps/showcase/assets/apidoc/usedatatable.json",
5
+ "data": {
6
+ "description": "The useDataTable manages the state and functionality of a DataTable component.",
7
+ "interfaces": {
8
+ "UseDataTableSortEvent": {
9
+ "description": "Event object for DataTable sort changes.",
10
+ "relatedProp": "",
11
+ "props": [
12
+ {
13
+ "name": "originalEvent",
14
+ "type": "SyntheticEvent",
15
+ "default": "",
16
+ "description": "The original browser event that triggered the sort."
17
+ },
18
+ {
19
+ "name": "field",
20
+ "type": "string",
21
+ "default": "",
22
+ "description": "The field name that was sorted."
23
+ },
24
+ {
25
+ "name": "order",
26
+ "type": "SortOrder",
27
+ "default": "",
28
+ "description": "The new sort order."
29
+ },
30
+ {
31
+ "name": "multiSortMeta",
32
+ "type": "SortMeta[]",
33
+ "default": "",
34
+ "description": "Multi-sort metadata when sorting by multiple columns."
35
+ }
36
+ ],
37
+ "methods": []
38
+ },
39
+ "UseDataTableExpansionEvent": {
40
+ "description": "Defines the event object for row expansion changes.",
41
+ "relatedProp": "",
42
+ "props": [
43
+ {
44
+ "name": "originalEvent",
45
+ "type": "SyntheticEvent",
46
+ "default": "",
47
+ "description": "Browser event that triggered the change."
48
+ },
49
+ {
50
+ "name": "value",
51
+ "type": "ExpandedKeys",
52
+ "default": "",
53
+ "description": "The new expanded keys map."
54
+ }
55
+ ],
56
+ "methods": []
57
+ },
58
+ "UseDataTableColumnResizeEvent": {
59
+ "description": "Event object for column resize end.",
60
+ "relatedProp": "",
61
+ "props": [
62
+ {
63
+ "name": "originalEvent",
64
+ "type": "MouseEvent | TouchEvent",
65
+ "default": "",
66
+ "description": "The original browser event."
67
+ },
68
+ {
69
+ "name": "columnIndex",
70
+ "type": "number",
71
+ "default": "",
72
+ "description": "The column index that was resized."
73
+ },
74
+ {
75
+ "name": "delta",
76
+ "type": "number",
77
+ "default": "",
78
+ "description": "The pixel delta of the resize."
79
+ }
80
+ ],
81
+ "methods": []
82
+ },
83
+ "UseDataTableCellEditEvent": {
84
+ "description": "Event object for cell edit completion.",
85
+ "relatedProp": "",
86
+ "props": [
87
+ {
88
+ "name": "originalEvent",
89
+ "type": "SyntheticEvent",
90
+ "default": "",
91
+ "description": "The original browser event."
92
+ },
93
+ {
94
+ "name": "rowData",
95
+ "type": "Record<string, unknown>",
96
+ "default": "",
97
+ "description": "The row data being edited."
98
+ },
99
+ {
100
+ "name": "newRowData",
101
+ "type": "Record<string, unknown>",
102
+ "default": "",
103
+ "description": "The new row data after editing."
104
+ },
105
+ {
106
+ "name": "field",
107
+ "type": "string",
108
+ "default": "",
109
+ "description": "The field name of the cell."
110
+ },
111
+ {
112
+ "name": "value",
113
+ "type": "unknown",
114
+ "default": "",
115
+ "description": "The original cell value."
116
+ },
117
+ {
118
+ "name": "newValue",
119
+ "type": "unknown",
120
+ "default": "",
121
+ "description": "The new cell value."
122
+ },
123
+ {
124
+ "name": "rowIndex",
125
+ "type": "number",
126
+ "default": "",
127
+ "description": "The row index."
128
+ },
129
+ {
130
+ "name": "type",
131
+ "type": "\"enter\" | \"tab\" | \"outside\" | \"escape\"",
132
+ "default": "",
133
+ "description": "The type of action that completed the edit."
134
+ },
135
+ {
136
+ "name": "preventDefault",
137
+ "type": "() => void",
138
+ "default": "",
139
+ "description": "Call to prevent the edit from completing (keep cell in edit mode)."
140
+ }
141
+ ],
142
+ "methods": []
143
+ },
144
+ "UseDataTableRowEditEvent": {
145
+ "description": "Event object for row edit operations.",
146
+ "relatedProp": "",
147
+ "props": [
148
+ {
149
+ "name": "originalEvent",
150
+ "type": "SyntheticEvent",
151
+ "default": "",
152
+ "description": "The original browser event."
153
+ },
154
+ {
155
+ "name": "data",
156
+ "type": "Record<string, unknown>",
157
+ "default": "",
158
+ "description": "The row data."
159
+ },
160
+ {
161
+ "name": "newData",
162
+ "type": "Record<string, unknown>",
163
+ "default": "",
164
+ "description": "The new row data (for save operations)."
165
+ },
166
+ {
167
+ "name": "index",
168
+ "type": "number",
169
+ "default": "",
170
+ "description": "The row index."
171
+ }
172
+ ],
173
+ "methods": []
174
+ },
175
+ "UseDataTableEditingEvent": {
176
+ "description": "Event object for editing keys change.",
177
+ "relatedProp": "",
178
+ "props": [
179
+ {
180
+ "name": "originalEvent",
181
+ "type": "SyntheticEvent",
182
+ "default": "",
183
+ "description": "The original browser event."
184
+ },
185
+ {
186
+ "name": "value",
187
+ "type": "EditingKeys",
188
+ "default": "",
189
+ "description": "The new editing keys map."
190
+ }
191
+ ],
192
+ "methods": []
193
+ },
194
+ "UseDataTableFilterEvent": {
195
+ "description": "Event fired when filters change.",
196
+ "relatedProp": "",
197
+ "props": [
198
+ {
199
+ "name": "originalEvent",
200
+ "type": "SyntheticEvent",
201
+ "default": ""
202
+ },
203
+ {
204
+ "name": "filters",
205
+ "type": "DataTableFilterMeta",
206
+ "default": ""
207
+ }
208
+ ],
209
+ "methods": []
210
+ },
211
+ "UseDataTableFilterExposes": {
212
+ "description": "Defines filter-related methods exposed by useDataTable.",
213
+ "relatedProp": "",
214
+ "props": [
215
+ {
216
+ "name": "setFieldFilter",
217
+ "type": "(event: SyntheticEvent, field: string, meta: ColumnFilterMeta) => void",
218
+ "default": "",
219
+ "description": "Sets the filter for a specific field."
220
+ },
221
+ {
222
+ "name": "clearFieldFilter",
223
+ "type": "(event: SyntheticEvent, field: string) => void",
224
+ "default": "",
225
+ "description": "Clears the filter for a specific field."
226
+ },
227
+ {
228
+ "name": "clearAllFilters",
229
+ "type": "(event: SyntheticEvent) => void",
230
+ "default": "",
231
+ "description": "Clears all filters."
232
+ },
233
+ {
234
+ "name": "addConstraint",
235
+ "type": "(event: SyntheticEvent, field: string, defaultMatchMode?: FilterMatchMode) => void",
236
+ "default": "",
237
+ "description": "Adds a new constraint to a field's filter."
238
+ },
239
+ {
240
+ "name": "removeConstraint",
241
+ "type": "(event: SyntheticEvent, field: string, index: number) => void",
242
+ "default": "",
243
+ "description": "Removes a constraint from a field's filter by index."
244
+ },
245
+ {
246
+ "name": "setOperator",
247
+ "type": "(event: SyntheticEvent, field: string, operator: \"and\" | \"or\") => void",
248
+ "default": "",
249
+ "description": "Sets the operator (and/or) for a field's filter."
250
+ },
251
+ {
252
+ "name": "setConstraintValue",
253
+ "type": "(event: SyntheticEvent, field: string, index: number, value: unknown, matchMode?: FilterMatchMode) => void",
254
+ "default": "",
255
+ "description": "Updates a specific constraint's value and optionally its matchMode."
256
+ },
257
+ {
258
+ "name": "setConstraintMatchMode",
259
+ "type": "(event: SyntheticEvent, field: string, index: number, matchMode: FilterMatchMode) => void",
260
+ "default": "",
261
+ "description": "Changes the match mode of a specific constraint."
262
+ },
263
+ {
264
+ "name": "hasFilterValue",
265
+ "type": "(field: string) => boolean",
266
+ "default": "",
267
+ "description": "Checks if a field has an active filter."
268
+ },
269
+ {
270
+ "name": "isFiltered",
271
+ "type": "() => boolean",
272
+ "default": "",
273
+ "description": "Checks if any filter is active."
274
+ },
275
+ {
276
+ "name": "getFieldFilterMeta",
277
+ "type": "(field: string) => ColumnFilterMeta",
278
+ "default": "",
279
+ "description": "Gets the complete filter metadata for a field."
280
+ },
281
+ {
282
+ "name": "getFilterRootProps",
283
+ "type": "(field: string, display?: \"menu\" | \"row\") => Record<string, any>",
284
+ "default": "",
285
+ "description": "Returns base data-attrs for a `DataTable.Filter` root element."
286
+ }
287
+ ],
288
+ "methods": []
289
+ },
290
+ "UseDataTableRowMouseEvent": {
291
+ "description": "Event payload for row click / double-click / context-menu callbacks.",
292
+ "relatedProp": "",
293
+ "props": [
294
+ {
295
+ "name": "originalEvent",
296
+ "type": "MouseEvent",
297
+ "default": "",
298
+ "description": "Original browser mouse event."
299
+ },
300
+ {
301
+ "name": "data",
302
+ "type": "Record<string, unknown>",
303
+ "default": "",
304
+ "description": "Row data object."
305
+ },
306
+ {
307
+ "name": "index",
308
+ "type": "number",
309
+ "default": "",
310
+ "description": "Zero-based row index within the current render."
311
+ }
312
+ ],
313
+ "methods": []
314
+ },
315
+ "UseDataTableRowReorderEvent": {
316
+ "description": "Event object for row reorder.",
317
+ "relatedProp": "",
318
+ "props": [
319
+ {
320
+ "name": "originalEvent",
321
+ "type": "DragEvent",
322
+ "default": "",
323
+ "description": "The original browser event."
324
+ },
325
+ {
326
+ "name": "dragIndex",
327
+ "type": "number",
328
+ "default": "",
329
+ "description": "The index of the dragged row."
330
+ },
331
+ {
332
+ "name": "dropIndex",
333
+ "type": "number",
334
+ "default": "",
335
+ "description": "The index of the drop target row."
336
+ },
337
+ {
338
+ "name": "value",
339
+ "type": "Record<string, unknown>[]",
340
+ "default": "",
341
+ "description": "The reordered data array."
342
+ }
343
+ ],
344
+ "methods": []
345
+ },
346
+ "UseDataTableRowReorderExposes": {
347
+ "description": "Defines row-reorder-related methods exposed by useDataTable.",
348
+ "relatedProp": "",
349
+ "props": [
350
+ {
351
+ "name": "onDragStart",
352
+ "type": "(event: DragEvent, rowIndex: number) => void",
353
+ "default": "",
354
+ "description": "Handles drag start on a row."
355
+ },
356
+ {
357
+ "name": "onDragOver",
358
+ "type": "(event: DragEvent, rowIndex: number) => void",
359
+ "default": "",
360
+ "description": "Handles drag over on a row."
361
+ },
362
+ {
363
+ "name": "onDragEnter",
364
+ "type": "(event: DragEvent, rowIndex: number) => void",
365
+ "default": "",
366
+ "description": "Handles drag enter on a row (alias of `onDragOver` )."
367
+ },
368
+ {
369
+ "name": "onDragLeave",
370
+ "type": "(event: DragEvent) => void",
371
+ "default": "",
372
+ "description": "Handles drag leave on a row — clears drop-point markers."
373
+ },
374
+ {
375
+ "name": "onDrop",
376
+ "type": "(event: DragEvent) => void",
377
+ "default": "",
378
+ "description": "Handles drop on a row."
379
+ },
380
+ {
381
+ "name": "onDragEnd",
382
+ "type": "(event?: DragEvent) => void",
383
+ "default": "",
384
+ "description": "Handles drag end."
385
+ },
386
+ {
387
+ "name": "getRowReorderHandleProps",
388
+ "type": "() => Record<string, any>",
389
+ "default": "",
390
+ "description": "Returns props for the row reorder drag-handle element."
391
+ }
392
+ ],
393
+ "methods": []
394
+ },
395
+ "UseDataTableExportExposes": {
396
+ "description": "Defines export-related methods exposed by useDataTable.",
397
+ "relatedProp": "",
398
+ "props": [
399
+ {
400
+ "name": "exportCSV",
401
+ "type": "(options?: DataTableExportOptions) => void",
402
+ "default": "",
403
+ "description": "Exports data to CSV."
404
+ }
405
+ ],
406
+ "methods": []
407
+ },
408
+ "UseDataTableLazyLoadEvent": {
409
+ "description": "Event fired when lazy loading is triggered.",
410
+ "relatedProp": "",
411
+ "props": [
412
+ {
413
+ "name": "originalEvent",
414
+ "type": "SyntheticEvent",
415
+ "default": ""
416
+ },
417
+ {
418
+ "name": "first",
419
+ "type": "number",
420
+ "default": ""
421
+ },
422
+ {
423
+ "name": "rows",
424
+ "type": "number",
425
+ "default": ""
426
+ },
427
+ {
428
+ "name": "page",
429
+ "type": "number",
430
+ "default": ""
431
+ },
432
+ {
433
+ "name": "sortField",
434
+ "type": "string",
435
+ "default": ""
436
+ },
437
+ {
438
+ "name": "sortOrder",
439
+ "type": "SortOrder",
440
+ "default": ""
441
+ },
442
+ {
443
+ "name": "multiSortMeta",
444
+ "type": "SortMeta[]",
445
+ "default": ""
446
+ },
447
+ {
448
+ "name": "filters",
449
+ "type": "DataTableFilterMeta",
450
+ "default": ""
451
+ },
452
+ {
453
+ "name": "globalFilter",
454
+ "type": "string",
455
+ "default": ""
456
+ }
457
+ ],
458
+ "methods": []
459
+ },
460
+ "UseDataTableColumnReorderEvent": {
461
+ "description": "Event object for column reorder.",
462
+ "relatedProp": "",
463
+ "props": [
464
+ {
465
+ "name": "originalEvent",
466
+ "type": "DragEvent",
467
+ "default": "",
468
+ "description": "The original browser event."
469
+ },
470
+ {
471
+ "name": "dragIndex",
472
+ "type": "number",
473
+ "default": "",
474
+ "description": "The index of the column being dragged."
475
+ },
476
+ {
477
+ "name": "dropIndex",
478
+ "type": "number",
479
+ "default": "",
480
+ "description": "The index of the column being dropped on."
481
+ }
482
+ ],
483
+ "methods": []
484
+ },
485
+ "UseDataTableColumnReorderExposes": {
486
+ "description": "Defines column-reorder-related methods exposed by useDataTable.",
487
+ "relatedProp": "",
488
+ "props": [
489
+ {
490
+ "name": "onDragStart",
491
+ "type": "(event: DragEvent, columnIndex: number) => void",
492
+ "default": "",
493
+ "description": "Handles drag start on a column header."
494
+ },
495
+ {
496
+ "name": "onDragOver",
497
+ "type": "(event: DragEvent, columnIndex: number) => void",
498
+ "default": "",
499
+ "description": "Handles drag over on a column header."
500
+ },
501
+ {
502
+ "name": "onDragEnter",
503
+ "type": "(event: DragEvent, columnIndex: number) => void",
504
+ "default": "",
505
+ "description": "Handles drag enter on a column header."
506
+ },
507
+ {
508
+ "name": "onDragLeave",
509
+ "type": "(event: DragEvent) => void",
510
+ "default": "",
511
+ "description": "Handles drag leave on a column header."
512
+ },
513
+ {
514
+ "name": "onDrop",
515
+ "type": "(event: DragEvent, columnIndex: number) => void",
516
+ "default": "",
517
+ "description": "Handles drop on a column header."
518
+ },
519
+ {
520
+ "name": "onDragEnd",
521
+ "type": "(event: DragEvent) => void",
522
+ "default": "",
523
+ "description": "Handles drag end."
524
+ },
525
+ {
526
+ "name": "registerDropTarget",
527
+ "type": "(columnIndex: number, notify: (state: { side: \"start\" | \"end\" }) => void) => () => void",
528
+ "default": "",
529
+ "description": "Registers a drop-target for a specific column index. The hook calls `notify` with `{ side }` \nwhen this column becomes the active drop target and with `null` when it stops being active.\nReturns an unregister function to call on unmount."
530
+ },
531
+ {
532
+ "name": "getColumnReorderHandleProps",
533
+ "type": "() => Record<string, any>",
534
+ "default": "",
535
+ "description": "Returns props for the column reorder drag-handle element."
536
+ },
537
+ {
538
+ "name": "getColumnReorderIndicatorUpProps",
539
+ "type": "() => Record<string, any>",
540
+ "default": "",
541
+ "description": "Returns props for the column reorder up-indicator element."
542
+ },
543
+ {
544
+ "name": "getColumnReorderIndicatorDownProps",
545
+ "type": "() => Record<string, any>",
546
+ "default": "",
547
+ "description": "Returns props for the column reorder down-indicator element."
548
+ }
549
+ ],
550
+ "methods": []
551
+ },
552
+ "UseDataTableColumnResizeExposes": {
553
+ "description": "Defines column-resize-related methods exposed by useDataTable.",
554
+ "relatedProp": "",
555
+ "props": [
556
+ {
557
+ "name": "onResizeStart",
558
+ "type": "(event: PointerEvent, columnIndex: number, headerCell: HTMLElement) => void",
559
+ "default": "",
560
+ "description": "Handles mouse down on the column resize handle."
561
+ },
562
+ {
563
+ "name": "registerIndicator",
564
+ "type": "(element: HTMLElement) => void",
565
+ "default": "",
566
+ "description": "Registers a DOM element that the hook will use as the visual resize indicator.\nPass `null` to unregister (e.g. on component unmount)."
567
+ },
568
+ {
569
+ "name": "getColumnResizerProps",
570
+ "type": "(columnIndex?: number) => Record<string, any>",
571
+ "default": "",
572
+ "description": "Returns props for the column resizer handle element. Pointer-down starts the drag."
573
+ }
574
+ ],
575
+ "methods": []
576
+ },
577
+ "UseDataTableEditingExposes": {
578
+ "description": "Defines editing-related methods exposed by useDataTable.",
579
+ "relatedProp": "",
580
+ "props": [
581
+ {
582
+ "name": "isEditing",
583
+ "type": "(key: string | number) => boolean",
584
+ "default": "",
585
+ "description": "Checks if a row with the given key is being edited."
586
+ },
587
+ {
588
+ "name": "startRowEdit",
589
+ "type": "(event: SyntheticEvent, key: string | number, rowData?: Record<string, unknown>, rowIndex?: number) => void",
590
+ "default": "",
591
+ "description": "Starts editing a row."
592
+ },
593
+ {
594
+ "name": "saveRowEdit",
595
+ "type": "(event: SyntheticEvent, key: string | number, rowData?: Record<string, unknown>, newData?: Record<string, unknown>, rowIndex?: number) => void",
596
+ "default": "",
597
+ "description": "Saves a row edit."
598
+ },
599
+ {
600
+ "name": "cancelRowEdit",
601
+ "type": "(event: SyntheticEvent, key: string | number, rowData?: Record<string, unknown>, rowIndex?: number) => void",
602
+ "default": "",
603
+ "description": "Cancels a row edit."
604
+ },
605
+ {
606
+ "name": "startCellEdit",
607
+ "type": "(event: SyntheticEvent, rowIndex: number, field: string, rowKey?: string | number) => void",
608
+ "default": "",
609
+ "description": "Starts editing a cell. `rowKey` should be passed when available so the editor stays on the same\nlogical row if its `rowIndex` shifts (e.g. tree expand/collapse)."
610
+ },
611
+ {
612
+ "name": "completeCellEdit",
613
+ "type": "(event: UseDataTableCellEditEvent) => boolean",
614
+ "default": "",
615
+ "description": "Completes a cell edit."
616
+ },
617
+ {
618
+ "name": "cancelCellEdit",
619
+ "type": "(event: SyntheticEvent, rowIndex: number, field: string) => void",
620
+ "default": "",
621
+ "description": "Cancels a cell edit."
622
+ },
623
+ {
624
+ "name": "isCellEditing",
625
+ "type": "(rowIndex: number, field: string, rowKey?: string | number) => boolean",
626
+ "default": "",
627
+ "description": "Checks if a specific cell is being edited. When `rowKey` is provided the check prefers key\nequality so the editor survives reshuffles of the flat row order (tree expand/collapse)."
628
+ },
629
+ {
630
+ "name": "getCellEditorRootProps",
631
+ "type": "(params: { rowIndex: number; field: string; rowKey?: string | number; isEditing: boolean }) => Record<string, any>",
632
+ "default": "",
633
+ "description": "Returns base data-attrs for the cell editor wrapper element."
634
+ },
635
+ {
636
+ "name": "getRowEditorInitProps",
637
+ "type": "() => Record<string, any>",
638
+ "default": "",
639
+ "description": "Returns base props for the row editor init button."
640
+ },
641
+ {
642
+ "name": "getRowEditorSaveProps",
643
+ "type": "() => Record<string, any>",
644
+ "default": "",
645
+ "description": "Returns base props for the row editor save button."
646
+ },
647
+ {
648
+ "name": "getRowEditorCancelProps",
649
+ "type": "() => Record<string, any>",
650
+ "default": "",
651
+ "description": "Returns base props for the row editor cancel button."
652
+ }
653
+ ],
654
+ "methods": []
655
+ },
656
+ "UseDataTableExpansionExposes": {
657
+ "description": "Defines the expansion-related methods exposed by useDataTable.",
658
+ "relatedProp": "",
659
+ "props": [
660
+ {
661
+ "name": "isExpanded",
662
+ "type": "(key: string | number) => boolean",
663
+ "default": "",
664
+ "description": "Checks if a row with the given key is expanded."
665
+ },
666
+ {
667
+ "name": "toggleExpansion",
668
+ "type": "(event: SyntheticEvent, key: string | number) => void",
669
+ "default": "",
670
+ "description": "Toggles the expansion state of a row."
671
+ },
672
+ {
673
+ "name": "getRowToggleProps",
674
+ "type": "(rowKey: string | number, item?: Record<string, unknown>) => { isSpacer: true; spacerProps: Record<string, any> } | { isSpacer: false; rootProps: Record<string, any>; isExpanded: boolean }",
675
+ "default": "",
676
+ "description": "Returns props for the row toggle element. The shape distinguishes between a \"spacer\"\n(rendered for tree-mode leaves) and a real button."
677
+ }
678
+ ],
679
+ "methods": []
680
+ },
681
+ "UseDataTableSelectionEvent": {
682
+ "description": "Event object for DataTable selection changes.",
683
+ "relatedProp": "",
684
+ "props": [
685
+ {
686
+ "name": "originalEvent",
687
+ "type": "SyntheticEvent",
688
+ "default": "",
689
+ "description": "Browser event that triggered the selection change."
690
+ },
691
+ {
692
+ "name": "value",
693
+ "type": "SelectionKeys",
694
+ "default": "",
695
+ "description": "The new selection keys after the change."
696
+ },
697
+ {
698
+ "name": "type",
699
+ "type": "\"checkbox\" | \"radio\" | \"row\" | \"all\"",
700
+ "default": "",
701
+ "description": "The type of selection action that occurred."
702
+ }
703
+ ],
704
+ "methods": []
705
+ },
706
+ "UseDataTableSelectionExposes": {
707
+ "description": "Defines the selection-related methods exposed by useDataTable.",
708
+ "relatedProp": "",
709
+ "props": [
710
+ {
711
+ "name": "isSelected",
712
+ "type": "(key: string | number) => boolean",
713
+ "default": "",
714
+ "description": "Checks if a row with the given key is selected."
715
+ },
716
+ {
717
+ "name": "toggleSelection",
718
+ "type": "(event: SyntheticEvent, key: string | number, mode: \"checkbox\" | \"radio\" | \"single\") => void",
719
+ "default": "",
720
+ "description": "Toggles the selection state of a row."
721
+ },
722
+ {
723
+ "name": "toggleAll",
724
+ "type": "(event: SyntheticEvent) => void",
725
+ "default": "",
726
+ "description": "Toggles the selection of all rows."
727
+ },
728
+ {
729
+ "name": "isAllSelected",
730
+ "type": "() => boolean",
731
+ "default": "",
732
+ "description": "Checks if all rows are selected."
733
+ },
734
+ {
735
+ "name": "onRowClick",
736
+ "type": "(event: MouseEvent, key: string | number) => void",
737
+ "default": "",
738
+ "description": "Handles row click selection with metaKey/shift support."
739
+ },
740
+ {
741
+ "name": "isSomeSelected",
742
+ "type": "() => boolean",
743
+ "default": "",
744
+ "description": "Checks if some but not all rows are selected."
745
+ },
746
+ {
747
+ "name": "isPartiallySelected",
748
+ "type": "(key: string | number) => boolean",
749
+ "default": "",
750
+ "description": "Checks if a tree node is partially selected (some descendants selected, but not all).\nOnly relevant in tree mode."
751
+ }
752
+ ],
753
+ "methods": []
754
+ },
755
+ "UseDataTableSortExposes": {
756
+ "description": "Defines sort-related methods exposed by useDataTable.",
757
+ "relatedProp": "",
758
+ "props": [
759
+ {
760
+ "name": "onSort",
761
+ "type": "(event: SyntheticEvent, field: string, multiSort?: boolean) => void",
762
+ "default": "",
763
+ "description": "Handles a sort event for the given field."
764
+ },
765
+ {
766
+ "name": "isSorted",
767
+ "type": "(field: string) => boolean",
768
+ "default": "",
769
+ "description": "Returns whether the given field is currently sorted."
770
+ },
771
+ {
772
+ "name": "getSortOrder",
773
+ "type": "(field: string) => SortOrder",
774
+ "default": "",
775
+ "description": "Returns the current sort order for the given field."
776
+ },
777
+ {
778
+ "name": "getSortIndex",
779
+ "type": "(field: string) => number",
780
+ "default": "",
781
+ "description": "Returns the index of the given field in multi-sort metadata."
782
+ },
783
+ {
784
+ "name": "getSortProps",
785
+ "type": "(field: string) => Record<string, any>",
786
+ "default": "",
787
+ "description": "Returns props (data-attrs, role, aria, handlers) for a `DataTable.Sort` root element."
788
+ }
789
+ ],
790
+ "methods": []
791
+ },
792
+ "UseDataTablePageEvent": {
793
+ "description": "Event object for DataTable page changes.",
794
+ "relatedProp": "",
795
+ "props": [
796
+ {
797
+ "name": "originalEvent",
798
+ "type": "SyntheticEvent",
799
+ "default": "",
800
+ "description": "The original browser event that triggered the page change."
801
+ },
802
+ {
803
+ "name": "page",
804
+ "type": "number",
805
+ "default": "",
806
+ "description": "The new page number (0-indexed)."
807
+ },
808
+ {
809
+ "name": "rows",
810
+ "type": "number",
811
+ "default": "",
812
+ "description": "The number of rows per page."
813
+ },
814
+ {
815
+ "name": "first",
816
+ "type": "number",
817
+ "default": "",
818
+ "description": "The index of the first row on the new page."
819
+ },
820
+ {
821
+ "name": "pageCount",
822
+ "type": "number",
823
+ "default": "",
824
+ "description": "The total number of pages."
825
+ }
826
+ ],
827
+ "methods": []
828
+ },
829
+ "UseDataTablePaginationExposes": {
830
+ "description": "Defines pagination-related methods exposed by useDataTable.",
831
+ "relatedProp": "",
832
+ "props": [
833
+ {
834
+ "name": "page",
835
+ "type": "number",
836
+ "default": "",
837
+ "description": "The current page number (0-indexed)."
838
+ },
839
+ {
840
+ "name": "rows",
841
+ "type": "number",
842
+ "default": "",
843
+ "description": "The number of rows per page."
844
+ },
845
+ {
846
+ "name": "first",
847
+ "type": "number",
848
+ "default": "",
849
+ "description": "The index of the first row on the current page."
850
+ },
851
+ {
852
+ "name": "pageCount",
853
+ "type": "number",
854
+ "default": "",
855
+ "description": "The total number of pages."
856
+ },
857
+ {
858
+ "name": "totalRecords",
859
+ "type": "number",
860
+ "default": "",
861
+ "description": "Total number of records across all pages. In lazy mode this is the `totalRecords` prop\nthe caller supplies; otherwise it's the length of the (filtered, sorted) dataset."
862
+ },
863
+ {
864
+ "name": "onPageChange",
865
+ "type": "(event: SyntheticEvent, page: number) => void",
866
+ "default": "",
867
+ "description": "Handles a page change event."
868
+ },
869
+ {
870
+ "name": "onRowsChange",
871
+ "type": "(event: SyntheticEvent, rows: number) => void",
872
+ "default": "",
873
+ "description": "Handles a rows per page change event."
874
+ }
875
+ ],
876
+ "methods": []
877
+ },
878
+ "UseDataTableProps": {
879
+ "description": "Defines valid properties in useDataTable.",
880
+ "relatedProp": "",
881
+ "props": [
882
+ {
883
+ "name": "data",
884
+ "type": "Record<string, unknown>[] | object[]",
885
+ "default": "null",
886
+ "description": "An array of objects to display."
887
+ },
888
+ {
889
+ "name": "defaultValue",
890
+ "type": "string",
891
+ "default": "null",
892
+ "description": "Default sort value for uncontrolled mode."
893
+ },
894
+ {
895
+ "name": "value",
896
+ "type": "string",
897
+ "default": "null",
898
+ "description": "Sort field value for controlled mode."
899
+ },
900
+ {
901
+ "name": "dataKey",
902
+ "type": "string",
903
+ "default": "null",
904
+ "description": "A property to uniquely identify each row in the data."
905
+ },
906
+ {
907
+ "name": "loading",
908
+ "type": "boolean",
909
+ "default": "false",
910
+ "description": "Whether the data is currently being loaded."
911
+ },
912
+ {
913
+ "name": "lazy",
914
+ "type": "boolean",
915
+ "default": "false",
916
+ "description": "Defines if data is loaded and interacted with in lazy manner."
917
+ },
918
+ {
919
+ "name": "totalRecords",
920
+ "type": "number",
921
+ "default": "0",
922
+ "description": "Number of total records, used in lazy mode."
923
+ },
924
+ {
925
+ "name": "scrollable",
926
+ "type": "boolean",
927
+ "default": "false",
928
+ "description": "When enabled, the table can be scrolled horizontally and/or vertically."
929
+ },
930
+ {
931
+ "name": "scrollHeight",
932
+ "type": "string",
933
+ "default": "null",
934
+ "description": "Height of the scroll viewport in fixed pixels or the \"flex\" keyword for a dynamic size."
935
+ },
936
+ {
937
+ "name": "sortField",
938
+ "type": "string",
939
+ "default": "undefined",
940
+ "description": "Property name to sort by in single-sort mode."
941
+ },
942
+ {
943
+ "name": "sortOrder",
944
+ "type": "SortOrder",
945
+ "default": "undefined",
946
+ "description": "Sort order for single-sort mode."
947
+ },
948
+ {
949
+ "name": "defaultSortField",
950
+ "type": "string",
951
+ "default": "undefined",
952
+ "description": "Default sort field for uncontrolled single-sort mode."
953
+ },
954
+ {
955
+ "name": "defaultSortOrder",
956
+ "type": "SortOrder",
957
+ "default": "undefined",
958
+ "description": "Default sort order for uncontrolled single-sort mode."
959
+ },
960
+ {
961
+ "name": "multiSortMeta",
962
+ "type": "SortMeta[]",
963
+ "default": "undefined",
964
+ "description": "An array of SortMeta objects for multi-column sorting (controlled)."
965
+ },
966
+ {
967
+ "name": "defaultMultiSortMeta",
968
+ "type": "SortMeta[]",
969
+ "default": "undefined",
970
+ "description": "Initial multi-column sort metadata for uncontrolled mode."
971
+ },
972
+ {
973
+ "name": "onSortChange",
974
+ "type": "(event: UseDataTableSortEvent) => void",
975
+ "default": "",
976
+ "description": "Callback invoked when the sort state changes."
977
+ },
978
+ {
979
+ "name": "removableSort",
980
+ "type": "boolean",
981
+ "default": "false",
982
+ "description": "When true, clicking a sorted column header a third time removes the sort."
983
+ },
984
+ {
985
+ "name": "nullSortOrder",
986
+ "type": "number",
987
+ "default": "1",
988
+ "description": "Determines where null values are placed during sort.\n1 = nulls last (default), -1 = nulls first."
989
+ },
990
+ {
991
+ "name": "selectionMode",
992
+ "type": "\"multiple\" | \"single\"",
993
+ "default": "null",
994
+ "description": "Defines the selection mode. 'single' allows one row, 'multiple' allows many."
995
+ },
996
+ {
997
+ "name": "metaKeySelection",
998
+ "type": "boolean",
999
+ "default": "false",
1000
+ "description": "When true, row click selection requires Ctrl/Cmd key. Without it, click selects only that row.\nShift+Click extends range. Only applies when selectionMode is set."
1001
+ },
1002
+ {
1003
+ "name": "selectionKeys",
1004
+ "type": "SelectionKeys",
1005
+ "default": "undefined",
1006
+ "description": "The selection keys for controlled mode."
1007
+ },
1008
+ {
1009
+ "name": "defaultSelectionKeys",
1010
+ "type": "SelectionKeys",
1011
+ "default": "undefined",
1012
+ "description": "The default selection keys for uncontrolled mode."
1013
+ },
1014
+ {
1015
+ "name": "selectedKeys",
1016
+ "type": "SelectionKeys",
1017
+ "default": "undefined",
1018
+ "description": "The selection keys for controlled mode.",
1019
+ "deprecated": "Use "
1020
+ },
1021
+ {
1022
+ "name": "defaultSelectedKeys",
1023
+ "type": "SelectionKeys",
1024
+ "default": "undefined",
1025
+ "description": "The default selection keys for uncontrolled mode.",
1026
+ "deprecated": "Use "
1027
+ },
1028
+ {
1029
+ "name": "onSelectionChange",
1030
+ "type": "(event: UseDataTableSelectionEvent) => void",
1031
+ "default": "undefined",
1032
+ "description": "Callback invoked when the selection changes."
1033
+ },
1034
+ {
1035
+ "name": "page",
1036
+ "type": "number",
1037
+ "default": "undefined",
1038
+ "description": "Current page number for controlled pagination (0-indexed)."
1039
+ },
1040
+ {
1041
+ "name": "defaultPage",
1042
+ "type": "number",
1043
+ "default": "0",
1044
+ "description": "Default page number for uncontrolled pagination (0-indexed)."
1045
+ },
1046
+ {
1047
+ "name": "rows",
1048
+ "type": "number",
1049
+ "default": "undefined",
1050
+ "description": "Number of rows to display per page for controlled mode."
1051
+ },
1052
+ {
1053
+ "name": "defaultRows",
1054
+ "type": "number",
1055
+ "default": "10",
1056
+ "description": "Default number of rows to display per page for uncontrolled mode."
1057
+ },
1058
+ {
1059
+ "name": "rowsPerPageOptions",
1060
+ "type": "number[]",
1061
+ "default": "undefined",
1062
+ "description": "Array of integer values to display inside the rows per page dropdown."
1063
+ },
1064
+ {
1065
+ "name": "paginator",
1066
+ "type": "boolean",
1067
+ "default": "false",
1068
+ "description": "Whether pagination is enabled."
1069
+ },
1070
+ {
1071
+ "name": "onPageChange",
1072
+ "type": "(event: UseDataTablePageEvent) => void",
1073
+ "default": "",
1074
+ "description": "Callback invoked when the page or rows per page changes."
1075
+ },
1076
+ {
1077
+ "name": "expandedKeys",
1078
+ "type": "ExpandedKeys",
1079
+ "default": "undefined",
1080
+ "description": "The expanded keys map for controlled row expansion."
1081
+ },
1082
+ {
1083
+ "name": "defaultExpandedKeys",
1084
+ "type": "ExpandedKeys",
1085
+ "default": "undefined",
1086
+ "description": "The default expanded keys map for uncontrolled row expansion."
1087
+ },
1088
+ {
1089
+ "name": "onExpandedChange",
1090
+ "type": "(event: UseDataTableExpansionEvent) => void",
1091
+ "default": "",
1092
+ "description": "Callback invoked when the expanded keys change."
1093
+ },
1094
+ {
1095
+ "name": "groupField",
1096
+ "type": "string",
1097
+ "default": "undefined",
1098
+ "description": "The field name to group rows by."
1099
+ },
1100
+ {
1101
+ "name": "reorderableColumns",
1102
+ "type": "boolean",
1103
+ "default": "false",
1104
+ "description": "When enabled, columns can be reordered using drag and drop."
1105
+ },
1106
+ {
1107
+ "name": "onColumnReorder",
1108
+ "type": "(event: UseDataTableColumnReorderEvent) => void",
1109
+ "default": "",
1110
+ "description": "Callback invoked when columns are reordered."
1111
+ },
1112
+ {
1113
+ "name": "resizableColumns",
1114
+ "type": "boolean",
1115
+ "default": "false",
1116
+ "description": "When enabled, columns can be resized using drag and drop."
1117
+ },
1118
+ {
1119
+ "name": "columnResizeMode",
1120
+ "type": "ColumnResizeMode",
1121
+ "default": "'fit'",
1122
+ "description": "Defines whether the overall table width should change on column resize.\n'fit' mode keeps total width the same. 'expand' mode increases total width."
1123
+ },
1124
+ {
1125
+ "name": "onColumnResizeEnd",
1126
+ "type": "(event: UseDataTableColumnResizeEvent) => void",
1127
+ "default": "",
1128
+ "description": "Callback invoked when a column resize ends."
1129
+ },
1130
+ {
1131
+ "name": "editMode",
1132
+ "type": "DataTableEditMode",
1133
+ "default": "undefined",
1134
+ "description": "Defines the editing mode."
1135
+ },
1136
+ {
1137
+ "name": "editingKeys",
1138
+ "type": "EditingKeys",
1139
+ "default": "undefined",
1140
+ "description": "The editing keys map for controlled row editing."
1141
+ },
1142
+ {
1143
+ "name": "defaultEditingKeys",
1144
+ "type": "EditingKeys",
1145
+ "default": "undefined",
1146
+ "description": "The default editing keys for uncontrolled row editing."
1147
+ },
1148
+ {
1149
+ "name": "onEditingKeysChange",
1150
+ "type": "(event: UseDataTableEditingEvent) => void",
1151
+ "default": "",
1152
+ "description": "Callback invoked when the editing keys change."
1153
+ },
1154
+ {
1155
+ "name": "onRowEditInit",
1156
+ "type": "(event: UseDataTableRowEditEvent) => void",
1157
+ "default": "",
1158
+ "description": "Callback invoked when a row edit is initiated."
1159
+ },
1160
+ {
1161
+ "name": "onRowEditSave",
1162
+ "type": "(event: UseDataTableRowEditEvent) => void",
1163
+ "default": "",
1164
+ "description": "Callback invoked when a row edit is saved."
1165
+ },
1166
+ {
1167
+ "name": "onRowEditCancel",
1168
+ "type": "(event: UseDataTableRowEditEvent) => void",
1169
+ "default": "",
1170
+ "description": "Callback invoked when a row edit is cancelled."
1171
+ },
1172
+ {
1173
+ "name": "onCellEditInit",
1174
+ "type": "(event: { originalEvent: SyntheticEvent; field: string; rowIndex: number }) => void",
1175
+ "default": "",
1176
+ "description": "Callback invoked when a cell edit is initiated."
1177
+ },
1178
+ {
1179
+ "name": "onCellEditComplete",
1180
+ "type": "(event: UseDataTableCellEditEvent) => void",
1181
+ "default": "",
1182
+ "description": "Callback invoked when a cell edit completes."
1183
+ },
1184
+ {
1185
+ "name": "onCellEditCancel",
1186
+ "type": "(event: UseDataTableCellEditEvent) => void",
1187
+ "default": "",
1188
+ "description": "Callback invoked when a cell edit is cancelled."
1189
+ },
1190
+ {
1191
+ "name": "filters",
1192
+ "type": "DataTableFilterMeta",
1193
+ "default": "undefined",
1194
+ "description": "Filter metadata for controlled mode."
1195
+ },
1196
+ {
1197
+ "name": "defaultFilters",
1198
+ "type": "DataTableFilterMeta",
1199
+ "default": "undefined",
1200
+ "description": "Default filter metadata for uncontrolled mode."
1201
+ },
1202
+ {
1203
+ "name": "globalFilter",
1204
+ "type": "string",
1205
+ "default": "null",
1206
+ "description": "Global filter value applied across globalFilterFields."
1207
+ },
1208
+ {
1209
+ "name": "globalFilterFields",
1210
+ "type": "string[]",
1211
+ "default": "undefined",
1212
+ "description": "An array of field names to search with globalFilter."
1213
+ },
1214
+ {
1215
+ "name": "filterDelay",
1216
+ "type": "number",
1217
+ "default": "0",
1218
+ "description": "Delay in ms before applying filter (for debounce)."
1219
+ },
1220
+ {
1221
+ "name": "onFilter",
1222
+ "type": "(event: UseDataTableFilterEvent) => void",
1223
+ "default": "",
1224
+ "description": "Callback invoked when filters change."
1225
+ },
1226
+ {
1227
+ "name": "reorderableRows",
1228
+ "type": "boolean",
1229
+ "default": "false",
1230
+ "description": "When enabled, rows can be reordered using drag and drop."
1231
+ },
1232
+ {
1233
+ "name": "onRowReorder",
1234
+ "type": "(event: UseDataTableRowReorderEvent) => void",
1235
+ "default": "",
1236
+ "description": "Callback invoked when rows are reordered."
1237
+ },
1238
+ {
1239
+ "name": "rowClassName",
1240
+ "type": "(data: Record<string, unknown>, options: { index: number; props: UseDataTableProps }) => string",
1241
+ "default": "",
1242
+ "description": "A function that returns a className for a given row."
1243
+ },
1244
+ {
1245
+ "name": "onLazyLoad",
1246
+ "type": "(event: UseDataTableLazyLoadEvent) => void",
1247
+ "default": "",
1248
+ "description": "Callback invoked when lazy loading is triggered (page, sort, filter change in lazy mode)."
1249
+ },
1250
+ {
1251
+ "name": "onRowClick",
1252
+ "type": "(event: UseDataTableRowMouseEvent) => void",
1253
+ "default": "",
1254
+ "description": "Callback fired when a row is clicked. Does NOT fire when the click originates on interactive content\n(buttons, inputs, checkboxes, radios) — those bubble their own semantics."
1255
+ },
1256
+ {
1257
+ "name": "onRowDoubleClick",
1258
+ "type": "(event: UseDataTableRowMouseEvent) => void",
1259
+ "default": "",
1260
+ "description": "Callback fired on row double-click."
1261
+ },
1262
+ {
1263
+ "name": "onRowContextMenu",
1264
+ "type": "(event: UseDataTableRowMouseEvent) => void",
1265
+ "default": "",
1266
+ "description": "Callback fired on row right-click (contextmenu). Does not prevent the default menu — call\n `event.originalEvent.preventDefault()` in the handler if you want to."
1267
+ },
1268
+ {
1269
+ "name": "rowHover",
1270
+ "type": "boolean",
1271
+ "default": "false",
1272
+ "description": "When enabled, rows highlight on mouse hover via `data-row-hover` attribute on root."
1273
+ },
1274
+ {
1275
+ "name": "highlightOnSelect",
1276
+ "type": "boolean",
1277
+ "default": "true",
1278
+ "description": "When enabled, selected rows are highlighted via `data-highlight-on-select` attribute on root."
1279
+ },
1280
+ {
1281
+ "name": "treeMode",
1282
+ "type": "boolean",
1283
+ "default": "false",
1284
+ "description": "When enabled, data is treated as a tree structure with `key` , `data` , and `children` fields.\nTree nodes are flattened internally and sort, filter, pagination operate on the tree structure.\nPagination applies to root-level nodes only."
1285
+ },
1286
+ {
1287
+ "name": "size",
1288
+ "type": "\"small\" | \"large\"",
1289
+ "default": "undefined",
1290
+ "description": "Table size variant. Adjusts cell padding and font size via CSS."
1291
+ },
1292
+ {
1293
+ "name": "stripedRows",
1294
+ "type": "boolean",
1295
+ "default": "false",
1296
+ "description": "When enabled, rows are rendered with alternating background colors."
1297
+ },
1298
+ {
1299
+ "name": "showGridlines",
1300
+ "type": "boolean",
1301
+ "default": "false",
1302
+ "description": "When enabled, borders are displayed between cells."
1303
+ }
1304
+ ],
1305
+ "methods": []
1306
+ },
1307
+ "UseDataTableState": {
1308
+ "description": "Defines valid state in useDataTable.",
1309
+ "relatedProp": "",
1310
+ "props": [
1311
+ {
1312
+ "name": "processedData",
1313
+ "type": "Record<string, unknown>[]",
1314
+ "default": "",
1315
+ "description": "The processed data array after applying sort, filter, and pagination."
1316
+ },
1317
+ {
1318
+ "name": "loading",
1319
+ "type": "boolean",
1320
+ "default": "",
1321
+ "description": "Whether the data is currently being loaded."
1322
+ },
1323
+ {
1324
+ "name": "sortField",
1325
+ "type": "string",
1326
+ "default": "",
1327
+ "description": "The current sort field."
1328
+ },
1329
+ {
1330
+ "name": "sortOrder",
1331
+ "type": "SortOrder",
1332
+ "default": "",
1333
+ "description": "The current sort order."
1334
+ },
1335
+ {
1336
+ "name": "multiSortMeta",
1337
+ "type": "SortMeta[]",
1338
+ "default": "",
1339
+ "description": "The current multi-sort metadata."
1340
+ },
1341
+ {
1342
+ "name": "selectionKeys",
1343
+ "type": "SelectionKeys",
1344
+ "default": "",
1345
+ "description": "The current selection keys."
1346
+ },
1347
+ {
1348
+ "name": "page",
1349
+ "type": "number",
1350
+ "default": "",
1351
+ "description": "The current page number (0-indexed)."
1352
+ },
1353
+ {
1354
+ "name": "rows",
1355
+ "type": "number",
1356
+ "default": "",
1357
+ "description": "The number of rows per page."
1358
+ },
1359
+ {
1360
+ "name": "first",
1361
+ "type": "number",
1362
+ "default": "",
1363
+ "description": "The index of the first row on the current page."
1364
+ },
1365
+ {
1366
+ "name": "pageCount",
1367
+ "type": "number",
1368
+ "default": "",
1369
+ "description": "The total number of pages."
1370
+ },
1371
+ {
1372
+ "name": "totalRecords",
1373
+ "type": "number",
1374
+ "default": "",
1375
+ "description": "Total record count. In lazy mode this is the `totalRecords` prop; otherwise the length of\nthe filtered/sorted dataset."
1376
+ },
1377
+ {
1378
+ "name": "paginatedData",
1379
+ "type": "Record<string, unknown>[]",
1380
+ "default": "",
1381
+ "description": "The paginated data array for the current page (non-lazy mode only)."
1382
+ },
1383
+ {
1384
+ "name": "expandedKeys",
1385
+ "type": "ExpandedKeys",
1386
+ "default": "",
1387
+ "description": "The current expanded keys map."
1388
+ },
1389
+ {
1390
+ "name": "groupMetaMap",
1391
+ "type": "Map<number, RowGroupMeta>",
1392
+ "default": "",
1393
+ "description": "The computed group metadata for each row, keyed by row index.\nOnly populated when groupField is set."
1394
+ },
1395
+ {
1396
+ "name": "editingKeys",
1397
+ "type": "EditingKeys",
1398
+ "default": "",
1399
+ "description": "The current editing keys map."
1400
+ },
1401
+ {
1402
+ "name": "editingCell",
1403
+ "type": "{ rowIndex: number; field: string; rowKey?: string | number }",
1404
+ "default": "",
1405
+ "description": "The currently editing cell, if any."
1406
+ },
1407
+ {
1408
+ "name": "filters",
1409
+ "type": "DataTableFilterMeta",
1410
+ "default": "",
1411
+ "description": "The current filter metadata."
1412
+ },
1413
+ {
1414
+ "name": "globalFilter",
1415
+ "type": "string",
1416
+ "default": "",
1417
+ "description": "The current global filter value."
1418
+ }
1419
+ ],
1420
+ "methods": []
1421
+ },
1422
+ "UseDataTableRootProps": {
1423
+ "description": "Data attribute props for the DataTable root element.",
1424
+ "relatedProp": "",
1425
+ "props": [
1426
+ {
1427
+ "name": "data-scope",
1428
+ "type": "string",
1429
+ "default": "",
1430
+ "description": "Component scope identifier."
1431
+ },
1432
+ {
1433
+ "name": "data-part",
1434
+ "type": "string",
1435
+ "default": "",
1436
+ "description": "Component part identifier."
1437
+ },
1438
+ {
1439
+ "name": "data-loading",
1440
+ "type": "string",
1441
+ "default": "",
1442
+ "description": "Present when the datatable is loading."
1443
+ }
1444
+ ],
1445
+ "methods": []
1446
+ },
1447
+ "UseDataTableTableContainerProps": {
1448
+ "description": "Pre-built props for the table container element.",
1449
+ "relatedProp": "",
1450
+ "props": [
1451
+ {
1452
+ "name": "data-scope",
1453
+ "type": "string",
1454
+ "default": "",
1455
+ "description": "Component scope identifier."
1456
+ },
1457
+ {
1458
+ "name": "data-part",
1459
+ "type": "string",
1460
+ "default": "",
1461
+ "description": "Component part identifier."
1462
+ },
1463
+ {
1464
+ "name": "style",
1465
+ "type": "CSSProperties",
1466
+ "default": "",
1467
+ "description": "Inline styles for scroll support."
1468
+ }
1469
+ ],
1470
+ "methods": []
1471
+ },
1472
+ "UseDataTableTableProps": {
1473
+ "description": "Pre-built props for the table element.",
1474
+ "relatedProp": "",
1475
+ "props": [
1476
+ {
1477
+ "name": "data-scope",
1478
+ "type": "string",
1479
+ "default": "",
1480
+ "description": "Component scope identifier."
1481
+ },
1482
+ {
1483
+ "name": "data-part",
1484
+ "type": "string",
1485
+ "default": "",
1486
+ "description": "Component part identifier."
1487
+ },
1488
+ {
1489
+ "name": "role",
1490
+ "type": "string",
1491
+ "default": "",
1492
+ "description": "ARIA role for the table."
1493
+ }
1494
+ ],
1495
+ "methods": []
1496
+ },
1497
+ "UseDataTableExposes": {
1498
+ "description": "Defines the methods and properties exposed by useDataTable.",
1499
+ "relatedProp": "",
1500
+ "props": [
1501
+ {
1502
+ "name": "state",
1503
+ "type": "UseDataTableState",
1504
+ "default": "",
1505
+ "description": "The state of the useDataTable."
1506
+ },
1507
+ {
1508
+ "name": "rootProps",
1509
+ "type": "UseDataTableRootProps",
1510
+ "default": "",
1511
+ "description": "Pre-built data attribute props for the root element."
1512
+ },
1513
+ {
1514
+ "name": "tableContainerProps",
1515
+ "type": "UseDataTableTableContainerProps",
1516
+ "default": "",
1517
+ "description": "Pre-built props for the table container element (scroll wrapper)."
1518
+ },
1519
+ {
1520
+ "name": "tableProps",
1521
+ "type": "UseDataTableTableProps",
1522
+ "default": "",
1523
+ "description": "Pre-built props for the table element."
1524
+ },
1525
+ {
1526
+ "name": "getRowKey",
1527
+ "type": "(item: Record<string, unknown>, index: number) => string | number",
1528
+ "default": "",
1529
+ "description": "Returns a unique key for the given row using the dataKey property."
1530
+ },
1531
+ {
1532
+ "name": "sort",
1533
+ "type": "UseDataTableSortExposes",
1534
+ "default": "",
1535
+ "description": "Sort-related methods and utilities."
1536
+ },
1537
+ {
1538
+ "name": "selection",
1539
+ "type": "UseDataTableSelectionExposes",
1540
+ "default": "",
1541
+ "description": "Selection-related methods and utilities."
1542
+ },
1543
+ {
1544
+ "name": "pagination",
1545
+ "type": "UseDataTablePaginationExposes",
1546
+ "default": "",
1547
+ "description": "Pagination-related state and methods."
1548
+ },
1549
+ {
1550
+ "name": "expansion",
1551
+ "type": "UseDataTableExpansionExposes",
1552
+ "default": "",
1553
+ "description": "Expansion-related methods and utilities."
1554
+ },
1555
+ {
1556
+ "name": "columnReorder",
1557
+ "type": "UseDataTableColumnReorderExposes",
1558
+ "default": "",
1559
+ "description": "Column reorder-related methods and utilities."
1560
+ },
1561
+ {
1562
+ "name": "columnResize",
1563
+ "type": "UseDataTableColumnResizeExposes",
1564
+ "default": "",
1565
+ "description": "Column resize-related methods and utilities."
1566
+ },
1567
+ {
1568
+ "name": "editing",
1569
+ "type": "UseDataTableEditingExposes",
1570
+ "default": "",
1571
+ "description": "Editing-related methods and utilities."
1572
+ },
1573
+ {
1574
+ "name": "filter",
1575
+ "type": "UseDataTableFilterExposes",
1576
+ "default": "",
1577
+ "description": "Filter-related methods and utilities."
1578
+ },
1579
+ {
1580
+ "name": "rowReorder",
1581
+ "type": "UseDataTableRowReorderExposes",
1582
+ "default": "",
1583
+ "description": "Row reorder-related methods and utilities."
1584
+ },
1585
+ {
1586
+ "name": "exportData",
1587
+ "type": "UseDataTableExportExposes",
1588
+ "default": "",
1589
+ "description": "Export-related methods and utilities."
1590
+ },
1591
+ {
1592
+ "name": "keyboard",
1593
+ "type": "{ getRowTabIndex: (index: number) => number; onRowKeyDown: (event: KeyboardEvent<HTMLTableRowElement>, index: number) => void; focusRow: (tbody: HTMLElement, index: number) => void }",
1594
+ "default": "",
1595
+ "description": "Keyboard navigation methods."
1596
+ }
1597
+ ],
1598
+ "methods": []
1599
+ }
1600
+ },
1601
+ "types": {
1602
+ "UseDataTableInstance": {
1603
+ "description": "Instance of useDataTable headless.",
1604
+ "values": "HeadlessInstance<UseDataTableProps, UseDataTableState, UseDataTableExposes>"
1605
+ }
1606
+ },
1607
+ "variables": {}
1608
+ }
1609
+ },
1610
+ {
1611
+ "name": "useDataTableRow",
1612
+ "source": "apps/showcase/assets/apidoc/usedatatablerow.json",
1613
+ "data": {
1614
+ "description": "The useDataTableRow manages the state and functionality of a DataTable row.",
1615
+ "interfaces": {
1616
+ "UseDataTableRowProps": {
1617
+ "description": "Defines valid properties in useDataTableRow.",
1618
+ "relatedProp": "",
1619
+ "props": [
1620
+ {
1621
+ "name": "item",
1622
+ "type": "Record<string, unknown>",
1623
+ "default": "null",
1624
+ "description": "The data object for this row."
1625
+ },
1626
+ {
1627
+ "name": "index",
1628
+ "type": "number",
1629
+ "default": "0",
1630
+ "description": "The index of the row in the data array."
1631
+ },
1632
+ {
1633
+ "name": "context",
1634
+ "type": "UseDataTableInstance",
1635
+ "default": "",
1636
+ "description": "The parent datatable instance providing state and methods."
1637
+ }
1638
+ ],
1639
+ "methods": []
1640
+ },
1641
+ "UseDataTableRowState": {
1642
+ "description": "Defines valid state in useDataTableRow.",
1643
+ "relatedProp": "",
1644
+ "props": [],
1645
+ "methods": []
1646
+ },
1647
+ "UseDataTableRowExposes": {
1648
+ "description": "Defines the methods and properties exposed by useDataTableRow.",
1649
+ "relatedProp": "",
1650
+ "props": [
1651
+ {
1652
+ "name": "state",
1653
+ "type": "UseDataTableRowState",
1654
+ "default": "",
1655
+ "description": "The state of the useDataTableRow."
1656
+ },
1657
+ {
1658
+ "name": "rowProps",
1659
+ "type": "UseDataTableRowRootProps",
1660
+ "default": "",
1661
+ "description": "Pre-built data attribute props for the row element.\nIncludes role, aria-rowindex."
1662
+ }
1663
+ ],
1664
+ "methods": []
1665
+ }
1666
+ },
1667
+ "types": {
1668
+ "UseDataTableRowRootProps": {
1669
+ "description": "Data attribute props for the DataTable row element.",
1670
+ "values": "Record<string, any>"
1671
+ },
1672
+ "UseDataTableRowInstance": {
1673
+ "description": "Instance of useDataTableRow headless.",
1674
+ "values": "HeadlessInstance<UseDataTableRowProps, UseDataTableRowState, UseDataTableRowExposes>"
1675
+ }
1676
+ },
1677
+ "variables": {}
1678
+ }
1679
+ }
1680
+ ]