@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,276 @@
|
|
|
1
|
+
# Dialog
|
|
2
|
+
|
|
3
|
+
An unstyled modal dialog component with built-in focus trap, scroll lock, drag support, and dismissable backdrop.
|
|
4
|
+
|
|
5
|
+
<DocPrimitiveIntro description="Build fully custom modal dialogs with complete control over layout and styling." />
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
'use client';
|
|
9
|
+
import { Times } from '@primeicons/react/times';
|
|
10
|
+
import { Dialog } from 'primereact/dialog';
|
|
11
|
+
import styles from './basic-demo.module.css';
|
|
12
|
+
|
|
13
|
+
export default function BasicDemo() {
|
|
14
|
+
return (
|
|
15
|
+
<div className={styles.wrapper}>
|
|
16
|
+
<Dialog.Root>
|
|
17
|
+
<Dialog.Trigger className={styles.trigger}>Edit Profile</Dialog.Trigger>
|
|
18
|
+
<Dialog.Portal>
|
|
19
|
+
<Dialog.Backdrop className={styles.backdrop} />
|
|
20
|
+
<Dialog.Positioner className={styles.positioner}>
|
|
21
|
+
<Dialog.Popup className={styles.popup}>
|
|
22
|
+
<Dialog.Header className={styles.header}>
|
|
23
|
+
<Dialog.Title className={styles.title}>Edit Profile</Dialog.Title>
|
|
24
|
+
<Dialog.HeaderActions>
|
|
25
|
+
<Dialog.Close className={styles.close}>
|
|
26
|
+
<Times />
|
|
27
|
+
</Dialog.Close>
|
|
28
|
+
</Dialog.HeaderActions>
|
|
29
|
+
</Dialog.Header>
|
|
30
|
+
<Dialog.Content className={styles.content}>
|
|
31
|
+
<div className={styles.form}>
|
|
32
|
+
<div className={styles.field}>
|
|
33
|
+
<label htmlFor="name" className={styles.label}>
|
|
34
|
+
Name
|
|
35
|
+
</label>
|
|
36
|
+
<input id="name" defaultValue="Amanda Miller" className={styles.input} />
|
|
37
|
+
</div>
|
|
38
|
+
<div className={styles.field}>
|
|
39
|
+
<label htmlFor="username" className={styles.label}>
|
|
40
|
+
Username
|
|
41
|
+
</label>
|
|
42
|
+
<input id="username" defaultValue="@amandamiller" className={styles.input} />
|
|
43
|
+
</div>
|
|
44
|
+
<div className={styles.field}>
|
|
45
|
+
<label htmlFor="email" className={styles.label}>
|
|
46
|
+
Email
|
|
47
|
+
</label>
|
|
48
|
+
<input id="email" defaultValue="amanda@example.com" className={styles.input} />
|
|
49
|
+
</div>
|
|
50
|
+
<div className={styles.actions}>
|
|
51
|
+
<Dialog.Close className={styles.cancelButton}>Cancel</Dialog.Close>
|
|
52
|
+
<Dialog.Close className={styles.saveButton}>Save Changes</Dialog.Close>
|
|
53
|
+
</div>
|
|
54
|
+
</div>
|
|
55
|
+
</Dialog.Content>
|
|
56
|
+
</Dialog.Popup>
|
|
57
|
+
</Dialog.Positioner>
|
|
58
|
+
</Dialog.Portal>
|
|
59
|
+
</Dialog.Root>
|
|
60
|
+
</div>
|
|
61
|
+
);
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
<DocPrimitiveLinks name="Dialog" />
|
|
66
|
+
|
|
67
|
+
## Features
|
|
68
|
+
|
|
69
|
+
- Compound component API with sub-components: `Root`, `Trigger`, `Portal`, `Backdrop`, `Positioner`, `Popup`, `Header`, `Title`, `HeaderActions`, `Maximizable`, `Close`, `Content`, `Footer`
|
|
70
|
+
- Nine position modes: `center`, `top`, `bottom`, `left`, `right`, `topleft`, `topright`, `bottomleft`, `bottomright`
|
|
71
|
+
- Integrated focus trap with automatic focus management on open and close
|
|
72
|
+
- Dismissable [Backdrop](/docs/primitive/components/backdrop) with click-outside detection
|
|
73
|
+
- Built-in drag support with viewport boundary enforcement
|
|
74
|
+
- Maximizable mode with fullscreen toggle
|
|
75
|
+
- Scroll lock support via `blockScroll`
|
|
76
|
+
|
|
77
|
+
## Usage
|
|
78
|
+
|
|
79
|
+
```tsx
|
|
80
|
+
import { Dialog } from 'primereact/dialog';
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
```tsx
|
|
84
|
+
<Dialog.Root>
|
|
85
|
+
<Dialog.Trigger></Dialog.Trigger>
|
|
86
|
+
<Dialog.Portal>
|
|
87
|
+
<Dialog.Backdrop />
|
|
88
|
+
<Dialog.Positioner>
|
|
89
|
+
<Dialog.Popup>
|
|
90
|
+
<Dialog.Header>
|
|
91
|
+
<Dialog.Title></Dialog.Title>
|
|
92
|
+
<Dialog.HeaderActions>
|
|
93
|
+
<Dialog.Maximizable></Dialog.Maximizable>
|
|
94
|
+
<Dialog.Close></Dialog.Close>
|
|
95
|
+
</Dialog.HeaderActions>
|
|
96
|
+
</Dialog.Header>
|
|
97
|
+
<Dialog.Content></Dialog.Content>
|
|
98
|
+
<Dialog.Footer></Dialog.Footer>
|
|
99
|
+
</Dialog.Popup>
|
|
100
|
+
</Dialog.Positioner>
|
|
101
|
+
</Dialog.Portal>
|
|
102
|
+
</Dialog.Root>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Behavior
|
|
106
|
+
|
|
107
|
+
### Motion Animation
|
|
108
|
+
|
|
109
|
+
```tsx
|
|
110
|
+
<Dialog.Popup motionProps={{ name: 'p-dialog', appear: true }}>...</Dialog.Popup>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
See [Motion](/docs/primitive/components/motion) for animation phases, CSS variables, and hide strategies.
|
|
114
|
+
|
|
115
|
+
### Polymorphic Rendering
|
|
116
|
+
|
|
117
|
+
Use `as` on any sub-component to change the rendered HTML element.
|
|
118
|
+
|
|
119
|
+
```tsx
|
|
120
|
+
<Dialog.Trigger as="div">...</Dialog.Trigger>
|
|
121
|
+
<Dialog.Close as="a">...</Dialog.Close>
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Default elements: `Root`=`div`, `Trigger`=`button`, `Positioner`=`div`, `Popup`=`div`, `Header`=`div`, `Title`=`div`, `HeaderActions`=`div`, `Maximizable`=`button`, `Close`=`button`, `Content`=`div`, `Footer`=`div`.
|
|
125
|
+
|
|
126
|
+
### Render Function Children
|
|
127
|
+
|
|
128
|
+
Sub-components accept a render function as children, providing access to the component instance.
|
|
129
|
+
|
|
130
|
+
```tsx
|
|
131
|
+
<Dialog.Content>{(instance) => <div>{instance.dialog?.state.open ? 'Open' : 'Closed'}</div>}</Dialog.Content>
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Pass Through
|
|
135
|
+
|
|
136
|
+
<DocPTViewer name="dialog-pt" components={['DialogRoot']} />
|
|
137
|
+
|
|
138
|
+
## API
|
|
139
|
+
|
|
140
|
+
### DialogRoot
|
|
141
|
+
|
|
142
|
+
<DocTable name="DialogRoot" category="api" />
|
|
143
|
+
|
|
144
|
+
| Attribute | Value |
|
|
145
|
+
| ---------------- | ------------------------------------ |
|
|
146
|
+
| `data-open` | Present when the dialog is open |
|
|
147
|
+
| `data-closed` | Present when the dialog is closed |
|
|
148
|
+
| `data-maximized` | Present when the dialog is maximized |
|
|
149
|
+
|
|
150
|
+
<DocTable name="DialogRoot" category="pt" />
|
|
151
|
+
|
|
152
|
+
### DialogTrigger
|
|
153
|
+
|
|
154
|
+
<DocTable name="DialogTrigger" category="api" />
|
|
155
|
+
|
|
156
|
+
| Attribute | Value |
|
|
157
|
+
| ------------- | --------------------------------- |
|
|
158
|
+
| `data-open` | Present when the dialog is open |
|
|
159
|
+
| `data-closed` | Present when the dialog is closed |
|
|
160
|
+
|
|
161
|
+
<DocTable name="DialogTrigger" category="pt" />
|
|
162
|
+
|
|
163
|
+
### DialogPortal
|
|
164
|
+
|
|
165
|
+
<DocTable name="DialogPortal" category="api" />
|
|
166
|
+
|
|
167
|
+
<DocTable name="DialogPortal" category="pt" />
|
|
168
|
+
|
|
169
|
+
### DialogBackdrop
|
|
170
|
+
|
|
171
|
+
<DocTable name="DialogBackdrop" category="api" />
|
|
172
|
+
|
|
173
|
+
Uses the [Backdrop](/docs/primitive/components/backdrop) component internally for animated overlay rendering.
|
|
174
|
+
|
|
175
|
+
<DocTable name="DialogBackdrop" category="pt" />
|
|
176
|
+
|
|
177
|
+
### DialogPositioner
|
|
178
|
+
|
|
179
|
+
<DocTable name="DialogPositioner" category="api" />
|
|
180
|
+
|
|
181
|
+
| Attribute | Value |
|
|
182
|
+
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
183
|
+
| `data-position` | `"center"` \| `"top"` \| `"bottom"` \| `"left"` \| `"right"` \| `"topleft"` \| `"topright"` \| `"bottomleft"` \| `"bottomright"` |
|
|
184
|
+
| `data-scroll-behavior` | `"inside"` \| `"outside"` |
|
|
185
|
+
| `data-open` | Present when the dialog is open |
|
|
186
|
+
| `data-closed` | Present when the dialog is closed |
|
|
187
|
+
| `data-maximized` | Present when the dialog is maximized |
|
|
188
|
+
|
|
189
|
+
<DocTable name="DialogPositioner" category="pt" />
|
|
190
|
+
|
|
191
|
+
### DialogPopup
|
|
192
|
+
|
|
193
|
+
<DocTable name="DialogPopup" category="api" />
|
|
194
|
+
|
|
195
|
+
| Attribute | Value |
|
|
196
|
+
| ---------------- | ------------------------------------ |
|
|
197
|
+
| `data-open` | Present when the dialog is open |
|
|
198
|
+
| `data-maximized` | Present when the dialog is maximized |
|
|
199
|
+
|
|
200
|
+
Uses [VisuallyHidden](/docs/primitive/components/visuallyhidden) elements internally for focus trap boundaries.
|
|
201
|
+
|
|
202
|
+
<DocTable name="DialogPopup" category="pt" />
|
|
203
|
+
|
|
204
|
+
### DialogHeader
|
|
205
|
+
|
|
206
|
+
<DocTable name="DialogHeader" category="api" />
|
|
207
|
+
|
|
208
|
+
<DocTable name="DialogHeader" category="pt" />
|
|
209
|
+
|
|
210
|
+
### DialogTitle
|
|
211
|
+
|
|
212
|
+
<DocTable name="DialogTitle" category="api" />
|
|
213
|
+
|
|
214
|
+
<DocTable name="DialogTitle" category="pt" />
|
|
215
|
+
|
|
216
|
+
### DialogHeaderActions
|
|
217
|
+
|
|
218
|
+
<DocTable name="DialogHeaderActions" category="api" />
|
|
219
|
+
|
|
220
|
+
<DocTable name="DialogHeaderActions" category="pt" />
|
|
221
|
+
|
|
222
|
+
### DialogMaximizable
|
|
223
|
+
|
|
224
|
+
<DocTable name="DialogMaximizable" category="api" />
|
|
225
|
+
|
|
226
|
+
| Attribute | Value |
|
|
227
|
+
| ---------------- | ---------------------------------------- |
|
|
228
|
+
| `data-maximized` | Present when the dialog is maximized |
|
|
229
|
+
| `data-minimized` | Present when the dialog is not maximized |
|
|
230
|
+
|
|
231
|
+
<DocTable name="DialogMaximizable" category="pt" />
|
|
232
|
+
|
|
233
|
+
### DialogClose
|
|
234
|
+
|
|
235
|
+
<DocTable name="DialogClose" category="api" />
|
|
236
|
+
|
|
237
|
+
<DocTable name="DialogClose" category="pt" />
|
|
238
|
+
|
|
239
|
+
### DialogContent
|
|
240
|
+
|
|
241
|
+
<DocTable name="DialogContent" category="api" />
|
|
242
|
+
|
|
243
|
+
| Attribute | Value |
|
|
244
|
+
| ---------------- | ------------------------------------ |
|
|
245
|
+
| `data-maximized` | Present when the dialog is maximized |
|
|
246
|
+
|
|
247
|
+
<DocTable name="DialogContent" category="pt" />
|
|
248
|
+
|
|
249
|
+
### DialogFooter
|
|
250
|
+
|
|
251
|
+
<DocTable name="DialogFooter" category="api" />
|
|
252
|
+
|
|
253
|
+
<DocTable name="DialogFooter" category="pt" />
|
|
254
|
+
|
|
255
|
+
## Accessibility
|
|
256
|
+
|
|
257
|
+
### Screen Reader
|
|
258
|
+
|
|
259
|
+
Dialog component uses `dialog` role along with `aria-labelledby` referring to the header element however any attribute is passed to the root element so `aria-labelledby` can be used to override this default behavior. In addition `aria-modal` is added since focus is kept within the popup.
|
|
260
|
+
|
|
261
|
+
Trigger element also has `aria-expanded` and `aria-controls` to indicate the dialog state.
|
|
262
|
+
|
|
263
|
+
### Overlay Keyboard Support
|
|
264
|
+
|
|
265
|
+
| Key | Function |
|
|
266
|
+
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
267
|
+
| `tab` | Moves focus to the next the focusable element within the dialog if `modal` is true. Otherwise, the focusable element in the page tab sequence. |
|
|
268
|
+
| `shift + tab` | Moves focus to the previous the focusable element within the dialog if `modal` is true. Otherwise, the focusable element in the page tab sequence. |
|
|
269
|
+
| `escape` | Closes the dialog if `closeOnEscape` is true. |
|
|
270
|
+
|
|
271
|
+
### Close Button Keyboard Support
|
|
272
|
+
|
|
273
|
+
| Key | Function |
|
|
274
|
+
| ------- | ------------------ |
|
|
275
|
+
| `enter` | Closes the dialog. |
|
|
276
|
+
| `space` | Closes the dialog. |
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "DividerRoot",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/divider.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "Divider is used to separate contents.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"DividerPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of Divider component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "DividerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "content",
|
|
20
|
+
"type": "DividerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
21
|
+
"default": "",
|
|
22
|
+
"description": "Used to pass attributes to the content's DOM element."
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"methods": []
|
|
26
|
+
},
|
|
27
|
+
"DividerProps": {
|
|
28
|
+
"description": "Defines valid properties in Divider component.",
|
|
29
|
+
"relatedProp": "",
|
|
30
|
+
"extendedTypes": "BaseComponentProps<DividerInstance, UseDividerProps, DividerPassThrough>",
|
|
31
|
+
"props": [
|
|
32
|
+
{
|
|
33
|
+
"name": "ref",
|
|
34
|
+
"type": "Ref<unknown>",
|
|
35
|
+
"default": "",
|
|
36
|
+
"description": "The reference to the component instance."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "pIf",
|
|
40
|
+
"type": "boolean",
|
|
41
|
+
"default": "true",
|
|
42
|
+
"description": "Whether the component should be rendered."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "style",
|
|
46
|
+
"type": "CSSProperties | ((instance?: DividerInstance) => CSSProperties)",
|
|
47
|
+
"default": "",
|
|
48
|
+
"description": "The style to apply to the component."
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "className",
|
|
52
|
+
"type": "string | ((instance?: DividerInstance) => string)",
|
|
53
|
+
"default": "",
|
|
54
|
+
"description": "The class name to apply to the component."
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "as",
|
|
58
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
59
|
+
"default": "",
|
|
60
|
+
"description": "The component type to render."
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "asChild",
|
|
64
|
+
"type": "boolean",
|
|
65
|
+
"default": "false",
|
|
66
|
+
"description": "Whether the component should be rendered as a child component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "instance",
|
|
70
|
+
"type": "DividerInstance",
|
|
71
|
+
"default": "",
|
|
72
|
+
"description": "The instance to pass to the component."
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "pt",
|
|
76
|
+
"type": "SafeRecord<DividerPassThrough>",
|
|
77
|
+
"default": "",
|
|
78
|
+
"description": "The pass-through props to pass to the component."
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "ptOptions",
|
|
82
|
+
"type": "PassThroughOptions",
|
|
83
|
+
"default": "",
|
|
84
|
+
"description": "The pass-through options to pass to the component."
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "unstyled",
|
|
88
|
+
"type": "boolean",
|
|
89
|
+
"default": "",
|
|
90
|
+
"description": "Whether the component should be rendered without classes."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "dt",
|
|
94
|
+
"type": "unknown",
|
|
95
|
+
"default": "",
|
|
96
|
+
"description": "The design token to use for the component."
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "styles",
|
|
100
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
101
|
+
"default": "",
|
|
102
|
+
"description": "The styles to use for the component."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "render",
|
|
106
|
+
"type": "(instance: DividerInstance) => ReactNode",
|
|
107
|
+
"default": "",
|
|
108
|
+
"description": "The render function to render the component with instance access."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "children",
|
|
112
|
+
"type": "any",
|
|
113
|
+
"default": "",
|
|
114
|
+
"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."
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "align",
|
|
118
|
+
"type": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\"",
|
|
119
|
+
"default": "",
|
|
120
|
+
"description": "Alignment of the content."
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "orientation",
|
|
124
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
125
|
+
"default": "horizontal",
|
|
126
|
+
"description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'."
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "type",
|
|
130
|
+
"type": "\"solid\" | \"dashed\" | \"dotted\"",
|
|
131
|
+
"default": "solid",
|
|
132
|
+
"description": "Border style type."
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "[key: string]",
|
|
136
|
+
"type": "any",
|
|
137
|
+
"description": ""
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"name": "pt-{optionName}-*",
|
|
141
|
+
"type": "-",
|
|
142
|
+
"default": "",
|
|
143
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
144
|
+
"deprecated": false
|
|
145
|
+
}
|
|
146
|
+
],
|
|
147
|
+
"methods": []
|
|
148
|
+
},
|
|
149
|
+
"DividerState": {
|
|
150
|
+
"description": "Defines valid state in Divider component.",
|
|
151
|
+
"relatedProp": "",
|
|
152
|
+
"extendedTypes": "UseDividerState",
|
|
153
|
+
"props": [],
|
|
154
|
+
"methods": []
|
|
155
|
+
},
|
|
156
|
+
"DividerExposes": {
|
|
157
|
+
"description": "Defines the methods and properties exposed by Divider component.",
|
|
158
|
+
"relatedProp": "",
|
|
159
|
+
"extendedTypes": "UseDividerExposes",
|
|
160
|
+
"props": [
|
|
161
|
+
{
|
|
162
|
+
"name": "rootProps",
|
|
163
|
+
"type": "UseDividerRootProps",
|
|
164
|
+
"default": "",
|
|
165
|
+
"description": "Pre-built data attribute props for the root element.\nIncludes role, aria-orientation, data-orientation, data-align."
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"name": "contentProps",
|
|
169
|
+
"type": "UseDividerContentProps",
|
|
170
|
+
"default": "",
|
|
171
|
+
"description": "Pre-built data attribute props for the content element.\nRendered only when the consumer passes children."
|
|
172
|
+
}
|
|
173
|
+
],
|
|
174
|
+
"methods": []
|
|
175
|
+
}
|
|
176
|
+
},
|
|
177
|
+
"types": {
|
|
178
|
+
"DividerClassNamesType": {
|
|
179
|
+
"description": "Type representing the CSS class names used in the Divider component.",
|
|
180
|
+
"values": "typeof DividerClassNames[keyof typeof DividerClassNames]"
|
|
181
|
+
},
|
|
182
|
+
"DividerPassThroughType": {
|
|
183
|
+
"description": "Defines passthrough(pt) options type in Divider component.",
|
|
184
|
+
"values": "PassThroughType<DividerInstance, E>"
|
|
185
|
+
},
|
|
186
|
+
"DividerInstance": {
|
|
187
|
+
"description": "Instance of Divider component.",
|
|
188
|
+
"values": "ComponentInstance<DividerProps, DividerState, DividerExposes>"
|
|
189
|
+
}
|
|
190
|
+
},
|
|
191
|
+
"variables": {
|
|
192
|
+
"DividerClassNames": {
|
|
193
|
+
"description": "Defines the CSS class names used in the Divider component.",
|
|
194
|
+
"variables": [
|
|
195
|
+
{
|
|
196
|
+
"name": "root",
|
|
197
|
+
"value": "p-divider",
|
|
198
|
+
"optional": false,
|
|
199
|
+
"readonly": true,
|
|
200
|
+
"description": "Class name of the root element"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "content",
|
|
204
|
+
"value": "p-divider-content",
|
|
205
|
+
"optional": false,
|
|
206
|
+
"readonly": true,
|
|
207
|
+
"description": "Class name of the content element"
|
|
208
|
+
}
|
|
209
|
+
]
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
]
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Divider
|
|
2
|
+
|
|
3
|
+
An unstyled separator component for horizontal and vertical content division.
|
|
4
|
+
|
|
5
|
+
<DocPrimitiveIntro description="Build fully custom content separators with complete control over layout and styling." />
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
'use client';
|
|
9
|
+
import { Divider } from 'primereact/divider';
|
|
10
|
+
import styles from './basic-demo.module.css';
|
|
11
|
+
|
|
12
|
+
export default function BasicDemo() {
|
|
13
|
+
return (
|
|
14
|
+
<div className={styles.wrapper}>
|
|
15
|
+
<div className={styles.row}>
|
|
16
|
+
<div className={styles.column}>
|
|
17
|
+
<span className={styles.label}>Invoice No</span>
|
|
18
|
+
<span className={styles.value}>0000123</span>
|
|
19
|
+
</div>
|
|
20
|
+
<Divider orientation="vertical" className={styles.vertical} />
|
|
21
|
+
<div className={styles.column}>
|
|
22
|
+
<span className={styles.label}>Issued</span>
|
|
23
|
+
<span className={styles.value}>01/01/2026</span>
|
|
24
|
+
</div>
|
|
25
|
+
<Divider orientation="vertical" className={styles.vertical} />
|
|
26
|
+
<div className={styles.column}>
|
|
27
|
+
<span className={styles.label}>Due Date</span>
|
|
28
|
+
<span className={styles.value}>02/02/2026</span>
|
|
29
|
+
</div>
|
|
30
|
+
</div>
|
|
31
|
+
<Divider className={styles.horizontal} />
|
|
32
|
+
<p className={styles.value}>Fast setup, no credit card required.</p>
|
|
33
|
+
</div>
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
<DocPrimitiveLinks name="Divider" />
|
|
39
|
+
|
|
40
|
+
## Features
|
|
41
|
+
|
|
42
|
+
- Horizontal and vertical orientations
|
|
43
|
+
- Three border types: `solid`, `dashed`, `dotted`
|
|
44
|
+
- Content alignment within the divider line (`left`, `center`, `right` for horizontal; `top`, `center`, `bottom` for vertical)
|
|
45
|
+
|
|
46
|
+
## Usage
|
|
47
|
+
|
|
48
|
+
```tsx
|
|
49
|
+
import { Divider } from 'primereact/divider';
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```tsx
|
|
53
|
+
<Divider />
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Behavior
|
|
57
|
+
|
|
58
|
+
### Polymorphic Rendering
|
|
59
|
+
|
|
60
|
+
Use `as` to change the rendered HTML element.
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
<Divider as="hr" />
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Default element: `div`.
|
|
67
|
+
|
|
68
|
+
### Render Function Children
|
|
69
|
+
|
|
70
|
+
`Divider` accepts a render function as children, providing access to the component instance.
|
|
71
|
+
|
|
72
|
+
```tsx
|
|
73
|
+
<Divider>{(instance) => <span>{instance.divider?.props.orientation}</span>}</Divider>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Pass Through
|
|
77
|
+
|
|
78
|
+
<DocPTViewer name="divider-pt" components={['DividerRoot']} />
|
|
79
|
+
|
|
80
|
+
## API
|
|
81
|
+
|
|
82
|
+
### DividerRoot
|
|
83
|
+
|
|
84
|
+
<DocTable name="DividerRoot" category="api" />
|
|
85
|
+
|
|
86
|
+
<DocTable name="DividerRoot" category="pt" />
|
|
87
|
+
|
|
88
|
+
## Accessibility
|
|
89
|
+
|
|
90
|
+
### Screen Reader
|
|
91
|
+
|
|
92
|
+
Divider uses `role="separator"` with `aria-orientation` set to either `"horizontal"` or `"vertical"`.
|
|
93
|
+
|
|
94
|
+
### Keyboard Support
|
|
95
|
+
|
|
96
|
+
Component does not include any interactive elements.
|