@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,231 @@
|
|
|
1
|
+
# Accordion
|
|
2
|
+
|
|
3
|
+
An unstyled, accessible accordion component with compound composition.
|
|
4
|
+
|
|
5
|
+
<DocPrimitiveIntro description="Build fully custom collapsible content sections with complete control over layout and styling." />
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
'use client';
|
|
9
|
+
import { ChevronDown } from '@primeicons/react/chevron-down';
|
|
10
|
+
import { Accordion } from 'primereact/accordion';
|
|
11
|
+
import styles from './basic-demo.module.css';
|
|
12
|
+
|
|
13
|
+
const items = [
|
|
14
|
+
{
|
|
15
|
+
value: '1',
|
|
16
|
+
title: 'What is PrimeReact?',
|
|
17
|
+
content:
|
|
18
|
+
'PrimeReact is a rich set of open source UI components for React. It provides a wide range of accessible, themeable components to build modern web applications.'
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
value: '2',
|
|
22
|
+
title: 'How to get started?',
|
|
23
|
+
content:
|
|
24
|
+
'Install PrimeReact via npm and import the components you need. Each component is available as a compound primitive or as a styled variant with built-in theming.'
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
value: '3',
|
|
28
|
+
title: 'What about accessibility?',
|
|
29
|
+
content:
|
|
30
|
+
'All components follow WAI-ARIA guidelines with full keyboard support. Accordion headers use proper button semantics and aria-expanded attributes automatically.'
|
|
31
|
+
}
|
|
32
|
+
];
|
|
33
|
+
|
|
34
|
+
export default function BasicDemo() {
|
|
35
|
+
return (
|
|
36
|
+
<Accordion.Root className={styles.root}>
|
|
37
|
+
{items.map((item) => (
|
|
38
|
+
<Accordion.Panel key={item.value} value={item.value} className={styles.panel}>
|
|
39
|
+
<Accordion.Header className={styles.header}>
|
|
40
|
+
<Accordion.Trigger className={styles.trigger}>
|
|
41
|
+
{item.title}
|
|
42
|
+
<Accordion.Indicator className={styles.indicator}>
|
|
43
|
+
<ChevronDown />
|
|
44
|
+
</Accordion.Indicator>
|
|
45
|
+
</Accordion.Trigger>
|
|
46
|
+
</Accordion.Header>
|
|
47
|
+
<Accordion.Content className={styles.content}>
|
|
48
|
+
<div className={styles.contentInner}>{item.content}</div>
|
|
49
|
+
</Accordion.Content>
|
|
50
|
+
</Accordion.Panel>
|
|
51
|
+
))}
|
|
52
|
+
</Accordion.Root>
|
|
53
|
+
);
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
<DocPrimitiveLinks name="Accordion" />
|
|
58
|
+
|
|
59
|
+
## Features
|
|
60
|
+
|
|
61
|
+
- Compound component API with six sub-components: `Root`, `Panel`, `Header`, `Trigger`, `Content`, `Indicator`
|
|
62
|
+
- Single or multiple panel expansion
|
|
63
|
+
|
|
64
|
+
## Usage
|
|
65
|
+
|
|
66
|
+
```tsx
|
|
67
|
+
import { Accordion } from 'primereact/accordion';
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
```tsx
|
|
71
|
+
<Accordion.Root>
|
|
72
|
+
<Accordion.Panel>
|
|
73
|
+
<Accordion.Header>
|
|
74
|
+
<Accordion.Trigger>
|
|
75
|
+
<Accordion.Indicator />
|
|
76
|
+
</Accordion.Trigger>
|
|
77
|
+
</Accordion.Header>
|
|
78
|
+
<Accordion.Content />
|
|
79
|
+
</Accordion.Panel>
|
|
80
|
+
</Accordion.Root>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Behavior
|
|
84
|
+
|
|
85
|
+
### Motion Animation
|
|
86
|
+
|
|
87
|
+
Use `motionProps` on `Root` to configure open/close animations.
|
|
88
|
+
|
|
89
|
+
```tsx
|
|
90
|
+
<Accordion.Root motionProps={{ name: 'accordion-slide', cssVarPrefix: 'accordion-content', hideStrategy: 'none' }}>...</Accordion.Root>
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
See [Motion](/docs/primitive/components/motion) for animation phases, CSS variables, and hide strategies.
|
|
94
|
+
|
|
95
|
+
### Polymorphic Rendering
|
|
96
|
+
|
|
97
|
+
Use `as` on any sub-component to change the rendered HTML element or use a custom React component.
|
|
98
|
+
|
|
99
|
+
```tsx
|
|
100
|
+
<Accordion.Root as="section">
|
|
101
|
+
<Accordion.Panel as="article">
|
|
102
|
+
<Accordion.Header as="h3">
|
|
103
|
+
<Accordion.Trigger as="div">...</Accordion.Trigger>
|
|
104
|
+
</Accordion.Header>
|
|
105
|
+
<Accordion.Content as="section">...</Accordion.Content>
|
|
106
|
+
</Accordion.Panel>
|
|
107
|
+
</Accordion.Root>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Custom components receive all the props that would be applied to the default element:
|
|
111
|
+
|
|
112
|
+
```tsx
|
|
113
|
+
<Accordion.Trigger as={MyCustomButton}>...</Accordion.Trigger>
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Default elements: `Root`=`div`, `Panel`=`div`, `Header`=`div`, `Trigger`=`button`, `Content`=`div`, `Indicator`=`span`.
|
|
117
|
+
|
|
118
|
+
### Render Function Children
|
|
119
|
+
|
|
120
|
+
`Content` accepts a render function as children, providing access to the component instance. The instance exposes `accordion` (root instance), `accordionpanel` (parent panel instance), and `motion` (animation state).
|
|
121
|
+
|
|
122
|
+
```tsx
|
|
123
|
+
<Accordion.Content>{(instance) => <div>Panel is {instance.accordionpanel?.state.open ? 'open' : 'closed'}</div>}</Accordion.Content>
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Pass Through
|
|
127
|
+
|
|
128
|
+
<DocPTViewer name="accordion-pt" components={['AccordionRoot']} />
|
|
129
|
+
|
|
130
|
+
## API
|
|
131
|
+
|
|
132
|
+
### AccordionRoot
|
|
133
|
+
|
|
134
|
+
<DocTable name="AccordionRoot" category="api" />
|
|
135
|
+
|
|
136
|
+
| Attribute | Value |
|
|
137
|
+
| --------------- | --------------------- |
|
|
138
|
+
| `data-scope` | `"accordion"` |
|
|
139
|
+
| `data-part` | `"root"` |
|
|
140
|
+
| `data-disabled` | Present when disabled |
|
|
141
|
+
|
|
142
|
+
<DocTable name="AccordionRoot" category="pt" />
|
|
143
|
+
|
|
144
|
+
### AccordionPanel
|
|
145
|
+
|
|
146
|
+
<DocTable name="AccordionPanel" category="api" />
|
|
147
|
+
|
|
148
|
+
| Attribute | Value |
|
|
149
|
+
| --------------- | ---------------------- |
|
|
150
|
+
| `data-scope` | `"accordion"` |
|
|
151
|
+
| `data-part` | `"panel"` |
|
|
152
|
+
| `data-open` | Present when expanded |
|
|
153
|
+
| `data-closed` | Present when collapsed |
|
|
154
|
+
| `data-disabled` | Present when disabled |
|
|
155
|
+
|
|
156
|
+
<DocTable name="AccordionPanel" category="pt" />
|
|
157
|
+
|
|
158
|
+
### AccordionHeader
|
|
159
|
+
|
|
160
|
+
<DocTable name="AccordionHeader" category="api" />
|
|
161
|
+
|
|
162
|
+
| Attribute | Value |
|
|
163
|
+
| ------------- | ---------------------- |
|
|
164
|
+
| `data-scope` | `"accordion"` |
|
|
165
|
+
| `data-part` | `"header"` |
|
|
166
|
+
| `data-open` | Present when expanded |
|
|
167
|
+
| `data-closed` | Present when collapsed |
|
|
168
|
+
|
|
169
|
+
<DocTable name="AccordionHeader" category="pt" />
|
|
170
|
+
|
|
171
|
+
### AccordionTrigger
|
|
172
|
+
|
|
173
|
+
<DocTable name="AccordionTrigger" category="api" />
|
|
174
|
+
|
|
175
|
+
| Attribute | Value |
|
|
176
|
+
| --------------------- | --------------------------- |
|
|
177
|
+
| `data-scope` | `"accordion"` |
|
|
178
|
+
| `data-part` | `"trigger"` |
|
|
179
|
+
| `data-content-open` | Present when content open |
|
|
180
|
+
| `data-content-closed` | Present when content closed |
|
|
181
|
+
| `data-disabled` | Present when disabled |
|
|
182
|
+
|
|
183
|
+
<DocTable name="AccordionTrigger" category="pt" />
|
|
184
|
+
|
|
185
|
+
### AccordionContent
|
|
186
|
+
|
|
187
|
+
<DocTable name="AccordionContent" category="api" />
|
|
188
|
+
|
|
189
|
+
| Attribute | Value |
|
|
190
|
+
| --------------- | ---------------------- |
|
|
191
|
+
| `data-scope` | `"accordion"` |
|
|
192
|
+
| `data-part` | `"content"` |
|
|
193
|
+
| `data-open` | Present when expanded |
|
|
194
|
+
| `data-closed` | Present when collapsed |
|
|
195
|
+
| `data-disabled` | Present when disabled |
|
|
196
|
+
|
|
197
|
+
<DocTable name="AccordionContent" category="pt" />
|
|
198
|
+
|
|
199
|
+
### AccordionIndicator
|
|
200
|
+
|
|
201
|
+
<DocTable name="AccordionIndicator" category="api" />
|
|
202
|
+
|
|
203
|
+
| Attribute | Value |
|
|
204
|
+
| ------------- | ---------------------- |
|
|
205
|
+
| `data-scope` | `"accordion"` |
|
|
206
|
+
| `data-part` | `"indicator"` |
|
|
207
|
+
| `data-open` | Present when expanded |
|
|
208
|
+
| `data-closed` | Present when collapsed |
|
|
209
|
+
|
|
210
|
+
<DocTable name="AccordionIndicator" category="pt" />
|
|
211
|
+
|
|
212
|
+
## Accessibility
|
|
213
|
+
|
|
214
|
+
### Screen Reader
|
|
215
|
+
|
|
216
|
+
Accordion headers are buttons. They use `aria-controls` to reference the content region and `aria-expanded` to reflect visibility state. The announced label can be customized with `aria-label` or `aria-labelledby` via pt.
|
|
217
|
+
|
|
218
|
+
The content uses `role="region"` and an `id` that matches the header button's `aria-controls`.
|
|
219
|
+
|
|
220
|
+
### Header Keyboard Support
|
|
221
|
+
|
|
222
|
+
| Key | Function |
|
|
223
|
+
| ------------- | ---------------------------------------------------------------------------------------------------- |
|
|
224
|
+
| `tab` | Moves focus to the next focusable element in the page tab sequence. |
|
|
225
|
+
| `shift + tab` | Moves focus to the previous focusable element in the page tab sequence. |
|
|
226
|
+
| `enter` | Toggles the visibility of the content. |
|
|
227
|
+
| `space` | Toggles the visibility of the content. |
|
|
228
|
+
| `down arrow` | Moves focus to the next header. If focus is on the last header, moves focus to the first header. |
|
|
229
|
+
| `up arrow` | Moves focus to the previous header. If focus is on the first header, moves focus to the last header. |
|
|
230
|
+
| `home` | Moves focus to the first header. |
|
|
231
|
+
| `end` | Moves focus to the last header. |
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "AnimateOnScroll",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/animateonscroll.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "AnimateOnScroll is used to apply animations to elements when entering or leaving the viewport during scrolling.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"AnimateOnScrollPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of AnimateOnScroll component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "AnimateOnScrollPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"AnimateOnScrollProps": {
|
|
22
|
+
"description": "Defines valid properties in AnimateOnScroll component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<AnimateOnScrollInstance, UseAnimateOnScrollProps, AnimateOnScrollPassThrough>",
|
|
25
|
+
"props": [
|
|
26
|
+
{
|
|
27
|
+
"name": "ref",
|
|
28
|
+
"type": "Ref<unknown>",
|
|
29
|
+
"default": "",
|
|
30
|
+
"description": "The reference to the component instance."
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "pIf",
|
|
34
|
+
"type": "boolean",
|
|
35
|
+
"default": "true",
|
|
36
|
+
"description": "Whether the component should be rendered."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "style",
|
|
40
|
+
"type": "CSSProperties | ((instance?: AnimateOnScrollInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: AnimateOnScrollInstance) => string)",
|
|
47
|
+
"default": "",
|
|
48
|
+
"description": "The class name to apply to the component."
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "as",
|
|
52
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
53
|
+
"default": "",
|
|
54
|
+
"description": "The component type to render."
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "asChild",
|
|
58
|
+
"type": "boolean",
|
|
59
|
+
"default": "false",
|
|
60
|
+
"description": "Whether the component should be rendered as a child component."
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "instance",
|
|
64
|
+
"type": "AnimateOnScrollInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<AnimateOnScrollPassThrough>",
|
|
71
|
+
"default": "",
|
|
72
|
+
"description": "The pass-through props to pass to the component."
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "ptOptions",
|
|
76
|
+
"type": "PassThroughOptions",
|
|
77
|
+
"default": "",
|
|
78
|
+
"description": "The pass-through options to pass to the component."
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "unstyled",
|
|
82
|
+
"type": "boolean",
|
|
83
|
+
"default": "",
|
|
84
|
+
"description": "Whether the component should be rendered without classes."
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "dt",
|
|
88
|
+
"type": "unknown",
|
|
89
|
+
"default": "",
|
|
90
|
+
"description": "The design token to use for the component."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "styles",
|
|
94
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
95
|
+
"default": "",
|
|
96
|
+
"description": "The styles to use for the component."
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "render",
|
|
100
|
+
"type": "(instance: AnimateOnScrollInstance) => ReactNode",
|
|
101
|
+
"default": "",
|
|
102
|
+
"description": "The render function to render the component with instance access."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "children",
|
|
106
|
+
"type": "any",
|
|
107
|
+
"default": "",
|
|
108
|
+
"description": "The children to render.\n\nAccepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access.\nTyped as `any` to avoid JSX type errors when used directly in templates."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "enterClassName",
|
|
112
|
+
"type": "string",
|
|
113
|
+
"default": "",
|
|
114
|
+
"description": "CSS class names that are applied when the element enters the viewport."
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "leaveClassName",
|
|
118
|
+
"type": "string",
|
|
119
|
+
"default": "",
|
|
120
|
+
"description": "CSS class names that are applied when the element leaves the viewport."
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "once",
|
|
124
|
+
"type": "boolean",
|
|
125
|
+
"default": "false",
|
|
126
|
+
"description": "When enabled, animation is triggered only once."
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "[key: string]",
|
|
130
|
+
"type": "any",
|
|
131
|
+
"description": ""
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "pt-{optionName}-*",
|
|
135
|
+
"type": "-",
|
|
136
|
+
"default": "",
|
|
137
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
138
|
+
"deprecated": false
|
|
139
|
+
}
|
|
140
|
+
],
|
|
141
|
+
"methods": []
|
|
142
|
+
},
|
|
143
|
+
"AnimateOnScrollState": {
|
|
144
|
+
"description": "Defines valid state in AnimateOnScroll component.",
|
|
145
|
+
"relatedProp": "",
|
|
146
|
+
"extendedTypes": "UseAnimateOnScrollState",
|
|
147
|
+
"props": [],
|
|
148
|
+
"methods": []
|
|
149
|
+
},
|
|
150
|
+
"AnimateOnScrollExposes": {
|
|
151
|
+
"description": "Defines the methods and properties exposed by AnimateOnScroll component.",
|
|
152
|
+
"relatedProp": "",
|
|
153
|
+
"extendedTypes": "UseAnimateOnScrollExposes",
|
|
154
|
+
"props": [
|
|
155
|
+
{
|
|
156
|
+
"name": "state",
|
|
157
|
+
"type": "UseAnimateOnScrollState",
|
|
158
|
+
"default": "",
|
|
159
|
+
"description": "State of the animate on scroll."
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"name": "rootProps",
|
|
163
|
+
"type": "UseAnimateOnScrollRootProps",
|
|
164
|
+
"default": "",
|
|
165
|
+
"description": "Pre-built props for the root element."
|
|
166
|
+
}
|
|
167
|
+
],
|
|
168
|
+
"methods": []
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
"types": {
|
|
172
|
+
"AnimateOnScrollPassThroughType": {
|
|
173
|
+
"description": "Defines passthrough(pt) options type in AnimateOnScroll component.",
|
|
174
|
+
"values": "PassThroughType<AnimateOnScrollInstance, E>"
|
|
175
|
+
},
|
|
176
|
+
"AnimateOnScrollClassNamesType": {
|
|
177
|
+
"description": "Type representing the CSS class names used in the AnimateOnScroll component.",
|
|
178
|
+
"values": "typeof AnimateOnScrollClassNames[keyof typeof AnimateOnScrollClassNames]"
|
|
179
|
+
},
|
|
180
|
+
"AnimateOnScrollInstance": {
|
|
181
|
+
"description": "Instance of AnimateOnScroll component.",
|
|
182
|
+
"values": "ComponentInstance<AnimateOnScrollProps, AnimateOnScrollState, AnimateOnScrollExposes>"
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
"variables": {
|
|
186
|
+
"AnimateOnScrollClassNames": {
|
|
187
|
+
"description": "Defines the CSS class names used in the AnimateOnScroll component.",
|
|
188
|
+
"variables": []
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
]
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# AnimateOnScroll
|
|
2
|
+
|
|
3
|
+
An unstyled component that applies CSS animations to elements entering or leaving the viewport.
|
|
4
|
+
|
|
5
|
+
<DocPrimitiveIntro description="Build fully custom scroll-triggered animations with complete control over enter and leave transitions." />
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
'use client';
|
|
9
|
+
import { ArrowDown } from '@primeicons/react/arrow-down';
|
|
10
|
+
import { AnimateOnScroll } from 'primereact/animateonscroll';
|
|
11
|
+
import styles from './basic-demo.module.css';
|
|
12
|
+
|
|
13
|
+
export default function BasicDemo() {
|
|
14
|
+
return (
|
|
15
|
+
<div className={styles.container}>
|
|
16
|
+
<div className={styles.intro}>
|
|
17
|
+
<div className={styles.introTitle}>Scroll Down</div>
|
|
18
|
+
<div className={styles.introIcon}>
|
|
19
|
+
<ArrowDown />
|
|
20
|
+
</div>
|
|
21
|
+
</div>
|
|
22
|
+
<div className={styles.spacer}></div>
|
|
23
|
+
<div className={styles.content}>
|
|
24
|
+
<AnimateOnScroll enterClassName={styles.fadeSlideIn} leaveClassName={styles.fadeOut}>
|
|
25
|
+
<div className={styles.heading}>Discover real-world design inspiration.</div>
|
|
26
|
+
</AnimateOnScroll>
|
|
27
|
+
<AnimateOnScroll enterClassName={styles.fadeSlideIn} leaveClassName={styles.fadeOut}>
|
|
28
|
+
<div className={styles.subtitle}>Featuring over 400,000 screens and 1,000 iOS, Android & Web apps.</div>
|
|
29
|
+
</AnimateOnScroll>
|
|
30
|
+
</div>
|
|
31
|
+
<div className={styles.spacerSmall}></div>
|
|
32
|
+
</div>
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
<DocPrimitiveLinks name="AnimateOnScroll" />
|
|
38
|
+
|
|
39
|
+
## Features
|
|
40
|
+
|
|
41
|
+
- Applies `enterClassName` when the element scrolls into view and `leaveClassName` when it scrolls out
|
|
42
|
+
- Configurable Intersection Observer options: `root`, `rootMargin`, `threshold`
|
|
43
|
+
- `once` mode to trigger animation only on first viewport entry
|
|
44
|
+
- Automatic cleanup of animation classes after `animationend` and `transitionend` events
|
|
45
|
+
|
|
46
|
+
## Usage
|
|
47
|
+
|
|
48
|
+
```tsx
|
|
49
|
+
import { AnimateOnScroll } from 'primereact/animateonscroll';
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```tsx
|
|
53
|
+
<AnimateOnScroll enterClassName="" leaveClassName=""></AnimateOnScroll>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Behavior
|
|
57
|
+
|
|
58
|
+
### Polymorphic Rendering
|
|
59
|
+
|
|
60
|
+
Use `as` to change the rendered HTML element.
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
<AnimateOnScroll as="section" enterClassName="fade-in">
|
|
64
|
+
...
|
|
65
|
+
</AnimateOnScroll>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Default element: `div`.
|
|
69
|
+
|
|
70
|
+
## API
|
|
71
|
+
|
|
72
|
+
### AnimateOnScroll
|
|
73
|
+
|
|
74
|
+
<DocTable name="AnimateOnScroll" category="api" />
|
|
75
|
+
|
|
76
|
+
| Attribute | Value |
|
|
77
|
+
| ------------ | ------------------- |
|
|
78
|
+
| `data-scope` | `"animateonscroll"` |
|
|
79
|
+
| `data-part` | `"root"` |
|
|
80
|
+
|
|
81
|
+
<DocTable name="AnimateOnScroll" category="pt" />
|
|
82
|
+
|
|
83
|
+
## Accessibility
|
|
84
|
+
|
|
85
|
+
### Screen Reader
|
|
86
|
+
|
|
87
|
+
AnimateOnScroll does not require any roles and attributes.
|
|
88
|
+
|
|
89
|
+
### Keyboard Support
|
|
90
|
+
|
|
91
|
+
Component does not include any interactive elements.
|