@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,280 @@
|
|
|
1
|
+
# useDialog
|
|
2
|
+
|
|
3
|
+
Hook that manages dialog open/close state, focus trapping, dragging, scroll lock, and z-index layering.
|
|
4
|
+
|
|
5
|
+
```tsx
|
|
6
|
+
'use client';
|
|
7
|
+
import { Times } from '@primeicons/react/times';
|
|
8
|
+
import { useMotion } from '@primereact/core/motion';
|
|
9
|
+
import { useDialog } from '@primereact/headless/dialog';
|
|
10
|
+
import { usePortal } from '@primereact/headless/portal';
|
|
11
|
+
import * as React from 'react';
|
|
12
|
+
import { createPortal } from 'react-dom';
|
|
13
|
+
|
|
14
|
+
export default function BasicDemo() {
|
|
15
|
+
const { triggerProps, backdropProps, positionerProps, popupProps, closeProps, headerProps, contentProps, rootProps, state } = useDialog();
|
|
16
|
+
const portal = usePortal();
|
|
17
|
+
|
|
18
|
+
const popupRef = React.useRef<HTMLDivElement>(null);
|
|
19
|
+
const popupMotion = useMotion({
|
|
20
|
+
name: 'p-dialog',
|
|
21
|
+
appear: true,
|
|
22
|
+
elementRef: popupRef,
|
|
23
|
+
visible: state.open,
|
|
24
|
+
enterFromClassName: 'opacity-0 scale-75',
|
|
25
|
+
enterActiveClassName: 'transition-[opacity,transform] duration-150 ease-out',
|
|
26
|
+
enterToClassName: 'opacity-100 scale-100',
|
|
27
|
+
leaveFromClassName: 'opacity-100 scale-100',
|
|
28
|
+
leaveActiveClassName: 'transition-[opacity,transform] duration-150 ease-out',
|
|
29
|
+
leaveToClassName: 'opacity-0 scale-75'
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
const backdropRef = React.useRef<HTMLDivElement>(null);
|
|
33
|
+
const backdropMotion = useMotion({
|
|
34
|
+
elementRef: backdropRef,
|
|
35
|
+
visible: state.open,
|
|
36
|
+
enterFromClassName: 'opacity-0',
|
|
37
|
+
enterActiveClassName: 'transition-opacity duration-150',
|
|
38
|
+
enterToClassName: 'opacity-100',
|
|
39
|
+
leaveFromClassName: 'opacity-100',
|
|
40
|
+
leaveActiveClassName: 'transition-opacity duration-150',
|
|
41
|
+
leaveToClassName: 'opacity-0'
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
return (
|
|
45
|
+
<div {...rootProps} className="flex justify-center">
|
|
46
|
+
<button
|
|
47
|
+
{...triggerProps}
|
|
48
|
+
className="px-4 py-2 bg-primary text-primary-contrast rounded-lg cursor-pointer font-medium text-sm focus-visible:outline focus-visible:outline-1 focus-visible:outline-offset-2 focus-visible:outline-primary transition hover:bg-primary-emphasis"
|
|
49
|
+
>
|
|
50
|
+
Edit Profile
|
|
51
|
+
</button>
|
|
52
|
+
|
|
53
|
+
{portal.state.mounted &&
|
|
54
|
+
popupMotion.state.rendered &&
|
|
55
|
+
createPortal(
|
|
56
|
+
<div className="fixed inset-0 z-1100">
|
|
57
|
+
{backdropMotion.state.rendered && <div {...backdropProps} ref={backdropRef} className="fixed inset-0 bg-black/50" />}
|
|
58
|
+
<div {...positionerProps} className="fixed inset-0 flex items-center justify-center p-8 pointer-events-none">
|
|
59
|
+
{popupMotion.state.rendered && (
|
|
60
|
+
<div
|
|
61
|
+
{...popupProps}
|
|
62
|
+
ref={popupRef}
|
|
63
|
+
className="w-[28rem] max-w-[90vw] max-h-full bg-surface-0 dark:bg-surface-900 rounded-xl shadow-2xl flex flex-col border border-surface-200 dark:border-surface-700 pointer-events-auto"
|
|
64
|
+
>
|
|
65
|
+
<div {...headerProps} className="flex items-center justify-between p-5">
|
|
66
|
+
<span className="text-lg font-semibold">Edit Profile</span>
|
|
67
|
+
<button
|
|
68
|
+
{...closeProps}
|
|
69
|
+
className="inline-flex items-center justify-center w-8 h-8 rounded-full cursor-pointer hover:bg-surface-100 dark:hover:bg-surface-800 focus-visible:outline focus-visible:outline-1 focus-visible:outline-offset-2 focus-visible:outline-primary transition"
|
|
70
|
+
>
|
|
71
|
+
<Times />
|
|
72
|
+
</button>
|
|
73
|
+
</div>
|
|
74
|
+
<div {...contentProps} className="px-5 pb-5 flex flex-col gap-4 overflow-y-auto">
|
|
75
|
+
<div className="flex flex-col gap-1">
|
|
76
|
+
<label htmlFor="name" className="text-sm font-semibold">
|
|
77
|
+
Name
|
|
78
|
+
</label>
|
|
79
|
+
<input
|
|
80
|
+
id="name"
|
|
81
|
+
defaultValue="Amanda Miller"
|
|
82
|
+
className="w-full px-3 py-2 border border-surface-200 dark:border-surface-700 rounded-lg bg-transparent text-sm focus:outline focus:outline-1 focus:outline-primary"
|
|
83
|
+
/>
|
|
84
|
+
</div>
|
|
85
|
+
<div className="flex flex-col gap-1">
|
|
86
|
+
<label htmlFor="username" className="text-sm font-semibold">
|
|
87
|
+
Username
|
|
88
|
+
</label>
|
|
89
|
+
<input
|
|
90
|
+
id="username"
|
|
91
|
+
defaultValue="@amandamiller"
|
|
92
|
+
className="w-full px-3 py-2 border border-surface-200 dark:border-surface-700 rounded-lg bg-transparent text-sm focus:outline focus:outline-1 focus:outline-primary"
|
|
93
|
+
/>
|
|
94
|
+
</div>
|
|
95
|
+
<div className="flex flex-col gap-1">
|
|
96
|
+
<label htmlFor="email" className="text-sm font-semibold">
|
|
97
|
+
Email
|
|
98
|
+
</label>
|
|
99
|
+
<input
|
|
100
|
+
id="email"
|
|
101
|
+
defaultValue="amanda@example.com"
|
|
102
|
+
className="w-full px-3 py-2 border border-surface-200 dark:border-surface-700 rounded-lg bg-transparent text-sm focus:outline focus:outline-1 focus:outline-primary"
|
|
103
|
+
/>
|
|
104
|
+
</div>
|
|
105
|
+
<div className="flex justify-end gap-2 mt-2">
|
|
106
|
+
<button
|
|
107
|
+
{...closeProps}
|
|
108
|
+
className="px-4 py-2 rounded-lg border border-surface-200 dark:border-surface-700 bg-transparent text-sm font-medium cursor-pointer hover:bg-surface-50 dark:hover:bg-surface-800 focus-visible:outline focus-visible:outline-1 focus-visible:outline-offset-2 focus-visible:outline-primary transition"
|
|
109
|
+
>
|
|
110
|
+
Cancel
|
|
111
|
+
</button>
|
|
112
|
+
<button
|
|
113
|
+
{...closeProps}
|
|
114
|
+
className="px-4 py-2 rounded-lg bg-primary text-primary-contrast text-sm font-medium cursor-pointer hover:bg-primary-emphasis focus-visible:outline focus-visible:outline-1 focus-visible:outline-offset-2 focus-visible:outline-primary transition"
|
|
115
|
+
>
|
|
116
|
+
Save Changes
|
|
117
|
+
</button>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
</div>
|
|
121
|
+
)}
|
|
122
|
+
</div>
|
|
123
|
+
</div>,
|
|
124
|
+
document.body
|
|
125
|
+
)}
|
|
126
|
+
</div>
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Usage
|
|
132
|
+
|
|
133
|
+
```tsx
|
|
134
|
+
import { useMotion } from '@primereact/core/motion';
|
|
135
|
+
import { useDialog } from '@primereact/headless/dialog';
|
|
136
|
+
import { usePortal } from '@primereact/headless/portal';
|
|
137
|
+
import * as React from 'react';
|
|
138
|
+
import { createPortal } from 'react-dom';
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
```tsx
|
|
142
|
+
const { rootProps, triggerProps, backdropProps, positionerProps, popupProps, closeProps, headerProps, contentProps, maximizableProps, state } = useDialog();
|
|
143
|
+
const portal = usePortal();
|
|
144
|
+
|
|
145
|
+
<div {...rootProps}>
|
|
146
|
+
<button {...triggerProps}></button>
|
|
147
|
+
{portal.state.mounted &&
|
|
148
|
+
createPortal(
|
|
149
|
+
<>
|
|
150
|
+
<div {...backdropProps} />
|
|
151
|
+
<div {...positionerProps}>
|
|
152
|
+
<div {...popupProps}>
|
|
153
|
+
<div {...headerProps}>
|
|
154
|
+
<button {...maximizableProps}></button>
|
|
155
|
+
<button {...closeProps}></button>
|
|
156
|
+
</div>
|
|
157
|
+
<div {...contentProps}></div>
|
|
158
|
+
</div>
|
|
159
|
+
</div>
|
|
160
|
+
</>,
|
|
161
|
+
document.body
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
`useDialog` manages open/close state, focus trapping, dragging, scroll locking, and z-index layering. See [Primitive](/docs/primitive/components/dialog) for a component-based API.
|
|
165
|
+
|
|
166
|
+
## Features
|
|
167
|
+
|
|
168
|
+
- **Open/close lifecycle**, controlled or uncontrolled visibility with backdrop dismissal, escape handling, and return-focus on close
|
|
169
|
+
- **Focus management**, automatic focus trap that moves focus into the dialog on open and restores it to the trigger on close
|
|
170
|
+
- **Positioning and layout**, nine preset positions, `inside`/`outside` scroll behavior, and full-screen/maximizable rendering
|
|
171
|
+
- **Dragging**, opt-in drag support wired through the header element for repositioning the popup
|
|
172
|
+
- **Scroll and layering**, body scroll lock plus `baseZIndex`/`autoZIndex` coordination with other overlays
|
|
173
|
+
- **Imperative controls**, `close()` and `toggleMaximized()` for programmatic control alongside `state.open` and `state.maximized`
|
|
174
|
+
|
|
175
|
+
## Working with callbacks
|
|
176
|
+
|
|
177
|
+
### Controlled open state
|
|
178
|
+
|
|
179
|
+
Pass `open` and `onOpenChange` to drive visibility from external state.
|
|
180
|
+
|
|
181
|
+
```tsx
|
|
182
|
+
const [isOpen, setIsOpen] = React.useState(false);
|
|
183
|
+
|
|
184
|
+
const dialog = useDialog({
|
|
185
|
+
open: isOpen,
|
|
186
|
+
onOpenChange: (e) => setIsOpen(e.value)
|
|
187
|
+
});
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Draggable header
|
|
191
|
+
|
|
192
|
+
Enable drag support and spread `headerProps` on the element that should initiate the drag.
|
|
193
|
+
|
|
194
|
+
```tsx
|
|
195
|
+
const dialog = useDialog({ draggable: true });
|
|
196
|
+
|
|
197
|
+
<div {...dialog.popupProps}>
|
|
198
|
+
<div {...dialog.headerProps}>Drag me</div>
|
|
199
|
+
</div>;
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Outside vs inside scrolling
|
|
203
|
+
|
|
204
|
+
Switch `scrollBehavior` to `outside` when the entire dialog should scroll as one unit instead of only the content region.
|
|
205
|
+
|
|
206
|
+
```tsx
|
|
207
|
+
const dialog = useDialog({ scrollBehavior: 'outside' });
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Maximizable toggle
|
|
211
|
+
|
|
212
|
+
`toggleMaximized()` switches between normal and full-screen. Pair it with `state.maximized` to swap icons on the maximize button.
|
|
213
|
+
|
|
214
|
+
```tsx
|
|
215
|
+
const dialog = useDialog({ fullScreen: false });
|
|
216
|
+
|
|
217
|
+
<button {...dialog.maximizableProps} onClick={dialog.toggleMaximized}>
|
|
218
|
+
{dialog.state.maximized ? <MinimizeIcon /> : <MaximizeIcon />}
|
|
219
|
+
</button>;
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Overlay layering
|
|
223
|
+
|
|
224
|
+
Combine `baseZIndex` with `autoZIndex` when stacking dialogs on top of other overlays so each new dialog renders above the previous one.
|
|
225
|
+
|
|
226
|
+
```tsx
|
|
227
|
+
const dialog = useDialog({ baseZIndex: 1000, autoZIndex: true });
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
## Styling with data attributes
|
|
231
|
+
|
|
232
|
+
The hook exposes state through `data-*` attributes on each part. Use them as CSS selectors, no className juggling.
|
|
233
|
+
|
|
234
|
+
| Scope | Part | States |
|
|
235
|
+
| -------- | ------------- | -------------------------------------------- |
|
|
236
|
+
| `dialog` | `root` | `data-open`, `data-closed` |
|
|
237
|
+
| `dialog` | `popup` | `data-open`, `data-closed`, `data-maximized` |
|
|
238
|
+
| `dialog` | `positioner` | `data-position`, `data-scroll-behavior` |
|
|
239
|
+
| `dialog` | `maximizable` | `data-maximized`, `data-minimized` |
|
|
240
|
+
|
|
241
|
+
```css
|
|
242
|
+
[data-scope='dialog'][data-part='positioner'] {
|
|
243
|
+
position: fixed;
|
|
244
|
+
inset: 0;
|
|
245
|
+
display: flex;
|
|
246
|
+
align-items: center;
|
|
247
|
+
justify-content: center;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
[data-scope='dialog'][data-part='positioner'][data-position='top'] {
|
|
251
|
+
align-items: flex-start;
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
[data-scope='dialog'][data-part='positioner'][data-scroll-behavior='outside'] {
|
|
255
|
+
overflow: auto;
|
|
256
|
+
align-items: flex-start;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
[data-scope='dialog'][data-part='popup'][data-maximized] {
|
|
260
|
+
width: 100vw;
|
|
261
|
+
height: 100vh;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
[data-scope='dialog'][data-part='maximizable'][data-maximized] .maximize-icon {
|
|
265
|
+
display: none;
|
|
266
|
+
}
|
|
267
|
+
[data-scope='dialog'][data-part='maximizable'][data-minimized] .minimize-icon {
|
|
268
|
+
display: none;
|
|
269
|
+
}
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
## API
|
|
273
|
+
|
|
274
|
+
### useDialog
|
|
275
|
+
|
|
276
|
+
<DocTable name="useDialog" category="api" />
|
|
277
|
+
|
|
278
|
+
## Accessibility
|
|
279
|
+
|
|
280
|
+
Escape closes the dialog when closeOnEscape is enabled, Tab cycles focus inside the dialog via focus trap, and focus returns to the trigger on close. See [Primitive](/docs/primitive/components/dialog#accessibility) for full WAI-ARIA compliance details.
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "useDivider",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/usedivider.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "The useDivider manages the state and functionality of a divider component.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"UseDividerProps": {
|
|
9
|
+
"description": "Defines valid properties in useDivider.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "align",
|
|
14
|
+
"type": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\"",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Alignment of the content."
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "orientation",
|
|
20
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
21
|
+
"default": "horizontal",
|
|
22
|
+
"description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'."
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "type",
|
|
26
|
+
"type": "\"solid\" | \"dashed\" | \"dotted\"",
|
|
27
|
+
"default": "solid",
|
|
28
|
+
"description": "Border style type."
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"methods": []
|
|
32
|
+
},
|
|
33
|
+
"UseDividerState": {
|
|
34
|
+
"description": "Defines valid state in useDivider.",
|
|
35
|
+
"relatedProp": "",
|
|
36
|
+
"props": [],
|
|
37
|
+
"methods": []
|
|
38
|
+
},
|
|
39
|
+
"UseDividerRootProps": {
|
|
40
|
+
"description": "Data attribute props for the Divider root element.",
|
|
41
|
+
"relatedProp": "",
|
|
42
|
+
"props": [
|
|
43
|
+
{
|
|
44
|
+
"name": "data-scope",
|
|
45
|
+
"type": "string",
|
|
46
|
+
"default": "",
|
|
47
|
+
"description": "Component scope identifier."
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "data-part",
|
|
51
|
+
"type": "string",
|
|
52
|
+
"default": "",
|
|
53
|
+
"description": "Component part identifier."
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "role",
|
|
57
|
+
"type": "\"separator\"",
|
|
58
|
+
"default": "",
|
|
59
|
+
"description": "ARIA separator role."
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"name": "aria-orientation",
|
|
63
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
64
|
+
"default": "",
|
|
65
|
+
"description": "ARIA orientation reflecting the `orientation` prop."
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "data-orientation",
|
|
69
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
70
|
+
"default": "",
|
|
71
|
+
"description": "Reflects the `orientation` prop for CSS targeting."
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "data-align",
|
|
75
|
+
"type": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\"",
|
|
76
|
+
"default": "",
|
|
77
|
+
"description": "Reflects the `align` prop for CSS targeting."
|
|
78
|
+
}
|
|
79
|
+
],
|
|
80
|
+
"methods": []
|
|
81
|
+
},
|
|
82
|
+
"UseDividerContentProps": {
|
|
83
|
+
"description": "Data attribute props for the Divider content element.",
|
|
84
|
+
"relatedProp": "",
|
|
85
|
+
"props": [
|
|
86
|
+
{
|
|
87
|
+
"name": "data-scope",
|
|
88
|
+
"type": "string",
|
|
89
|
+
"default": "",
|
|
90
|
+
"description": "Component scope identifier."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "data-part",
|
|
94
|
+
"type": "string",
|
|
95
|
+
"default": "",
|
|
96
|
+
"description": "Component part identifier."
|
|
97
|
+
}
|
|
98
|
+
],
|
|
99
|
+
"methods": []
|
|
100
|
+
},
|
|
101
|
+
"UseDividerExposes": {
|
|
102
|
+
"description": "Defines the methods and properties exposed by useDivider.",
|
|
103
|
+
"relatedProp": "",
|
|
104
|
+
"props": [
|
|
105
|
+
{
|
|
106
|
+
"name": "rootProps",
|
|
107
|
+
"type": "UseDividerRootProps",
|
|
108
|
+
"default": "",
|
|
109
|
+
"description": "Pre-built data attribute props for the root element.\nIncludes role, aria-orientation, data-orientation, data-align."
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "contentProps",
|
|
113
|
+
"type": "UseDividerContentProps",
|
|
114
|
+
"default": "",
|
|
115
|
+
"description": "Pre-built data attribute props for the content element.\nRendered only when the consumer passes children."
|
|
116
|
+
}
|
|
117
|
+
],
|
|
118
|
+
"methods": []
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
"types": {
|
|
122
|
+
"UseDividerInstance": {
|
|
123
|
+
"description": "Instance of useDivider headless.",
|
|
124
|
+
"values": "HeadlessInstance<UseDividerProps, UseDividerState, UseDividerExposes>"
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"variables": {}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
]
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# useDivider
|
|
2
|
+
|
|
3
|
+
Headless hook for building content separators with custom markup.
|
|
4
|
+
|
|
5
|
+
```tsx
|
|
6
|
+
'use client';
|
|
7
|
+
import { useDivider } from '@primereact/headless/divider';
|
|
8
|
+
|
|
9
|
+
export default function BasicDemo() {
|
|
10
|
+
const { rootProps } = useDivider();
|
|
11
|
+
|
|
12
|
+
return (
|
|
13
|
+
<div className="max-w-md mx-auto space-y-4">
|
|
14
|
+
<p className="text-sm mb-4!">Fast setup, no credit card required.</p>
|
|
15
|
+
<div {...rootProps} role="separator" className="border-t border-surface-200 dark:border-surface-700" />
|
|
16
|
+
<p className="text-sm">Cancel anytime from your account.</p>
|
|
17
|
+
</div>
|
|
18
|
+
);
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import { useDivider } from '@primereact/headless/divider';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
const { rootProps } = useDivider({ orientation: 'horizontal' });
|
|
30
|
+
|
|
31
|
+
return <div {...rootProps} role="separator" />;
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
`useDivider` returns spread-ready `rootProps` with orientation and alignment data attributes so you can style horizontal and vertical separators with pure CSS. See [Primitive](/docs/primitive/components/divider) for a component-based API.
|
|
35
|
+
|
|
36
|
+
## Features
|
|
37
|
+
|
|
38
|
+
- **Orientation awareness**, `orientation` drives both `aria-orientation` and `data-orientation` on the root
|
|
39
|
+
- **Alignment data**, `align` writes a `data-align` attribute you can target from CSS for content placement
|
|
40
|
+
- **Stateless**, no internal state or effects; markup and styling are entirely yours
|
|
41
|
+
- **Markup-agnostic**, works with any block element that accepts standard props
|
|
42
|
+
|
|
43
|
+
## Working with callbacks
|
|
44
|
+
|
|
45
|
+
### Vertical separator
|
|
46
|
+
|
|
47
|
+
Switch `orientation` to `"vertical"` when separating inline content such as toolbar items.
|
|
48
|
+
|
|
49
|
+
```tsx
|
|
50
|
+
const { rootProps } = useDivider({ orientation: 'vertical' });
|
|
51
|
+
|
|
52
|
+
<div {...rootProps} role="separator" />;
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Divider with label
|
|
56
|
+
|
|
57
|
+
Provide `align` to position label content inside the divider, then render the text as a child.
|
|
58
|
+
|
|
59
|
+
```tsx
|
|
60
|
+
const { rootProps } = useDivider({ align: 'center' });
|
|
61
|
+
|
|
62
|
+
<div {...rootProps} role="separator">
|
|
63
|
+
<span>OR</span>
|
|
64
|
+
</div>;
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Styling with data attributes
|
|
68
|
+
|
|
69
|
+
Use `data-orientation` and `data-align` to branch styles without conditional class logic.
|
|
70
|
+
|
|
71
|
+
```css
|
|
72
|
+
[data-scope='divider'][data-part='root'] {
|
|
73
|
+
border-top: 1px solid #e5e7eb;
|
|
74
|
+
}
|
|
75
|
+
[data-scope='divider'][data-orientation='vertical'] {
|
|
76
|
+
width: 1px;
|
|
77
|
+
align-self: stretch;
|
|
78
|
+
}
|
|
79
|
+
[data-scope='divider'][data-align='center'] {
|
|
80
|
+
text-align: center;
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## API
|
|
85
|
+
|
|
86
|
+
### useDivider
|
|
87
|
+
|
|
88
|
+
<DocTable name="useDivider" category="api" />
|
|
89
|
+
|
|
90
|
+
## Accessibility
|
|
91
|
+
|
|
92
|
+
Announced as a separator via the ARIA role, otherwise non-interactive. See [Primitive](/docs/primitive/components/divider#accessibility) for full WAI-ARIA compliance details.
|