@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.
- package/LICENSE.md +45 -0
- package/README.md +94 -0
- package/data/llms/headless/add-ons/introduction.md +16 -0
- package/data/llms/headless/components/accordion/api.json +252 -0
- package/data/llms/headless/components/accordion.md +196 -0
- package/data/llms/headless/components/animateonscroll/api.json +88 -0
- package/data/llms/headless/components/animateonscroll.md +141 -0
- package/data/llms/headless/components/autocomplete/api.json +787 -0
- package/data/llms/headless/components/autocomplete.md +249 -0
- package/data/llms/headless/components/avatar/api.json +154 -0
- package/data/llms/headless/components/avatar.md +149 -0
- package/data/llms/headless/components/badge/api.json +68 -0
- package/data/llms/headless/components/badge.md +150 -0
- package/data/llms/headless/components/breadcrumb/api.json +142 -0
- package/data/llms/headless/components/breadcrumb.md +149 -0
- package/data/llms/headless/components/button/api.json +62 -0
- package/data/llms/headless/components/button.md +73 -0
- package/data/llms/headless/components/card/api.json +36 -0
- package/data/llms/headless/components/card.md +96 -0
- package/data/llms/headless/components/carousel/api.json +793 -0
- package/data/llms/headless/components/carousel.md +196 -0
- package/data/llms/headless/components/checkbox/api.json +593 -0
- package/data/llms/headless/components/checkbox.md +184 -0
- package/data/llms/headless/components/chip/api.json +107 -0
- package/data/llms/headless/components/chip.md +141 -0
- package/data/llms/headless/components/collapsible/api.json +301 -0
- package/data/llms/headless/components/collapsible.md +136 -0
- package/data/llms/headless/components/compare/api.json +533 -0
- package/data/llms/headless/components/compare.md +142 -0
- package/data/llms/headless/components/contextmenu/api.json +495 -0
- package/data/llms/headless/components/contextmenu.md +282 -0
- package/data/llms/headless/components/datatable/api.json +1680 -0
- package/data/llms/headless/components/datatable.md +258 -0
- package/data/llms/headless/components/dataview/api.json +199 -0
- package/data/llms/headless/components/dataview.md +147 -0
- package/data/llms/headless/components/datepicker/api.json +2796 -0
- package/data/llms/headless/components/datepicker.md +456 -0
- package/data/llms/headless/components/dialog/api.json +626 -0
- package/data/llms/headless/components/dialog.md +280 -0
- package/data/llms/headless/components/divider/api.json +130 -0
- package/data/llms/headless/components/divider.md +92 -0
- package/data/llms/headless/components/drawer/api.json +425 -0
- package/data/llms/headless/components/drawer.md +220 -0
- package/data/llms/headless/components/fieldset/api.json +195 -0
- package/data/llms/headless/components/fieldset.md +154 -0
- package/data/llms/headless/components/fileupload/api.json +905 -0
- package/data/llms/headless/components/fileupload.md +323 -0
- package/data/llms/headless/components/floatlabel/api.json +36 -0
- package/data/llms/headless/components/floatlabel.md +19 -0
- package/data/llms/headless/components/fluid/api.json +36 -0
- package/data/llms/headless/components/fluid.md +19 -0
- package/data/llms/headless/components/focustrap/api.json +135 -0
- package/data/llms/headless/components/focustrap.md +125 -0
- package/data/llms/headless/components/gallery/api.json +1349 -0
- package/data/llms/headless/components/gallery.md +355 -0
- package/data/llms/headless/components/iconfield/api.json +62 -0
- package/data/llms/headless/components/iconfield.md +19 -0
- package/data/llms/headless/components/iftalabel/api.json +62 -0
- package/data/llms/headless/components/iftalabel.md +19 -0
- package/data/llms/headless/components/inplace/api.json +340 -0
- package/data/llms/headless/components/inplace.md +153 -0
- package/data/llms/headless/components/inputcolor/api.json +469 -0
- package/data/llms/headless/components/inputcolor.md +253 -0
- package/data/llms/headless/components/inputgroup/api.json +62 -0
- package/data/llms/headless/components/inputgroup.md +19 -0
- package/data/llms/headless/components/inputnumber/api.json +554 -0
- package/data/llms/headless/components/inputnumber.md +167 -0
- package/data/llms/headless/components/inputotp/api.json +276 -0
- package/data/llms/headless/components/inputotp.md +130 -0
- package/data/llms/headless/components/inputpassword/api.json +180 -0
- package/data/llms/headless/components/inputpassword.md +117 -0
- package/data/llms/headless/components/inputtags/api.json +497 -0
- package/data/llms/headless/components/inputtags.md +298 -0
- package/data/llms/headless/components/inputtext/api.json +81 -0
- package/data/llms/headless/components/inputtext.md +109 -0
- package/data/llms/headless/components/knob/api.json +429 -0
- package/data/llms/headless/components/knob.md +151 -0
- package/data/llms/headless/components/label/api.json +62 -0
- package/data/llms/headless/components/label.md +19 -0
- package/data/llms/headless/components/listbox/api.json +814 -0
- package/data/llms/headless/components/listbox.md +194 -0
- package/data/llms/headless/components/menu/api.json +1247 -0
- package/data/llms/headless/components/menu.md +283 -0
- package/data/llms/headless/components/message/api.json +131 -0
- package/data/llms/headless/components/message.md +143 -0
- package/data/llms/headless/components/metergroup/api.json +266 -0
- package/data/llms/headless/components/metergroup.md +129 -0
- package/data/llms/headless/components/motion/api.json +237 -0
- package/data/llms/headless/components/motion.md +160 -0
- package/data/llms/headless/components/navigationmenu/api.json +220 -0
- package/data/llms/headless/components/navigationmenu.md +166 -0
- package/data/llms/headless/components/orderlist/api.json +196 -0
- package/data/llms/headless/components/orderlist.md +221 -0
- package/data/llms/headless/components/organizationchart/api.json +372 -0
- package/data/llms/headless/components/organizationchart.md +254 -0
- package/data/llms/headless/components/paginator/api.json +311 -0
- package/data/llms/headless/components/paginator.md +187 -0
- package/data/llms/headless/components/panel/api.json +195 -0
- package/data/llms/headless/components/panel.md +150 -0
- package/data/llms/headless/components/picklist/api.json +293 -0
- package/data/llms/headless/components/picklist.md +270 -0
- package/data/llms/headless/components/popover/api.json +405 -0
- package/data/llms/headless/components/popover.md +301 -0
- package/data/llms/headless/components/portal/api.json +56 -0
- package/data/llms/headless/components/portal.md +102 -0
- package/data/llms/headless/components/positioner/api.json +165 -0
- package/data/llms/headless/components/positioner.md +181 -0
- package/data/llms/headless/components/progressbar/api.json +87 -0
- package/data/llms/headless/components/progressbar.md +122 -0
- package/data/llms/headless/components/progressspinner/api.json +337 -0
- package/data/llms/headless/components/progressspinner.md +128 -0
- package/data/llms/headless/components/radiobutton/api.json +569 -0
- package/data/llms/headless/components/radiobutton.md +195 -0
- package/data/llms/headless/components/rating/api.json +347 -0
- package/data/llms/headless/components/rating.md +181 -0
- package/data/llms/headless/components/scrollarea/api.json +730 -0
- package/data/llms/headless/components/scrollarea.md +232 -0
- package/data/llms/headless/components/select/api.json +829 -0
- package/data/llms/headless/components/select.md +262 -0
- package/data/llms/headless/components/sidebar/api.json +433 -0
- package/data/llms/headless/components/sidebar.md +266 -0
- package/data/llms/headless/components/skeleton/api.json +68 -0
- package/data/llms/headless/components/skeleton.md +95 -0
- package/data/llms/headless/components/slider/api.json +559 -0
- package/data/llms/headless/components/slider.md +158 -0
- package/data/llms/headless/components/speeddial/api.json +459 -0
- package/data/llms/headless/components/speeddial.md +181 -0
- package/data/llms/headless/components/splitter/api.json +582 -0
- package/data/llms/headless/components/splitter.md +159 -0
- package/data/llms/headless/components/stepper/api.json +385 -0
- package/data/llms/headless/components/stepper.md +183 -0
- package/data/llms/headless/components/styleclass/api.json +134 -0
- package/data/llms/headless/components/styleclass.md +129 -0
- package/data/llms/headless/components/tabs/api.json +336 -0
- package/data/llms/headless/components/tabs.md +158 -0
- package/data/llms/headless/components/tag/api.json +62 -0
- package/data/llms/headless/components/tag.md +121 -0
- package/data/llms/headless/components/terminal/api.json +117 -0
- package/data/llms/headless/components/terminal.md +183 -0
- package/data/llms/headless/components/textarea/api.json +81 -0
- package/data/llms/headless/components/textarea.md +110 -0
- package/data/llms/headless/components/timeline/api.json +270 -0
- package/data/llms/headless/components/timeline.md +117 -0
- package/data/llms/headless/components/toast/api.json +455 -0
- package/data/llms/headless/components/toast.md +277 -0
- package/data/llms/headless/components/togglebutton/api.json +357 -0
- package/data/llms/headless/components/togglebutton.md +183 -0
- package/data/llms/headless/components/toggleswitch/api.json +326 -0
- package/data/llms/headless/components/toggleswitch.md +164 -0
- package/data/llms/headless/components/toolbar/api.json +68 -0
- package/data/llms/headless/components/toolbar.md +96 -0
- package/data/llms/headless/components/tooltip/api.json +478 -0
- package/data/llms/headless/components/tooltip.md +233 -0
- package/data/llms/headless/components/tree/api.json +1297 -0
- package/data/llms/headless/components/tree.md +297 -0
- package/data/llms/headless/components/treetable/api.json +1680 -0
- package/data/llms/headless/components/treetable.md +177 -0
- package/data/llms/headless/guides/ai/llms.md +25 -0
- package/data/llms/headless/guides/installation.md +126 -0
- package/data/llms/headless/guides/introduction.md +20 -0
- package/data/llms/headless/guides/misc/accessibility.md +228 -0
- package/data/llms/headless/llms.md +25 -0
- package/data/llms/headless/resources/introduction.md +15 -0
- package/data/llms/hooks/gettingstarted/introduction.md +34 -0
- package/data/llms/hooks/gettingstarted/setup.md +54 -0
- package/data/llms/hooks/use-attr-selector.md +25 -0
- package/data/llms/hooks/use-controlled-state.md +31 -0
- package/data/llms/hooks/use-event-listener.md +37 -0
- package/data/llms/hooks/use-filter.md +312 -0
- package/data/llms/hooks/use-hot-key.md +40 -0
- package/data/llms/hooks/use-id.md +24 -0
- package/data/llms/hooks/use-intersection-observer.md +42 -0
- package/data/llms/hooks/use-is-mobile.md +24 -0
- package/data/llms/hooks/use-key-filter.md +139 -0
- package/data/llms/hooks/use-local-storage.md +28 -0
- package/data/llms/hooks/use-mask.md +53 -0
- package/data/llms/hooks/use-match-media.md +28 -0
- package/data/llms/hooks/use-mount-effect.md +25 -0
- package/data/llms/hooks/use-mounted.md +36 -0
- package/data/llms/hooks/use-number-formatter.md +48 -0
- package/data/llms/hooks/use-presence.md +44 -0
- package/data/llms/hooks/use-previous.md +28 -0
- package/data/llms/hooks/use-props.md +37 -0
- package/data/llms/hooks/use-queue-task.md +29 -0
- package/data/llms/hooks/use-scrolltop.md +87 -0
- package/data/llms/hooks/use-sortable-list.md +226 -0
- package/data/llms/hooks/use-tree-filter.md +216 -0
- package/data/llms/hooks/use-unmount-effect.md +23 -0
- package/data/llms/hooks/use-update-effect.md +27 -0
- package/data/llms/hooks/use-view-transition.md +31 -0
- package/data/llms/hooks/use-visibility-change.md +30 -0
- package/data/llms/llms-full.txt +125291 -0
- package/data/llms/llms.txt +379 -0
- package/data/llms/manifest.json +12409 -0
- package/data/llms/mcp-data.json +14481 -0
- package/data/llms/primitive/add-ons/introduction.md +16 -0
- package/data/llms/primitive/components/accordion/api.json +1411 -0
- package/data/llms/primitive/components/accordion.md +231 -0
- package/data/llms/primitive/components/animateonscroll/api.json +193 -0
- package/data/llms/primitive/components/animateonscroll.md +91 -0
- package/data/llms/primitive/components/autocomplete/api.json +3167 -0
- package/data/llms/primitive/components/autocomplete.md +344 -0
- package/data/llms/primitive/components/avatar/api.json +703 -0
- package/data/llms/primitive/components/avatar.md +134 -0
- package/data/llms/primitive/components/badge/api.json +363 -0
- package/data/llms/primitive/components/badge.md +118 -0
- package/data/llms/primitive/components/breadcrumb/api.json +1162 -0
- package/data/llms/primitive/components/breadcrumb.md +196 -0
- package/data/llms/primitive/components/button/api.json +246 -0
- package/data/llms/primitive/components/button.md +114 -0
- package/data/llms/primitive/components/buttongroup/api.json +168 -0
- package/data/llms/primitive/components/buttongroup.md +43 -0
- package/data/llms/primitive/components/card/api.json +1252 -0
- package/data/llms/primitive/components/card.md +159 -0
- package/data/llms/primitive/components/carousel/api.json +1374 -0
- package/data/llms/primitive/components/carousel.md +220 -0
- package/data/llms/primitive/components/checkbox/api.json +697 -0
- package/data/llms/primitive/components/checkbox.md +160 -0
- package/data/llms/primitive/components/checkboxgroup/api.json +252 -0
- package/data/llms/primitive/components/checkboxgroup.md +58 -0
- package/data/llms/primitive/components/chip/api.json +853 -0
- package/data/llms/primitive/components/chip.md +135 -0
- package/data/llms/primitive/components/collapsible/api.json +581 -0
- package/data/llms/primitive/components/collapsible.md +133 -0
- package/data/llms/primitive/components/compare/api.json +909 -0
- package/data/llms/primitive/components/compare.md +156 -0
- package/data/llms/primitive/components/contextmenu/api.json +3454 -0
- package/data/llms/primitive/components/contextmenu.md +483 -0
- package/data/llms/primitive/components/datatable/api.json +7832 -0
- package/data/llms/primitive/components/datatable.md +561 -0
- package/data/llms/primitive/components/dataview/api.json +819 -0
- package/data/llms/primitive/components/dataview.md +163 -0
- package/data/llms/primitive/components/datepicker/api.json +9055 -0
- package/data/llms/primitive/components/datepicker.md +760 -0
- package/data/llms/primitive/components/dialog/api.json +2491 -0
- package/data/llms/primitive/components/dialog.md +276 -0
- package/data/llms/primitive/components/divider/api.json +214 -0
- package/data/llms/primitive/components/divider.md +96 -0
- package/data/llms/primitive/components/drawer/api.json +1879 -0
- package/data/llms/primitive/components/drawer.md +220 -0
- package/data/llms/primitive/components/fieldset/api.json +1116 -0
- package/data/llms/primitive/components/fieldset.md +183 -0
- package/data/llms/primitive/components/fileupload/api.json +2445 -0
- package/data/llms/primitive/components/fileupload.md +282 -0
- package/data/llms/primitive/components/floatlabel/api.json +176 -0
- package/data/llms/primitive/components/floatlabel.md +47 -0
- package/data/llms/primitive/components/focustrap/api.json +241 -0
- package/data/llms/primitive/components/focustrap.md +93 -0
- package/data/llms/primitive/components/gallery/api.json +3622 -0
- package/data/llms/primitive/components/gallery.md +387 -0
- package/data/llms/primitive/components/iconfield/api.json +322 -0
- package/data/llms/primitive/components/iconfield.md +53 -0
- package/data/llms/primitive/components/iftalabel/api.json +177 -0
- package/data/llms/primitive/components/iftalabel.md +47 -0
- package/data/llms/primitive/components/inplace/api.json +783 -0
- package/data/llms/primitive/components/inplace.md +141 -0
- package/data/llms/primitive/components/inputcolor/api.json +2211 -0
- package/data/llms/primitive/components/inputcolor.md +295 -0
- package/data/llms/primitive/components/inputnumber/api.json +469 -0
- package/data/llms/primitive/components/inputnumber.md +99 -0
- package/data/llms/primitive/components/inputotp/api.json +469 -0
- package/data/llms/primitive/components/inputotp.md +121 -0
- package/data/llms/primitive/components/inputpassword/api.json +278 -0
- package/data/llms/primitive/components/inputpassword.md +84 -0
- package/data/llms/primitive/components/inputtags/api.json +407 -0
- package/data/llms/primitive/components/inputtags.md +243 -0
- package/data/llms/primitive/components/inputtext/api.json +207 -0
- package/data/llms/primitive/components/inputtext.md +81 -0
- package/data/llms/primitive/components/knob/api.json +841 -0
- package/data/llms/primitive/components/knob.md +148 -0
- package/data/llms/primitive/components/label/api.json +177 -0
- package/data/llms/primitive/components/label.md +44 -0
- package/data/llms/primitive/components/listbox/api.json +1741 -0
- package/data/llms/primitive/components/listbox.md +206 -0
- package/data/llms/primitive/components/menu/api.json +3836 -0
- package/data/llms/primitive/components/menu.md +479 -0
- package/data/llms/primitive/components/message/api.json +863 -0
- package/data/llms/primitive/components/message.md +151 -0
- package/data/llms/primitive/components/metergroup/api.json +1222 -0
- package/data/llms/primitive/components/metergroup.md +209 -0
- package/data/llms/primitive/components/motion.md +112 -0
- package/data/llms/primitive/components/navigationmenu/api.json +298 -0
- package/data/llms/primitive/components/navigationmenu.md +184 -0
- package/data/llms/primitive/components/organizationchart.md +133 -0
- package/data/llms/primitive/components/paginator/api.json +1637 -0
- package/data/llms/primitive/components/paginator.md +223 -0
- package/data/llms/primitive/components/panel/api.json +1270 -0
- package/data/llms/primitive/components/panel.md +186 -0
- package/data/llms/primitive/components/popover/api.json +2281 -0
- package/data/llms/primitive/components/popover.md +277 -0
- package/data/llms/primitive/components/portal/api.json +176 -0
- package/data/llms/primitive/components/portal.md +79 -0
- package/data/llms/primitive/components/progressbar/api.json +857 -0
- package/data/llms/primitive/components/progressbar.md +153 -0
- package/data/llms/primitive/components/progressspinner/api.json +725 -0
- package/data/llms/primitive/components/progressspinner.md +133 -0
- package/data/llms/primitive/components/radiobutton/api.json +929 -0
- package/data/llms/primitive/components/radiobutton.md +201 -0
- package/data/llms/primitive/components/rating/api.json +878 -0
- package/data/llms/primitive/components/rating.md +160 -0
- package/data/llms/primitive/components/scrollarea/api.json +1187 -0
- package/data/llms/primitive/components/scrollarea.md +255 -0
- package/data/llms/primitive/components/select/api.json +3167 -0
- package/data/llms/primitive/components/select.md +351 -0
- package/data/llms/primitive/components/sidebar/api.json +3699 -0
- package/data/llms/primitive/components/sidebar.md +444 -0
- package/data/llms/primitive/components/skeleton/api.json +213 -0
- package/data/llms/primitive/components/skeleton.md +80 -0
- package/data/llms/primitive/components/slider/api.json +1066 -0
- package/data/llms/primitive/components/slider.md +161 -0
- package/data/llms/primitive/components/speeddial/api.json +1002 -0
- package/data/llms/primitive/components/speeddial.md +197 -0
- package/data/llms/primitive/components/splitter/api.json +901 -0
- package/data/llms/primitive/components/splitter.md +137 -0
- package/data/llms/primitive/components/stepper/api.json +2102 -0
- package/data/llms/primitive/components/stepper.md +253 -0
- package/data/llms/primitive/components/styleclass.md +399 -0
- package/data/llms/primitive/components/tabs/api.json +1705 -0
- package/data/llms/primitive/components/tabs.md +200 -0
- package/data/llms/primitive/components/tag/api.json +189 -0
- package/data/llms/primitive/components/tag.md +100 -0
- package/data/llms/primitive/components/terminal/api.json +1709 -0
- package/data/llms/primitive/components/terminal.md +227 -0
- package/data/llms/primitive/components/textarea/api.json +213 -0
- package/data/llms/primitive/components/textarea.md +83 -0
- package/data/llms/primitive/components/timeline/api.json +1180 -0
- package/data/llms/primitive/components/timeline.md +185 -0
- package/data/llms/primitive/components/toast/api.json +2102 -0
- package/data/llms/primitive/components/toast.md +291 -0
- package/data/llms/primitive/components/togglebutton/api.json +433 -0
- package/data/llms/primitive/components/togglebutton.md +161 -0
- package/data/llms/primitive/components/togglebuttongroup/api.json +276 -0
- package/data/llms/primitive/components/togglebuttongroup.md +61 -0
- package/data/llms/primitive/components/toggleswitch/api.json +681 -0
- package/data/llms/primitive/components/toggleswitch.md +149 -0
- package/data/llms/primitive/components/toolbar/api.json +646 -0
- package/data/llms/primitive/components/toolbar.md +126 -0
- package/data/llms/primitive/components/tooltip/api.json +1534 -0
- package/data/llms/primitive/components/tooltip.md +202 -0
- package/data/llms/primitive/components/tree/api.json +2952 -0
- package/data/llms/primitive/components/tree.md +292 -0
- package/data/llms/primitive/components/treetable.md +187 -0
- package/data/llms/primitive/components/visuallyhidden/api.json +186 -0
- package/data/llms/primitive/components/visuallyhidden.md +87 -0
- package/data/llms/primitive/guides/ai/llms.md +25 -0
- package/data/llms/primitive/guides/icons/customicons.md +47 -0
- package/data/llms/primitive/guides/icons/primeicons.md +112 -0
- package/data/llms/primitive/guides/installation.md +115 -0
- package/data/llms/primitive/guides/introduction.md +20 -0
- package/data/llms/primitive/guides/misc/accessibility.md +215 -0
- package/data/llms/primitive/guides/misc/passthrough.md +95 -0
- package/data/llms/primitive/guides/misc/rtl.md +27 -0
- package/data/llms/primitive/llms.md +25 -0
- package/data/llms/primitive/resources/introduction.md +15 -0
- package/data/llms/styled/add-ons/introduction.md +16 -0
- package/data/llms/styled/components/accordion.md +735 -0
- package/data/llms/styled/components/animateonscroll.md +264 -0
- package/data/llms/styled/components/autocomplete.md +1597 -0
- package/data/llms/styled/components/avatar.md +313 -0
- package/data/llms/styled/components/badge.md +213 -0
- package/data/llms/styled/components/breadcrumb.md +461 -0
- package/data/llms/styled/components/button/api.json +246 -0
- package/data/llms/styled/components/button.md +641 -0
- package/data/llms/styled/components/buttongroup.md +614 -0
- package/data/llms/styled/components/card.md +228 -0
- package/data/llms/styled/components/carousel.md +388 -0
- package/data/llms/styled/components/checkbox.md +329 -0
- package/data/llms/styled/components/checkboxgroup.md +619 -0
- package/data/llms/styled/components/chip.md +300 -0
- package/data/llms/styled/components/compare.md +271 -0
- package/data/llms/styled/components/contextmenu.md +550 -0
- package/data/llms/styled/components/datatable.md +8259 -0
- package/data/llms/styled/components/dataview.md +907 -0
- package/data/llms/styled/components/datepicker.md +2807 -0
- package/data/llms/styled/components/dialog.md +1047 -0
- package/data/llms/styled/components/divider.md +207 -0
- package/data/llms/styled/components/drawer.md +470 -0
- package/data/llms/styled/components/fieldset.md +334 -0
- package/data/llms/styled/components/fileupload.md +747 -0
- package/data/llms/styled/components/floatlabel/api.json +210 -0
- package/data/llms/styled/components/floatlabel.md +231 -0
- package/data/llms/styled/components/fluid/api.json +204 -0
- package/data/llms/styled/components/fluid.md +177 -0
- package/data/llms/styled/components/focustrap.md +203 -0
- package/data/llms/styled/components/gallery.md +553 -0
- package/data/llms/styled/components/iconfield/api.json +382 -0
- package/data/llms/styled/components/iconfield.md +385 -0
- package/data/llms/styled/components/iftalabel/api.json +237 -0
- package/data/llms/styled/components/iftalabel.md +158 -0
- package/data/llms/styled/components/inplace.md +312 -0
- package/data/llms/styled/components/inputcolor.md +674 -0
- package/data/llms/styled/components/inputgroup/api.json +399 -0
- package/data/llms/styled/components/inputgroup.md +604 -0
- package/data/llms/styled/components/inputmask.md +282 -0
- package/data/llms/styled/components/inputnumber.md +563 -0
- package/data/llms/styled/components/inputotp.md +335 -0
- package/data/llms/styled/components/inputpassword.md +630 -0
- package/data/llms/styled/components/inputtags.md +727 -0
- package/data/llms/styled/components/inputtext.md +190 -0
- package/data/llms/styled/components/keyfilter.md +289 -0
- package/data/llms/styled/components/knob.md +305 -0
- package/data/llms/styled/components/label/api.json +237 -0
- package/data/llms/styled/components/label.md +224 -0
- package/data/llms/styled/components/listbox.md +807 -0
- package/data/llms/styled/components/menu.md +1175 -0
- package/data/llms/styled/components/message.md +570 -0
- package/data/llms/styled/components/metergroup.md +449 -0
- package/data/llms/styled/components/navigationmenu.md +926 -0
- package/data/llms/styled/components/orderlist.md +519 -0
- package/data/llms/styled/components/organizationchart/api.json +1457 -0
- package/data/llms/styled/components/organizationchart.md +791 -0
- package/data/llms/styled/components/overlaymanager.md +519 -0
- package/data/llms/styled/components/paginator.md +506 -0
- package/data/llms/styled/components/panel.md +394 -0
- package/data/llms/styled/components/picklist.md +1004 -0
- package/data/llms/styled/components/popover.md +372 -0
- package/data/llms/styled/components/progressbar.md +438 -0
- package/data/llms/styled/components/progressspinner.md +128 -0
- package/data/llms/styled/components/radiobutton.md +488 -0
- package/data/llms/styled/components/rating/api.json +766 -0
- package/data/llms/styled/components/rating.md +518 -0
- package/data/llms/styled/components/scrollarea.md +627 -0
- package/data/llms/styled/components/select.md +2122 -0
- package/data/llms/styled/components/sidebar.md +1587 -0
- package/data/llms/styled/components/skeleton.md +226 -0
- package/data/llms/styled/components/slider.md +453 -0
- package/data/llms/styled/components/speeddial.md +723 -0
- package/data/llms/styled/components/splitter.md +536 -0
- package/data/llms/styled/components/stepper.md +614 -0
- package/data/llms/styled/components/tabs.md +543 -0
- package/data/llms/styled/components/tag.md +263 -0
- package/data/llms/styled/components/terminal.md +543 -0
- package/data/llms/styled/components/textarea.md +257 -0
- package/data/llms/styled/components/timeline.md +620 -0
- package/data/llms/styled/components/toast.md +1013 -0
- package/data/llms/styled/components/togglebutton.md +287 -0
- package/data/llms/styled/components/togglebuttongroup.md +328 -0
- package/data/llms/styled/components/toggleswitch.md +262 -0
- package/data/llms/styled/components/toolbar.md +187 -0
- package/data/llms/styled/components/tooltip.md +430 -0
- package/data/llms/styled/components/tree.md +1386 -0
- package/data/llms/styled/components/treetable.md +6842 -0
- package/data/llms/styled/guides/ai/llms.md +25 -0
- package/data/llms/styled/guides/configuration.md +151 -0
- package/data/llms/styled/guides/icons/customicons.md +47 -0
- package/data/llms/styled/guides/icons/primeicons.md +112 -0
- package/data/llms/styled/guides/installation/astro.md +97 -0
- package/data/llms/styled/guides/installation/manual.md +3 -0
- package/data/llms/styled/guides/installation/nextjs.md +129 -0
- package/data/llms/styled/guides/installation/react-router.md +88 -0
- package/data/llms/styled/guides/installation/tanstack.md +92 -0
- package/data/llms/styled/guides/installation/vite.md +91 -0
- package/data/llms/styled/guides/installation.md +42 -0
- package/data/llms/styled/guides/introduction.md +20 -0
- package/data/llms/styled/guides/misc/accessibility.md +211 -0
- package/data/llms/styled/guides/misc/animations.md +389 -0
- package/data/llms/styled/guides/misc/passthrough.md +95 -0
- package/data/llms/styled/guides/misc/rtl.md +27 -0
- package/data/llms/styled/guides/theming/styled.md +779 -0
- package/data/llms/styled/guides/theming/tailwind.md +473 -0
- package/data/llms/styled/guides/theming/unstyled.md +115 -0
- package/data/llms/styled/resources/introduction.md +15 -0
- package/data/llms/tailwind/add-ons/introduction.md +16 -0
- package/data/llms/tailwind/components/accordion.md +383 -0
- package/data/llms/tailwind/components/autocomplete.md +1346 -0
- package/data/llms/tailwind/components/avatar.md +305 -0
- package/data/llms/tailwind/components/badge.md +207 -0
- package/data/llms/tailwind/components/breadcrumb.md +387 -0
- package/data/llms/tailwind/components/button/api.json +246 -0
- package/data/llms/tailwind/components/button.md +617 -0
- package/data/llms/tailwind/components/buttongroup.md +599 -0
- package/data/llms/tailwind/components/card.md +224 -0
- package/data/llms/tailwind/components/carousel.md +329 -0
- package/data/llms/tailwind/components/checkbox.md +179 -0
- package/data/llms/tailwind/components/checkboxgroup.md +279 -0
- package/data/llms/tailwind/components/chip.md +304 -0
- package/data/llms/tailwind/components/compare.md +295 -0
- package/data/llms/tailwind/components/contextmenu.md +415 -0
- package/data/llms/tailwind/components/datatable.md +4062 -0
- package/data/llms/tailwind/components/dataview.md +864 -0
- package/data/llms/tailwind/components/datepicker.md +823 -0
- package/data/llms/tailwind/components/dialog.md +1216 -0
- package/data/llms/tailwind/components/divider.md +205 -0
- package/data/llms/tailwind/components/drawer.md +500 -0
- package/data/llms/tailwind/components/fieldset.md +326 -0
- package/data/llms/tailwind/components/fluid.md +117 -0
- package/data/llms/tailwind/components/iconfield.md +197 -0
- package/data/llms/tailwind/components/inplace.md +324 -0
- package/data/llms/tailwind/components/inputcolor.md +493 -0
- package/data/llms/tailwind/components/inputgroup.md +375 -0
- package/data/llms/tailwind/components/inputnumber.md +463 -0
- package/data/llms/tailwind/components/inputotp.md +255 -0
- package/data/llms/tailwind/components/inputpassword.md +543 -0
- package/data/llms/tailwind/components/inputtext.md +141 -0
- package/data/llms/tailwind/components/label.md +100 -0
- package/data/llms/tailwind/components/listbox.md +886 -0
- package/data/llms/tailwind/components/menu.md +1049 -0
- package/data/llms/tailwind/components/message.md +575 -0
- package/data/llms/tailwind/components/metergroup.md +510 -0
- package/data/llms/tailwind/components/navigationmenu.md +528 -0
- package/data/llms/tailwind/components/overlaymanager.md +567 -0
- package/data/llms/tailwind/components/paginator.md +306 -0
- package/data/llms/tailwind/components/panel.md +395 -0
- package/data/llms/tailwind/components/popover.md +424 -0
- package/data/llms/tailwind/components/progressbar.md +313 -0
- package/data/llms/tailwind/components/radiobutton.md +366 -0
- package/data/llms/tailwind/components/rating.md +300 -0
- package/data/llms/tailwind/components/scrollarea.md +638 -0
- package/data/llms/tailwind/components/select.md +1220 -0
- package/data/llms/tailwind/components/sidebar.md +1511 -0
- package/data/llms/tailwind/components/skeleton.md +236 -0
- package/data/llms/tailwind/components/slider.md +291 -0
- package/data/llms/tailwind/components/splitter.md +546 -0
- package/data/llms/tailwind/components/tabs.md +462 -0
- package/data/llms/tailwind/components/tag.md +255 -0
- package/data/llms/tailwind/components/textarea.md +170 -0
- package/data/llms/tailwind/components/timeline.md +656 -0
- package/data/llms/tailwind/components/toast.md +246 -0
- package/data/llms/tailwind/components/togglebutton.md +264 -0
- package/data/llms/tailwind/components/togglebuttongroup.md +262 -0
- package/data/llms/tailwind/components/toggleswitch.md +203 -0
- package/data/llms/tailwind/components/toolbar.md +192 -0
- package/data/llms/tailwind/components/tooltip.md +449 -0
- package/data/llms/tailwind/guides/ai/llms.md +25 -0
- package/data/llms/tailwind/guides/icons/customicons.md +47 -0
- package/data/llms/tailwind/guides/icons/primeicons.md +112 -0
- package/data/llms/tailwind/guides/installation/astro.md +165 -0
- package/data/llms/tailwind/guides/installation/manual.md +3 -0
- package/data/llms/tailwind/guides/installation/nextjs.md +169 -0
- package/data/llms/tailwind/guides/installation/react-router.md +157 -0
- package/data/llms/tailwind/guides/installation/tanstack.md +161 -0
- package/data/llms/tailwind/guides/installation/vite.md +160 -0
- package/data/llms/tailwind/guides/installation.md +42 -0
- package/data/llms/tailwind/guides/introduction.md +20 -0
- package/data/llms/tailwind/guides/misc/accessibility.md +205 -0
- package/data/llms/tailwind/guides/misc/passthrough.md +95 -0
- package/data/llms/tailwind/guides/misc/rtl.md +27 -0
- package/data/llms/tailwind/guides/theming/guide.md +179 -0
- package/data/llms/tailwind/guides/theming.md +191 -0
- package/data/llms/tailwind/llms.md +25 -0
- package/data/llms/tailwind/resources/introduction.md +15 -0
- package/data/manifest.json +12409 -0
- package/data/mcp-data.json +14481 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +2 -0
- package/package.json +61 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# PrimeUI License
|
|
2
|
+
|
|
3
|
+
This package is part of **PrimeUI**, a family of commercial UI libraries by PrimeTek Informatics.
|
|
4
|
+
|
|
5
|
+
## How PrimeUI May Be Used
|
|
6
|
+
|
|
7
|
+
PrimeUI may be used under one of two licenses. You choose the one that applies to you based on eligibility.
|
|
8
|
+
|
|
9
|
+
### Community License (Free)
|
|
10
|
+
|
|
11
|
+
Free for organizations that meet all of the following criteria:
|
|
12
|
+
|
|
13
|
+
- Less than $1,000,000 USD in annual gross revenue
|
|
14
|
+
- Fewer than 5 developers
|
|
15
|
+
- Fewer than 10 employees
|
|
16
|
+
- Less than $3,000,000 USD in venture capital or outside funding
|
|
17
|
+
|
|
18
|
+
Individuals, students, non-profits, and non-commercial open source projects also qualify.
|
|
19
|
+
|
|
20
|
+
The Community License provides full access to the core libraries and supports up to 4 developers. It requires annual renewal by confirming continued eligibility.
|
|
21
|
+
|
|
22
|
+
### Commercial License (Paid)
|
|
23
|
+
|
|
24
|
+
For organizations that do not qualify for the Community License.
|
|
25
|
+
|
|
26
|
+
Licensed per developer, perpetual, with one year of updates included. Renewal is optional and extends access to new versions. The Commercial Suite also includes PrimeBlocks, Theme Designer, all PrimeUI Pro components, and Premium Support.
|
|
27
|
+
|
|
28
|
+
## License Key
|
|
29
|
+
|
|
30
|
+
A valid license key is required to use this software. License verification is performed offline, with no telemetry and no remote connection. A missing, invalid, or expired key may cause the software to display a license notice.
|
|
31
|
+
|
|
32
|
+
## Full Terms
|
|
33
|
+
|
|
34
|
+
The complete license terms, eligibility details, and renewal information are available at:
|
|
35
|
+
|
|
36
|
+
- Community License: https://primeui.dev/licenses/community
|
|
37
|
+
- Commercial License: https://primeui.dev/licenses/commercial
|
|
38
|
+
|
|
39
|
+
## Restrictions
|
|
40
|
+
|
|
41
|
+
This software is distributed as a compiled package. You may not reverse-engineer, decompile, or extract its source code, redistribute it as a component library or development tool, or remove its license mechanisms. Redistributing the software so that third parties can develop with it requires a separate OEM License. See the full terms for details.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
Copyright 2026 PrimeTek Informatics. All rights reserved.
|
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# @primereact/mcp
|
|
2
|
+
|
|
3
|
+
Model Context Protocol server for PrimeReact v11 generated documentation.
|
|
4
|
+
|
|
5
|
+
The package is a thin PrimeReact server over the shared `@primeuix/mcp` v2 core. It exposes the compact v2 tool surface only:
|
|
6
|
+
|
|
7
|
+
- `list`
|
|
8
|
+
- `search`
|
|
9
|
+
- `get_component`
|
|
10
|
+
- `get_guide`
|
|
11
|
+
- `get_example`
|
|
12
|
+
- `get_setup`
|
|
13
|
+
- `validate_usage`
|
|
14
|
+
- `version`
|
|
15
|
+
|
|
16
|
+
PrimeReact mode boundaries are preserved through the generated docs data: `styled`, `tailwind`, `primitive`, `headless`, and `hooks`.
|
|
17
|
+
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
Run the server with:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx -y @primereact/mcp@alpha
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The package bundles generated docs from `apps/showcase/public/llms` into `packages/mcp/data`. Generated Markdown and API resources are read from package-owned `data/llms` first, with the local showcase tree used only as a source-development fallback.
|
|
27
|
+
|
|
28
|
+
Package-manager assumption: `@primereact/mcp` does not vendor the shared core. For the first alpha, its published dependency on `@primeuix/mcp` is exactly `2.0.0-alpha.1`; do not widen this to `^2.0.0` or `^2.0.0-alpha.1` until the alpha package install path has been validated from the public registry.
|
|
29
|
+
|
|
30
|
+
## Claude Code
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
claude mcp add primereact -s user -- npx -y @primereact/mcp@alpha
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Project-local install:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
claude mcp add primereact -- npx -y @primereact/mcp@alpha
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Cursor
|
|
43
|
+
|
|
44
|
+
Create `.cursor/mcp.json` in your project or `~/.cursor/mcp.json` globally:
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"mcpServers": {
|
|
49
|
+
"primereact": {
|
|
50
|
+
"command": "npx",
|
|
51
|
+
"args": ["-y", "@primereact/mcp@alpha"]
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## VS Code
|
|
58
|
+
|
|
59
|
+
Create `.vscode/mcp.json` in your project:
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"servers": {
|
|
64
|
+
"primereact": {
|
|
65
|
+
"command": "npx",
|
|
66
|
+
"args": ["-y", "@primereact/mcp@alpha"]
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
For a user-level setup, place the same `servers` object in your VS Code MCP user configuration.
|
|
73
|
+
|
|
74
|
+
## Codex
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
codex mcp add primereact -- npx -y @primereact/mcp@alpha
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Direct `~/.codex/config.toml` configuration:
|
|
81
|
+
|
|
82
|
+
```toml
|
|
83
|
+
[mcp_servers.primereact]
|
|
84
|
+
command = "npx"
|
|
85
|
+
args = ["-y", "@primereact/mcp@alpha"]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Development
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
corepack pnpm --filter @primereact/mcp test
|
|
92
|
+
corepack pnpm --filter @primereact/mcp build
|
|
93
|
+
corepack pnpm --filter @primereact/mcp type:check
|
|
94
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Add-Ons
|
|
2
|
+
|
|
3
|
+
Premium templates, UI blocks and design tooling that build on top of PrimeReact.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Add-Ons are premium, production-ready resources built on top of PrimeReact. They help you skip the boilerplate and ship faster, from full application templates to ready-made UI blocks and design tooling.
|
|
8
|
+
|
|
9
|
+
## What's included
|
|
10
|
+
|
|
11
|
+
- **Templates**, complete, themeable application starters with layouts, pages and integrations wired up.
|
|
12
|
+
- **Blocks**, copy-and-paste UI sections for application, marketing and e-commerce pages.
|
|
13
|
+
- **Figma UI Kit**, the design source that mirrors the component library, for designing before you build.
|
|
14
|
+
- **Theme Designer**, a visual tool to craft and export your own design tokens and themes.
|
|
15
|
+
|
|
16
|
+
Pick a category from the sidebar to explore each add-on.
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "useAccordion",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/useaccordion.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "The useAccordion manages the state and functionality of a Accordion component.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"UseAccordionChangeEvent": {
|
|
9
|
+
"description": "Event fired when the accordion's value changes.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "originalEvent",
|
|
14
|
+
"type": "E",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "The original event that triggered the change."
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "value",
|
|
20
|
+
"type": "string | number | (string | number)[]",
|
|
21
|
+
"default": "",
|
|
22
|
+
"description": "The value of the accordion."
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"methods": []
|
|
26
|
+
},
|
|
27
|
+
"UseAccordionProps": {
|
|
28
|
+
"description": "Defines valid properties in useAccordion.",
|
|
29
|
+
"relatedProp": "",
|
|
30
|
+
"props": [
|
|
31
|
+
{
|
|
32
|
+
"name": "defaultValue",
|
|
33
|
+
"type": "string | number | (string | number)[]",
|
|
34
|
+
"default": "null",
|
|
35
|
+
"description": "Default value of the active panel or an array of values in multiple mode."
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"name": "value",
|
|
39
|
+
"type": "string | number | (string | number)[]",
|
|
40
|
+
"default": "null",
|
|
41
|
+
"description": "Value of the active panel or an array of values in multiple mode."
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"name": "multiple",
|
|
45
|
+
"type": "boolean",
|
|
46
|
+
"default": "false",
|
|
47
|
+
"description": "When enabled, multiple tabs can be activated at the same time."
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "disabled",
|
|
51
|
+
"type": "boolean",
|
|
52
|
+
"default": "false",
|
|
53
|
+
"description": "When disabled, the component cannot be interacted with."
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "tabIndex",
|
|
57
|
+
"type": "number",
|
|
58
|
+
"default": "0",
|
|
59
|
+
"description": "Index of the element in tabbing order."
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"name": "openOnFocus",
|
|
63
|
+
"type": "boolean",
|
|
64
|
+
"default": "false",
|
|
65
|
+
"description": "When enabled, the accordion panel will be opened on focus."
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "onValueChange",
|
|
69
|
+
"type": "(event: UseAccordionChangeEvent) => void",
|
|
70
|
+
"default": "",
|
|
71
|
+
"description": "Callback fired when the accordion's value changes."
|
|
72
|
+
}
|
|
73
|
+
],
|
|
74
|
+
"methods": []
|
|
75
|
+
},
|
|
76
|
+
"UseAccordionState": {
|
|
77
|
+
"description": "Defines valid state in useAccordion.",
|
|
78
|
+
"relatedProp": "",
|
|
79
|
+
"props": [
|
|
80
|
+
{
|
|
81
|
+
"name": "value",
|
|
82
|
+
"type": "string | number | (string | number)[]",
|
|
83
|
+
"default": "",
|
|
84
|
+
"description": "Value of the active panel or an array of values in multiple mode."
|
|
85
|
+
}
|
|
86
|
+
],
|
|
87
|
+
"methods": []
|
|
88
|
+
},
|
|
89
|
+
"UseAccordionRootProps": {
|
|
90
|
+
"description": "Data attribute props for the Accordion root element.",
|
|
91
|
+
"relatedProp": "",
|
|
92
|
+
"props": [
|
|
93
|
+
{
|
|
94
|
+
"name": "data-scope",
|
|
95
|
+
"type": "string",
|
|
96
|
+
"default": "",
|
|
97
|
+
"description": "Component scope identifier."
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "data-part",
|
|
101
|
+
"type": "string",
|
|
102
|
+
"default": "",
|
|
103
|
+
"description": "Component part identifier."
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "data-disabled",
|
|
107
|
+
"type": "string",
|
|
108
|
+
"default": "",
|
|
109
|
+
"description": "Present when the accordion is disabled."
|
|
110
|
+
}
|
|
111
|
+
],
|
|
112
|
+
"methods": []
|
|
113
|
+
},
|
|
114
|
+
"UseAccordionExposes": {
|
|
115
|
+
"description": "Defines the methods and properties exposed by useAccordion.",
|
|
116
|
+
"relatedProp": "",
|
|
117
|
+
"props": [
|
|
118
|
+
{
|
|
119
|
+
"name": "state",
|
|
120
|
+
"type": "UseAccordionState",
|
|
121
|
+
"default": "",
|
|
122
|
+
"description": "The state of the useAccordion."
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"name": "rootProps",
|
|
126
|
+
"type": "UseAccordionRootProps",
|
|
127
|
+
"default": "",
|
|
128
|
+
"description": "Pre-built data attribute props for the root element.\nIncludes data-disabled."
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "updateValue",
|
|
132
|
+
"type": "(event: SyntheticEvent, key: string | number) => void",
|
|
133
|
+
"default": "",
|
|
134
|
+
"description": "The method to update the value of the active panel."
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"name": "isItemActive",
|
|
138
|
+
"type": "(key: string | number) => boolean",
|
|
139
|
+
"default": "",
|
|
140
|
+
"description": "The method to check if the panel is active."
|
|
141
|
+
}
|
|
142
|
+
],
|
|
143
|
+
"methods": []
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"types": {
|
|
147
|
+
"UseAccordionInstance": {
|
|
148
|
+
"description": "Instance of useAccordion headless.",
|
|
149
|
+
"values": "HeadlessInstance<UseAccordionProps, UseAccordionState, UseAccordionExposes>"
|
|
150
|
+
}
|
|
151
|
+
},
|
|
152
|
+
"variables": {}
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"name": "useAccordionPanel",
|
|
157
|
+
"source": "apps/showcase/assets/apidoc/useaccordionpanel.json",
|
|
158
|
+
"data": {
|
|
159
|
+
"description": "The useAccordionPanel manages the state and functionality of an Accordion panel.",
|
|
160
|
+
"interfaces": {
|
|
161
|
+
"UseAccordionPanelProps": {
|
|
162
|
+
"description": "Defines valid properties in useAccordionPanel.",
|
|
163
|
+
"relatedProp": "",
|
|
164
|
+
"props": [
|
|
165
|
+
{
|
|
166
|
+
"name": "value",
|
|
167
|
+
"type": "string | number",
|
|
168
|
+
"default": "null",
|
|
169
|
+
"description": "Unique value of the panel."
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "disabled",
|
|
173
|
+
"type": "boolean",
|
|
174
|
+
"default": "false",
|
|
175
|
+
"description": "Whether the panel is disabled."
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "context",
|
|
179
|
+
"type": "UseAccordionInstance",
|
|
180
|
+
"default": "",
|
|
181
|
+
"description": "The parent accordion instance providing state and methods."
|
|
182
|
+
}
|
|
183
|
+
],
|
|
184
|
+
"methods": []
|
|
185
|
+
},
|
|
186
|
+
"UseAccordionPanelState": {
|
|
187
|
+
"description": "Defines valid state in useAccordionPanel.",
|
|
188
|
+
"relatedProp": "",
|
|
189
|
+
"props": [
|
|
190
|
+
{
|
|
191
|
+
"name": "open",
|
|
192
|
+
"type": "boolean",
|
|
193
|
+
"default": "",
|
|
194
|
+
"description": "Whether the panel is open (active)."
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "disabled",
|
|
198
|
+
"type": "boolean",
|
|
199
|
+
"default": "",
|
|
200
|
+
"description": "Whether the panel is disabled (combined panel + accordion root)."
|
|
201
|
+
}
|
|
202
|
+
],
|
|
203
|
+
"methods": []
|
|
204
|
+
},
|
|
205
|
+
"UseAccordionPanelExposes": {
|
|
206
|
+
"description": "Defines the methods and properties exposed by useAccordionPanel.",
|
|
207
|
+
"relatedProp": "",
|
|
208
|
+
"props": [
|
|
209
|
+
{
|
|
210
|
+
"name": "panelProps",
|
|
211
|
+
"type": "AccordionPanelRootElementProps",
|
|
212
|
+
"default": "",
|
|
213
|
+
"description": "Pre-built props for the panel root element."
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "headerProps",
|
|
217
|
+
"type": "AccordionPanelHeaderProps",
|
|
218
|
+
"default": "",
|
|
219
|
+
"description": "Pre-built props for the header element."
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"name": "triggerProps",
|
|
223
|
+
"type": "AccordionPanelTriggerProps",
|
|
224
|
+
"default": "",
|
|
225
|
+
"description": "Pre-built props for the trigger element."
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"name": "contentProps",
|
|
229
|
+
"type": "AccordionPanelContentProps",
|
|
230
|
+
"default": "",
|
|
231
|
+
"description": "Pre-built props for the content element."
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"name": "indicatorProps",
|
|
235
|
+
"type": "AccordionPanelIndicatorProps",
|
|
236
|
+
"default": "",
|
|
237
|
+
"description": "Pre-built props for the indicator element."
|
|
238
|
+
}
|
|
239
|
+
],
|
|
240
|
+
"methods": []
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"types": {
|
|
244
|
+
"UseAccordionPanelInstance": {
|
|
245
|
+
"description": "Instance of useAccordionPanel headless.",
|
|
246
|
+
"values": "HeadlessInstance<UseAccordionPanelProps, UseAccordionPanelState, UseAccordionPanelExposes>"
|
|
247
|
+
}
|
|
248
|
+
},
|
|
249
|
+
"variables": {}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
]
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# useAccordion
|
|
2
|
+
|
|
3
|
+
Hooks that manage accordion state, keyboard navigation, and ARIA attributes.
|
|
4
|
+
|
|
5
|
+
```tsx
|
|
6
|
+
'use client';
|
|
7
|
+
import { ChevronDown } from '@primeicons/react/chevron-down';
|
|
8
|
+
import { useAccordion, useAccordionPanel } from '@primereact/headless/accordion';
|
|
9
|
+
|
|
10
|
+
export default function BasicDemo() {
|
|
11
|
+
const accordion = useAccordion({ defaultValue: '1' });
|
|
12
|
+
|
|
13
|
+
const panel1 = useAccordionPanel({ value: '1', context: accordion });
|
|
14
|
+
const panel2 = useAccordionPanel({ value: '2', context: accordion });
|
|
15
|
+
const panel3 = useAccordionPanel({ value: '3', context: accordion });
|
|
16
|
+
|
|
17
|
+
const items = [
|
|
18
|
+
{ panel: panel1, title: 'What is PrimeReact?', content: 'PrimeReact is a rich set of open source UI components for React.' },
|
|
19
|
+
{ panel: panel2, title: 'How to get started?', content: 'Install PrimeReact via npm and import the components you need.' },
|
|
20
|
+
{ panel: panel3, title: 'What about accessibility?', content: 'All components follow WAI-ARIA guidelines with full keyboard support.' }
|
|
21
|
+
];
|
|
22
|
+
|
|
23
|
+
return (
|
|
24
|
+
<div {...accordion.rootProps} className="max-w-md mx-auto">
|
|
25
|
+
{items.map(({ panel, title, content }) => (
|
|
26
|
+
<div key={title} {...panel.panelProps} className="border-b border-surface-200 dark:border-surface-700">
|
|
27
|
+
<div {...panel.headerProps}>
|
|
28
|
+
<button
|
|
29
|
+
{...panel.triggerProps}
|
|
30
|
+
className="flex items-center justify-between w-full py-3 px-4 text-left cursor-pointer text-muted-color hover:text-color transition focus-visible:outline-1 focus-visible:-outline-offset-1 focus-visible:outline-primary"
|
|
31
|
+
>
|
|
32
|
+
<span>{title}</span>
|
|
33
|
+
<span {...panel.indicatorProps} className="transition-transform duration-200 data-[open]:rotate-180">
|
|
34
|
+
<ChevronDown />
|
|
35
|
+
</span>
|
|
36
|
+
</button>
|
|
37
|
+
</div>
|
|
38
|
+
{panel.state.open && (
|
|
39
|
+
<div {...panel.contentProps} className="px-4 pb-3 text-surface-600 dark:text-surface-300 text-sm">
|
|
40
|
+
{content}
|
|
41
|
+
</div>
|
|
42
|
+
)}
|
|
43
|
+
</div>
|
|
44
|
+
))}
|
|
45
|
+
</div>
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Usage
|
|
51
|
+
|
|
52
|
+
```tsx
|
|
53
|
+
import { useAccordion, useAccordionPanel } from '@primereact/headless/accordion';
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
```tsx
|
|
57
|
+
const accordion = useAccordion({ defaultValue: '1' });
|
|
58
|
+
const { rootProps } = accordion;
|
|
59
|
+
|
|
60
|
+
const { panelProps, headerProps, triggerProps, contentProps, indicatorProps, state } = useAccordionPanel({
|
|
61
|
+
value: '1',
|
|
62
|
+
context: accordion
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
<div {...rootProps}>
|
|
66
|
+
<div {...panelProps}>
|
|
67
|
+
<div {...headerProps}>
|
|
68
|
+
<button {...triggerProps}>
|
|
69
|
+
<span {...indicatorProps} />
|
|
70
|
+
</button>
|
|
71
|
+
</div>
|
|
72
|
+
{state.open && <div {...contentProps}></div>}
|
|
73
|
+
</div>
|
|
74
|
+
</div>;
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`useAccordion` manages root state while `useAccordionPanel` consumes that context to return prop objects for each panel element, see [Primitive](/docs/primitive/components/accordion) for a component-based API.
|
|
78
|
+
|
|
79
|
+
## Features
|
|
80
|
+
|
|
81
|
+
- **Two-hook architecture**, `useAccordion` owns root state and keyboard focus cycling; `useAccordionPanel` consumes its context to render individual panels
|
|
82
|
+
- **Single or multiple expansion**, one open panel at a time or an array of open keys, switchable via the `multiple` flag
|
|
83
|
+
- **Controlled or uncontrolled**, drive the active key(s) from outside or let the hook manage its own state
|
|
84
|
+
- **Focus-triggered expansion**, opt into `openOnFocus` to open a panel the moment its trigger is focused via keyboard
|
|
85
|
+
- **Imperative controls**, `updateValue()` toggles a key and `isItemActive()` checks open state from custom code paths
|
|
86
|
+
- **Full render control**, `state.open` lets you conditionally mount content, pair with CSS, or wire up animation hooks
|
|
87
|
+
|
|
88
|
+
## Working with callbacks
|
|
89
|
+
|
|
90
|
+
### Controlled active panel
|
|
91
|
+
|
|
92
|
+
Drive the open panel from outside state by pairing `value` with `onValueChange`.
|
|
93
|
+
|
|
94
|
+
```tsx
|
|
95
|
+
const [value, setValue] = React.useState<string | null>('1');
|
|
96
|
+
|
|
97
|
+
const accordion = useAccordion({
|
|
98
|
+
value,
|
|
99
|
+
onValueChange: (e) => setValue(e.value)
|
|
100
|
+
});
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
`onValueChange` receives `{ originalEvent, value }`, `value` is a single key in single mode or the new array in multiple mode.
|
|
104
|
+
|
|
105
|
+
### Multiple open panels
|
|
106
|
+
|
|
107
|
+
Set `multiple` to keep several panels open at once. Both `value` and `defaultValue` become arrays.
|
|
108
|
+
|
|
109
|
+
```tsx
|
|
110
|
+
const accordion = useAccordion({
|
|
111
|
+
multiple: true,
|
|
112
|
+
defaultValue: ['1', '2'],
|
|
113
|
+
onValueChange: (e) => console.log(e.value) // string[]
|
|
114
|
+
});
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Imperative toggling from custom UI
|
|
118
|
+
|
|
119
|
+
Use `updateValue` to toggle panels from buttons that live outside the accordion tree, such as a sidebar or toolbar.
|
|
120
|
+
|
|
121
|
+
```tsx
|
|
122
|
+
const accordion = useAccordion({ multiple: true });
|
|
123
|
+
|
|
124
|
+
<button onClick={(e) => accordion.updateValue(e, '3')}>Toggle section 3</button>;
|
|
125
|
+
|
|
126
|
+
if (accordion.isItemActive('2')) {
|
|
127
|
+
// run logic only when panel 2 is open
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
In single mode `updateValue` toggles between the key and `null`; in multiple mode it adds or removes the key from the array.
|
|
132
|
+
|
|
133
|
+
### Animated enter/leave with `state.open`
|
|
134
|
+
|
|
135
|
+
Because the hook leaves content rendering to you, pair `state.open` with a motion primitive to animate transitions.
|
|
136
|
+
|
|
137
|
+
```tsx
|
|
138
|
+
const { contentProps, state } = useAccordionPanel({ value: '1', context: accordion });
|
|
139
|
+
|
|
140
|
+
<AnimatePresence>
|
|
141
|
+
{state.open && (
|
|
142
|
+
<motion.div {...contentProps} initial={{ height: 0 }} animate={{ height: 'auto' }} exit={{ height: 0 }}>
|
|
143
|
+
Panel content
|
|
144
|
+
</motion.div>
|
|
145
|
+
)}
|
|
146
|
+
</AnimatePresence>;
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
For a built-in approach, use the [useMotion](/docs/headless/components/motion) hook alongside `state.open`.
|
|
150
|
+
|
|
151
|
+
## Styling with data attributes
|
|
152
|
+
|
|
153
|
+
Every prop object includes `data-scope="accordion"` and a `data-part` attribute. State-dependent attributes are applied automatically so styling can stay in CSS.
|
|
154
|
+
|
|
155
|
+
| Scope | Part | States |
|
|
156
|
+
| ----------- | --------- | ------------------------------------------- |
|
|
157
|
+
| `accordion` | `panel` | `data-open`, `data-closed`, `data-disabled` |
|
|
158
|
+
| `accordion` | `trigger` | `data-content-open`, `data-content-closed` |
|
|
159
|
+
| `accordion` | `content` | `data-open`, `data-closed` |
|
|
160
|
+
|
|
161
|
+
```css
|
|
162
|
+
[data-scope='accordion'][data-part='trigger'] {
|
|
163
|
+
font-weight: 600;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
[data-scope='accordion'][data-part='content'][data-open] {
|
|
167
|
+
animation: slideDown 200ms ease-out;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
[data-scope='accordion'][data-part='content'][data-closed] {
|
|
171
|
+
animation: slideUp 200ms ease-out;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
[data-scope='accordion'][data-part='panel'][data-disabled] {
|
|
175
|
+
opacity: 0.5;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
[data-scope='accordion'][data-part='trigger'][data-content-open] {
|
|
179
|
+
color: blue;
|
|
180
|
+
font-weight: 700;
|
|
181
|
+
}
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## API
|
|
185
|
+
|
|
186
|
+
### useAccordion
|
|
187
|
+
|
|
188
|
+
<DocTable name="useAccordion" category="api" />
|
|
189
|
+
|
|
190
|
+
### useAccordionPanel
|
|
191
|
+
|
|
192
|
+
<DocTable name="useAccordionPanel" category="api" />
|
|
193
|
+
|
|
194
|
+
## Accessibility
|
|
195
|
+
|
|
196
|
+
Arrow keys move between headers, Home/End jump to first/last, and Enter or Space toggles the focused panel. See [Primitive](/docs/primitive/components/accordion#accessibility) for full WAI-ARIA compliance details.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "useAnimateOnScroll",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/useanimateonscroll.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "The useAnimateOnScroll manages the state and functionality of an AnimateOnScroll component.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"UseAnimateOnScrollProps": {
|
|
9
|
+
"description": "Defines valid properties in useAnimateOnScroll.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"extendedTypes": "Pick<IntersectionObserverInit, \"root\" | \"rootMargin\" | \"threshold\">",
|
|
12
|
+
"props": [
|
|
13
|
+
{
|
|
14
|
+
"name": "enterClassName",
|
|
15
|
+
"type": "string",
|
|
16
|
+
"default": "",
|
|
17
|
+
"description": "CSS class names that are applied when the element enters the viewport."
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"name": "leaveClassName",
|
|
21
|
+
"type": "string",
|
|
22
|
+
"default": "",
|
|
23
|
+
"description": "CSS class names that are applied when the element leaves the viewport."
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"name": "once",
|
|
27
|
+
"type": "boolean",
|
|
28
|
+
"default": "false",
|
|
29
|
+
"description": "When enabled, animation is triggered only once."
|
|
30
|
+
}
|
|
31
|
+
],
|
|
32
|
+
"methods": []
|
|
33
|
+
},
|
|
34
|
+
"UseAnimateOnScrollState": {
|
|
35
|
+
"description": "Defines valid state in useAnimateOnScroll.",
|
|
36
|
+
"relatedProp": "",
|
|
37
|
+
"props": [],
|
|
38
|
+
"methods": []
|
|
39
|
+
},
|
|
40
|
+
"UseAnimateOnScrollRootProps": {
|
|
41
|
+
"description": "Pre-built props for the root element.",
|
|
42
|
+
"relatedProp": "",
|
|
43
|
+
"props": [
|
|
44
|
+
{
|
|
45
|
+
"name": "data-scope",
|
|
46
|
+
"type": "string",
|
|
47
|
+
"default": "",
|
|
48
|
+
"description": "Component scope identifier."
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "data-part",
|
|
52
|
+
"type": "string",
|
|
53
|
+
"default": "",
|
|
54
|
+
"description": "Component part identifier."
|
|
55
|
+
}
|
|
56
|
+
],
|
|
57
|
+
"methods": []
|
|
58
|
+
},
|
|
59
|
+
"UseAnimateOnScrollExposes": {
|
|
60
|
+
"description": "Defines the methods and properties exposed by useAnimateOnScroll.",
|
|
61
|
+
"relatedProp": "",
|
|
62
|
+
"props": [
|
|
63
|
+
{
|
|
64
|
+
"name": "state",
|
|
65
|
+
"type": "UseAnimateOnScrollState",
|
|
66
|
+
"default": "",
|
|
67
|
+
"description": "State of the animate on scroll."
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "rootProps",
|
|
71
|
+
"type": "UseAnimateOnScrollRootProps",
|
|
72
|
+
"default": "",
|
|
73
|
+
"description": "Pre-built props for the root element."
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"methods": []
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"types": {
|
|
80
|
+
"UseAnimateOnScrollInstance": {
|
|
81
|
+
"description": "Instance of useAnimateOnScroll headless.",
|
|
82
|
+
"values": "HeadlessInstance<UseAnimateOnScrollProps, UseAnimateOnScrollState, UseAnimateOnScrollExposes>"
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"variables": {}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
]
|