@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
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
# With Astro
|
|
2
|
+
|
|
3
|
+
Setting up PrimeReact Tailwind components in an Astro project.
|
|
4
|
+
|
|
5
|
+
<DocMessage>
|
|
6
|
+
Start from our <a href="https://github.com/primefaces/primereact-examples/tree/main/astro-tailwind-quickstart" target="_blank" rel="noopener noreferrer">Astro + Tailwind template</a>, pre-configured with PrimeReact.
|
|
7
|
+
</DocMessage>
|
|
8
|
+
|
|
9
|
+
## Install via CLI
|
|
10
|
+
|
|
11
|
+
PrimeReact's Tailwind components ship as a shadcn-compatible registry, so the shadcn CLI can scaffold everything for you. You need a project with Tailwind CSS v4 already set up.
|
|
12
|
+
|
|
13
|
+
<DocStepper>
|
|
14
|
+
<DocStep>
|
|
15
|
+
|
|
16
|
+
### Initialize
|
|
17
|
+
|
|
18
|
+
Run `init` with the PrimeReact theme. This creates `components.json`, installs the base packages, adds the `cn` helper, and writes the design tokens (`--p-primary-*`, `--p-surface-*`) and the `tailwindcss-primeui` plugin to your global stylesheet:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx shadcn@latest init -t astro https://primereact.dev/r/theme.json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
</DocStep>
|
|
25
|
+
<DocStep>
|
|
26
|
+
|
|
27
|
+
### Wrap with PrimeReactProvider
|
|
28
|
+
|
|
29
|
+
Wrap your components with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available — see the [PrimeReactProvider](#primereactprovider) snippet below (in Astro, render it as a React island).
|
|
30
|
+
|
|
31
|
+
</DocStep>
|
|
32
|
+
<DocStep>
|
|
33
|
+
|
|
34
|
+
### Add Components
|
|
35
|
+
|
|
36
|
+
Add any component by its registry URL:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then pick your colors — see [Theming](/docs/tailwind/guides/theming).
|
|
43
|
+
|
|
44
|
+
</DocStep>
|
|
45
|
+
|
|
46
|
+
</DocStepper>
|
|
47
|
+
|
|
48
|
+
## Manual installation
|
|
49
|
+
|
|
50
|
+
PrimeReact Tailwind components are distributed through a shadcn-compatible registry, each component is copied into your codebase, so there is no theme file or runtime theme provider to set up. In Astro, render the components as React islands.
|
|
51
|
+
|
|
52
|
+
<DocStepper>
|
|
53
|
+
<DocStep>
|
|
54
|
+
|
|
55
|
+
### Install Packages
|
|
56
|
+
|
|
57
|
+
Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
</DocStep>
|
|
64
|
+
<DocStep>
|
|
65
|
+
|
|
66
|
+
### Add the `cn` Helper
|
|
67
|
+
|
|
68
|
+
The components rely on a `cn` utility to merge class names. Create `lib/utils.ts` and add the helper:
|
|
69
|
+
|
|
70
|
+
```ts showLineNumbers title="lib/utils.ts"
|
|
71
|
+
import { cn as _cn } from '@primeuix/utils';
|
|
72
|
+
import { twMerge } from 'tailwind-merge';
|
|
73
|
+
|
|
74
|
+
export function cn(...inputs: unknown[]) {
|
|
75
|
+
return twMerge(_cn(...inputs));
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</DocStep>
|
|
80
|
+
<DocStep>
|
|
81
|
+
|
|
82
|
+
### Set up Global Styles
|
|
83
|
+
|
|
84
|
+
Import Tailwind and the `tailwindcss-primeui` plugin in your global stylesheet, and register the `dark` variant so utilities and components respond to a `.dark` class:
|
|
85
|
+
|
|
86
|
+
```css showLineNumbers title="src/styles/global.css" {4}
|
|
87
|
+
@import 'tailwindcss';
|
|
88
|
+
@import 'tailwindcss-primeui';
|
|
89
|
+
|
|
90
|
+
@custom-variant dark (&:where(.dark, .dark *));
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The PrimeReact design tokens (`--p-primary-*`, `--p-surface-*`, …) live under `:root` and `.dark`. Add them by running `npx shadcn@latest add https://primereact.dev/r/theme.json`, or copy them from the [Theming](/docs/tailwind/guides/theming) guide.
|
|
94
|
+
|
|
95
|
+
</DocStep>
|
|
96
|
+
<DocStep>
|
|
97
|
+
|
|
98
|
+
### PrimeReactProvider
|
|
99
|
+
|
|
100
|
+
Wrap your components with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available. Set `darkModeSelector` to the same `.dark` class used above:
|
|
101
|
+
|
|
102
|
+
```tsx showLineNumbers title="src/components/Providers.tsx" {7,10}
|
|
103
|
+
import { PrimeReactProvider } from '@primereact/core';
|
|
104
|
+
import type { ReactNode } from 'react';
|
|
105
|
+
|
|
106
|
+
const primereact = {
|
|
107
|
+
theme: {
|
|
108
|
+
options: {
|
|
109
|
+
darkModeSelector: '.dark'
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
license: 'PrimeUI-Commercial-Key...'
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
export default function Providers({ children }: { children: ReactNode }) {
|
|
116
|
+
return <PrimeReactProvider {...primereact}>{children}</PrimeReactProvider>;
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Render it as an island in your `.astro` page with a `client:*` directive so it hydrates on the client:
|
|
121
|
+
|
|
122
|
+
```astro showLineNumbers title="src/pages/index.astro"
|
|
123
|
+
---
|
|
124
|
+
import Providers from '../components/Providers';
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
<Providers client:load>
|
|
128
|
+
<!-- render PrimeReact components here -->
|
|
129
|
+
</Providers>
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
</DocStep>
|
|
133
|
+
<DocStep>
|
|
134
|
+
|
|
135
|
+
### Add Components
|
|
136
|
+
|
|
137
|
+
You can add a component with the shadcn CLI, or add it manually. For example, to add the Button component with the CLI:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
To add it manually instead, head to the [Button](/docs/tailwind/components/button) component page and follow the install steps there.
|
|
144
|
+
|
|
145
|
+
Once added, import the component into a React island and render it with a `client:*` directive to verify your setup:
|
|
146
|
+
|
|
147
|
+
```tsx showLineNumbers {1}
|
|
148
|
+
import { Button } from '@/components/ui/button';
|
|
149
|
+
|
|
150
|
+
export default function VerifyInstallation() {
|
|
151
|
+
return (
|
|
152
|
+
<div className="card flex justify-center">
|
|
153
|
+
<Button>Verify</Button>
|
|
154
|
+
</div>
|
|
155
|
+
);
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
</DocStep>
|
|
160
|
+
|
|
161
|
+
</DocStepper>
|
|
162
|
+
|
|
163
|
+
## Next Steps
|
|
164
|
+
|
|
165
|
+
[Theme your components](/docs/tailwind/guides/theming) with CSS variables, then [browse the components](/docs/tailwind/components/button) to add and customize the ones you need.
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# With Next.js
|
|
2
|
+
|
|
3
|
+
Setting up PrimeReact Tailwind components in a Next.js project.
|
|
4
|
+
|
|
5
|
+
<DocMessage>
|
|
6
|
+
Start from our <a href="https://github.com/primefaces/primereact-examples/tree/main/nextjs-tailwind-quickstart" target="_blank" rel="noopener noreferrer">Next.js + Tailwind template</a>, pre-configured with PrimeReact.
|
|
7
|
+
</DocMessage>
|
|
8
|
+
|
|
9
|
+
## Install via CLI
|
|
10
|
+
|
|
11
|
+
PrimeReact's Tailwind components ship as a shadcn-compatible registry, so the shadcn CLI can scaffold everything for you. You need a project with Tailwind CSS v4 already set up.
|
|
12
|
+
|
|
13
|
+
<DocStepper>
|
|
14
|
+
<DocStep>
|
|
15
|
+
|
|
16
|
+
### Initialize
|
|
17
|
+
|
|
18
|
+
Run `init` with the PrimeReact theme. This creates `components.json`, installs the base packages, adds the `cn` helper, and writes the design tokens (`--p-primary-*`, `--p-surface-*`) and the `tailwindcss-primeui` plugin to your global stylesheet:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx shadcn@latest init -t next https://primereact.dev/r/theme.json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
</DocStep>
|
|
25
|
+
<DocStep>
|
|
26
|
+
|
|
27
|
+
### Wrap with PrimeReactProvider
|
|
28
|
+
|
|
29
|
+
Wrap your app with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere — see the [PrimeReactProvider](#primereactprovider) snippet below.
|
|
30
|
+
|
|
31
|
+
</DocStep>
|
|
32
|
+
<DocStep>
|
|
33
|
+
|
|
34
|
+
### Add Components
|
|
35
|
+
|
|
36
|
+
Add any component by its registry URL:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then pick your colors — see [Theming](/docs/tailwind/guides/theming).
|
|
43
|
+
|
|
44
|
+
</DocStep>
|
|
45
|
+
|
|
46
|
+
</DocStepper>
|
|
47
|
+
|
|
48
|
+
## Manual installation
|
|
49
|
+
|
|
50
|
+
PrimeReact Tailwind components are distributed through a shadcn-compatible registry, each component is copied into your codebase and themed with CSS variables.
|
|
51
|
+
|
|
52
|
+
<DocStepper>
|
|
53
|
+
<DocStep>
|
|
54
|
+
|
|
55
|
+
### Install Packages
|
|
56
|
+
|
|
57
|
+
Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
</DocStep>
|
|
64
|
+
<DocStep>
|
|
65
|
+
|
|
66
|
+
### Add the `cn` Helper
|
|
67
|
+
|
|
68
|
+
The components rely on a `cn` utility to merge class names. Create `lib/utils.ts` and add the helper:
|
|
69
|
+
|
|
70
|
+
```ts showLineNumbers title="lib/utils.ts"
|
|
71
|
+
import { cn as _cn } from '@primeuix/utils';
|
|
72
|
+
import { twMerge } from 'tailwind-merge';
|
|
73
|
+
|
|
74
|
+
export function cn(...inputs: unknown[]) {
|
|
75
|
+
return twMerge(_cn(...inputs));
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</DocStep>
|
|
80
|
+
<DocStep>
|
|
81
|
+
|
|
82
|
+
### Set up Global Styles
|
|
83
|
+
|
|
84
|
+
Import Tailwind and the `tailwindcss-primeui` plugin in your global stylesheet, and register the `dark` variant so utilities and components respond to a `.dark` class:
|
|
85
|
+
|
|
86
|
+
```css showLineNumbers title="app/globals.css" {4}
|
|
87
|
+
@import 'tailwindcss';
|
|
88
|
+
@import 'tailwindcss-primeui';
|
|
89
|
+
|
|
90
|
+
@custom-variant dark (&:where(.dark, .dark *));
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The PrimeReact design tokens (`--p-primary-*`, `--p-surface-*`, …) live under `:root` and `.dark`. Add them by running `npx shadcn@latest add https://primereact.dev/r/theme.json`, or copy them from the [Theming](/docs/tailwind/guides/theming) guide.
|
|
94
|
+
|
|
95
|
+
</DocStep>
|
|
96
|
+
<DocStep>
|
|
97
|
+
|
|
98
|
+
### PrimeReactProvider
|
|
99
|
+
|
|
100
|
+
Even in Tailwind mode, wrap your app with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere. Set `darkModeSelector` to the same `.dark` class used above:
|
|
101
|
+
|
|
102
|
+
```tsx showLineNumbers title="components/prime-provider.tsx" {7,10}
|
|
103
|
+
'use client';
|
|
104
|
+
import { PrimeReactProvider } from '@primereact/core';
|
|
105
|
+
|
|
106
|
+
const primereact = {
|
|
107
|
+
theme: {
|
|
108
|
+
options: {
|
|
109
|
+
darkModeSelector: '.dark'
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
license: 'PrimeUI-Commercial-Key...'
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
export function PrimeProvider({ children }: { children: React.ReactNode }) {
|
|
116
|
+
return <PrimeReactProvider {...primereact}>{children}</PrimeReactProvider>;
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Then wrap your app with it in `app/layout.tsx`:
|
|
121
|
+
|
|
122
|
+
```tsx showLineNumbers title="app/layout.tsx" {1,6}
|
|
123
|
+
import { PrimeProvider } from '@/components/prime-provider';
|
|
124
|
+
|
|
125
|
+
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
126
|
+
return (
|
|
127
|
+
<html lang="en">
|
|
128
|
+
<body>
|
|
129
|
+
<PrimeProvider>{children}</PrimeProvider>
|
|
130
|
+
</body>
|
|
131
|
+
</html>
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
</DocStep>
|
|
137
|
+
<DocStep>
|
|
138
|
+
|
|
139
|
+
### Add Components
|
|
140
|
+
|
|
141
|
+
You can add a component with the shadcn CLI, or add it manually. For example, to add the Button component with the CLI:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
To add it manually instead, head to the [Button](/docs/tailwind/components/button) component page and follow the install steps there.
|
|
148
|
+
|
|
149
|
+
Once added, import the component and render it to verify your setup:
|
|
150
|
+
|
|
151
|
+
```tsx showLineNumbers {1}
|
|
152
|
+
import { Button } from '@/components/ui/button';
|
|
153
|
+
|
|
154
|
+
export default function VerifyInstallation() {
|
|
155
|
+
return (
|
|
156
|
+
<div className="card flex justify-center">
|
|
157
|
+
<Button>Verify</Button>
|
|
158
|
+
</div>
|
|
159
|
+
);
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
</DocStep>
|
|
164
|
+
|
|
165
|
+
</DocStepper>
|
|
166
|
+
|
|
167
|
+
## Next Steps
|
|
168
|
+
|
|
169
|
+
[Theme your components](/docs/tailwind/guides/theming) with CSS variables, then [browse the components](/docs/tailwind/components/button) to add and customize the ones you need.
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# With React Router
|
|
2
|
+
|
|
3
|
+
Setting up PrimeReact Tailwind components in a React Router project.
|
|
4
|
+
|
|
5
|
+
<DocMessage>
|
|
6
|
+
Start from our <a href="https://github.com/primefaces/primereact-examples/tree/main/react-router-tailwind-quickstart" target="_blank" rel="noopener noreferrer">React Router + Tailwind template</a>, pre-configured with PrimeReact.
|
|
7
|
+
</DocMessage>
|
|
8
|
+
|
|
9
|
+
## Install via CLI
|
|
10
|
+
|
|
11
|
+
PrimeReact's Tailwind components ship as a shadcn-compatible registry, so the shadcn CLI can scaffold everything for you. You need a project with Tailwind CSS v4 already set up.
|
|
12
|
+
|
|
13
|
+
<DocStepper>
|
|
14
|
+
<DocStep>
|
|
15
|
+
|
|
16
|
+
### Initialize
|
|
17
|
+
|
|
18
|
+
Run `init` with the PrimeReact theme. This creates `components.json`, installs the base packages, adds the `cn` helper, and writes the design tokens (`--p-primary-*`, `--p-surface-*`) and the `tailwindcss-primeui` plugin to your global stylesheet:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx shadcn@latest init -t react-router https://primereact.dev/r/theme.json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
</DocStep>
|
|
25
|
+
<DocStep>
|
|
26
|
+
|
|
27
|
+
### Wrap with PrimeReactProvider
|
|
28
|
+
|
|
29
|
+
Wrap your app with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere — see the [PrimeReactProvider](#primereactprovider) snippet below.
|
|
30
|
+
|
|
31
|
+
</DocStep>
|
|
32
|
+
<DocStep>
|
|
33
|
+
|
|
34
|
+
### Add Components
|
|
35
|
+
|
|
36
|
+
Add any component by its registry URL:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then pick your colors — see [Theming](/docs/tailwind/guides/theming).
|
|
43
|
+
|
|
44
|
+
</DocStep>
|
|
45
|
+
|
|
46
|
+
</DocStepper>
|
|
47
|
+
|
|
48
|
+
## Manual installation
|
|
49
|
+
|
|
50
|
+
PrimeReact Tailwind components are distributed through a shadcn-compatible registry, each component is copied into your codebase, so there is no theme file or runtime theme provider to set up.
|
|
51
|
+
|
|
52
|
+
<DocStepper>
|
|
53
|
+
<DocStep>
|
|
54
|
+
|
|
55
|
+
### Install Packages
|
|
56
|
+
|
|
57
|
+
Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
</DocStep>
|
|
64
|
+
<DocStep>
|
|
65
|
+
|
|
66
|
+
### Add the `cn` Helper
|
|
67
|
+
|
|
68
|
+
The components rely on a `cn` utility to merge class names. Create `lib/utils.ts` and add the helper:
|
|
69
|
+
|
|
70
|
+
```ts showLineNumbers title="lib/utils.ts"
|
|
71
|
+
import { cn as _cn } from '@primeuix/utils';
|
|
72
|
+
import { twMerge } from 'tailwind-merge';
|
|
73
|
+
|
|
74
|
+
export function cn(...inputs: unknown[]) {
|
|
75
|
+
return twMerge(_cn(...inputs));
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</DocStep>
|
|
80
|
+
<DocStep>
|
|
81
|
+
|
|
82
|
+
### Set up Global Styles
|
|
83
|
+
|
|
84
|
+
Import Tailwind and the `tailwindcss-primeui` plugin in your global stylesheet, and register the `dark` variant so utilities and components respond to a `.dark` class:
|
|
85
|
+
|
|
86
|
+
```css showLineNumbers title="app/app.css" {4}
|
|
87
|
+
@import 'tailwindcss';
|
|
88
|
+
@import 'tailwindcss-primeui';
|
|
89
|
+
|
|
90
|
+
@custom-variant dark (&:where(.dark, .dark *));
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The PrimeReact design tokens (`--p-primary-*`, `--p-surface-*`, …) live under `:root` and `.dark`. Add them by running `npx shadcn@latest add https://primereact.dev/r/theme.json`, or copy them from the [Theming](/docs/tailwind/guides/theming) guide.
|
|
94
|
+
|
|
95
|
+
</DocStep>
|
|
96
|
+
<DocStep>
|
|
97
|
+
|
|
98
|
+
### PrimeReactProvider
|
|
99
|
+
|
|
100
|
+
Wrap your app with `PrimeReactProvider` in `app/root.tsx` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere. Set `darkModeSelector` to the same `.dark` class used above:
|
|
101
|
+
|
|
102
|
+
```tsx showLineNumbers title="app/root.tsx" {7,10}
|
|
103
|
+
import { Outlet } from 'react-router';
|
|
104
|
+
import { PrimeReactProvider } from '@primereact/core';
|
|
105
|
+
|
|
106
|
+
const primereact = {
|
|
107
|
+
theme: {
|
|
108
|
+
options: {
|
|
109
|
+
darkModeSelector: '.dark'
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
license: 'PrimeUI-Commercial-Key...'
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
export default function App() {
|
|
116
|
+
return (
|
|
117
|
+
<PrimeReactProvider {...primereact}>
|
|
118
|
+
<Outlet />
|
|
119
|
+
</PrimeReactProvider>
|
|
120
|
+
);
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
</DocStep>
|
|
125
|
+
<DocStep>
|
|
126
|
+
|
|
127
|
+
### Add Components
|
|
128
|
+
|
|
129
|
+
You can add a component with the shadcn CLI, or add it manually. For example, to add the Button component with the CLI:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
To add it manually instead, head to the [Button](/docs/tailwind/components/button) component page and follow the install steps there.
|
|
136
|
+
|
|
137
|
+
Once added, import the component and render it to verify your setup:
|
|
138
|
+
|
|
139
|
+
```tsx showLineNumbers {1}
|
|
140
|
+
import { Button } from '@/components/ui/button';
|
|
141
|
+
|
|
142
|
+
export default function VerifyInstallation() {
|
|
143
|
+
return (
|
|
144
|
+
<div className="card flex justify-center">
|
|
145
|
+
<Button>Verify</Button>
|
|
146
|
+
</div>
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
</DocStep>
|
|
152
|
+
|
|
153
|
+
</DocStepper>
|
|
154
|
+
|
|
155
|
+
## Next Steps
|
|
156
|
+
|
|
157
|
+
[Theme your components](/docs/tailwind/guides/theming) with CSS variables, then [browse the components](/docs/tailwind/components/button) to add and customize the ones you need.
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# With TanStack
|
|
2
|
+
|
|
3
|
+
Setting up PrimeReact Tailwind components in a TanStack Start project.
|
|
4
|
+
|
|
5
|
+
<DocMessage>
|
|
6
|
+
Start from our <a href="https://github.com/primefaces/primereact-examples/tree/main/tanstack-tailwind-quickstart" target="_blank" rel="noopener noreferrer">TanStack + Tailwind template</a>, pre-configured with PrimeReact.
|
|
7
|
+
</DocMessage>
|
|
8
|
+
|
|
9
|
+
## Install via CLI
|
|
10
|
+
|
|
11
|
+
PrimeReact's Tailwind components ship as a shadcn-compatible registry, so the shadcn CLI can scaffold everything for you. You need a project with Tailwind CSS v4 already set up.
|
|
12
|
+
|
|
13
|
+
<DocStepper>
|
|
14
|
+
<DocStep>
|
|
15
|
+
|
|
16
|
+
### Initialize
|
|
17
|
+
|
|
18
|
+
Run `init` with the PrimeReact theme. This creates `components.json`, installs the base packages, adds the `cn` helper, and writes the design tokens (`--p-primary-*`, `--p-surface-*`) and the `tailwindcss-primeui` plugin to your global stylesheet:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx shadcn@latest init -t start https://primereact.dev/r/theme.json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
</DocStep>
|
|
25
|
+
<DocStep>
|
|
26
|
+
|
|
27
|
+
### Wrap with PrimeReactProvider
|
|
28
|
+
|
|
29
|
+
Wrap your app with `PrimeReactProvider` so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere — see the [PrimeReactProvider](#primereactprovider) snippet below.
|
|
30
|
+
|
|
31
|
+
</DocStep>
|
|
32
|
+
<DocStep>
|
|
33
|
+
|
|
34
|
+
### Add Components
|
|
35
|
+
|
|
36
|
+
Add any component by its registry URL:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then pick your colors — see [Theming](/docs/tailwind/guides/theming).
|
|
43
|
+
|
|
44
|
+
</DocStep>
|
|
45
|
+
|
|
46
|
+
</DocStepper>
|
|
47
|
+
|
|
48
|
+
## Manual installation
|
|
49
|
+
|
|
50
|
+
PrimeReact Tailwind components are distributed through a shadcn-compatible registry, each component is copied into your codebase, so there is no theme file or runtime theme provider to set up.
|
|
51
|
+
|
|
52
|
+
<DocStepper>
|
|
53
|
+
<DocStep>
|
|
54
|
+
|
|
55
|
+
### Install Packages
|
|
56
|
+
|
|
57
|
+
Install PrimeReact along with the icon package and the Tailwind utilities the components rely on:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm install primereact@11.0.0-rc.2 @primeicons/react@8.0.0-rc.1 tailwindcss-primeui tailwind-merge
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
</DocStep>
|
|
64
|
+
<DocStep>
|
|
65
|
+
|
|
66
|
+
### Add the `cn` Helper
|
|
67
|
+
|
|
68
|
+
The components rely on a `cn` utility to merge class names. Create `lib/utils.ts` and add the helper:
|
|
69
|
+
|
|
70
|
+
```ts showLineNumbers title="lib/utils.ts"
|
|
71
|
+
import { cn as _cn } from '@primeuix/utils';
|
|
72
|
+
import { twMerge } from 'tailwind-merge';
|
|
73
|
+
|
|
74
|
+
export function cn(...inputs: unknown[]) {
|
|
75
|
+
return twMerge(_cn(...inputs));
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</DocStep>
|
|
80
|
+
<DocStep>
|
|
81
|
+
|
|
82
|
+
### Set up Global Styles
|
|
83
|
+
|
|
84
|
+
Import Tailwind and the `tailwindcss-primeui` plugin in your global stylesheet, and register the `dark` variant so utilities and components respond to a `.dark` class:
|
|
85
|
+
|
|
86
|
+
```css showLineNumbers title="src/styles.css" {4}
|
|
87
|
+
@import 'tailwindcss';
|
|
88
|
+
@import 'tailwindcss-primeui';
|
|
89
|
+
|
|
90
|
+
@custom-variant dark (&:where(.dark, .dark *));
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The PrimeReact design tokens (`--p-primary-*`, `--p-surface-*`, …) live under `:root` and `.dark`. Add them by running `npx shadcn@latest add https://primereact.dev/r/theme.json`, or copy them from the [Theming](/docs/tailwind/guides/theming) guide.
|
|
94
|
+
|
|
95
|
+
</DocStep>
|
|
96
|
+
<DocStep>
|
|
97
|
+
|
|
98
|
+
### PrimeReactProvider
|
|
99
|
+
|
|
100
|
+
Wrap your app with `PrimeReactProvider` in your root route (`src/routes/__root.tsx`) so component behavior and your [PrimeUI](https://primeui.dev/pricing) license are available everywhere. Set `darkModeSelector` to the same `.dark` class used above:
|
|
101
|
+
|
|
102
|
+
```tsx showLineNumbers title="src/routes/__root.tsx" {7,10}
|
|
103
|
+
import { Outlet, createRootRoute } from '@tanstack/react-router';
|
|
104
|
+
import { PrimeReactProvider } from '@primereact/core';
|
|
105
|
+
|
|
106
|
+
const primereact = {
|
|
107
|
+
theme: {
|
|
108
|
+
options: {
|
|
109
|
+
darkModeSelector: '.dark'
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
license: 'PrimeUI-Commercial-Key...'
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
export const Route = createRootRoute({
|
|
116
|
+
component: RootComponent
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
function RootComponent() {
|
|
120
|
+
return (
|
|
121
|
+
<PrimeReactProvider {...primereact}>
|
|
122
|
+
<Outlet />
|
|
123
|
+
</PrimeReactProvider>
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
</DocStep>
|
|
129
|
+
<DocStep>
|
|
130
|
+
|
|
131
|
+
### Add Components
|
|
132
|
+
|
|
133
|
+
You can add a component with the shadcn CLI, or add it manually. For example, to add the Button component with the CLI:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
npx shadcn@latest add https://primereact.dev/r/button.json
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
To add it manually instead, head to the [Button](/docs/tailwind/components/button) component page and follow the install steps there.
|
|
140
|
+
|
|
141
|
+
Once added, import the component and render it to verify your setup:
|
|
142
|
+
|
|
143
|
+
```tsx showLineNumbers {1}
|
|
144
|
+
import { Button } from '@/components/ui/button';
|
|
145
|
+
|
|
146
|
+
export default function VerifyInstallation() {
|
|
147
|
+
return (
|
|
148
|
+
<div className="card flex justify-center">
|
|
149
|
+
<Button>Verify</Button>
|
|
150
|
+
</div>
|
|
151
|
+
);
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
</DocStep>
|
|
156
|
+
|
|
157
|
+
</DocStepper>
|
|
158
|
+
|
|
159
|
+
## Next Steps
|
|
160
|
+
|
|
161
|
+
[Theme your components](/docs/tailwind/guides/theming) with CSS variables, then [browse the components](/docs/tailwind/components/button) to add and customize the ones you need.
|