@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,886 @@
1
+ # Listbox
2
+
3
+ Listbox is used to select one or more values from a list of items.
4
+
5
+ ```tsx
6
+ import { Label } from '@/components/ui/label';
7
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
8
+
9
+ const airports = [
10
+ { name: 'John F. Kennedy', code: 'JFK', city: 'New York', country: 'us' },
11
+ { name: 'Heathrow', code: 'LHR', city: 'London', country: 'gb' },
12
+ { name: 'Charles de Gaulle', code: 'CDG', city: 'Paris', country: 'fr' },
13
+ { name: 'Frankfurt', code: 'FRA', city: 'Frankfurt', country: 'de' },
14
+ { name: 'Schiphol', code: 'AMS', city: 'Amsterdam', country: 'nl' },
15
+ { name: 'Istanbul', code: 'IST', city: 'Istanbul', country: 'tr' },
16
+ { name: 'Dubai', code: 'DXB', city: 'Dubai', country: 'ae' },
17
+ { name: 'Changi', code: 'SIN', city: 'Singapore', country: 'sg' },
18
+ { name: 'Haneda', code: 'HND', city: 'Tokyo', country: 'jp' }
19
+ ];
20
+
21
+ export default function Preview() {
22
+ return (
23
+ <div className="flex flex-col gap-2 w-full md:w-60 mx-auto">
24
+ <div className="flex items-center justify-between">
25
+ <Label>Choose Airport</Label>
26
+ <span className="text-xs text-muted-color">{airports.length} airports</span>
27
+ </div>
28
+ <Listbox options={airports} optionKey="code" className="w-full">
29
+ <ListboxList>
30
+ {airports.map((airport, index) => (
31
+ <ListboxOption key={airport.code} index={index}>
32
+ <div className="flex items-center justify-between w-full gap-3">
33
+ <div className="flex items-center gap-3 min-w-0">
34
+ <img
35
+ alt={airport.country}
36
+ src="https://primefaces.org/cdn/primevue/images/flag/flag_placeholder.png"
37
+ className={`flag flag-${airport.country} shrink-0`}
38
+ style={{ width: '18px', height: '12px' }}
39
+ />
40
+ <span className="truncate">{airport.name}</span>
41
+ </div>
42
+ <span className="text-xs font-mono px-1.5 py-0.5 rounded bg-surface-100 dark:bg-surface-800 text-muted-color in-data-selected:bg-primary in-data-selected:text-primary-contrast">
43
+ {airport.code}
44
+ </span>
45
+ </div>
46
+ </ListboxOption>
47
+ ))}
48
+ </ListboxList>
49
+ </Listbox>
50
+ </div>
51
+ );
52
+ }
53
+ ```
54
+
55
+ ## Installation
56
+
57
+ <DocTabs value="CLI">
58
+ <DocTabsList>
59
+ <DocTabsTab value="CLI">Shadcn CLI</DocTabsTab>
60
+ <DocTabsTab value="Manual">Manual</DocTabsTab>
61
+ </DocTabsList>
62
+ <DocTabsPanel value="CLI">
63
+ ```bash
64
+ npx shadcn@latest add https://primereact.dev/r/listbox.json
65
+ ```
66
+ </DocTabsPanel>
67
+ <DocTabsPanel value="Manual">
68
+ Copy and paste the following code into your project
69
+ <DocSourceViewer name="components/ui/listbox" />
70
+ Update the import paths to match your project setup.
71
+ </DocTabsPanel>
72
+ </DocTabs>
73
+
74
+ ## Usage
75
+
76
+ ```tsx
77
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
78
+ ```
79
+
80
+ ```tsx
81
+ <Listbox options={items} optionLabel="name">
82
+ <ListboxList>
83
+ {items.map((item, index) => (
84
+ <ListboxOption key={index} index={index}>
85
+ {item.name}
86
+ </ListboxOption>
87
+ ))}
88
+ </ListboxList>
89
+ </Listbox>
90
+ ```
91
+
92
+ ## Examples
93
+
94
+ ### Basic
95
+
96
+ Select one or multiple options from a scrollable list.
97
+
98
+ ```tsx
99
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
100
+
101
+ const cities = [
102
+ { name: 'New York', code: 'NY' },
103
+ { name: 'Rome', code: 'RM' },
104
+ { name: 'London', code: 'LDN' },
105
+ { name: 'Istanbul', code: 'IST' },
106
+ { name: 'Paris', code: 'PRS' }
107
+ ];
108
+
109
+ export default function BasicDemo() {
110
+ return (
111
+ <div className="flex justify-center">
112
+ <Listbox options={cities} optionLabel="name" className="w-full md:w-56">
113
+ <ListboxList>
114
+ {cities.map((city, index) => (
115
+ <ListboxOption key={index} index={index}>
116
+ {city.name}
117
+ </ListboxOption>
118
+ ))}
119
+ </ListboxList>
120
+ </Listbox>
121
+ </div>
122
+ );
123
+ }
124
+ ```
125
+
126
+ ### Controlled
127
+
128
+ Use the `value` and `onValueChange` properties to control the selected value. The `optionLabel` and `optionValue` properties define the label and value fields of each option respectively.
129
+
130
+ ```tsx
131
+ 'use client';
132
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
133
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
134
+ import { useState } from 'react';
135
+
136
+ const cities = [
137
+ { name: 'New York', code: 'NY' },
138
+ { name: 'Rome', code: 'RM' },
139
+ { name: 'London', code: 'LDN' },
140
+ { name: 'Istanbul', code: 'IST' },
141
+ { name: 'Paris', code: 'PRS' }
142
+ ];
143
+
144
+ export default function ControlledDemo() {
145
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
146
+
147
+ return (
148
+ <div className="flex justify-center">
149
+ <Listbox
150
+ value={selectedCity}
151
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
152
+ options={cities}
153
+ optionLabel="name"
154
+ optionValue="code"
155
+ className="w-full md:w-56"
156
+ >
157
+ <ListboxList>
158
+ {cities.map((city, index) => (
159
+ <ListboxOption key={index} index={index}>
160
+ {city.name}
161
+ </ListboxOption>
162
+ ))}
163
+ </ListboxList>
164
+ </Listbox>
165
+ </div>
166
+ );
167
+ }
168
+ ```
169
+
170
+ ### Focus Behavior
171
+
172
+ Use `autoOptionFocus` to control initial focused option behavior, `selectOnFocus` to select options while navigating with focus, and `focusOnHover` to move focus with mouse hover when the component is focused.
173
+
174
+ ```tsx
175
+ 'use client';
176
+ import { Button } from '@/components/ui/button';
177
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
178
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
179
+ import * as React from 'react';
180
+
181
+ const cities = [
182
+ { name: 'New York', code: 'NY' },
183
+ { name: 'Rome', code: 'RM' },
184
+ { name: 'London', code: 'LDN' },
185
+ { name: 'Istanbul', code: 'IST' },
186
+ { name: 'Paris', code: 'PRS' }
187
+ ];
188
+
189
+ export default function FocusBehaviorDemo() {
190
+ const [selectedCity, setSelectedCity] = React.useState<string | null>(null);
191
+ const [autoOptionFocus, setAutoOptionFocus] = React.useState(true);
192
+ const [selectOnFocus, setSelectOnFocus] = React.useState(false);
193
+ const [focusOnHover, setFocusOnHover] = React.useState(true);
194
+
195
+ return (
196
+ <div className="space-y-4">
197
+ <div className="flex flex-wrap gap-2 justify-center">
198
+ <Button size="small" severity={autoOptionFocus ? undefined : 'secondary'} onClick={() => setAutoOptionFocus((prev) => !prev)}>
199
+ autoOptionFocus: {String(autoOptionFocus)}
200
+ </Button>
201
+ <Button size="small" severity={selectOnFocus ? undefined : 'secondary'} onClick={() => setSelectOnFocus((prev) => !prev)}>
202
+ selectOnFocus: {String(selectOnFocus)}
203
+ </Button>
204
+ <Button size="small" severity={focusOnHover ? undefined : 'secondary'} onClick={() => setFocusOnHover((prev) => !prev)}>
205
+ focusOnHover: {String(focusOnHover)}
206
+ </Button>
207
+ </div>
208
+
209
+ <div className="flex justify-center">
210
+ <Listbox
211
+ value={selectedCity}
212
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
213
+ options={cities}
214
+ optionLabel="name"
215
+ optionValue="code"
216
+ autoOptionFocus={autoOptionFocus}
217
+ selectOnFocus={selectOnFocus}
218
+ focusOnHover={focusOnHover}
219
+ className="w-full md:w-56"
220
+ >
221
+ <ListboxList>
222
+ {cities.map((city, index) => (
223
+ <ListboxOption key={index} index={index}>
224
+ {city.name}
225
+ </ListboxOption>
226
+ ))}
227
+ </ListboxList>
228
+ </Listbox>
229
+ </div>
230
+ </div>
231
+ );
232
+ }
233
+ ```
234
+
235
+ ### Option
236
+
237
+ Use the `Listbox.Option` component to define options manually. Each option requires a `uKey` or `index` prop for identification and the `optionKey` property on the root specifies the corresponding field from the data.
238
+
239
+ ```tsx
240
+ 'use client';
241
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
242
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
243
+ import { useState } from 'react';
244
+
245
+ const cities = [
246
+ { name: 'New York', code: 'NY' },
247
+ { name: 'Rome', code: 'RM' },
248
+ { name: 'London', code: 'LDN' },
249
+ { name: 'Istanbul', code: 'IST' },
250
+ { name: 'Paris', code: 'PRS' }
251
+ ];
252
+
253
+ export default function OptionDemo() {
254
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
255
+
256
+ return (
257
+ <div className="flex justify-center">
258
+ <Listbox
259
+ value={selectedCity}
260
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
261
+ options={cities}
262
+ optionKey="code"
263
+ className="w-full md:w-56"
264
+ >
265
+ <ListboxList>
266
+ <ListboxOption uKey="NY">New York</ListboxOption>
267
+ <ListboxOption uKey="RM">Rome</ListboxOption>
268
+ <ListboxOption uKey="LDN">London</ListboxOption>
269
+ <ListboxOption uKey="IST">Istanbul</ListboxOption>
270
+ <ListboxOption uKey="PRS">Paris</ListboxOption>
271
+ </ListboxList>
272
+ </Listbox>
273
+ </div>
274
+ );
275
+ }
276
+ ```
277
+
278
+ ### Selection
279
+
280
+ #### Checkmark
281
+
282
+ Use the `Listbox.OptionIndicator` component to display a checkmark indicator next to the selected option. The `match` prop controls visibility based on selection state with values `always`, `selected`, or `unselected`.
283
+
284
+ ```tsx
285
+ 'use client';
286
+ import { Listbox, ListboxList, ListboxOption, ListboxOptionIndicator } from '@/components/ui/listbox';
287
+ import { Check } from '@primeicons/react';
288
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
289
+ import { useState } from 'react';
290
+
291
+ const cities = [
292
+ { name: 'New York', code: 'NY' },
293
+ { name: 'Rome', code: 'RM' },
294
+ { name: 'London', code: 'LDN' },
295
+ { name: 'Istanbul', code: 'IST' },
296
+ { name: 'Paris', code: 'PRS' }
297
+ ];
298
+
299
+ export default function CheckmarkSelectionDemo() {
300
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
301
+
302
+ return (
303
+ <div className="flex justify-center">
304
+ <Listbox
305
+ value={selectedCity}
306
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
307
+ options={cities}
308
+ optionValue="code"
309
+ optionKey="code"
310
+ className="w-full md:w-56"
311
+ >
312
+ <ListboxList>
313
+ {cities.map((option, index) => (
314
+ <ListboxOption key={index} uKey={option.code} className="gap-2">
315
+ <ListboxOptionIndicator className="data-unselected:invisible">
316
+ <Check />
317
+ </ListboxOptionIndicator>
318
+ {option.name}
319
+ </ListboxOption>
320
+ ))}
321
+ </ListboxList>
322
+ </Listbox>
323
+ </div>
324
+ );
325
+ }
326
+ ```
327
+
328
+ #### Multiple
329
+
330
+ Use the `multiple` property to allow selecting more than one item. In this mode, the value should be an array.
331
+
332
+ ```tsx
333
+ 'use client';
334
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
335
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
336
+ import { useState } from 'react';
337
+
338
+ const cities = [
339
+ { name: 'New York', code: 'NY' },
340
+ { name: 'Rome', code: 'RM' },
341
+ { name: 'London', code: 'LDN' },
342
+ { name: 'Istanbul', code: 'IST' },
343
+ { name: 'Paris', code: 'PRS' }
344
+ ];
345
+
346
+ export default function MultipleSelectionDemo() {
347
+ const [selectedCity, setSelectedCity] = useState<string[] | null>(null);
348
+
349
+ return (
350
+ <div className="flex justify-center">
351
+ <Listbox
352
+ value={selectedCity}
353
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string[] | null)}
354
+ options={cities}
355
+ optionLabel="name"
356
+ optionValue="code"
357
+ multiple
358
+ className="w-full md:w-56"
359
+ >
360
+ <ListboxList>
361
+ {cities.map((city, index) => (
362
+ <ListboxOption key={index} index={index}>
363
+ {city.name}
364
+ </ListboxOption>
365
+ ))}
366
+ </ListboxList>
367
+ </Listbox>
368
+ </div>
369
+ );
370
+ }
371
+ ```
372
+
373
+ #### Meta Key Selection
374
+
375
+ Use `metaKeySelection` in multiple mode to require <kbd>Ctrl</kbd> / <kbd>Cmd</kbd> for additive selection.
376
+
377
+ ```tsx
378
+ 'use client';
379
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
380
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
381
+ import { useState } from 'react';
382
+
383
+ const cities = [
384
+ { name: 'New York', code: 'NY' },
385
+ { name: 'Rome', code: 'RM' },
386
+ { name: 'London', code: 'LDN' },
387
+ { name: 'Istanbul', code: 'IST' },
388
+ { name: 'Paris', code: 'PRS' }
389
+ ];
390
+
391
+ export default function MetaKeySelectionDemo() {
392
+ const [selectedCities, setSelectedCities] = useState<string[] | null>(null);
393
+
394
+ return (
395
+ <div className="space-y-3">
396
+ <p className="text-sm text-color-secondary text-center">
397
+ Hold <kbd className="px-1 py-0.5 border rounded text-xs">Ctrl</kbd> (or <kbd className="px-1 py-0.5 border rounded text-xs">Cmd</kbd>{' '}
398
+ on macOS) while selecting to keep existing selections.
399
+ </p>
400
+ <div className="flex justify-center">
401
+ <Listbox
402
+ value={selectedCities}
403
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCities(e.value as string[] | null)}
404
+ options={cities}
405
+ optionLabel="name"
406
+ optionValue="code"
407
+ multiple
408
+ metaKeySelection
409
+ className="w-full md:w-56"
410
+ >
411
+ <ListboxList>
412
+ {cities.map((city, index) => (
413
+ <ListboxOption key={index} index={index}>
414
+ {city.name}
415
+ </ListboxOption>
416
+ ))}
417
+ </ListboxList>
418
+ </Listbox>
419
+ </div>
420
+ </div>
421
+ );
422
+ }
423
+ ```
424
+
425
+ #### Checkbox
426
+
427
+ Combine the `multiple` property with the `Checkbox` component inside `Listbox.OptionIndicator` to render checkboxes for each option. A `Listbox.Header` can be used to add a select all control.
428
+
429
+ ```tsx
430
+ 'use client';
431
+ import { Checkbox } from '@/components/ui/checkbox';
432
+ import { Listbox, ListboxHeader, ListboxList, ListboxOption } from '@/components/ui/listbox';
433
+ import type { CheckboxRootChangeEvent } from 'primereact/checkbox';
434
+ import type { ListboxListInstance, ListboxRootValueChangeEvent } from 'primereact/listbox';
435
+ import { useState } from 'react';
436
+
437
+ const cities = [
438
+ { name: 'New York', code: 'NY' },
439
+ { name: 'Rome', code: 'RM' },
440
+ { name: 'London', code: 'LDN' },
441
+ { name: 'Istanbul', code: 'IST' },
442
+ { name: 'Paris', code: 'PRS' }
443
+ ];
444
+
445
+ export default function CheckboxDemo() {
446
+ const [selectedCity, setSelectedCity] = useState<string[] | null>(null);
447
+
448
+ const isAllSelected = cities.every((city) => selectedCity?.includes(city.code));
449
+ const indeterminate = cities.some((city) => selectedCity?.includes(city.code)) && !isAllSelected;
450
+
451
+ return (
452
+ <div className="flex justify-center">
453
+ <Listbox
454
+ value={selectedCity}
455
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string[])}
456
+ options={cities}
457
+ optionValue="code"
458
+ optionKey="code"
459
+ multiple
460
+ className="w-full md:w-56"
461
+ >
462
+ <ListboxHeader>
463
+ <Checkbox
464
+ aria-label="Select all cities"
465
+ indeterminate={indeterminate}
466
+ checked={isAllSelected}
467
+ onCheckedChange={(e: CheckboxRootChangeEvent) => setSelectedCity(e.checked ? cities.map((city) => city.code) : [])}
468
+ className="ms-1.5"
469
+ />
470
+ </ListboxHeader>
471
+ <ListboxList>
472
+ {(instance: ListboxListInstance) => {
473
+ const { listbox } = instance;
474
+ const options = instance.options as typeof cities | undefined | null;
475
+
476
+ return options?.map((option, index) => {
477
+ const selected = listbox?.isSelected(option);
478
+
479
+ return (
480
+ <ListboxOption key={index} uKey={option.code} className="gap-2">
481
+ <Checkbox defaultChecked={!!selected} tabIndex={-1} readOnly />
482
+ {option.name}
483
+ </ListboxOption>
484
+ );
485
+ });
486
+ }}
487
+ </ListboxList>
488
+ </Listbox>
489
+ </div>
490
+ );
491
+ }
492
+ ```
493
+
494
+ ### Group
495
+
496
+ #### Simple
497
+
498
+ Use the `optionGroupLabel` and `optionGroupChildren` properties to organize options into groups.
499
+
500
+ ```tsx
501
+ 'use client';
502
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
503
+ import type { ListboxListInstance, ListboxRootValueChangeEvent } from 'primereact/listbox';
504
+ import { useState } from 'react';
505
+
506
+ const groupedCities = [
507
+ {
508
+ label: 'Germany',
509
+ code: 'DE',
510
+ items: [
511
+ { label: 'Berlin', value: 'Berlin' },
512
+ { label: 'Frankfurt', value: 'Frankfurt' },
513
+ { label: 'Hamburg', value: 'Hamburg' },
514
+ { label: 'Munich', value: 'Munich' }
515
+ ]
516
+ },
517
+ {
518
+ label: 'USA',
519
+ code: 'US',
520
+ items: [
521
+ { label: 'Chicago', value: 'Chicago' },
522
+ { label: 'Los Angeles', value: 'Los Angeles' },
523
+ { label: 'New York', value: 'New York' },
524
+ { label: 'San Francisco', value: 'San Francisco' }
525
+ ]
526
+ },
527
+ {
528
+ label: 'Japan',
529
+ code: 'JP',
530
+ items: [
531
+ { label: 'Kyoto', value: 'Kyoto' },
532
+ { label: 'Osaka', value: 'Osaka' },
533
+ { label: 'Tokyo', value: 'Tokyo' },
534
+ { label: 'Yokohama', value: 'Yokohama' }
535
+ ]
536
+ }
537
+ ];
538
+
539
+ export default function GroupDemo() {
540
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
541
+
542
+ return (
543
+ <div className="flex justify-center">
544
+ <Listbox
545
+ value={selectedCity}
546
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
547
+ options={groupedCities}
548
+ optionLabel="label"
549
+ optionGroupLabel="label"
550
+ optionGroupChildren="items"
551
+ className="w-full md:w-56"
552
+ >
553
+ <ListboxList style={{ maxHeight: '250px' }}>
554
+ {(instance: ListboxListInstance) => {
555
+ const { listbox, options } = instance;
556
+
557
+ return (options as unknown[])?.map((option: unknown, index: number) => {
558
+ const isGroup = listbox?.isOptionGroup(option);
559
+
560
+ if (isGroup) {
561
+ const label = listbox?.getOptionGroupLabel((option as Record<string, unknown>).optionGroup);
562
+
563
+ return (
564
+ <ListboxOption key={index} index={index} group>
565
+ {label}
566
+ </ListboxOption>
567
+ );
568
+ }
569
+
570
+ const label = listbox?.getOptionLabel(option);
571
+
572
+ return (
573
+ <ListboxOption key={index} index={index}>
574
+ {label}
575
+ </ListboxOption>
576
+ );
577
+ });
578
+ }}
579
+ </ListboxList>
580
+ </Listbox>
581
+ </div>
582
+ );
583
+ }
584
+ ```
585
+
586
+ #### Custom
587
+
588
+ Use the `Listbox.Option` component with the `group` prop to customize group headers with custom content like icons or flags.
589
+
590
+ ```tsx
591
+ 'use client';
592
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
593
+ import type { ListboxListInstance, ListboxRootValueChangeEvent } from 'primereact/listbox';
594
+ import { useState } from 'react';
595
+
596
+ const groupedCities = [
597
+ {
598
+ label: 'Germany',
599
+ code: 'DE',
600
+ items: [
601
+ { label: 'Berlin', value: 'Berlin' },
602
+ { label: 'Frankfurt', value: 'Frankfurt' },
603
+ { label: 'Hamburg', value: 'Hamburg' },
604
+ { label: 'Munich', value: 'Munich' }
605
+ ]
606
+ },
607
+ {
608
+ label: 'USA',
609
+ code: 'US',
610
+ items: [
611
+ { label: 'Chicago', value: 'Chicago' },
612
+ { label: 'Los Angeles', value: 'Los Angeles' },
613
+ { label: 'New York', value: 'New York' },
614
+ { label: 'San Francisco', value: 'San Francisco' }
615
+ ]
616
+ },
617
+ {
618
+ label: 'Japan',
619
+ code: 'JP',
620
+ items: [
621
+ { label: 'Kyoto', value: 'Kyoto' },
622
+ { label: 'Osaka', value: 'Osaka' },
623
+ { label: 'Tokyo', value: 'Tokyo' },
624
+ { label: 'Yokohama', value: 'Yokohama' }
625
+ ]
626
+ }
627
+ ];
628
+
629
+ const countryFlags: Record<string, string> = {
630
+ DE: '\uD83C\uDDE9\uD83C\uDDEA',
631
+ US: '\uD83C\uDDFA\uD83C\uDDF8',
632
+ JP: '\uD83C\uDDEF\uD83C\uDDF5'
633
+ };
634
+
635
+ export default function CustomGroupDemo() {
636
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
637
+
638
+ return (
639
+ <div className="flex justify-center">
640
+ <Listbox
641
+ value={selectedCity}
642
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
643
+ options={groupedCities}
644
+ optionLabel="label"
645
+ optionGroupLabel="label"
646
+ optionGroupChildren="items"
647
+ className="w-full md:w-56 overflow-hidden"
648
+ >
649
+ <ListboxList style={{ maxHeight: '250px' }} className="p-0">
650
+ {(instance: ListboxListInstance) => {
651
+ const { listbox, options } = instance;
652
+
653
+ return (options as unknown[])?.map((option: unknown, index: number) => {
654
+ const isGroup = listbox?.isOptionGroup(option);
655
+
656
+ if (isGroup) {
657
+ const optionGroup = (option as Record<string, unknown>).optionGroup as Record<string, string>;
658
+ const code = optionGroup?.code;
659
+
660
+ return (
661
+ <ListboxOption
662
+ key={index}
663
+ index={index}
664
+ group
665
+ className="flex items-center gap-2 sticky top-0 z-1 bg-surface-0 dark:bg-surface-900 border-b border-surface"
666
+ >
667
+ <span>{countryFlags[code]}</span>
668
+ <span>{optionGroup?.label}</span>
669
+ </ListboxOption>
670
+ );
671
+ }
672
+
673
+ const label = listbox?.getOptionLabel(option);
674
+
675
+ return (
676
+ <ListboxOption key={index} index={index}>
677
+ {label}
678
+ </ListboxOption>
679
+ );
680
+ });
681
+ }}
682
+ </ListboxList>
683
+ </Listbox>
684
+ </div>
685
+ );
686
+ }
687
+ ```
688
+
689
+ ### Filter
690
+
691
+ Place a `Listbox.Filter` component inside `Listbox.Header` to add a search input. Use the `as` prop to render any input component and control the filtering logic with `onChange`. A `Listbox.Empty` component displays a message when no options match.
692
+
693
+ ```tsx
694
+ 'use client';
695
+ import { IconField, IconFieldInset } from '@/components/ui/iconfield';
696
+ import { InputText } from '@/components/ui/inputtext';
697
+ import { Listbox, ListboxEmpty, ListboxFilter, ListboxHeader, ListboxList, ListboxOption } from '@/components/ui/listbox';
698
+ import { Search } from '@primeicons/react';
699
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
700
+ import { useMemo, useState } from 'react';
701
+
702
+ const cities = [
703
+ { name: 'New York', code: 'NY' },
704
+ { name: 'Rome', code: 'RM' },
705
+ { name: 'London', code: 'LDN' },
706
+ { name: 'Istanbul', code: 'IST' },
707
+ { name: 'Paris', code: 'PRS' }
708
+ ];
709
+
710
+ export default function FilterDemo() {
711
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
712
+ const [filterValue, setFilterValue] = useState<string>('');
713
+ const filteredCities = useMemo(() => cities.filter((city) => city.name.toLowerCase().startsWith(filterValue.toLowerCase())), [filterValue]);
714
+
715
+ return (
716
+ <div className="flex justify-center">
717
+ <Listbox
718
+ value={selectedCity}
719
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
720
+ options={filteredCities}
721
+ optionLabel="name"
722
+ optionValue="code"
723
+ className="w-full md:w-56"
724
+ >
725
+ <ListboxHeader>
726
+ <IconField>
727
+ <ListboxFilter
728
+ as={InputText}
729
+ placeholder="Search city"
730
+ value={filterValue}
731
+ onChange={(e: React.ChangeEvent<HTMLInputElement>) => setFilterValue(e.target.value)}
732
+ />
733
+ <IconFieldInset>
734
+ <Search />
735
+ </IconFieldInset>
736
+ </IconField>
737
+ </ListboxHeader>
738
+ <ListboxList>
739
+ {filteredCities.map((city, index) => (
740
+ <ListboxOption key={index} index={index}>
741
+ {city.name}
742
+ </ListboxOption>
743
+ ))}
744
+ </ListboxList>
745
+ <ListboxEmpty>No options found</ListboxEmpty>
746
+ </Listbox>
747
+ </div>
748
+ );
749
+ }
750
+ ```
751
+
752
+ ### Invalid
753
+
754
+ Use the `invalid` property to indicate a validation error.
755
+
756
+ ```tsx
757
+ 'use client';
758
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
759
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
760
+ import { useState } from 'react';
761
+
762
+ const cities = [
763
+ { name: 'New York', code: 'NY' },
764
+ { name: 'Rome', code: 'RM' },
765
+ { name: 'London', code: 'LDN' },
766
+ { name: 'Istanbul', code: 'IST' },
767
+ { name: 'Paris', code: 'PRS' }
768
+ ];
769
+
770
+ export default function InvalidDemo() {
771
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
772
+
773
+ return (
774
+ <div className="flex justify-center">
775
+ <Listbox
776
+ value={selectedCity}
777
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
778
+ options={cities}
779
+ optionLabel="name"
780
+ optionValue="code"
781
+ invalid={selectedCity === null}
782
+ className="w-full md:w-56"
783
+ >
784
+ <ListboxList>
785
+ {cities.map((city, index) => (
786
+ <ListboxOption key={index} index={index}>
787
+ {city.name}
788
+ </ListboxOption>
789
+ ))}
790
+ </ListboxList>
791
+ </Listbox>
792
+ </div>
793
+ );
794
+ }
795
+ ```
796
+
797
+ ### Disabled
798
+
799
+ Use the `disabled` property to prevent interaction.
800
+
801
+ ```tsx
802
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
803
+
804
+ const cities = [
805
+ { name: 'New York', code: 'NY' },
806
+ { name: 'Rome', code: 'RM' },
807
+ { name: 'London', code: 'LDN' },
808
+ { name: 'Istanbul', code: 'IST' },
809
+ { name: 'Paris', code: 'PRS' }
810
+ ];
811
+
812
+ export default function DisabledDemo() {
813
+ return (
814
+ <div className="flex justify-center">
815
+ <Listbox options={cities} optionLabel="name" optionValue="code" disabled className="w-full md:w-56">
816
+ <ListboxList>
817
+ {cities.map((city, index) => (
818
+ <ListboxOption key={index} index={index}>
819
+ {city.name}
820
+ </ListboxOption>
821
+ ))}
822
+ </ListboxList>
823
+ </Listbox>
824
+ </div>
825
+ );
826
+ }
827
+ ```
828
+
829
+ ### Disabled Options
830
+
831
+ Use `optionDisabled` to disable specific items by field name while keeping the listbox itself interactive.
832
+
833
+ ```tsx
834
+ 'use client';
835
+ import { Listbox, ListboxList, ListboxOption } from '@/components/ui/listbox';
836
+ import { ListboxRootValueChangeEvent } from 'primereact/listbox';
837
+ import { useState } from 'react';
838
+
839
+ const cities = [
840
+ { name: 'New York', code: 'NY' },
841
+ { name: 'Rome', code: 'RM' },
842
+ { name: 'London', code: 'LDN', disabled: true },
843
+ { name: 'Istanbul', code: 'IST' },
844
+ { name: 'Paris', code: 'PRS', disabled: true }
845
+ ];
846
+
847
+ export default function OptionDisabledDemo() {
848
+ const [selectedCity, setSelectedCity] = useState<string | null>(null);
849
+
850
+ return (
851
+ <div className="flex justify-center">
852
+ <Listbox
853
+ value={selectedCity}
854
+ onValueChange={(e: ListboxRootValueChangeEvent) => setSelectedCity(e.value as string | null)}
855
+ options={cities}
856
+ optionLabel="name"
857
+ optionValue="code"
858
+ optionDisabled="disabled"
859
+ className="w-full md:w-56"
860
+ >
861
+ <ListboxList>
862
+ {cities.map((city, index) => (
863
+ <ListboxOption key={index} index={index}>
864
+ {city.name}
865
+ </ListboxOption>
866
+ ))}
867
+ </ListboxList>
868
+ </Listbox>
869
+ </div>
870
+ );
871
+ }
872
+ ```
873
+
874
+ ### API
875
+
876
+ ### Sub-Components
877
+
878
+ See [Primitive API](/docs/primitive/components/listbox#api) for `ListboxRoot`, `ListboxList`, `ListboxOption`, `ListboxOptionIndicator`, `ListboxHeader`, `ListboxFilter`, `ListboxEmpty`, `ListboxFooter` component documentation.
879
+
880
+ ### Hooks
881
+
882
+ See [Headless API](/docs/headless/components/listbox#api) for `useListbox` and `useListboxOption` hook documentation.
883
+
884
+ ## Accessibility
885
+
886
+ See [Listbox Primitive](/docs/primitive/components/listbox#accessibility) for WAI-ARIA compliance details and keyboard support.