@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,3836 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "MenuArrow",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/menuarrow.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "MenuArrow is a component that displays an arrow pointing to the anchor element.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"MenuArrowPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of MenuArrow component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "MenuArrowPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"MenuArrowProps": {
|
|
22
|
+
"description": "Defines valid properties in MenuArrow component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<MenuArrowInstance, unknown, MenuArrowPassThrough>",
|
|
25
|
+
"props": [
|
|
26
|
+
{
|
|
27
|
+
"name": "ref",
|
|
28
|
+
"type": "Ref<unknown>",
|
|
29
|
+
"default": "",
|
|
30
|
+
"description": "The reference to the component instance."
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "pIf",
|
|
34
|
+
"type": "boolean",
|
|
35
|
+
"default": "true",
|
|
36
|
+
"description": "Whether the component should be rendered."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "style",
|
|
40
|
+
"type": "CSSProperties | ((instance?: MenuArrowInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: MenuArrowInstance) => string)",
|
|
47
|
+
"default": "",
|
|
48
|
+
"description": "The class name to apply to the component."
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "as",
|
|
52
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
53
|
+
"default": "",
|
|
54
|
+
"description": "The component type to render."
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "asChild",
|
|
58
|
+
"type": "boolean",
|
|
59
|
+
"default": "false",
|
|
60
|
+
"description": "Whether the component should be rendered as a child component."
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "instance",
|
|
64
|
+
"type": "MenuArrowInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<MenuArrowPassThrough>",
|
|
71
|
+
"default": "",
|
|
72
|
+
"description": "The pass-through props to pass to the component."
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "ptOptions",
|
|
76
|
+
"type": "PassThroughOptions",
|
|
77
|
+
"default": "",
|
|
78
|
+
"description": "The pass-through options to pass to the component."
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "unstyled",
|
|
82
|
+
"type": "boolean",
|
|
83
|
+
"default": "",
|
|
84
|
+
"description": "Whether the component should be rendered without classes."
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "dt",
|
|
88
|
+
"type": "unknown",
|
|
89
|
+
"default": "",
|
|
90
|
+
"description": "The design token to use for the component."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "styles",
|
|
94
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
95
|
+
"default": "",
|
|
96
|
+
"description": "The styles to use for the component."
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "render",
|
|
100
|
+
"type": "(instance: MenuArrowInstance) => ReactNode",
|
|
101
|
+
"default": "",
|
|
102
|
+
"description": "The render function to render the component with instance access."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "children",
|
|
106
|
+
"type": "any",
|
|
107
|
+
"default": "",
|
|
108
|
+
"description": "The children to render.\n\nAccepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access.\nTyped as `any` to avoid JSX type errors when used directly in templates."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "[key: string]",
|
|
112
|
+
"type": "any",
|
|
113
|
+
"description": ""
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "pt-{optionName}-*",
|
|
117
|
+
"type": "-",
|
|
118
|
+
"default": "",
|
|
119
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
120
|
+
"deprecated": false
|
|
121
|
+
}
|
|
122
|
+
],
|
|
123
|
+
"methods": []
|
|
124
|
+
},
|
|
125
|
+
"MenuArrowState": {
|
|
126
|
+
"description": "Defines valid state in MenuArrow component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"MenuArrowExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by MenuArrow component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "menu",
|
|
137
|
+
"type": "MenuRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Menu component instance."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"MenuArrowPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in MenuArrow component.",
|
|
148
|
+
"values": "PassThroughType<MenuArrowInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"MenuArrowInstance": {
|
|
151
|
+
"description": "Instance of MenuArrow component.",
|
|
152
|
+
"values": "ComponentInstance<MenuArrowProps, MenuArrowState, MenuArrowExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "MenuCheckboxItem",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/menucheckboxitem.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "MenuCheckboxItem is a checkable menu item managed by useCheckbox.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"MenuCheckboxItemPassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of MenuCheckboxItem component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "MenuCheckboxItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"MenuCheckboxItemCheckedChangeEvent": {
|
|
178
|
+
"description": "Event fired when the checkbox item's checked state changes.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "UseCheckboxChangeEvent<React.SyntheticEvent>",
|
|
181
|
+
"props": [
|
|
182
|
+
{
|
|
183
|
+
"name": "originalEvent",
|
|
184
|
+
"type": "SyntheticEvent",
|
|
185
|
+
"default": "",
|
|
186
|
+
"description": "The original event that triggered the change."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "checked",
|
|
190
|
+
"type": "boolean",
|
|
191
|
+
"default": "",
|
|
192
|
+
"description": "The checked state of the checkbox."
|
|
193
|
+
}
|
|
194
|
+
],
|
|
195
|
+
"methods": []
|
|
196
|
+
},
|
|
197
|
+
"MenuCheckboxItemProps": {
|
|
198
|
+
"description": "Defines valid properties in MenuCheckboxItem component.",
|
|
199
|
+
"relatedProp": "",
|
|
200
|
+
"extendedTypes": "BaseComponentProps<MenuCheckboxItemInstance, Omit<UseCheckboxProps, \"onCheckedChange\">, MenuCheckboxItemPassThrough>",
|
|
201
|
+
"props": [
|
|
202
|
+
{
|
|
203
|
+
"name": "ref",
|
|
204
|
+
"type": "Ref<unknown>",
|
|
205
|
+
"default": "",
|
|
206
|
+
"description": "The reference to the component instance."
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "pIf",
|
|
210
|
+
"type": "boolean",
|
|
211
|
+
"default": "true",
|
|
212
|
+
"description": "Whether the component should be rendered."
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "style",
|
|
216
|
+
"type": "CSSProperties | ((instance?: MenuCheckboxItemInstance) => CSSProperties)",
|
|
217
|
+
"default": "",
|
|
218
|
+
"description": "The style to apply to the component."
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "className",
|
|
222
|
+
"type": "string | ((instance?: MenuCheckboxItemInstance) => string)",
|
|
223
|
+
"default": "",
|
|
224
|
+
"description": "The class name to apply to the component."
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "as",
|
|
228
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
229
|
+
"default": "",
|
|
230
|
+
"description": "The component type to render."
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "asChild",
|
|
234
|
+
"type": "boolean",
|
|
235
|
+
"default": "false",
|
|
236
|
+
"description": "Whether the component should be rendered as a child component."
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "instance",
|
|
240
|
+
"type": "MenuCheckboxItemInstance",
|
|
241
|
+
"default": "",
|
|
242
|
+
"description": "The instance to pass to the component."
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"name": "pt",
|
|
246
|
+
"type": "SafeRecord<MenuCheckboxItemPassThrough>",
|
|
247
|
+
"default": "",
|
|
248
|
+
"description": "The pass-through props to pass to the component."
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "ptOptions",
|
|
252
|
+
"type": "PassThroughOptions",
|
|
253
|
+
"default": "",
|
|
254
|
+
"description": "The pass-through options to pass to the component."
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "unstyled",
|
|
258
|
+
"type": "boolean",
|
|
259
|
+
"default": "",
|
|
260
|
+
"description": "Whether the component should be rendered without classes."
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "dt",
|
|
264
|
+
"type": "unknown",
|
|
265
|
+
"default": "",
|
|
266
|
+
"description": "The design token to use for the component."
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "styles",
|
|
270
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
271
|
+
"default": "",
|
|
272
|
+
"description": "The styles to use for the component."
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "render",
|
|
276
|
+
"type": "(instance: MenuCheckboxItemInstance) => ReactNode",
|
|
277
|
+
"default": "",
|
|
278
|
+
"description": "The render function to render the component with instance access."
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "children",
|
|
282
|
+
"type": "any",
|
|
283
|
+
"default": "",
|
|
284
|
+
"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."
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "checked",
|
|
288
|
+
"type": "boolean",
|
|
289
|
+
"default": "",
|
|
290
|
+
"description": "When present, it specifies the input's checked state."
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"name": "defaultChecked",
|
|
294
|
+
"type": "boolean",
|
|
295
|
+
"default": "",
|
|
296
|
+
"description": "The default value for the input when not controlled by `checked` and `onCheckedChange` ."
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"name": "inputId",
|
|
300
|
+
"type": "string",
|
|
301
|
+
"default": "",
|
|
302
|
+
"description": "Identifier of the underlying input element."
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "indeterminate",
|
|
306
|
+
"type": "boolean",
|
|
307
|
+
"default": "false",
|
|
308
|
+
"description": "When present, it specifies input state as indeterminate."
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"name": "trueValue",
|
|
312
|
+
"type": "string | number | boolean",
|
|
313
|
+
"default": "true",
|
|
314
|
+
"description": "Value in checked state."
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"name": "falseValue",
|
|
318
|
+
"type": "string | number | boolean",
|
|
319
|
+
"default": "false",
|
|
320
|
+
"description": "Value in unchecked state."
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "name",
|
|
324
|
+
"type": "string",
|
|
325
|
+
"default": "",
|
|
326
|
+
"description": "The name attribute of the input, resolved from group context if available."
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "readOnly",
|
|
330
|
+
"type": "boolean",
|
|
331
|
+
"default": "false",
|
|
332
|
+
"description": "When present, it specifies that an input field is read-only."
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "required",
|
|
336
|
+
"type": "boolean",
|
|
337
|
+
"default": "false",
|
|
338
|
+
"description": "When present, it specifies that the element is required."
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"name": "tabIndex",
|
|
342
|
+
"type": "number",
|
|
343
|
+
"default": "",
|
|
344
|
+
"description": "Tab index for keyboard navigation."
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"name": "invalid",
|
|
348
|
+
"type": "boolean",
|
|
349
|
+
"default": "false",
|
|
350
|
+
"description": "When present, it specifies that the component should have invalid state style."
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"name": "ariaLabelledby",
|
|
354
|
+
"type": "string",
|
|
355
|
+
"default": "",
|
|
356
|
+
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "ariaLabel",
|
|
360
|
+
"type": "string",
|
|
361
|
+
"default": "",
|
|
362
|
+
"description": "Establishes a string value that labels the component."
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"name": "onFocus",
|
|
366
|
+
"type": "(event: FocusEvent<HTMLInputElement>) => void",
|
|
367
|
+
"default": "",
|
|
368
|
+
"description": "Callback function that is called when the checkbox is focused."
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "onBlur",
|
|
372
|
+
"type": "(event: FocusEvent<HTMLInputElement>) => void",
|
|
373
|
+
"default": "",
|
|
374
|
+
"description": "Callback function that is called when the checkbox loses focus."
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"name": "disabled",
|
|
378
|
+
"type": "boolean",
|
|
379
|
+
"default": "",
|
|
380
|
+
"description": "When present, it specifies that the item should be disabled."
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "value",
|
|
384
|
+
"type": "unknown",
|
|
385
|
+
"default": "",
|
|
386
|
+
"description": "Semantic value that uniquely identifies this item within the menu and is forwarded to useCheckbox.\nUsed to generate a deterministic DOM id. When not provided, auto-generated."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "closeOnSelect",
|
|
390
|
+
"type": "boolean",
|
|
391
|
+
"default": "false",
|
|
392
|
+
"description": "Whether the menu should close when this checkbox item is toggled.\nDefaults to `false` for checkbox items so toggling the value keeps the\nmenu open; set explicitly to `true` to close on each toggle."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "onSelect",
|
|
396
|
+
"type": "(event: MenuItemSelectEvent) => void",
|
|
397
|
+
"default": "",
|
|
398
|
+
"description": "Callback fired when the item is activated. Calling\n `event.preventDefault()` keeps the menu open regardless of\n `closeOnSelect` ."
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "onCheckedChange",
|
|
402
|
+
"type": "(event: MenuCheckboxItemCheckedChangeEvent) => void",
|
|
403
|
+
"default": "",
|
|
404
|
+
"description": "Callback fired when the checkbox item's checked state changes."
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "[key: string]",
|
|
408
|
+
"type": "any",
|
|
409
|
+
"description": ""
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "pt-{optionName}-*",
|
|
413
|
+
"type": "-",
|
|
414
|
+
"default": "",
|
|
415
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
416
|
+
"deprecated": false
|
|
417
|
+
}
|
|
418
|
+
],
|
|
419
|
+
"methods": []
|
|
420
|
+
},
|
|
421
|
+
"MenuCheckboxItemState": {
|
|
422
|
+
"description": "Defines valid state in MenuCheckboxItem component.",
|
|
423
|
+
"relatedProp": "",
|
|
424
|
+
"props": [],
|
|
425
|
+
"methods": []
|
|
426
|
+
},
|
|
427
|
+
"MenuCheckboxItemExposes": {
|
|
428
|
+
"description": "Defines the methods and properties exposed by MenuCheckboxItem component.",
|
|
429
|
+
"relatedProp": "",
|
|
430
|
+
"extendedTypes": "UseCheckboxExposes",
|
|
431
|
+
"props": [
|
|
432
|
+
{
|
|
433
|
+
"name": "state",
|
|
434
|
+
"type": "UseCheckboxState",
|
|
435
|
+
"default": "",
|
|
436
|
+
"description": "The state of the useCheckbox."
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"name": "onChange",
|
|
440
|
+
"type": "(event: ChangeEvent<HTMLInputElement>) => void",
|
|
441
|
+
"default": "",
|
|
442
|
+
"description": "Callback fired when the useCheckbox's checked state changes."
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"name": "rootProps",
|
|
446
|
+
"type": "UseCheckboxRootProps",
|
|
447
|
+
"default": "",
|
|
448
|
+
"description": "Pre-built data attribute props for the root element.\nIncludes data-checked/unchecked, data-disabled, data-invalid, data-indeterminate."
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
"name": "inputProps",
|
|
452
|
+
"type": "UseCheckboxInputProps",
|
|
453
|
+
"default": "",
|
|
454
|
+
"description": "Pre-built props for the native input element.\nIncludes type, value, checked, ARIA attributes, and event handlers."
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"name": "boxProps",
|
|
458
|
+
"type": "UseCheckboxBoxProps",
|
|
459
|
+
"default": "",
|
|
460
|
+
"description": "Pre-built data attribute props for the box element.\nIncludes data-checked/unchecked, data-disabled, data-invalid, data-indeterminate."
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"name": "indicatorProps",
|
|
464
|
+
"type": "UseCheckboxIndicatorProps",
|
|
465
|
+
"default": "",
|
|
466
|
+
"description": "Pre-built data attribute props for the indicator element.\nIncludes data-checked/unchecked, data-indeterminate (from state), data-disabled, data-invalid."
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "menu",
|
|
470
|
+
"type": "MenuRootInstance",
|
|
471
|
+
"default": "",
|
|
472
|
+
"description": "Instance of the Menu component."
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
"name": "submenu",
|
|
476
|
+
"type": "MenuSubmenuInstance",
|
|
477
|
+
"default": "",
|
|
478
|
+
"description": "Instance of the MenuSubmenu component."
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "portal",
|
|
482
|
+
"type": "MenuPortalInstance",
|
|
483
|
+
"default": "",
|
|
484
|
+
"description": "Instance of the MenuPortal component."
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"name": "itemId",
|
|
488
|
+
"type": "string",
|
|
489
|
+
"default": "",
|
|
490
|
+
"description": "ID of the item element."
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
"name": "focused",
|
|
494
|
+
"type": "boolean",
|
|
495
|
+
"default": "",
|
|
496
|
+
"description": "Whether the item is focused or not."
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"name": "isDisabled",
|
|
500
|
+
"type": "boolean",
|
|
501
|
+
"default": "",
|
|
502
|
+
"description": "Whether the item is disabled or not."
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "checked",
|
|
506
|
+
"type": "boolean",
|
|
507
|
+
"default": "",
|
|
508
|
+
"description": "Whether the item is checked or not."
|
|
509
|
+
}
|
|
510
|
+
],
|
|
511
|
+
"methods": []
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
"types": {
|
|
515
|
+
"MenuCheckboxItemPassThroughType": {
|
|
516
|
+
"description": "Defines passthrough(pt) options type in MenuCheckboxItem component.",
|
|
517
|
+
"values": "PassThroughType<MenuCheckboxItemInstance, E>"
|
|
518
|
+
},
|
|
519
|
+
"MenuCheckboxItemInstance": {
|
|
520
|
+
"description": "Instance of MenuCheckboxItem component.",
|
|
521
|
+
"values": "ComponentInstance<MenuCheckboxItemProps, MenuCheckboxItemState, MenuCheckboxItemExposes>"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"variables": {}
|
|
525
|
+
}
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
"name": "MenuIndicator",
|
|
529
|
+
"source": "apps/showcase/assets/apidoc/menuindicator.json",
|
|
530
|
+
"data": {
|
|
531
|
+
"description": "MenuIndicator is a component that conditionally renders content based on the state of the parent menu element (submenu, checkbox, or radio item).",
|
|
532
|
+
"interfaces": {
|
|
533
|
+
"MenuIndicatorPassThrough": {
|
|
534
|
+
"description": "Defines passthrough(pt) options of MenuIndicator component.",
|
|
535
|
+
"relatedProp": "",
|
|
536
|
+
"props": [
|
|
537
|
+
{
|
|
538
|
+
"name": "root",
|
|
539
|
+
"type": "MenuIndicatorPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
540
|
+
"default": "",
|
|
541
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
542
|
+
}
|
|
543
|
+
],
|
|
544
|
+
"methods": []
|
|
545
|
+
},
|
|
546
|
+
"MenuIndicatorProps": {
|
|
547
|
+
"description": "Defines valid properties in MenuIndicator component.",
|
|
548
|
+
"relatedProp": "",
|
|
549
|
+
"extendedTypes": "BaseComponentProps<MenuIndicatorInstance, unknown, MenuIndicatorPassThrough>",
|
|
550
|
+
"props": [
|
|
551
|
+
{
|
|
552
|
+
"name": "ref",
|
|
553
|
+
"type": "Ref<unknown>",
|
|
554
|
+
"default": "",
|
|
555
|
+
"description": "The reference to the component instance."
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
"name": "pIf",
|
|
559
|
+
"type": "boolean",
|
|
560
|
+
"default": "true",
|
|
561
|
+
"description": "Whether the component should be rendered."
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "style",
|
|
565
|
+
"type": "CSSProperties | ((instance?: MenuIndicatorInstance) => CSSProperties)",
|
|
566
|
+
"default": "",
|
|
567
|
+
"description": "The style to apply to the component."
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "className",
|
|
571
|
+
"type": "string | ((instance?: MenuIndicatorInstance) => string)",
|
|
572
|
+
"default": "",
|
|
573
|
+
"description": "The class name to apply to the component."
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"name": "as",
|
|
577
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
578
|
+
"default": "",
|
|
579
|
+
"description": "The component type to render."
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"name": "asChild",
|
|
583
|
+
"type": "boolean",
|
|
584
|
+
"default": "false",
|
|
585
|
+
"description": "Whether the component should be rendered as a child component."
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "instance",
|
|
589
|
+
"type": "MenuIndicatorInstance",
|
|
590
|
+
"default": "",
|
|
591
|
+
"description": "The instance to pass to the component."
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"name": "pt",
|
|
595
|
+
"type": "SafeRecord<MenuIndicatorPassThrough>",
|
|
596
|
+
"default": "",
|
|
597
|
+
"description": "The pass-through props to pass to the component."
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "ptOptions",
|
|
601
|
+
"type": "PassThroughOptions",
|
|
602
|
+
"default": "",
|
|
603
|
+
"description": "The pass-through options to pass to the component."
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"name": "unstyled",
|
|
607
|
+
"type": "boolean",
|
|
608
|
+
"default": "",
|
|
609
|
+
"description": "Whether the component should be rendered without classes."
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"name": "dt",
|
|
613
|
+
"type": "unknown",
|
|
614
|
+
"default": "",
|
|
615
|
+
"description": "The design token to use for the component."
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "styles",
|
|
619
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
620
|
+
"default": "",
|
|
621
|
+
"description": "The styles to use for the component."
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "render",
|
|
625
|
+
"type": "(instance: MenuIndicatorInstance) => ReactNode",
|
|
626
|
+
"default": "",
|
|
627
|
+
"description": "The render function to render the component with instance access."
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "children",
|
|
631
|
+
"type": "any",
|
|
632
|
+
"default": "",
|
|
633
|
+
"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."
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "match",
|
|
637
|
+
"type": "\"checked\" | \"unchecked\" | \"open\" | \"closed\"",
|
|
638
|
+
"default": "",
|
|
639
|
+
"description": "Determines the visibility of the indicator based on the state of the parent menu element. Valid values are:\n- \"open\": Indicator is visible when the submenu is expanded.\n- \"closed\": Indicator is visible when the submenu is collapsed.\n- \"checked\": Indicator is visible when the checkbox/radio item is checked.\n- \"unchecked\": Indicator is visible when the checkbox/radio item is unchecked."
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "[key: string]",
|
|
643
|
+
"type": "any",
|
|
644
|
+
"description": ""
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"name": "pt-{optionName}-*",
|
|
648
|
+
"type": "-",
|
|
649
|
+
"default": "",
|
|
650
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
651
|
+
"deprecated": false
|
|
652
|
+
}
|
|
653
|
+
],
|
|
654
|
+
"methods": []
|
|
655
|
+
},
|
|
656
|
+
"MenuIndicatorState": {
|
|
657
|
+
"description": "Defines valid state in MenuIndicator component.",
|
|
658
|
+
"relatedProp": "",
|
|
659
|
+
"props": [],
|
|
660
|
+
"methods": []
|
|
661
|
+
},
|
|
662
|
+
"MenuIndicatorExposes": {
|
|
663
|
+
"description": "Defines the methods and properties exposed by MenuIndicator component.",
|
|
664
|
+
"relatedProp": "",
|
|
665
|
+
"props": [
|
|
666
|
+
{
|
|
667
|
+
"name": "menu",
|
|
668
|
+
"type": "MenuRootInstance",
|
|
669
|
+
"default": "",
|
|
670
|
+
"description": "The Menu component instance."
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "submenu",
|
|
674
|
+
"type": "MenuSubInstance",
|
|
675
|
+
"default": "",
|
|
676
|
+
"description": "The MenuSub component instance, if inside a submenu."
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "checkboxItem",
|
|
680
|
+
"type": "MenuCheckboxItemInstance",
|
|
681
|
+
"default": "",
|
|
682
|
+
"description": "The MenuCheckboxItem component instance, if inside a checkbox menu item."
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
"name": "radioItem",
|
|
686
|
+
"type": "MenuRadioItemInstance",
|
|
687
|
+
"default": "",
|
|
688
|
+
"description": "The MenuRadioItem component instance, if inside a radio menu item."
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "active",
|
|
692
|
+
"type": "boolean",
|
|
693
|
+
"default": "",
|
|
694
|
+
"description": "Whether the indicator is in active state (open for submenu, checked for checkbox/radio)."
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"name": "indicatorType",
|
|
698
|
+
"type": "\"checkbox\" | \"radio\" | \"submenu\"",
|
|
699
|
+
"default": "",
|
|
700
|
+
"description": "The type of the parent context."
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"methods": []
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"types": {
|
|
707
|
+
"MenuIndicatorPassThroughType": {
|
|
708
|
+
"description": "Defines passthrough(pt) options type in MenuIndicator component.",
|
|
709
|
+
"values": "PassThroughType<MenuIndicatorInstance, E>"
|
|
710
|
+
},
|
|
711
|
+
"MenuIndicatorInstance": {
|
|
712
|
+
"description": "Instance of MenuIndicator component.",
|
|
713
|
+
"values": "ComponentInstance<MenuIndicatorProps, MenuIndicatorState, MenuIndicatorExposes>"
|
|
714
|
+
}
|
|
715
|
+
},
|
|
716
|
+
"variables": {}
|
|
717
|
+
}
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
"name": "MenuItem",
|
|
721
|
+
"source": "apps/showcase/assets/apidoc/menuitem.json",
|
|
722
|
+
"data": {
|
|
723
|
+
"description": "MenuItem is a pure menu item.\nFor checkable items use MenuCheckboxItem or MenuRadioItem.",
|
|
724
|
+
"interfaces": {
|
|
725
|
+
"MenuItemPassThrough": {
|
|
726
|
+
"description": "Defines passthrough(pt) options of MenuItem component.",
|
|
727
|
+
"relatedProp": "",
|
|
728
|
+
"props": [
|
|
729
|
+
{
|
|
730
|
+
"name": "root",
|
|
731
|
+
"type": "MenuItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
732
|
+
"default": "",
|
|
733
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
734
|
+
}
|
|
735
|
+
],
|
|
736
|
+
"methods": []
|
|
737
|
+
},
|
|
738
|
+
"MenuItemProps": {
|
|
739
|
+
"description": "Defines valid properties in MenuItem component.",
|
|
740
|
+
"relatedProp": "",
|
|
741
|
+
"extendedTypes": "BaseComponentProps<MenuItemInstance, unknown, MenuItemPassThrough>",
|
|
742
|
+
"props": [
|
|
743
|
+
{
|
|
744
|
+
"name": "ref",
|
|
745
|
+
"type": "Ref<unknown>",
|
|
746
|
+
"default": "",
|
|
747
|
+
"description": "The reference to the component instance."
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
"name": "pIf",
|
|
751
|
+
"type": "boolean",
|
|
752
|
+
"default": "true",
|
|
753
|
+
"description": "Whether the component should be rendered."
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
"name": "style",
|
|
757
|
+
"type": "CSSProperties | ((instance?: MenuItemInstance) => CSSProperties)",
|
|
758
|
+
"default": "",
|
|
759
|
+
"description": "The style to apply to the component."
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "className",
|
|
763
|
+
"type": "string | ((instance?: MenuItemInstance) => string)",
|
|
764
|
+
"default": "",
|
|
765
|
+
"description": "The class name to apply to the component."
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
"name": "as",
|
|
769
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
770
|
+
"default": "",
|
|
771
|
+
"description": "The component type to render."
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "asChild",
|
|
775
|
+
"type": "boolean",
|
|
776
|
+
"default": "false",
|
|
777
|
+
"description": "Whether the component should be rendered as a child component."
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"name": "instance",
|
|
781
|
+
"type": "MenuItemInstance",
|
|
782
|
+
"default": "",
|
|
783
|
+
"description": "The instance to pass to the component."
|
|
784
|
+
},
|
|
785
|
+
{
|
|
786
|
+
"name": "pt",
|
|
787
|
+
"type": "SafeRecord<MenuItemPassThrough>",
|
|
788
|
+
"default": "",
|
|
789
|
+
"description": "The pass-through props to pass to the component."
|
|
790
|
+
},
|
|
791
|
+
{
|
|
792
|
+
"name": "ptOptions",
|
|
793
|
+
"type": "PassThroughOptions",
|
|
794
|
+
"default": "",
|
|
795
|
+
"description": "The pass-through options to pass to the component."
|
|
796
|
+
},
|
|
797
|
+
{
|
|
798
|
+
"name": "unstyled",
|
|
799
|
+
"type": "boolean",
|
|
800
|
+
"default": "",
|
|
801
|
+
"description": "Whether the component should be rendered without classes."
|
|
802
|
+
},
|
|
803
|
+
{
|
|
804
|
+
"name": "dt",
|
|
805
|
+
"type": "unknown",
|
|
806
|
+
"default": "",
|
|
807
|
+
"description": "The design token to use for the component."
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "styles",
|
|
811
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
812
|
+
"default": "",
|
|
813
|
+
"description": "The styles to use for the component."
|
|
814
|
+
},
|
|
815
|
+
{
|
|
816
|
+
"name": "render",
|
|
817
|
+
"type": "(instance: MenuItemInstance) => ReactNode",
|
|
818
|
+
"default": "",
|
|
819
|
+
"description": "The render function to render the component with instance access."
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"name": "children",
|
|
823
|
+
"type": "any",
|
|
824
|
+
"default": "",
|
|
825
|
+
"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."
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
"name": "disabled",
|
|
829
|
+
"type": "boolean",
|
|
830
|
+
"default": "",
|
|
831
|
+
"description": "When present, it specifies that the item should be disabled."
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
"name": "value",
|
|
835
|
+
"type": "string",
|
|
836
|
+
"default": "",
|
|
837
|
+
"description": "Semantic value that uniquely identifies this item within the menu.\nUsed to generate a deterministic DOM id. When not provided, auto-generated."
|
|
838
|
+
},
|
|
839
|
+
{
|
|
840
|
+
"name": "closeOnSelect",
|
|
841
|
+
"type": "boolean",
|
|
842
|
+
"default": "true",
|
|
843
|
+
"description": "Whether the menu should close when this item is activated. Overrides the\n `closeOnSelect` setting on `Menu.Root` for this item only."
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"name": "onSelect",
|
|
847
|
+
"type": "(event: MenuItemSelectEvent) => void",
|
|
848
|
+
"default": "",
|
|
849
|
+
"description": "Callback fired when the item is activated (click or keyboard). Calling\n `event.preventDefault()` keeps the menu open regardless of\n `closeOnSelect` ."
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"name": "[key: string]",
|
|
853
|
+
"type": "any",
|
|
854
|
+
"description": ""
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "pt-{optionName}-*",
|
|
858
|
+
"type": "-",
|
|
859
|
+
"default": "",
|
|
860
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
861
|
+
"deprecated": false
|
|
862
|
+
}
|
|
863
|
+
],
|
|
864
|
+
"methods": []
|
|
865
|
+
},
|
|
866
|
+
"MenuItemState": {
|
|
867
|
+
"description": "Defines valid state in MenuItem component.",
|
|
868
|
+
"relatedProp": "",
|
|
869
|
+
"props": [],
|
|
870
|
+
"methods": []
|
|
871
|
+
},
|
|
872
|
+
"MenuItemExposes": {
|
|
873
|
+
"description": "Defines the methods and properties exposed by MenuItem component.",
|
|
874
|
+
"relatedProp": "",
|
|
875
|
+
"props": [
|
|
876
|
+
{
|
|
877
|
+
"name": "menu",
|
|
878
|
+
"type": "MenuRootInstance",
|
|
879
|
+
"default": "",
|
|
880
|
+
"description": "Instance of the Menu component."
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"name": "submenu",
|
|
884
|
+
"type": "MenuSubmenuInstance",
|
|
885
|
+
"default": "",
|
|
886
|
+
"description": "Instance of the MenuSubmenu component."
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"name": "portal",
|
|
890
|
+
"type": "MenuPortalInstance",
|
|
891
|
+
"default": "",
|
|
892
|
+
"description": "Instance of the MenuPortal component."
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"name": "itemId",
|
|
896
|
+
"type": "string",
|
|
897
|
+
"default": "",
|
|
898
|
+
"description": "ID of the item element."
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "focused",
|
|
902
|
+
"type": "boolean",
|
|
903
|
+
"default": "",
|
|
904
|
+
"description": "Whether the item is focused or not."
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "isDisabled",
|
|
908
|
+
"type": "boolean",
|
|
909
|
+
"default": "",
|
|
910
|
+
"description": "Whether the item is disabled or not."
|
|
911
|
+
}
|
|
912
|
+
],
|
|
913
|
+
"methods": []
|
|
914
|
+
}
|
|
915
|
+
},
|
|
916
|
+
"types": {
|
|
917
|
+
"MenuItemPassThroughType": {
|
|
918
|
+
"description": "Defines passthrough(pt) options type in MenuItem component.",
|
|
919
|
+
"values": "PassThroughType<MenuItemInstance, E>"
|
|
920
|
+
},
|
|
921
|
+
"MenuItemInstance": {
|
|
922
|
+
"description": "Instance of MenuItem component.",
|
|
923
|
+
"values": "ComponentInstance<MenuItemProps, MenuItemState, MenuItemExposes>"
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"variables": {}
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
{
|
|
930
|
+
"name": "MenuLabel",
|
|
931
|
+
"source": "apps/showcase/assets/apidoc/menulabel.json",
|
|
932
|
+
"data": {
|
|
933
|
+
"description": "MenuLabel is a component that displays label.",
|
|
934
|
+
"interfaces": {
|
|
935
|
+
"MenuLabelPassThrough": {
|
|
936
|
+
"description": "Defines passthrough(pt) options of MenuLabel component.",
|
|
937
|
+
"relatedProp": "",
|
|
938
|
+
"props": [
|
|
939
|
+
{
|
|
940
|
+
"name": "root",
|
|
941
|
+
"type": "MenuLabelPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
942
|
+
"default": "",
|
|
943
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
944
|
+
}
|
|
945
|
+
],
|
|
946
|
+
"methods": []
|
|
947
|
+
},
|
|
948
|
+
"MenuLabelProps": {
|
|
949
|
+
"description": "Defines valid properties in MenuLabel component.",
|
|
950
|
+
"relatedProp": "",
|
|
951
|
+
"extendedTypes": "BaseComponentProps<MenuLabelInstance, unknown, MenuLabelPassThrough>",
|
|
952
|
+
"props": [
|
|
953
|
+
{
|
|
954
|
+
"name": "ref",
|
|
955
|
+
"type": "Ref<unknown>",
|
|
956
|
+
"default": "",
|
|
957
|
+
"description": "The reference to the component instance."
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"name": "pIf",
|
|
961
|
+
"type": "boolean",
|
|
962
|
+
"default": "true",
|
|
963
|
+
"description": "Whether the component should be rendered."
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "style",
|
|
967
|
+
"type": "CSSProperties | ((instance?: MenuLabelInstance) => CSSProperties)",
|
|
968
|
+
"default": "",
|
|
969
|
+
"description": "The style to apply to the component."
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "className",
|
|
973
|
+
"type": "string | ((instance?: MenuLabelInstance) => string)",
|
|
974
|
+
"default": "",
|
|
975
|
+
"description": "The class name to apply to the component."
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "as",
|
|
979
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
980
|
+
"default": "",
|
|
981
|
+
"description": "The component type to render."
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "asChild",
|
|
985
|
+
"type": "boolean",
|
|
986
|
+
"default": "false",
|
|
987
|
+
"description": "Whether the component should be rendered as a child component."
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"name": "instance",
|
|
991
|
+
"type": "MenuLabelInstance",
|
|
992
|
+
"default": "",
|
|
993
|
+
"description": "The instance to pass to the component."
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
"name": "pt",
|
|
997
|
+
"type": "SafeRecord<MenuLabelPassThrough>",
|
|
998
|
+
"default": "",
|
|
999
|
+
"description": "The pass-through props to pass to the component."
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
"name": "ptOptions",
|
|
1003
|
+
"type": "PassThroughOptions",
|
|
1004
|
+
"default": "",
|
|
1005
|
+
"description": "The pass-through options to pass to the component."
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"name": "unstyled",
|
|
1009
|
+
"type": "boolean",
|
|
1010
|
+
"default": "",
|
|
1011
|
+
"description": "Whether the component should be rendered without classes."
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"name": "dt",
|
|
1015
|
+
"type": "unknown",
|
|
1016
|
+
"default": "",
|
|
1017
|
+
"description": "The design token to use for the component."
|
|
1018
|
+
},
|
|
1019
|
+
{
|
|
1020
|
+
"name": "styles",
|
|
1021
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1022
|
+
"default": "",
|
|
1023
|
+
"description": "The styles to use for the component."
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"name": "render",
|
|
1027
|
+
"type": "(instance: MenuLabelInstance) => ReactNode",
|
|
1028
|
+
"default": "",
|
|
1029
|
+
"description": "The render function to render the component with instance access."
|
|
1030
|
+
},
|
|
1031
|
+
{
|
|
1032
|
+
"name": "children",
|
|
1033
|
+
"type": "any",
|
|
1034
|
+
"default": "",
|
|
1035
|
+
"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."
|
|
1036
|
+
},
|
|
1037
|
+
{
|
|
1038
|
+
"name": "[key: string]",
|
|
1039
|
+
"type": "any",
|
|
1040
|
+
"description": ""
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "pt-{optionName}-*",
|
|
1044
|
+
"type": "-",
|
|
1045
|
+
"default": "",
|
|
1046
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1047
|
+
"deprecated": false
|
|
1048
|
+
}
|
|
1049
|
+
],
|
|
1050
|
+
"methods": []
|
|
1051
|
+
},
|
|
1052
|
+
"MenuLabelState": {
|
|
1053
|
+
"description": "Defines valid state in MenuLabel component.",
|
|
1054
|
+
"relatedProp": "",
|
|
1055
|
+
"props": [],
|
|
1056
|
+
"methods": []
|
|
1057
|
+
},
|
|
1058
|
+
"MenuLabelExposes": {
|
|
1059
|
+
"description": "Defines the methods and properties exposed by MenuLabel component.",
|
|
1060
|
+
"relatedProp": "",
|
|
1061
|
+
"props": [
|
|
1062
|
+
{
|
|
1063
|
+
"name": "menu",
|
|
1064
|
+
"type": "MenuRootInstance",
|
|
1065
|
+
"default": "",
|
|
1066
|
+
"description": "Instance of the Menu component."
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "group",
|
|
1070
|
+
"type": "MenuGroupContextInterface",
|
|
1071
|
+
"default": "",
|
|
1072
|
+
"description": "Parent MenuGroup context, when this label is rendered inside a Menu.Group."
|
|
1073
|
+
}
|
|
1074
|
+
],
|
|
1075
|
+
"methods": []
|
|
1076
|
+
}
|
|
1077
|
+
},
|
|
1078
|
+
"types": {
|
|
1079
|
+
"MenuLabelPassThroughType": {
|
|
1080
|
+
"description": "Defines passthrough(pt) options type in MenuLabel component.",
|
|
1081
|
+
"values": "PassThroughType<MenuLabelInstance, E>"
|
|
1082
|
+
},
|
|
1083
|
+
"MenuLabelInstance": {
|
|
1084
|
+
"description": "Instance of MenuLabel component.",
|
|
1085
|
+
"values": "ComponentInstance<MenuLabelProps, MenuLabelState, MenuLabelExposes>"
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1088
|
+
"variables": {}
|
|
1089
|
+
}
|
|
1090
|
+
},
|
|
1091
|
+
{
|
|
1092
|
+
"name": "MenuList",
|
|
1093
|
+
"source": "apps/showcase/assets/apidoc/menulist.json",
|
|
1094
|
+
"data": {
|
|
1095
|
+
"description": "MenuList is a component that displays a list.",
|
|
1096
|
+
"interfaces": {
|
|
1097
|
+
"MenuListPassThrough": {
|
|
1098
|
+
"description": "Defines passthrough(pt) options of MenuList component.",
|
|
1099
|
+
"relatedProp": "",
|
|
1100
|
+
"props": [
|
|
1101
|
+
{
|
|
1102
|
+
"name": "root",
|
|
1103
|
+
"type": "MenuListPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1104
|
+
"default": "",
|
|
1105
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"name": "content",
|
|
1109
|
+
"type": "MenuListPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1110
|
+
"default": "",
|
|
1111
|
+
"description": "Used to pass attributes to the content's DOM element."
|
|
1112
|
+
}
|
|
1113
|
+
],
|
|
1114
|
+
"methods": []
|
|
1115
|
+
},
|
|
1116
|
+
"MenuListProps": {
|
|
1117
|
+
"description": "Defines valid properties in MenuList component.",
|
|
1118
|
+
"relatedProp": "",
|
|
1119
|
+
"extendedTypes": "BaseComponentProps<MenuListInstance, unknown, MenuListPassThrough>",
|
|
1120
|
+
"props": [
|
|
1121
|
+
{
|
|
1122
|
+
"name": "ref",
|
|
1123
|
+
"type": "Ref<unknown>",
|
|
1124
|
+
"default": "",
|
|
1125
|
+
"description": "The reference to the component instance."
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "pIf",
|
|
1129
|
+
"type": "boolean",
|
|
1130
|
+
"default": "true",
|
|
1131
|
+
"description": "Whether the component should be rendered."
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"name": "style",
|
|
1135
|
+
"type": "CSSProperties | ((instance?: MenuListInstance) => CSSProperties)",
|
|
1136
|
+
"default": "",
|
|
1137
|
+
"description": "The style to apply to the component."
|
|
1138
|
+
},
|
|
1139
|
+
{
|
|
1140
|
+
"name": "className",
|
|
1141
|
+
"type": "string | ((instance?: MenuListInstance) => string)",
|
|
1142
|
+
"default": "",
|
|
1143
|
+
"description": "The class name to apply to the component."
|
|
1144
|
+
},
|
|
1145
|
+
{
|
|
1146
|
+
"name": "as",
|
|
1147
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1148
|
+
"default": "",
|
|
1149
|
+
"description": "The component type to render."
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
"name": "asChild",
|
|
1153
|
+
"type": "boolean",
|
|
1154
|
+
"default": "false",
|
|
1155
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"name": "instance",
|
|
1159
|
+
"type": "MenuListInstance",
|
|
1160
|
+
"default": "",
|
|
1161
|
+
"description": "The instance to pass to the component."
|
|
1162
|
+
},
|
|
1163
|
+
{
|
|
1164
|
+
"name": "pt",
|
|
1165
|
+
"type": "SafeRecord<MenuListPassThrough>",
|
|
1166
|
+
"default": "",
|
|
1167
|
+
"description": "The pass-through props to pass to the component."
|
|
1168
|
+
},
|
|
1169
|
+
{
|
|
1170
|
+
"name": "ptOptions",
|
|
1171
|
+
"type": "PassThroughOptions",
|
|
1172
|
+
"default": "",
|
|
1173
|
+
"description": "The pass-through options to pass to the component."
|
|
1174
|
+
},
|
|
1175
|
+
{
|
|
1176
|
+
"name": "unstyled",
|
|
1177
|
+
"type": "boolean",
|
|
1178
|
+
"default": "",
|
|
1179
|
+
"description": "Whether the component should be rendered without classes."
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"name": "dt",
|
|
1183
|
+
"type": "unknown",
|
|
1184
|
+
"default": "",
|
|
1185
|
+
"description": "The design token to use for the component."
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"name": "styles",
|
|
1189
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1190
|
+
"default": "",
|
|
1191
|
+
"description": "The styles to use for the component."
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "render",
|
|
1195
|
+
"type": "(instance: MenuListInstance) => ReactNode",
|
|
1196
|
+
"default": "",
|
|
1197
|
+
"description": "The render function to render the component with instance access."
|
|
1198
|
+
},
|
|
1199
|
+
{
|
|
1200
|
+
"name": "children",
|
|
1201
|
+
"type": "any",
|
|
1202
|
+
"default": "",
|
|
1203
|
+
"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."
|
|
1204
|
+
},
|
|
1205
|
+
{
|
|
1206
|
+
"name": "[key: string]",
|
|
1207
|
+
"type": "any",
|
|
1208
|
+
"description": ""
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
"name": "pt-{optionName}-*",
|
|
1212
|
+
"type": "-",
|
|
1213
|
+
"default": "",
|
|
1214
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1215
|
+
"deprecated": false
|
|
1216
|
+
}
|
|
1217
|
+
],
|
|
1218
|
+
"methods": []
|
|
1219
|
+
},
|
|
1220
|
+
"MenuListState": {
|
|
1221
|
+
"description": "Defines valid state in MenuList component.",
|
|
1222
|
+
"relatedProp": "",
|
|
1223
|
+
"props": [],
|
|
1224
|
+
"methods": []
|
|
1225
|
+
},
|
|
1226
|
+
"MenuListExposes": {
|
|
1227
|
+
"description": "Defines the methods and properties exposed by MenuList component.",
|
|
1228
|
+
"relatedProp": "",
|
|
1229
|
+
"props": [
|
|
1230
|
+
{
|
|
1231
|
+
"name": "menu",
|
|
1232
|
+
"type": "MenuRootInstance",
|
|
1233
|
+
"default": "",
|
|
1234
|
+
"description": "Instance of the Menu component."
|
|
1235
|
+
},
|
|
1236
|
+
{
|
|
1237
|
+
"name": "submenu",
|
|
1238
|
+
"type": "MenuSubmenuInstance",
|
|
1239
|
+
"default": "",
|
|
1240
|
+
"description": "Instance of the MenuSubmenu component."
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
"name": "listId",
|
|
1244
|
+
"type": "string",
|
|
1245
|
+
"default": "",
|
|
1246
|
+
"description": "ID of the list element."
|
|
1247
|
+
}
|
|
1248
|
+
],
|
|
1249
|
+
"methods": []
|
|
1250
|
+
}
|
|
1251
|
+
},
|
|
1252
|
+
"types": {
|
|
1253
|
+
"MenuListPassThroughType": {
|
|
1254
|
+
"description": "Defines passthrough(pt) options type in MenuList component.",
|
|
1255
|
+
"values": "PassThroughType<MenuListInstance, E>"
|
|
1256
|
+
},
|
|
1257
|
+
"MenuListInstance": {
|
|
1258
|
+
"description": "Instance of MenuList component.",
|
|
1259
|
+
"values": "ComponentInstance<MenuListProps, MenuListState, MenuListExposes>"
|
|
1260
|
+
}
|
|
1261
|
+
},
|
|
1262
|
+
"variables": {}
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"name": "MenuPopup",
|
|
1267
|
+
"source": "apps/showcase/assets/apidoc/menupopup.json",
|
|
1268
|
+
"data": {
|
|
1269
|
+
"description": "MenuPopup is a component that displays the popup content of a menu.",
|
|
1270
|
+
"interfaces": {
|
|
1271
|
+
"MenuPopupPassThrough": {
|
|
1272
|
+
"description": "Defines passthrough(pt) options of MenuPopup component.",
|
|
1273
|
+
"relatedProp": "",
|
|
1274
|
+
"props": [
|
|
1275
|
+
{
|
|
1276
|
+
"name": "root",
|
|
1277
|
+
"type": "MenuPopupPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1278
|
+
"default": "",
|
|
1279
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1280
|
+
}
|
|
1281
|
+
],
|
|
1282
|
+
"methods": []
|
|
1283
|
+
},
|
|
1284
|
+
"MenuPopupProps": {
|
|
1285
|
+
"description": "Defines valid properties in MenuPopup component.",
|
|
1286
|
+
"relatedProp": "",
|
|
1287
|
+
"extendedTypes": "BaseComponentProps<MenuPopupInstance, unknown, MenuPopupPassThrough>",
|
|
1288
|
+
"props": [
|
|
1289
|
+
{
|
|
1290
|
+
"name": "ref",
|
|
1291
|
+
"type": "Ref<unknown>",
|
|
1292
|
+
"default": "",
|
|
1293
|
+
"description": "The reference to the component instance."
|
|
1294
|
+
},
|
|
1295
|
+
{
|
|
1296
|
+
"name": "pIf",
|
|
1297
|
+
"type": "boolean",
|
|
1298
|
+
"default": "true",
|
|
1299
|
+
"description": "Whether the component should be rendered."
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"name": "style",
|
|
1303
|
+
"type": "CSSProperties | ((instance?: MenuPopupInstance) => CSSProperties)",
|
|
1304
|
+
"default": "",
|
|
1305
|
+
"description": "The style to apply to the component."
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
"name": "className",
|
|
1309
|
+
"type": "string | ((instance?: MenuPopupInstance) => string)",
|
|
1310
|
+
"default": "",
|
|
1311
|
+
"description": "The class name to apply to the component."
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"name": "as",
|
|
1315
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1316
|
+
"default": "",
|
|
1317
|
+
"description": "The component type to render."
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
"name": "asChild",
|
|
1321
|
+
"type": "boolean",
|
|
1322
|
+
"default": "false",
|
|
1323
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1324
|
+
},
|
|
1325
|
+
{
|
|
1326
|
+
"name": "instance",
|
|
1327
|
+
"type": "MenuPopupInstance",
|
|
1328
|
+
"default": "",
|
|
1329
|
+
"description": "The instance to pass to the component."
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "pt",
|
|
1333
|
+
"type": "SafeRecord<MenuPopupPassThrough>",
|
|
1334
|
+
"default": "",
|
|
1335
|
+
"description": "The pass-through props to pass to the component."
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"name": "ptOptions",
|
|
1339
|
+
"type": "PassThroughOptions",
|
|
1340
|
+
"default": "",
|
|
1341
|
+
"description": "The pass-through options to pass to the component."
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"name": "unstyled",
|
|
1345
|
+
"type": "boolean",
|
|
1346
|
+
"default": "",
|
|
1347
|
+
"description": "Whether the component should be rendered without classes."
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
"name": "dt",
|
|
1351
|
+
"type": "unknown",
|
|
1352
|
+
"default": "",
|
|
1353
|
+
"description": "The design token to use for the component."
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "styles",
|
|
1357
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1358
|
+
"default": "",
|
|
1359
|
+
"description": "The styles to use for the component."
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"name": "render",
|
|
1363
|
+
"type": "(instance: MenuPopupInstance) => ReactNode",
|
|
1364
|
+
"default": "",
|
|
1365
|
+
"description": "The render function to render the component with instance access."
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
"name": "children",
|
|
1369
|
+
"type": "any",
|
|
1370
|
+
"default": "",
|
|
1371
|
+
"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."
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"name": "motionProps",
|
|
1375
|
+
"type": "UseMotionProps",
|
|
1376
|
+
"default": "",
|
|
1377
|
+
"description": "Used to apply motion to the popup element. It accepts the same properties as useMotion hook."
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"name": "[key: string]",
|
|
1381
|
+
"type": "any",
|
|
1382
|
+
"description": ""
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"name": "pt-{optionName}-*",
|
|
1386
|
+
"type": "-",
|
|
1387
|
+
"default": "",
|
|
1388
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1389
|
+
"deprecated": false
|
|
1390
|
+
}
|
|
1391
|
+
],
|
|
1392
|
+
"methods": []
|
|
1393
|
+
},
|
|
1394
|
+
"MenuPopupState": {
|
|
1395
|
+
"description": "Defines valid state in MenuPopup component.",
|
|
1396
|
+
"relatedProp": "",
|
|
1397
|
+
"props": [],
|
|
1398
|
+
"methods": []
|
|
1399
|
+
},
|
|
1400
|
+
"MenuPopupExposes": {
|
|
1401
|
+
"description": "Defines the methods and properties exposed by MenuPopup component.",
|
|
1402
|
+
"relatedProp": "",
|
|
1403
|
+
"props": [
|
|
1404
|
+
{
|
|
1405
|
+
"name": "menu",
|
|
1406
|
+
"type": "MenuRootInstance",
|
|
1407
|
+
"default": "",
|
|
1408
|
+
"description": "The Menu component instance."
|
|
1409
|
+
}
|
|
1410
|
+
],
|
|
1411
|
+
"methods": []
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
"types": {
|
|
1415
|
+
"MenuPopupPassThroughType": {
|
|
1416
|
+
"description": "Defines passthrough(pt) options type in MenuPopup component.",
|
|
1417
|
+
"values": "PassThroughType<MenuPopupInstance, E>"
|
|
1418
|
+
},
|
|
1419
|
+
"MenuPopupInstance": {
|
|
1420
|
+
"description": "Instance of MenuPopup component.",
|
|
1421
|
+
"values": "ComponentInstance<MenuPopupProps, MenuPopupState, MenuPopupExposes>"
|
|
1422
|
+
}
|
|
1423
|
+
},
|
|
1424
|
+
"variables": {}
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "MenuPortal",
|
|
1429
|
+
"source": "apps/showcase/assets/apidoc/menuportal.json",
|
|
1430
|
+
"data": {
|
|
1431
|
+
"description": "MenuPortal is a component that displays a portal.",
|
|
1432
|
+
"interfaces": {
|
|
1433
|
+
"MenuPortalPassThrough": {
|
|
1434
|
+
"description": "Defines passthrough(pt) options of MenuPortal component.",
|
|
1435
|
+
"relatedProp": "",
|
|
1436
|
+
"props": [
|
|
1437
|
+
{
|
|
1438
|
+
"name": "root",
|
|
1439
|
+
"type": "MenuPortalPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1440
|
+
"default": "",
|
|
1441
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1442
|
+
}
|
|
1443
|
+
],
|
|
1444
|
+
"methods": []
|
|
1445
|
+
},
|
|
1446
|
+
"MenuPortalProps": {
|
|
1447
|
+
"description": "Defines valid properties in MenuPortal component.",
|
|
1448
|
+
"relatedProp": "",
|
|
1449
|
+
"extendedTypes": "BaseComponentProps<MenuPortalInstance, PortalProps, MenuPortalPassThrough>",
|
|
1450
|
+
"props": [
|
|
1451
|
+
{
|
|
1452
|
+
"name": "ref",
|
|
1453
|
+
"type": "Ref<unknown>",
|
|
1454
|
+
"default": "",
|
|
1455
|
+
"description": "The reference to the component instance."
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "pIf",
|
|
1459
|
+
"type": "boolean",
|
|
1460
|
+
"default": "true",
|
|
1461
|
+
"description": "Whether the component should be rendered."
|
|
1462
|
+
},
|
|
1463
|
+
{
|
|
1464
|
+
"name": "style",
|
|
1465
|
+
"type": "(CSSProperties | ((instance?: PortalInstance) => CSSProperties)) & (CSSProperties | ((instance?: MenuPortalInstance) => CSSProperties))",
|
|
1466
|
+
"default": "",
|
|
1467
|
+
"description": "The style to apply to the component."
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"name": "className",
|
|
1471
|
+
"type": "(string | ((instance?: PortalInstance) => string)) & (string | ((instance?: MenuPortalInstance) => string))",
|
|
1472
|
+
"default": "",
|
|
1473
|
+
"description": "The class name to apply to the component."
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"name": "as",
|
|
1477
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1478
|
+
"default": "",
|
|
1479
|
+
"description": "The component type to render."
|
|
1480
|
+
},
|
|
1481
|
+
{
|
|
1482
|
+
"name": "asChild",
|
|
1483
|
+
"type": "boolean",
|
|
1484
|
+
"default": "false",
|
|
1485
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
"name": "instance",
|
|
1489
|
+
"type": "BaseInstance<SafeRecord<PortalProps>, unknown, HTMLElement> & { props: SafeRecord<SafeRecord<PortalProps>>; attrs: Omit<SafeRecord<SafeRecord<PortalProps>>, string | number | symbol> & Record<PropertyKey, unknown> } & { state: SafeRecord; $computedSetup: SafeRecord } & PortalExposes & Record<PropertyKey, unknown> & useComponentPTReturnType & useComponentStyleReturnType & BaseInstance<SafeRecord<MenuPortalProps>, unknown, HTMLElement> & { props: SafeRecord<SafeRecord<MenuPortalProps>>; attrs: Omit<SafeRecord<SafeRecord<MenuPortalProps>>, string | number | symbol> & Record<PropertyKey, unknown> } & { state: SafeRecord; $computedSetup: SafeRecord } & MenuPortalExposes",
|
|
1490
|
+
"default": "",
|
|
1491
|
+
"description": "The instance to pass to the component."
|
|
1492
|
+
},
|
|
1493
|
+
{
|
|
1494
|
+
"name": "pt",
|
|
1495
|
+
"type": "PortalPassThrough & Record<PropertyKey, unknown> & MenuPortalPassThrough",
|
|
1496
|
+
"default": "",
|
|
1497
|
+
"description": "The pass-through props to pass to the component."
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"name": "ptOptions",
|
|
1501
|
+
"type": "PassThroughOptions",
|
|
1502
|
+
"default": "",
|
|
1503
|
+
"description": "The pass-through options to pass to the component."
|
|
1504
|
+
},
|
|
1505
|
+
{
|
|
1506
|
+
"name": "unstyled",
|
|
1507
|
+
"type": "boolean",
|
|
1508
|
+
"default": "",
|
|
1509
|
+
"description": "Whether the component should be rendered without classes."
|
|
1510
|
+
},
|
|
1511
|
+
{
|
|
1512
|
+
"name": "dt",
|
|
1513
|
+
"type": "unknown",
|
|
1514
|
+
"default": "",
|
|
1515
|
+
"description": "The design token to use for the component."
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"name": "styles",
|
|
1519
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1520
|
+
"default": "",
|
|
1521
|
+
"description": "The styles to use for the component."
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
"name": "render",
|
|
1525
|
+
"type": "(instance: PortalInstance) => ReactNode & (instance: MenuPortalInstance) => ReactNode",
|
|
1526
|
+
"default": "",
|
|
1527
|
+
"description": "The render function to render the component with instance access."
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "children",
|
|
1531
|
+
"type": "any",
|
|
1532
|
+
"default": "",
|
|
1533
|
+
"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."
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
"name": "onMounted",
|
|
1537
|
+
"type": "() => void",
|
|
1538
|
+
"default": "",
|
|
1539
|
+
"description": "Callback function to invoke when the portal is mounted."
|
|
1540
|
+
},
|
|
1541
|
+
{
|
|
1542
|
+
"name": "onUnmounted",
|
|
1543
|
+
"type": "() => void",
|
|
1544
|
+
"default": "",
|
|
1545
|
+
"description": "Callback function to invoke when the portal is unmounted."
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"name": "element",
|
|
1549
|
+
"type": "HTMLElement | ReactNode",
|
|
1550
|
+
"default": "",
|
|
1551
|
+
"description": "The element to be rendered as the portal."
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"name": "elementRef",
|
|
1555
|
+
"type": "RefObject<HTMLElement>",
|
|
1556
|
+
"default": "",
|
|
1557
|
+
"description": "The element reference to be rendered as the portal."
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"name": "appendTo",
|
|
1561
|
+
"type": "string | HTMLElement | ((instance: PortalInstance) => HTMLElement)",
|
|
1562
|
+
"default": "'body'",
|
|
1563
|
+
"description": "The DOM element where the portal should be appended to."
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
"name": "[key: string]",
|
|
1567
|
+
"type": "any",
|
|
1568
|
+
"description": ""
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "pt-{optionName}-*",
|
|
1572
|
+
"type": "-",
|
|
1573
|
+
"default": "",
|
|
1574
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1575
|
+
"deprecated": false
|
|
1576
|
+
}
|
|
1577
|
+
],
|
|
1578
|
+
"methods": []
|
|
1579
|
+
},
|
|
1580
|
+
"MenuPortalState": {
|
|
1581
|
+
"description": "Defines valid state in MenuPortal component.",
|
|
1582
|
+
"relatedProp": "",
|
|
1583
|
+
"props": [],
|
|
1584
|
+
"methods": []
|
|
1585
|
+
},
|
|
1586
|
+
"MenuPortalExposes": {
|
|
1587
|
+
"description": "Defines the methods and properties exposed by MenuPortal component.",
|
|
1588
|
+
"relatedProp": "",
|
|
1589
|
+
"props": [
|
|
1590
|
+
{
|
|
1591
|
+
"name": "menu",
|
|
1592
|
+
"type": "MenuRootInstance",
|
|
1593
|
+
"default": "",
|
|
1594
|
+
"description": "Instance of the Menu component."
|
|
1595
|
+
}
|
|
1596
|
+
],
|
|
1597
|
+
"methods": []
|
|
1598
|
+
}
|
|
1599
|
+
},
|
|
1600
|
+
"types": {
|
|
1601
|
+
"MenuPortalPassThroughType": {
|
|
1602
|
+
"description": "Defines passthrough(pt) options type in MenuPortal component.",
|
|
1603
|
+
"values": "PassThroughType<MenuPortalInstance, E>"
|
|
1604
|
+
},
|
|
1605
|
+
"MenuPortalInstance": {
|
|
1606
|
+
"description": "Instance of MenuPortal component.",
|
|
1607
|
+
"values": "ComponentInstance<MenuPortalProps, MenuPortalState, MenuPortalExposes>"
|
|
1608
|
+
}
|
|
1609
|
+
},
|
|
1610
|
+
"variables": {}
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "MenuPositioner",
|
|
1615
|
+
"source": "apps/showcase/assets/apidoc/menupositioner.json",
|
|
1616
|
+
"data": {
|
|
1617
|
+
"description": "MenuPositioner is a component that positions the menu popup relative to the anchor element.",
|
|
1618
|
+
"interfaces": {
|
|
1619
|
+
"MenuPositionerPassThrough": {
|
|
1620
|
+
"description": "Defines passthrough(pt) options of MenuPositioner component.",
|
|
1621
|
+
"relatedProp": "",
|
|
1622
|
+
"props": [
|
|
1623
|
+
{
|
|
1624
|
+
"name": "root",
|
|
1625
|
+
"type": "MenuPositionerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1626
|
+
"default": "",
|
|
1627
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1628
|
+
}
|
|
1629
|
+
],
|
|
1630
|
+
"methods": []
|
|
1631
|
+
},
|
|
1632
|
+
"MenuPositionerProps": {
|
|
1633
|
+
"description": "Defines valid properties in MenuPositioner component.",
|
|
1634
|
+
"relatedProp": "",
|
|
1635
|
+
"extendedTypes": "BaseComponentProps<MenuPositionerInstance, UsePositionerProps, MenuPositionerPassThrough>",
|
|
1636
|
+
"props": [
|
|
1637
|
+
{
|
|
1638
|
+
"name": "ref",
|
|
1639
|
+
"type": "Ref<unknown>",
|
|
1640
|
+
"default": "",
|
|
1641
|
+
"description": "The reference to the component instance."
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "pIf",
|
|
1645
|
+
"type": "boolean",
|
|
1646
|
+
"default": "true",
|
|
1647
|
+
"description": "Whether the component should be rendered."
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
"name": "style",
|
|
1651
|
+
"type": "CSSProperties | ((instance?: MenuPositionerInstance) => CSSProperties)",
|
|
1652
|
+
"default": "",
|
|
1653
|
+
"description": "The style to apply to the component."
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"name": "className",
|
|
1657
|
+
"type": "string | ((instance?: MenuPositionerInstance) => string)",
|
|
1658
|
+
"default": "",
|
|
1659
|
+
"description": "The class name to apply to the component."
|
|
1660
|
+
},
|
|
1661
|
+
{
|
|
1662
|
+
"name": "as",
|
|
1663
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1664
|
+
"default": "",
|
|
1665
|
+
"description": "The component type to render."
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
"name": "asChild",
|
|
1669
|
+
"type": "boolean",
|
|
1670
|
+
"default": "false",
|
|
1671
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "instance",
|
|
1675
|
+
"type": "MenuPositionerInstance",
|
|
1676
|
+
"default": "",
|
|
1677
|
+
"description": "The instance to pass to the component."
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "pt",
|
|
1681
|
+
"type": "SafeRecord<MenuPositionerPassThrough>",
|
|
1682
|
+
"default": "",
|
|
1683
|
+
"description": "The pass-through props to pass to the component."
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "ptOptions",
|
|
1687
|
+
"type": "PassThroughOptions",
|
|
1688
|
+
"default": "",
|
|
1689
|
+
"description": "The pass-through options to pass to the component."
|
|
1690
|
+
},
|
|
1691
|
+
{
|
|
1692
|
+
"name": "unstyled",
|
|
1693
|
+
"type": "boolean",
|
|
1694
|
+
"default": "",
|
|
1695
|
+
"description": "Whether the component should be rendered without classes."
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"name": "dt",
|
|
1699
|
+
"type": "unknown",
|
|
1700
|
+
"default": "",
|
|
1701
|
+
"description": "The design token to use for the component."
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "styles",
|
|
1705
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1706
|
+
"default": "",
|
|
1707
|
+
"description": "The styles to use for the component."
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "render",
|
|
1711
|
+
"type": "(instance: MenuPositionerInstance) => ReactNode",
|
|
1712
|
+
"default": "",
|
|
1713
|
+
"description": "The render function to render the component with instance access."
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"name": "children",
|
|
1717
|
+
"type": "any",
|
|
1718
|
+
"default": "",
|
|
1719
|
+
"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."
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"name": "side",
|
|
1723
|
+
"type": "SideType",
|
|
1724
|
+
"default": "",
|
|
1725
|
+
"description": "The side of the positioner."
|
|
1726
|
+
},
|
|
1727
|
+
{
|
|
1728
|
+
"name": "align",
|
|
1729
|
+
"type": "AlignType",
|
|
1730
|
+
"default": "",
|
|
1731
|
+
"description": "The align of the positioner."
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "sideOffset",
|
|
1735
|
+
"type": "number",
|
|
1736
|
+
"default": "",
|
|
1737
|
+
"description": "The side offset of the positioner."
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "alignOffset",
|
|
1741
|
+
"type": "number",
|
|
1742
|
+
"default": "",
|
|
1743
|
+
"description": "The align offset of the positioner."
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "flip",
|
|
1747
|
+
"type": "boolean",
|
|
1748
|
+
"default": "",
|
|
1749
|
+
"description": "Whether to flip the positioner."
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "shift",
|
|
1753
|
+
"type": "boolean",
|
|
1754
|
+
"default": "",
|
|
1755
|
+
"description": "Whether to shift the positioner."
|
|
1756
|
+
},
|
|
1757
|
+
{
|
|
1758
|
+
"name": "hideWhenDetached",
|
|
1759
|
+
"type": "boolean",
|
|
1760
|
+
"default": "",
|
|
1761
|
+
"description": "Whether to hide the positioner when detached."
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"name": "strategy",
|
|
1765
|
+
"type": "\"fixed\" | \"absolute\"",
|
|
1766
|
+
"default": "'fixed'",
|
|
1767
|
+
"description": "The positioning strategy."
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "boundary",
|
|
1771
|
+
"type": "HTMLElement",
|
|
1772
|
+
"default": "",
|
|
1773
|
+
"description": "The boundary element that constrains the positioner placement.\nUsed in JS fallback mode only; CSS Anchor mode uses the containing block."
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "anchor",
|
|
1777
|
+
"type": "HTMLElement",
|
|
1778
|
+
"default": "",
|
|
1779
|
+
"description": "The anchor element."
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"name": "content",
|
|
1783
|
+
"type": "HTMLDivElement",
|
|
1784
|
+
"default": "",
|
|
1785
|
+
"description": "The content element."
|
|
1786
|
+
},
|
|
1787
|
+
{
|
|
1788
|
+
"name": "arrow",
|
|
1789
|
+
"type": "HTMLDivElement",
|
|
1790
|
+
"default": "",
|
|
1791
|
+
"description": "The arrow element."
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"name": "autoZIndex",
|
|
1795
|
+
"type": "boolean",
|
|
1796
|
+
"default": "true",
|
|
1797
|
+
"description": "Whether to automatically manage layering."
|
|
1798
|
+
},
|
|
1799
|
+
{
|
|
1800
|
+
"name": "baseZIndex",
|
|
1801
|
+
"type": "number",
|
|
1802
|
+
"default": "0",
|
|
1803
|
+
"description": "Base zIndex value to use in layering."
|
|
1804
|
+
},
|
|
1805
|
+
{
|
|
1806
|
+
"name": "onPlacementChange",
|
|
1807
|
+
"type": "(placement: { side: SideType; align: AlignType }) => void",
|
|
1808
|
+
"default": "",
|
|
1809
|
+
"description": "Callback invoked when the actual placement changes due to flip or shift."
|
|
1810
|
+
},
|
|
1811
|
+
{
|
|
1812
|
+
"name": "[key: string]",
|
|
1813
|
+
"type": "any",
|
|
1814
|
+
"description": ""
|
|
1815
|
+
},
|
|
1816
|
+
{
|
|
1817
|
+
"name": "pt-{optionName}-*",
|
|
1818
|
+
"type": "-",
|
|
1819
|
+
"default": "",
|
|
1820
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1821
|
+
"deprecated": false
|
|
1822
|
+
}
|
|
1823
|
+
],
|
|
1824
|
+
"methods": []
|
|
1825
|
+
},
|
|
1826
|
+
"MenuPositionerState": {
|
|
1827
|
+
"description": "Defines valid state in MenuPositioner component.",
|
|
1828
|
+
"relatedProp": "",
|
|
1829
|
+
"props": [],
|
|
1830
|
+
"methods": []
|
|
1831
|
+
},
|
|
1832
|
+
"MenuPositionerExposes": {
|
|
1833
|
+
"description": "Defines the methods and properties exposed by MenuPositioner component.",
|
|
1834
|
+
"relatedProp": "",
|
|
1835
|
+
"props": [
|
|
1836
|
+
{
|
|
1837
|
+
"name": "menu",
|
|
1838
|
+
"type": "MenuRootInstance",
|
|
1839
|
+
"default": "",
|
|
1840
|
+
"description": "The Menu component instance."
|
|
1841
|
+
}
|
|
1842
|
+
],
|
|
1843
|
+
"methods": []
|
|
1844
|
+
}
|
|
1845
|
+
},
|
|
1846
|
+
"types": {
|
|
1847
|
+
"MenuPositionerPassThroughType": {
|
|
1848
|
+
"description": "Defines passthrough(pt) options type in MenuPositioner component.",
|
|
1849
|
+
"values": "PassThroughType<MenuPositionerInstance, E>"
|
|
1850
|
+
},
|
|
1851
|
+
"MenuPositionerInstance": {
|
|
1852
|
+
"description": "Instance of MenuPositioner component.",
|
|
1853
|
+
"values": "ComponentInstance<MenuPositionerProps, MenuPositionerState, MenuPositionerExposes>"
|
|
1854
|
+
}
|
|
1855
|
+
},
|
|
1856
|
+
"variables": {}
|
|
1857
|
+
}
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"name": "MenuRadioItem",
|
|
1861
|
+
"source": "apps/showcase/assets/apidoc/menuradioitem.json",
|
|
1862
|
+
"data": {
|
|
1863
|
+
"description": "MenuRadioItem is a radio menu item managed by useRadioButton, used within MenuRadioItemGroup.",
|
|
1864
|
+
"interfaces": {
|
|
1865
|
+
"MenuRadioItemPassThrough": {
|
|
1866
|
+
"description": "Defines passthrough(pt) options of MenuRadioItem component.",
|
|
1867
|
+
"relatedProp": "",
|
|
1868
|
+
"props": [
|
|
1869
|
+
{
|
|
1870
|
+
"name": "root",
|
|
1871
|
+
"type": "MenuRadioItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1872
|
+
"default": "",
|
|
1873
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1874
|
+
}
|
|
1875
|
+
],
|
|
1876
|
+
"methods": []
|
|
1877
|
+
},
|
|
1878
|
+
"MenuRadioItemCheckedChangeEvent": {
|
|
1879
|
+
"description": "Event fired when the radio item's checked state changes.",
|
|
1880
|
+
"relatedProp": "",
|
|
1881
|
+
"extendedTypes": "UseRadioButtonChangeEvent<React.SyntheticEvent>",
|
|
1882
|
+
"props": [
|
|
1883
|
+
{
|
|
1884
|
+
"name": "originalEvent",
|
|
1885
|
+
"type": "SyntheticEvent",
|
|
1886
|
+
"default": "",
|
|
1887
|
+
"description": "The original event that triggered the change."
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
"name": "checked",
|
|
1891
|
+
"type": "boolean",
|
|
1892
|
+
"default": "",
|
|
1893
|
+
"description": "The checked state of the radio button."
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
"name": "value",
|
|
1897
|
+
"type": "unknown",
|
|
1898
|
+
"default": "",
|
|
1899
|
+
"description": "Value of the radio item."
|
|
1900
|
+
}
|
|
1901
|
+
],
|
|
1902
|
+
"methods": []
|
|
1903
|
+
},
|
|
1904
|
+
"MenuRadioItemProps": {
|
|
1905
|
+
"description": "Defines valid properties in MenuRadioItem component.",
|
|
1906
|
+
"relatedProp": "",
|
|
1907
|
+
"extendedTypes": "BaseComponentProps<MenuRadioItemInstance, Omit<UseRadioButtonProps, \"onCheckedChange\" | \"value\">, MenuRadioItemPassThrough>",
|
|
1908
|
+
"props": [
|
|
1909
|
+
{
|
|
1910
|
+
"name": "ref",
|
|
1911
|
+
"type": "Ref<unknown>",
|
|
1912
|
+
"default": "",
|
|
1913
|
+
"description": "The reference to the component instance."
|
|
1914
|
+
},
|
|
1915
|
+
{
|
|
1916
|
+
"name": "pIf",
|
|
1917
|
+
"type": "boolean",
|
|
1918
|
+
"default": "true",
|
|
1919
|
+
"description": "Whether the component should be rendered."
|
|
1920
|
+
},
|
|
1921
|
+
{
|
|
1922
|
+
"name": "style",
|
|
1923
|
+
"type": "CSSProperties | ((instance?: MenuRadioItemInstance) => CSSProperties)",
|
|
1924
|
+
"default": "",
|
|
1925
|
+
"description": "The style to apply to the component."
|
|
1926
|
+
},
|
|
1927
|
+
{
|
|
1928
|
+
"name": "className",
|
|
1929
|
+
"type": "string | ((instance?: MenuRadioItemInstance) => string)",
|
|
1930
|
+
"default": "",
|
|
1931
|
+
"description": "The class name to apply to the component."
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"name": "as",
|
|
1935
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1936
|
+
"default": "",
|
|
1937
|
+
"description": "The component type to render."
|
|
1938
|
+
},
|
|
1939
|
+
{
|
|
1940
|
+
"name": "asChild",
|
|
1941
|
+
"type": "boolean",
|
|
1942
|
+
"default": "false",
|
|
1943
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1944
|
+
},
|
|
1945
|
+
{
|
|
1946
|
+
"name": "instance",
|
|
1947
|
+
"type": "MenuRadioItemInstance",
|
|
1948
|
+
"default": "",
|
|
1949
|
+
"description": "The instance to pass to the component."
|
|
1950
|
+
},
|
|
1951
|
+
{
|
|
1952
|
+
"name": "pt",
|
|
1953
|
+
"type": "SafeRecord<MenuRadioItemPassThrough>",
|
|
1954
|
+
"default": "",
|
|
1955
|
+
"description": "The pass-through props to pass to the component."
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "ptOptions",
|
|
1959
|
+
"type": "PassThroughOptions",
|
|
1960
|
+
"default": "",
|
|
1961
|
+
"description": "The pass-through options to pass to the component."
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"name": "unstyled",
|
|
1965
|
+
"type": "boolean",
|
|
1966
|
+
"default": "",
|
|
1967
|
+
"description": "Whether the component should be rendered without classes."
|
|
1968
|
+
},
|
|
1969
|
+
{
|
|
1970
|
+
"name": "dt",
|
|
1971
|
+
"type": "unknown",
|
|
1972
|
+
"default": "",
|
|
1973
|
+
"description": "The design token to use for the component."
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"name": "styles",
|
|
1977
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1978
|
+
"default": "",
|
|
1979
|
+
"description": "The styles to use for the component."
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"name": "render",
|
|
1983
|
+
"type": "(instance: MenuRadioItemInstance) => ReactNode",
|
|
1984
|
+
"default": "",
|
|
1985
|
+
"description": "The render function to render the component with instance access."
|
|
1986
|
+
},
|
|
1987
|
+
{
|
|
1988
|
+
"name": "children",
|
|
1989
|
+
"type": "any",
|
|
1990
|
+
"default": "",
|
|
1991
|
+
"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."
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"name": "checked",
|
|
1995
|
+
"type": "boolean",
|
|
1996
|
+
"default": "",
|
|
1997
|
+
"description": "When present, it specifies the input's checked state."
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"name": "defaultChecked",
|
|
2001
|
+
"type": "boolean",
|
|
2002
|
+
"default": "",
|
|
2003
|
+
"description": "The default value for the input when not controlled by `checked` and `onCheckedChange` ."
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
"name": "inputId",
|
|
2007
|
+
"type": "string",
|
|
2008
|
+
"default": "",
|
|
2009
|
+
"description": "Identifier of the underlying input element."
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
"name": "name",
|
|
2013
|
+
"type": "string",
|
|
2014
|
+
"default": "",
|
|
2015
|
+
"description": "The name attribute of the input, resolved from group context if available."
|
|
2016
|
+
},
|
|
2017
|
+
{
|
|
2018
|
+
"name": "readOnly",
|
|
2019
|
+
"type": "boolean",
|
|
2020
|
+
"default": "false",
|
|
2021
|
+
"description": "When present, it specifies that an input field is read-only."
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
"name": "required",
|
|
2025
|
+
"type": "boolean",
|
|
2026
|
+
"default": "false",
|
|
2027
|
+
"description": "When present, it specifies that the element is required."
|
|
2028
|
+
},
|
|
2029
|
+
{
|
|
2030
|
+
"name": "tabIndex",
|
|
2031
|
+
"type": "number",
|
|
2032
|
+
"default": "",
|
|
2033
|
+
"description": "Tab index for keyboard navigation."
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "invalid",
|
|
2037
|
+
"type": "boolean",
|
|
2038
|
+
"default": "false",
|
|
2039
|
+
"description": "When present, it specifies that the component should have invalid state style."
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"name": "ariaLabelledby",
|
|
2043
|
+
"type": "string",
|
|
2044
|
+
"default": "",
|
|
2045
|
+
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs."
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "ariaLabel",
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"default": "",
|
|
2051
|
+
"description": "Establishes a string value that labels the component."
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
"name": "onFocus",
|
|
2055
|
+
"type": "(event: FocusEvent<HTMLInputElement>) => void",
|
|
2056
|
+
"default": "",
|
|
2057
|
+
"description": "Callback function that is called when the radio button is focused."
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"name": "onBlur",
|
|
2061
|
+
"type": "(event: FocusEvent<HTMLInputElement>) => void",
|
|
2062
|
+
"default": "",
|
|
2063
|
+
"description": "Callback function that is called when the radio button loses focus."
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"name": "value",
|
|
2067
|
+
"type": "unknown",
|
|
2068
|
+
"default": "",
|
|
2069
|
+
"description": "Value of the radio item. Used to determine the checked state against the parent group's value."
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"name": "disabled",
|
|
2073
|
+
"type": "boolean",
|
|
2074
|
+
"default": "",
|
|
2075
|
+
"description": "When present, it specifies that the item should be disabled."
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "closeOnSelect",
|
|
2079
|
+
"type": "boolean",
|
|
2080
|
+
"default": "false",
|
|
2081
|
+
"description": "Whether the menu should close when this radio item is selected.\nDefaults to `false` for radio items so selecting a value keeps the menu\nopen; set explicitly to `true` to close on each selection."
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"name": "onSelect",
|
|
2085
|
+
"type": "(event: MenuItemSelectEvent) => void",
|
|
2086
|
+
"default": "",
|
|
2087
|
+
"description": "Callback fired when the item is activated. Calling\n `event.preventDefault()` keeps the menu open regardless of\n `closeOnSelect` ."
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "onCheckedChange",
|
|
2091
|
+
"type": "(event: MenuRadioItemCheckedChangeEvent) => void",
|
|
2092
|
+
"default": "",
|
|
2093
|
+
"description": "Callback fired when the radio item is selected."
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "[key: string]",
|
|
2097
|
+
"type": "any",
|
|
2098
|
+
"description": ""
|
|
2099
|
+
},
|
|
2100
|
+
{
|
|
2101
|
+
"name": "pt-{optionName}-*",
|
|
2102
|
+
"type": "-",
|
|
2103
|
+
"default": "",
|
|
2104
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2105
|
+
"deprecated": false
|
|
2106
|
+
}
|
|
2107
|
+
],
|
|
2108
|
+
"methods": []
|
|
2109
|
+
},
|
|
2110
|
+
"MenuRadioItemState": {
|
|
2111
|
+
"description": "Defines valid state in MenuRadioItem component.",
|
|
2112
|
+
"relatedProp": "",
|
|
2113
|
+
"props": [],
|
|
2114
|
+
"methods": []
|
|
2115
|
+
},
|
|
2116
|
+
"MenuRadioItemExposes": {
|
|
2117
|
+
"description": "Defines the methods and properties exposed by MenuRadioItem component.",
|
|
2118
|
+
"relatedProp": "",
|
|
2119
|
+
"extendedTypes": "UseRadioButtonExposes",
|
|
2120
|
+
"props": [
|
|
2121
|
+
{
|
|
2122
|
+
"name": "state",
|
|
2123
|
+
"type": "UseRadioButtonState",
|
|
2124
|
+
"default": "",
|
|
2125
|
+
"description": "The state of the useRadioButton."
|
|
2126
|
+
},
|
|
2127
|
+
{
|
|
2128
|
+
"name": "onChange",
|
|
2129
|
+
"type": "(event: ChangeEvent<HTMLInputElement>) => void",
|
|
2130
|
+
"default": "",
|
|
2131
|
+
"description": "Callback fired when the useRadioButton's checked state changes."
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"name": "rootProps",
|
|
2135
|
+
"type": "UseRadioButtonRootProps",
|
|
2136
|
+
"default": "",
|
|
2137
|
+
"description": "Pre-built data attribute props for the root element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"name": "inputProps",
|
|
2141
|
+
"type": "UseRadioButtonInputProps",
|
|
2142
|
+
"default": "",
|
|
2143
|
+
"description": "Pre-built props for the native input element.\nIncludes type, value, checked, ARIA attributes, data attributes, and event handlers."
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
"name": "boxProps",
|
|
2147
|
+
"type": "UseRadioButtonBoxProps",
|
|
2148
|
+
"default": "",
|
|
2149
|
+
"description": "Pre-built data attribute props for the box element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
"name": "indicatorProps",
|
|
2153
|
+
"type": "UseRadioButtonIndicatorProps",
|
|
2154
|
+
"default": "",
|
|
2155
|
+
"description": "Pre-built data attribute props for the indicator element.\nIncludes data-checked/unchecked, data-disabled, data-invalid."
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
"name": "menu",
|
|
2159
|
+
"type": "MenuRootInstance",
|
|
2160
|
+
"default": "",
|
|
2161
|
+
"description": "Instance of the Menu component."
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
"name": "submenu",
|
|
2165
|
+
"type": "MenuSubmenuInstance",
|
|
2166
|
+
"default": "",
|
|
2167
|
+
"description": "Instance of the MenuSubmenu component."
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"name": "portal",
|
|
2171
|
+
"type": "MenuPortalInstance",
|
|
2172
|
+
"default": "",
|
|
2173
|
+
"description": "Instance of the MenuPortal component."
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"name": "group",
|
|
2177
|
+
"type": "MenuRadioItemGroupContextInterface",
|
|
2178
|
+
"default": "",
|
|
2179
|
+
"description": "Parent MenuRadioItemGroup context, if any."
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"name": "itemId",
|
|
2183
|
+
"type": "string",
|
|
2184
|
+
"default": "",
|
|
2185
|
+
"description": "ID of the item element."
|
|
2186
|
+
},
|
|
2187
|
+
{
|
|
2188
|
+
"name": "focused",
|
|
2189
|
+
"type": "boolean",
|
|
2190
|
+
"default": "",
|
|
2191
|
+
"description": "Whether the item is focused or not."
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"name": "isDisabled",
|
|
2195
|
+
"type": "boolean",
|
|
2196
|
+
"default": "",
|
|
2197
|
+
"description": "Whether the item is disabled or not."
|
|
2198
|
+
},
|
|
2199
|
+
{
|
|
2200
|
+
"name": "checked",
|
|
2201
|
+
"type": "boolean",
|
|
2202
|
+
"default": "",
|
|
2203
|
+
"description": "Whether the item is checked or not."
|
|
2204
|
+
}
|
|
2205
|
+
],
|
|
2206
|
+
"methods": []
|
|
2207
|
+
}
|
|
2208
|
+
},
|
|
2209
|
+
"types": {
|
|
2210
|
+
"MenuRadioItemPassThroughType": {
|
|
2211
|
+
"description": "Defines passthrough(pt) options type in MenuRadioItem component.",
|
|
2212
|
+
"values": "PassThroughType<MenuRadioItemInstance, E>"
|
|
2213
|
+
},
|
|
2214
|
+
"MenuRadioItemInstance": {
|
|
2215
|
+
"description": "Instance of MenuRadioItem component.",
|
|
2216
|
+
"values": "ComponentInstance<MenuRadioItemProps, MenuRadioItemState, MenuRadioItemExposes>"
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
"variables": {}
|
|
2220
|
+
}
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
"name": "MenuRadioItemGroup",
|
|
2224
|
+
"source": "apps/showcase/assets/apidoc/menuradioitemgroup.json",
|
|
2225
|
+
"data": {
|
|
2226
|
+
"description": "MenuRadioItemGroup is a component that groups MenuRadioItem children, managed by useRadioButtonGroup.",
|
|
2227
|
+
"interfaces": {
|
|
2228
|
+
"MenuRadioItemGroupPassThrough": {
|
|
2229
|
+
"description": "Defines passthrough(pt) options of MenuRadioItemGroup component.",
|
|
2230
|
+
"relatedProp": "",
|
|
2231
|
+
"props": [],
|
|
2232
|
+
"methods": []
|
|
2233
|
+
},
|
|
2234
|
+
"MenuRadioItemGroupValueChangeEvent": {
|
|
2235
|
+
"description": "Event fired when the radio item group's value changes.",
|
|
2236
|
+
"relatedProp": "",
|
|
2237
|
+
"extendedTypes": "UseRadioButtonGroupValueChangeEvent",
|
|
2238
|
+
"props": [
|
|
2239
|
+
{
|
|
2240
|
+
"name": "originalEvent",
|
|
2241
|
+
"type": "SyntheticEvent",
|
|
2242
|
+
"default": "",
|
|
2243
|
+
"description": "The original event that triggered the change."
|
|
2244
|
+
},
|
|
2245
|
+
{
|
|
2246
|
+
"name": "value",
|
|
2247
|
+
"type": "unknown",
|
|
2248
|
+
"default": "",
|
|
2249
|
+
"description": "The value of the radio button group."
|
|
2250
|
+
}
|
|
2251
|
+
],
|
|
2252
|
+
"methods": []
|
|
2253
|
+
},
|
|
2254
|
+
"MenuRadioItemGroupContextInterface": {
|
|
2255
|
+
"description": "Context value shared between MenuRadioItemGroup and its child MenuRadioItem children.",
|
|
2256
|
+
"relatedProp": "",
|
|
2257
|
+
"props": [
|
|
2258
|
+
{
|
|
2259
|
+
"name": "value",
|
|
2260
|
+
"type": "unknown",
|
|
2261
|
+
"default": "",
|
|
2262
|
+
"description": "Currently selected value in the radio item group."
|
|
2263
|
+
},
|
|
2264
|
+
{
|
|
2265
|
+
"name": "updateChange",
|
|
2266
|
+
"type": "(event: UseRadioButtonChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void",
|
|
2267
|
+
"default": "",
|
|
2268
|
+
"description": "Callback to update the selected value."
|
|
2269
|
+
},
|
|
2270
|
+
{
|
|
2271
|
+
"name": "name",
|
|
2272
|
+
"type": "string",
|
|
2273
|
+
"default": "",
|
|
2274
|
+
"description": "Optional name attribute for the radio item group."
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
"name": "defaultValue",
|
|
2278
|
+
"type": "unknown",
|
|
2279
|
+
"default": "",
|
|
2280
|
+
"description": "Default value of the group, exposed for child controlled-state initialization."
|
|
2281
|
+
}
|
|
2282
|
+
],
|
|
2283
|
+
"methods": []
|
|
2284
|
+
},
|
|
2285
|
+
"MenuRadioItemGroupProps": {
|
|
2286
|
+
"description": "Defines valid properties in MenuRadioItemGroup component.",
|
|
2287
|
+
"relatedProp": "",
|
|
2288
|
+
"extendedTypes": "BaseComponentProps<MenuRadioItemGroupInstance, Omit<UseRadioButtonGroupProps, \"onValueChange\">, MenuRadioItemGroupPassThrough>",
|
|
2289
|
+
"props": [
|
|
2290
|
+
{
|
|
2291
|
+
"name": "ref",
|
|
2292
|
+
"type": "Ref<unknown>",
|
|
2293
|
+
"default": "",
|
|
2294
|
+
"description": "The reference to the component instance."
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
"name": "pIf",
|
|
2298
|
+
"type": "boolean",
|
|
2299
|
+
"default": "true",
|
|
2300
|
+
"description": "Whether the component should be rendered."
|
|
2301
|
+
},
|
|
2302
|
+
{
|
|
2303
|
+
"name": "style",
|
|
2304
|
+
"type": "CSSProperties | ((instance?: MenuRadioItemGroupInstance) => CSSProperties)",
|
|
2305
|
+
"default": "",
|
|
2306
|
+
"description": "The style to apply to the component."
|
|
2307
|
+
},
|
|
2308
|
+
{
|
|
2309
|
+
"name": "className",
|
|
2310
|
+
"type": "string | ((instance?: MenuRadioItemGroupInstance) => string)",
|
|
2311
|
+
"default": "",
|
|
2312
|
+
"description": "The class name to apply to the component."
|
|
2313
|
+
},
|
|
2314
|
+
{
|
|
2315
|
+
"name": "as",
|
|
2316
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2317
|
+
"default": "",
|
|
2318
|
+
"description": "The component type to render."
|
|
2319
|
+
},
|
|
2320
|
+
{
|
|
2321
|
+
"name": "asChild",
|
|
2322
|
+
"type": "boolean",
|
|
2323
|
+
"default": "false",
|
|
2324
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2325
|
+
},
|
|
2326
|
+
{
|
|
2327
|
+
"name": "instance",
|
|
2328
|
+
"type": "MenuRadioItemGroupInstance",
|
|
2329
|
+
"default": "",
|
|
2330
|
+
"description": "The instance to pass to the component."
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"name": "pt",
|
|
2334
|
+
"type": "SafeRecord<MenuRadioItemGroupPassThrough>",
|
|
2335
|
+
"default": "",
|
|
2336
|
+
"description": "The pass-through props to pass to the component."
|
|
2337
|
+
},
|
|
2338
|
+
{
|
|
2339
|
+
"name": "ptOptions",
|
|
2340
|
+
"type": "PassThroughOptions",
|
|
2341
|
+
"default": "",
|
|
2342
|
+
"description": "The pass-through options to pass to the component."
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
"name": "unstyled",
|
|
2346
|
+
"type": "boolean",
|
|
2347
|
+
"default": "",
|
|
2348
|
+
"description": "Whether the component should be rendered without classes."
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"name": "dt",
|
|
2352
|
+
"type": "unknown",
|
|
2353
|
+
"default": "",
|
|
2354
|
+
"description": "The design token to use for the component."
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"name": "styles",
|
|
2358
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2359
|
+
"default": "",
|
|
2360
|
+
"description": "The styles to use for the component."
|
|
2361
|
+
},
|
|
2362
|
+
{
|
|
2363
|
+
"name": "render",
|
|
2364
|
+
"type": "(instance: MenuRadioItemGroupInstance) => ReactNode",
|
|
2365
|
+
"default": "",
|
|
2366
|
+
"description": "The render function to render the component with instance access."
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"name": "children",
|
|
2370
|
+
"type": "any",
|
|
2371
|
+
"default": "",
|
|
2372
|
+
"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."
|
|
2373
|
+
},
|
|
2374
|
+
{
|
|
2375
|
+
"name": "value",
|
|
2376
|
+
"type": "unknown",
|
|
2377
|
+
"default": "",
|
|
2378
|
+
"description": "Value of the radio button group."
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"name": "defaultValue",
|
|
2382
|
+
"type": "unknown",
|
|
2383
|
+
"default": "",
|
|
2384
|
+
"description": "The default value of the radio button group."
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"name": "name",
|
|
2388
|
+
"type": "string",
|
|
2389
|
+
"default": "",
|
|
2390
|
+
"description": "Name for the radio item group."
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
"name": "onValueChange",
|
|
2394
|
+
"type": "(event: MenuRadioItemGroupValueChangeEvent) => void",
|
|
2395
|
+
"default": "",
|
|
2396
|
+
"description": "Callback fired when the value changes."
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "[key: string]",
|
|
2400
|
+
"type": "any",
|
|
2401
|
+
"description": ""
|
|
2402
|
+
}
|
|
2403
|
+
],
|
|
2404
|
+
"methods": []
|
|
2405
|
+
},
|
|
2406
|
+
"MenuRadioItemGroupState": {
|
|
2407
|
+
"description": "Defines valid state in MenuRadioItemGroup component.",
|
|
2408
|
+
"relatedProp": "",
|
|
2409
|
+
"props": [],
|
|
2410
|
+
"methods": []
|
|
2411
|
+
},
|
|
2412
|
+
"MenuRadioItemGroupExposes": {
|
|
2413
|
+
"description": "Defines the methods and properties exposed by MenuRadioItemGroup component.",
|
|
2414
|
+
"relatedProp": "",
|
|
2415
|
+
"extendedTypes": "UseRadioButtonGroupExposes",
|
|
2416
|
+
"props": [
|
|
2417
|
+
{
|
|
2418
|
+
"name": "state",
|
|
2419
|
+
"type": "UseRadioButtonGroupState",
|
|
2420
|
+
"default": "",
|
|
2421
|
+
"description": "The state of the useRadioButtonGroup."
|
|
2422
|
+
},
|
|
2423
|
+
{
|
|
2424
|
+
"name": "rootProps",
|
|
2425
|
+
"type": "UseRadioButtonGroupRootProps",
|
|
2426
|
+
"default": "",
|
|
2427
|
+
"description": "Pre-built data attribute props for the root element."
|
|
2428
|
+
},
|
|
2429
|
+
{
|
|
2430
|
+
"name": "updateChange",
|
|
2431
|
+
"type": "(event: UseRadioButtonChangeEvent<SyntheticEvent<Element, Event>> & { value: unknown }) => void",
|
|
2432
|
+
"default": "",
|
|
2433
|
+
"description": "Updates the value of the radio button group."
|
|
2434
|
+
},
|
|
2435
|
+
{
|
|
2436
|
+
"name": "context",
|
|
2437
|
+
"type": "MenuRadioItemGroupContextInterface",
|
|
2438
|
+
"default": "",
|
|
2439
|
+
"description": "Context value for the radio item group exposed to children."
|
|
2440
|
+
}
|
|
2441
|
+
],
|
|
2442
|
+
"methods": []
|
|
2443
|
+
}
|
|
2444
|
+
},
|
|
2445
|
+
"types": {
|
|
2446
|
+
"MenuRadioItemGroupPassThroughType": {
|
|
2447
|
+
"description": "Defines passthrough(pt) options type in MenuRadioItemGroup component.",
|
|
2448
|
+
"values": "PassThroughType<MenuRadioItemGroupInstance, E>"
|
|
2449
|
+
},
|
|
2450
|
+
"MenuRadioItemGroupInstance": {
|
|
2451
|
+
"description": "Instance of MenuRadioItemGroup component.",
|
|
2452
|
+
"values": "ComponentInstance<MenuRadioItemGroupProps, MenuRadioItemGroupState, MenuRadioItemGroupExposes>"
|
|
2453
|
+
}
|
|
2454
|
+
},
|
|
2455
|
+
"variables": {}
|
|
2456
|
+
}
|
|
2457
|
+
},
|
|
2458
|
+
{
|
|
2459
|
+
"name": "MenuRoot",
|
|
2460
|
+
"source": "apps/showcase/assets/apidoc/menuroot.json",
|
|
2461
|
+
"data": {
|
|
2462
|
+
"description": "Menu is a navigation component that displays a list of items, with support for items, checkbox items, radio items, submenus, and inline rendering.",
|
|
2463
|
+
"interfaces": {
|
|
2464
|
+
"MenuRootPassThrough": {
|
|
2465
|
+
"description": "Defines passthrough(pt) options of Menu component.",
|
|
2466
|
+
"relatedProp": "",
|
|
2467
|
+
"props": [
|
|
2468
|
+
{
|
|
2469
|
+
"name": "root",
|
|
2470
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2471
|
+
"default": "",
|
|
2472
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
"name": "list",
|
|
2476
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2477
|
+
"default": "",
|
|
2478
|
+
"description": "Used to pass attributes to the list's DOM element."
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "item",
|
|
2482
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2483
|
+
"default": "",
|
|
2484
|
+
"description": "Used to pass attributes to the item's DOM element."
|
|
2485
|
+
},
|
|
2486
|
+
{
|
|
2487
|
+
"name": "label",
|
|
2488
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2489
|
+
"default": "",
|
|
2490
|
+
"description": "Used to pass attributes to the label's DOM element."
|
|
2491
|
+
},
|
|
2492
|
+
{
|
|
2493
|
+
"name": "sub",
|
|
2494
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2495
|
+
"default": "",
|
|
2496
|
+
"description": "Used to pass attributes to the submenu's DOM element."
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
"name": "trigger",
|
|
2500
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
2501
|
+
"default": "",
|
|
2502
|
+
"description": "Used to pass attributes to the trigger's DOM element."
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"name": "subtrigger",
|
|
2506
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2507
|
+
"default": "",
|
|
2508
|
+
"description": "Used to pass attributes to the subtrigger's DOM element."
|
|
2509
|
+
},
|
|
2510
|
+
{
|
|
2511
|
+
"name": "checkboxItemIndicator",
|
|
2512
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2513
|
+
"default": "",
|
|
2514
|
+
"description": "Used to pass attributes to the checkbox item indicator's DOM element."
|
|
2515
|
+
},
|
|
2516
|
+
{
|
|
2517
|
+
"name": "radioItemIndicator",
|
|
2518
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2519
|
+
"default": "",
|
|
2520
|
+
"description": "Used to pass attributes to the radio item indicator's DOM element."
|
|
2521
|
+
},
|
|
2522
|
+
{
|
|
2523
|
+
"name": "submenuIndicator",
|
|
2524
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2525
|
+
"default": "",
|
|
2526
|
+
"description": "Used to pass attributes to the submenu indicator's DOM element."
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
"name": "separator",
|
|
2530
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2531
|
+
"default": "",
|
|
2532
|
+
"description": "Used to pass attributes to the separator's DOM element."
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
"name": "popup",
|
|
2536
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2537
|
+
"default": "",
|
|
2538
|
+
"description": "Used to pass attributes to the popup's DOM element."
|
|
2539
|
+
},
|
|
2540
|
+
{
|
|
2541
|
+
"name": "arrow",
|
|
2542
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2543
|
+
"default": "",
|
|
2544
|
+
"description": "Used to pass attributes to the arrow's DOM element."
|
|
2545
|
+
},
|
|
2546
|
+
{
|
|
2547
|
+
"name": "positioner",
|
|
2548
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2549
|
+
"default": "",
|
|
2550
|
+
"description": "Used to pass attributes to the positioner's DOM element."
|
|
2551
|
+
},
|
|
2552
|
+
{
|
|
2553
|
+
"name": "subpositioner",
|
|
2554
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2555
|
+
"default": "",
|
|
2556
|
+
"description": "Used to pass attributes to the subpositioner's DOM element."
|
|
2557
|
+
},
|
|
2558
|
+
{
|
|
2559
|
+
"name": "subpopup",
|
|
2560
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2561
|
+
"default": "",
|
|
2562
|
+
"description": "Used to pass attributes to the subpopup's DOM element."
|
|
2563
|
+
},
|
|
2564
|
+
{
|
|
2565
|
+
"name": "subportal",
|
|
2566
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2567
|
+
"default": "",
|
|
2568
|
+
"description": "Used to pass attributes to the subportal's DOM element."
|
|
2569
|
+
}
|
|
2570
|
+
],
|
|
2571
|
+
"methods": []
|
|
2572
|
+
},
|
|
2573
|
+
"MenuRootOpenChangeEvent": {
|
|
2574
|
+
"description": "Event fired when the menu's open state changes.",
|
|
2575
|
+
"relatedProp": "",
|
|
2576
|
+
"extendedTypes": "UseMenuOpenChangeEvent",
|
|
2577
|
+
"props": [
|
|
2578
|
+
{
|
|
2579
|
+
"name": "originalEvent",
|
|
2580
|
+
"type": "Event",
|
|
2581
|
+
"default": "",
|
|
2582
|
+
"description": "The original browser event that triggered the change."
|
|
2583
|
+
},
|
|
2584
|
+
{
|
|
2585
|
+
"name": "open",
|
|
2586
|
+
"type": "boolean",
|
|
2587
|
+
"default": "",
|
|
2588
|
+
"description": "The open state of the menu."
|
|
2589
|
+
}
|
|
2590
|
+
],
|
|
2591
|
+
"methods": []
|
|
2592
|
+
},
|
|
2593
|
+
"MenuRootProps": {
|
|
2594
|
+
"description": "Defines valid properties in Menu component.",
|
|
2595
|
+
"relatedProp": "",
|
|
2596
|
+
"extendedTypes": "BaseComponentProps<MenuRootInstance, Omit<UseMenuProps, \"onOpenChange\">, MenuRootPassThrough>",
|
|
2597
|
+
"props": [
|
|
2598
|
+
{
|
|
2599
|
+
"name": "ref",
|
|
2600
|
+
"type": "Ref<unknown>",
|
|
2601
|
+
"default": "",
|
|
2602
|
+
"description": "The reference to the component instance."
|
|
2603
|
+
},
|
|
2604
|
+
{
|
|
2605
|
+
"name": "pIf",
|
|
2606
|
+
"type": "boolean",
|
|
2607
|
+
"default": "true",
|
|
2608
|
+
"description": "Whether the component should be rendered."
|
|
2609
|
+
},
|
|
2610
|
+
{
|
|
2611
|
+
"name": "style",
|
|
2612
|
+
"type": "CSSProperties | ((instance?: MenuRootInstance) => CSSProperties)",
|
|
2613
|
+
"default": "",
|
|
2614
|
+
"description": "The style to apply to the component."
|
|
2615
|
+
},
|
|
2616
|
+
{
|
|
2617
|
+
"name": "className",
|
|
2618
|
+
"type": "string | ((instance?: MenuRootInstance) => string)",
|
|
2619
|
+
"default": "",
|
|
2620
|
+
"description": "The class name to apply to the component."
|
|
2621
|
+
},
|
|
2622
|
+
{
|
|
2623
|
+
"name": "as",
|
|
2624
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2625
|
+
"default": "",
|
|
2626
|
+
"description": "The component type to render."
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
"name": "asChild",
|
|
2630
|
+
"type": "boolean",
|
|
2631
|
+
"default": "false",
|
|
2632
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2633
|
+
},
|
|
2634
|
+
{
|
|
2635
|
+
"name": "instance",
|
|
2636
|
+
"type": "MenuRootInstance",
|
|
2637
|
+
"default": "",
|
|
2638
|
+
"description": "The instance to pass to the component."
|
|
2639
|
+
},
|
|
2640
|
+
{
|
|
2641
|
+
"name": "pt",
|
|
2642
|
+
"type": "SafeRecord<MenuRootPassThrough>",
|
|
2643
|
+
"default": "",
|
|
2644
|
+
"description": "The pass-through props to pass to the component."
|
|
2645
|
+
},
|
|
2646
|
+
{
|
|
2647
|
+
"name": "ptOptions",
|
|
2648
|
+
"type": "PassThroughOptions",
|
|
2649
|
+
"default": "",
|
|
2650
|
+
"description": "The pass-through options to pass to the component."
|
|
2651
|
+
},
|
|
2652
|
+
{
|
|
2653
|
+
"name": "unstyled",
|
|
2654
|
+
"type": "boolean",
|
|
2655
|
+
"default": "",
|
|
2656
|
+
"description": "Whether the component should be rendered without classes."
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
"name": "dt",
|
|
2660
|
+
"type": "unknown",
|
|
2661
|
+
"default": "",
|
|
2662
|
+
"description": "The design token to use for the component."
|
|
2663
|
+
},
|
|
2664
|
+
{
|
|
2665
|
+
"name": "styles",
|
|
2666
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2667
|
+
"default": "",
|
|
2668
|
+
"description": "The styles to use for the component."
|
|
2669
|
+
},
|
|
2670
|
+
{
|
|
2671
|
+
"name": "render",
|
|
2672
|
+
"type": "(instance: MenuRootInstance) => ReactNode",
|
|
2673
|
+
"default": "",
|
|
2674
|
+
"description": "The render function to render the component with instance access."
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
"name": "children",
|
|
2678
|
+
"type": "any",
|
|
2679
|
+
"default": "",
|
|
2680
|
+
"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."
|
|
2681
|
+
},
|
|
2682
|
+
{
|
|
2683
|
+
"name": "open",
|
|
2684
|
+
"type": "boolean",
|
|
2685
|
+
"default": "",
|
|
2686
|
+
"description": "Controlled open state of the menu."
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
"name": "defaultOpen",
|
|
2690
|
+
"type": "boolean",
|
|
2691
|
+
"default": "false",
|
|
2692
|
+
"description": "Default open state for uncontrolled mode."
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"name": "composite",
|
|
2696
|
+
"type": "boolean",
|
|
2697
|
+
"default": "false",
|
|
2698
|
+
"description": "Whether the menu is in composite mode (navigationmenu).\nIn composite mode, submenus open on hover and focusedOptionId is an array tracking the focus path."
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"name": "appendTo",
|
|
2702
|
+
"type": "\"body\" | HTMLElement | \"self\"",
|
|
2703
|
+
"default": "'body'",
|
|
2704
|
+
"description": "The element to which the overlay is appended."
|
|
2705
|
+
},
|
|
2706
|
+
{
|
|
2707
|
+
"name": "baseZIndex",
|
|
2708
|
+
"type": "number",
|
|
2709
|
+
"default": "0",
|
|
2710
|
+
"description": "Base zIndex value to use in layering."
|
|
2711
|
+
},
|
|
2712
|
+
{
|
|
2713
|
+
"name": "autoZIndex",
|
|
2714
|
+
"type": "boolean",
|
|
2715
|
+
"default": "true",
|
|
2716
|
+
"description": "Whether to automatically manage layering."
|
|
2717
|
+
},
|
|
2718
|
+
{
|
|
2719
|
+
"name": "tabIndex",
|
|
2720
|
+
"type": "number",
|
|
2721
|
+
"default": "0",
|
|
2722
|
+
"description": "Index of the element in tabbing order."
|
|
2723
|
+
},
|
|
2724
|
+
{
|
|
2725
|
+
"name": "openDelay",
|
|
2726
|
+
"type": "number",
|
|
2727
|
+
"default": "100",
|
|
2728
|
+
"description": "The delay in milliseconds before opening the menu when hovering the trigger.\nOnly applies when `openOnHover` is true."
|
|
2729
|
+
},
|
|
2730
|
+
{
|
|
2731
|
+
"name": "closeDelay",
|
|
2732
|
+
"type": "number",
|
|
2733
|
+
"default": "0",
|
|
2734
|
+
"description": "The delay in milliseconds before closing the menu when the pointer leaves the trigger.\nOnly applies when `openOnHover` is true."
|
|
2735
|
+
},
|
|
2736
|
+
{
|
|
2737
|
+
"name": "openOnHover",
|
|
2738
|
+
"type": "boolean",
|
|
2739
|
+
"default": "false",
|
|
2740
|
+
"description": "When true, the menu opens on pointer hover over the trigger (in addition to click)."
|
|
2741
|
+
},
|
|
2742
|
+
{
|
|
2743
|
+
"name": "context",
|
|
2744
|
+
"type": "UseMenuSubmenuExposes",
|
|
2745
|
+
"default": "",
|
|
2746
|
+
"description": "Optional parent submenu context whose popover state should drive this menu.\nWhen provided, useMenu reuses the parent submenu's popover (anchor, open\nstate, positioner) instead of creating its own. Forwarded by Menu.Root\nautomatically when nested inside a Menu.Submenu."
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"name": "navigationmenu",
|
|
2750
|
+
"type": "UseNavigationMenuExposes",
|
|
2751
|
+
"default": "",
|
|
2752
|
+
"description": "Optional parent NavigationMenu context. When provided, ArrowRight / ArrowLeft\npressed on a list item that is not a submenu trigger will move focus to\nthe next / previous sibling navigationmenu trigger (WAI-ARIA NavigationMenu pattern).\nForwarded by Menu.Root when nested inside a `NavigationMenu` ."
|
|
2753
|
+
},
|
|
2754
|
+
{
|
|
2755
|
+
"name": "navigationmenuMenuId",
|
|
2756
|
+
"type": "string",
|
|
2757
|
+
"default": "",
|
|
2758
|
+
"description": "The id this menu is registered under in the parent NavigationMenu's trigger\nregistry. Required for `navigationmenu` sibling navigation to know which\ntrigger is \"current\"."
|
|
2759
|
+
},
|
|
2760
|
+
{
|
|
2761
|
+
"name": "closeOnSelect",
|
|
2762
|
+
"type": "boolean",
|
|
2763
|
+
"default": "true",
|
|
2764
|
+
"description": "Whether the menu should close when an item is activated. Item-level\n `closeOnSelect` always overrides this default."
|
|
2765
|
+
},
|
|
2766
|
+
{
|
|
2767
|
+
"name": "onSelect",
|
|
2768
|
+
"type": "(event: MenuItemSelectEvent) => void",
|
|
2769
|
+
"default": "",
|
|
2770
|
+
"description": "Callback fired when any item inside the menu is activated (clicked or\ntriggered with keyboard). Calling `event.preventDefault()` keeps the\nmenu open regardless of `closeOnSelect` ."
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"name": "onOpenChange",
|
|
2774
|
+
"type": "(event: MenuRootOpenChangeEvent) => void",
|
|
2775
|
+
"default": "",
|
|
2776
|
+
"description": "Callback fired when the menu's open state changes."
|
|
2777
|
+
},
|
|
2778
|
+
{
|
|
2779
|
+
"name": "[key: string]",
|
|
2780
|
+
"type": "any",
|
|
2781
|
+
"description": ""
|
|
2782
|
+
},
|
|
2783
|
+
{
|
|
2784
|
+
"name": "pt-{optionName}-*",
|
|
2785
|
+
"type": "-",
|
|
2786
|
+
"default": "",
|
|
2787
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2788
|
+
"deprecated": false
|
|
2789
|
+
}
|
|
2790
|
+
],
|
|
2791
|
+
"methods": []
|
|
2792
|
+
},
|
|
2793
|
+
"MenuRootState": {
|
|
2794
|
+
"description": "Defines valid state in Menu component.",
|
|
2795
|
+
"relatedProp": "",
|
|
2796
|
+
"extendedTypes": "UseMenuState",
|
|
2797
|
+
"props": [
|
|
2798
|
+
{
|
|
2799
|
+
"name": "open",
|
|
2800
|
+
"type": "boolean",
|
|
2801
|
+
"default": "",
|
|
2802
|
+
"description": "Whether the menu is open."
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
"name": "focused",
|
|
2806
|
+
"type": "boolean",
|
|
2807
|
+
"default": "",
|
|
2808
|
+
"description": "Whether the menu is focused."
|
|
2809
|
+
},
|
|
2810
|
+
{
|
|
2811
|
+
"name": "focusedOptionId",
|
|
2812
|
+
"type": "string | string[]",
|
|
2813
|
+
"default": "",
|
|
2814
|
+
"description": "The ID of the focused option (HTML id attribute).\nIn composite mode, this is an array representing the focus path (e.g., ['menu_0', 'menu_0_1']).\nThe last element is used for aria-activedescendant."
|
|
2815
|
+
}
|
|
2816
|
+
],
|
|
2817
|
+
"methods": []
|
|
2818
|
+
},
|
|
2819
|
+
"MenuRootExposes": {
|
|
2820
|
+
"description": "Defines the methods and properties exposed by Menu component.",
|
|
2821
|
+
"relatedProp": "",
|
|
2822
|
+
"extendedTypes": "UseMenuExposes",
|
|
2823
|
+
"props": [
|
|
2824
|
+
{
|
|
2825
|
+
"name": "state",
|
|
2826
|
+
"type": "UseMenuState",
|
|
2827
|
+
"default": "",
|
|
2828
|
+
"description": "The state of the useMenu."
|
|
2829
|
+
},
|
|
2830
|
+
{
|
|
2831
|
+
"name": "popover",
|
|
2832
|
+
"type": "UsePopoverExposes",
|
|
2833
|
+
"default": "",
|
|
2834
|
+
"description": "The popover instance for managing popup state and positioning."
|
|
2835
|
+
},
|
|
2836
|
+
{
|
|
2837
|
+
"name": "rootProps",
|
|
2838
|
+
"type": "UseMenuRootProps",
|
|
2839
|
+
"default": "",
|
|
2840
|
+
"description": "Props for the root element."
|
|
2841
|
+
},
|
|
2842
|
+
{
|
|
2843
|
+
"name": "triggerProps",
|
|
2844
|
+
"type": "UseMenuTriggerProps",
|
|
2845
|
+
"default": "",
|
|
2846
|
+
"description": "Props for the trigger element."
|
|
2847
|
+
},
|
|
2848
|
+
{
|
|
2849
|
+
"name": "arrowProps",
|
|
2850
|
+
"type": "UsePopoverArrowProps",
|
|
2851
|
+
"default": "",
|
|
2852
|
+
"description": "Props for the arrow element."
|
|
2853
|
+
},
|
|
2854
|
+
{
|
|
2855
|
+
"name": "popupProps",
|
|
2856
|
+
"type": "UsePopoverPopupProps",
|
|
2857
|
+
"default": "",
|
|
2858
|
+
"description": "Props for the popup element."
|
|
2859
|
+
},
|
|
2860
|
+
{
|
|
2861
|
+
"name": "positionerProps",
|
|
2862
|
+
"type": "UsePopoverPositionerProps",
|
|
2863
|
+
"default": "",
|
|
2864
|
+
"description": "Props for the positioner element."
|
|
2865
|
+
},
|
|
2866
|
+
{
|
|
2867
|
+
"name": "labelProps",
|
|
2868
|
+
"type": "UseMenuLabelProps",
|
|
2869
|
+
"default": "",
|
|
2870
|
+
"description": "Props for the label element."
|
|
2871
|
+
},
|
|
2872
|
+
{
|
|
2873
|
+
"name": "separatorProps",
|
|
2874
|
+
"type": "UseMenuSeparatorProps",
|
|
2875
|
+
"default": "",
|
|
2876
|
+
"description": "Props for the separator element."
|
|
2877
|
+
},
|
|
2878
|
+
{
|
|
2879
|
+
"name": "radioGroupProps",
|
|
2880
|
+
"type": "UseMenuRadioGroupProps",
|
|
2881
|
+
"default": "",
|
|
2882
|
+
"description": "Props for the radio group element."
|
|
2883
|
+
},
|
|
2884
|
+
{
|
|
2885
|
+
"name": "getItemId",
|
|
2886
|
+
"type": "(value: string) => string",
|
|
2887
|
+
"default": "",
|
|
2888
|
+
"description": "Generate a deterministic DOM id for an item given its value."
|
|
2889
|
+
},
|
|
2890
|
+
{
|
|
2891
|
+
"name": "getListId",
|
|
2892
|
+
"type": "(value?: string) => string",
|
|
2893
|
+
"default": "",
|
|
2894
|
+
"description": "Generate a deterministic DOM id for a list given an optional value."
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"name": "getItemProps",
|
|
2898
|
+
"type": "(input: UseMenuGetItemPropsInput) => UseMenuGetItemPropsReturn",
|
|
2899
|
+
"default": "",
|
|
2900
|
+
"description": "Get props for a menu item element. Returns ARIA attributes, data attributes, and mouse handlers."
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"name": "getSubTriggerProps",
|
|
2904
|
+
"type": "(input: UseMenuGetSubTriggerPropsInput) => UseMenuGetSubTriggerPropsReturn",
|
|
2905
|
+
"default": "",
|
|
2906
|
+
"description": "Get props for a submenu trigger element. Returns ARIA attributes, data attributes, and mouse handlers."
|
|
2907
|
+
},
|
|
2908
|
+
{
|
|
2909
|
+
"name": "getListProps",
|
|
2910
|
+
"type": "(input?: UseMenuGetListPropsInput) => UseMenuGetListPropsReturn",
|
|
2911
|
+
"default": "",
|
|
2912
|
+
"description": "Get props for a menu list element. Returns role, ARIA attributes, keyboard handlers, and focus handlers."
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"name": "getIndicatorProps",
|
|
2916
|
+
"type": "(input: UseMenuGetIndicatorPropsInput) => UseMenuGetIndicatorPropsReturn",
|
|
2917
|
+
"default": "",
|
|
2918
|
+
"description": "Get props for a menu indicator element. Returns data attributes and matchVisible flag based on indicator context."
|
|
2919
|
+
},
|
|
2920
|
+
{
|
|
2921
|
+
"name": "checkboxItemIndicatorProps",
|
|
2922
|
+
"type": "UseMenuIndicatorProps",
|
|
2923
|
+
"default": "",
|
|
2924
|
+
"description": "Static data attributes for the checkbox item indicator element."
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
"name": "radioItemIndicatorProps",
|
|
2928
|
+
"type": "UseMenuIndicatorProps",
|
|
2929
|
+
"default": "",
|
|
2930
|
+
"description": "Static data attributes for the radio item indicator element."
|
|
2931
|
+
},
|
|
2932
|
+
{
|
|
2933
|
+
"name": "submenuIndicatorProps",
|
|
2934
|
+
"type": "UseMenuIndicatorProps",
|
|
2935
|
+
"default": "",
|
|
2936
|
+
"description": "Static data attributes for the submenu indicator element."
|
|
2937
|
+
},
|
|
2938
|
+
{
|
|
2939
|
+
"name": "isFocused",
|
|
2940
|
+
"type": "(id: string) => boolean",
|
|
2941
|
+
"default": "",
|
|
2942
|
+
"description": "Check whether a given item ID is currently focused."
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
"name": "updateItemAria",
|
|
2946
|
+
"type": "(element: HTMLElement) => void",
|
|
2947
|
+
"default": "",
|
|
2948
|
+
"description": "Update ARIA level/position attributes on an item element using DOM-based calculation.\nShould be called after the element is mounted (e.g., in registerItem or useLayoutEffect)."
|
|
2949
|
+
},
|
|
2950
|
+
{
|
|
2951
|
+
"name": "onTriggerClick",
|
|
2952
|
+
"type": "(event?: MouseEvent) => void",
|
|
2953
|
+
"default": "",
|
|
2954
|
+
"description": "Handle trigger click event."
|
|
2955
|
+
},
|
|
2956
|
+
{
|
|
2957
|
+
"name": "onOverlayEnter",
|
|
2958
|
+
"type": "() => void",
|
|
2959
|
+
"default": "",
|
|
2960
|
+
"description": "Handle overlay enter event."
|
|
2961
|
+
},
|
|
2962
|
+
{
|
|
2963
|
+
"name": "changeVisibleState",
|
|
2964
|
+
"type": "(isVisible: boolean) => void",
|
|
2965
|
+
"default": "",
|
|
2966
|
+
"description": "Change the visible state."
|
|
2967
|
+
},
|
|
2968
|
+
{
|
|
2969
|
+
"name": "onListFocus",
|
|
2970
|
+
"type": "() => void",
|
|
2971
|
+
"default": "",
|
|
2972
|
+
"description": "Handle list focus event."
|
|
2973
|
+
},
|
|
2974
|
+
{
|
|
2975
|
+
"name": "onListBlur",
|
|
2976
|
+
"type": "() => void",
|
|
2977
|
+
"default": "",
|
|
2978
|
+
"description": "Handle list blur event."
|
|
2979
|
+
},
|
|
2980
|
+
{
|
|
2981
|
+
"name": "onListKeyDown",
|
|
2982
|
+
"type": "(event: KeyboardEvent) => void",
|
|
2983
|
+
"default": "",
|
|
2984
|
+
"description": "Handle keyboard events on the list."
|
|
2985
|
+
},
|
|
2986
|
+
{
|
|
2987
|
+
"name": "markMouseInteraction",
|
|
2988
|
+
"type": "(isMouseInteraction: boolean) => void",
|
|
2989
|
+
"default": "",
|
|
2990
|
+
"description": "Mark that a mouse interaction is in progress.\nPrevents onListFocus from auto-focusing the first item."
|
|
2991
|
+
},
|
|
2992
|
+
{
|
|
2993
|
+
"name": "changeFocusedOptionId",
|
|
2994
|
+
"type": "(id: string) => void",
|
|
2995
|
+
"default": "",
|
|
2996
|
+
"description": "Change the focused option ID.\nIn composite mode, uses DOM-based level detection."
|
|
2997
|
+
},
|
|
2998
|
+
{
|
|
2999
|
+
"name": "hideSubmenusAfterLevel",
|
|
3000
|
+
"type": "(targetItemId: string) => void",
|
|
3001
|
+
"default": "",
|
|
3002
|
+
"description": "Hide all submenus at or after a specific level (composite mode only).\nUses DOM-based level detection."
|
|
3003
|
+
},
|
|
3004
|
+
{
|
|
3005
|
+
"name": "hideAllSubmenus",
|
|
3006
|
+
"type": "() => void",
|
|
3007
|
+
"default": "",
|
|
3008
|
+
"description": "Hide all open submenus and reset focus (composite mode only)."
|
|
3009
|
+
},
|
|
3010
|
+
{
|
|
3011
|
+
"name": "onItemClick",
|
|
3012
|
+
"type": "(event: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>, isBlur?: boolean, isPortal?: boolean) => void",
|
|
3013
|
+
"default": "",
|
|
3014
|
+
"description": "Handle item click event."
|
|
3015
|
+
}
|
|
3016
|
+
],
|
|
3017
|
+
"methods": []
|
|
3018
|
+
}
|
|
3019
|
+
},
|
|
3020
|
+
"types": {
|
|
3021
|
+
"MenuRootPassThroughType": {
|
|
3022
|
+
"description": "Defines passthrough(pt) options type in Menu component.",
|
|
3023
|
+
"values": "PassThroughType<MenuRootInstance, E>"
|
|
3024
|
+
},
|
|
3025
|
+
"MenuRootInstance": {
|
|
3026
|
+
"description": "Instance of Menu component.",
|
|
3027
|
+
"values": "ComponentInstance<MenuRootProps, MenuRootState, MenuRootExposes>"
|
|
3028
|
+
}
|
|
3029
|
+
},
|
|
3030
|
+
"variables": {}
|
|
3031
|
+
}
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
"name": "MenuSeparator",
|
|
3035
|
+
"source": "apps/showcase/assets/apidoc/menuseparator.json",
|
|
3036
|
+
"data": {
|
|
3037
|
+
"description": "MenuSeparator is a component that displays a separator.",
|
|
3038
|
+
"interfaces": {
|
|
3039
|
+
"MenuSeparatorPassThrough": {
|
|
3040
|
+
"description": "Defines passthrough(pt) options of MenuSeparator component.",
|
|
3041
|
+
"relatedProp": "",
|
|
3042
|
+
"props": [
|
|
3043
|
+
{
|
|
3044
|
+
"name": "root",
|
|
3045
|
+
"type": "MenuSeparatorPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
3046
|
+
"default": "",
|
|
3047
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3048
|
+
}
|
|
3049
|
+
],
|
|
3050
|
+
"methods": []
|
|
3051
|
+
},
|
|
3052
|
+
"MenuSeparatorProps": {
|
|
3053
|
+
"description": "Defines valid properties in MenuSeparator component.",
|
|
3054
|
+
"relatedProp": "",
|
|
3055
|
+
"extendedTypes": "BaseComponentProps<MenuSeparatorInstance, unknown, MenuSeparatorPassThrough>",
|
|
3056
|
+
"props": [
|
|
3057
|
+
{
|
|
3058
|
+
"name": "ref",
|
|
3059
|
+
"type": "Ref<unknown>",
|
|
3060
|
+
"default": "",
|
|
3061
|
+
"description": "The reference to the component instance."
|
|
3062
|
+
},
|
|
3063
|
+
{
|
|
3064
|
+
"name": "pIf",
|
|
3065
|
+
"type": "boolean",
|
|
3066
|
+
"default": "true",
|
|
3067
|
+
"description": "Whether the component should be rendered."
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"name": "style",
|
|
3071
|
+
"type": "CSSProperties | ((instance?: MenuSeparatorInstance) => CSSProperties)",
|
|
3072
|
+
"default": "",
|
|
3073
|
+
"description": "The style to apply to the component."
|
|
3074
|
+
},
|
|
3075
|
+
{
|
|
3076
|
+
"name": "className",
|
|
3077
|
+
"type": "string | ((instance?: MenuSeparatorInstance) => string)",
|
|
3078
|
+
"default": "",
|
|
3079
|
+
"description": "The class name to apply to the component."
|
|
3080
|
+
},
|
|
3081
|
+
{
|
|
3082
|
+
"name": "as",
|
|
3083
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3084
|
+
"default": "",
|
|
3085
|
+
"description": "The component type to render."
|
|
3086
|
+
},
|
|
3087
|
+
{
|
|
3088
|
+
"name": "asChild",
|
|
3089
|
+
"type": "boolean",
|
|
3090
|
+
"default": "false",
|
|
3091
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3092
|
+
},
|
|
3093
|
+
{
|
|
3094
|
+
"name": "instance",
|
|
3095
|
+
"type": "MenuSeparatorInstance",
|
|
3096
|
+
"default": "",
|
|
3097
|
+
"description": "The instance to pass to the component."
|
|
3098
|
+
},
|
|
3099
|
+
{
|
|
3100
|
+
"name": "pt",
|
|
3101
|
+
"type": "SafeRecord<MenuSeparatorPassThrough>",
|
|
3102
|
+
"default": "",
|
|
3103
|
+
"description": "The pass-through props to pass to the component."
|
|
3104
|
+
},
|
|
3105
|
+
{
|
|
3106
|
+
"name": "ptOptions",
|
|
3107
|
+
"type": "PassThroughOptions",
|
|
3108
|
+
"default": "",
|
|
3109
|
+
"description": "The pass-through options to pass to the component."
|
|
3110
|
+
},
|
|
3111
|
+
{
|
|
3112
|
+
"name": "unstyled",
|
|
3113
|
+
"type": "boolean",
|
|
3114
|
+
"default": "",
|
|
3115
|
+
"description": "Whether the component should be rendered without classes."
|
|
3116
|
+
},
|
|
3117
|
+
{
|
|
3118
|
+
"name": "dt",
|
|
3119
|
+
"type": "unknown",
|
|
3120
|
+
"default": "",
|
|
3121
|
+
"description": "The design token to use for the component."
|
|
3122
|
+
},
|
|
3123
|
+
{
|
|
3124
|
+
"name": "styles",
|
|
3125
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3126
|
+
"default": "",
|
|
3127
|
+
"description": "The styles to use for the component."
|
|
3128
|
+
},
|
|
3129
|
+
{
|
|
3130
|
+
"name": "render",
|
|
3131
|
+
"type": "(instance: MenuSeparatorInstance) => ReactNode",
|
|
3132
|
+
"default": "",
|
|
3133
|
+
"description": "The render function to render the component with instance access."
|
|
3134
|
+
},
|
|
3135
|
+
{
|
|
3136
|
+
"name": "children",
|
|
3137
|
+
"type": "any",
|
|
3138
|
+
"default": "",
|
|
3139
|
+
"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."
|
|
3140
|
+
},
|
|
3141
|
+
{
|
|
3142
|
+
"name": "[key: string]",
|
|
3143
|
+
"type": "any",
|
|
3144
|
+
"description": ""
|
|
3145
|
+
},
|
|
3146
|
+
{
|
|
3147
|
+
"name": "pt-{optionName}-*",
|
|
3148
|
+
"type": "-",
|
|
3149
|
+
"default": "",
|
|
3150
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3151
|
+
"deprecated": false
|
|
3152
|
+
}
|
|
3153
|
+
],
|
|
3154
|
+
"methods": []
|
|
3155
|
+
},
|
|
3156
|
+
"MenuSeparatorState": {
|
|
3157
|
+
"description": "Defines valid state in MenuSeparator component.",
|
|
3158
|
+
"relatedProp": "",
|
|
3159
|
+
"props": [],
|
|
3160
|
+
"methods": []
|
|
3161
|
+
},
|
|
3162
|
+
"MenuSeparatorExposes": {
|
|
3163
|
+
"description": "Defines the methods and properties exposed by MenuSeparator component.",
|
|
3164
|
+
"relatedProp": "",
|
|
3165
|
+
"props": [
|
|
3166
|
+
{
|
|
3167
|
+
"name": "menu",
|
|
3168
|
+
"type": "MenuRootInstance",
|
|
3169
|
+
"default": "",
|
|
3170
|
+
"description": "Instance of the Menu component."
|
|
3171
|
+
}
|
|
3172
|
+
],
|
|
3173
|
+
"methods": []
|
|
3174
|
+
}
|
|
3175
|
+
},
|
|
3176
|
+
"types": {
|
|
3177
|
+
"MenuSeparatorPassThroughType": {
|
|
3178
|
+
"description": "Defines passthrough(pt) options type in MenuSeparator component.",
|
|
3179
|
+
"values": "PassThroughType<MenuSeparatorInstance, E>"
|
|
3180
|
+
},
|
|
3181
|
+
"MenuSeparatorInstance": {
|
|
3182
|
+
"description": "Instance of MenuSeparator component.",
|
|
3183
|
+
"values": "ComponentInstance<MenuSeparatorProps, MenuSeparatorState, MenuSeparatorExposes>"
|
|
3184
|
+
}
|
|
3185
|
+
},
|
|
3186
|
+
"variables": {}
|
|
3187
|
+
}
|
|
3188
|
+
},
|
|
3189
|
+
{
|
|
3190
|
+
"name": "MenuSubmenu",
|
|
3191
|
+
"source": "apps/showcase/assets/apidoc/menusubmenu.json",
|
|
3192
|
+
"data": {
|
|
3193
|
+
"description": "MenuSubmenu is a submenu component for nested menu structures.",
|
|
3194
|
+
"interfaces": {
|
|
3195
|
+
"MenuSubmenuPassThrough": {
|
|
3196
|
+
"description": "Defines passthrough(pt) options of MenuSubmenu component.",
|
|
3197
|
+
"relatedProp": "",
|
|
3198
|
+
"props": [
|
|
3199
|
+
{
|
|
3200
|
+
"name": "root",
|
|
3201
|
+
"type": "MenuSubmenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
3202
|
+
"default": "",
|
|
3203
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3204
|
+
}
|
|
3205
|
+
],
|
|
3206
|
+
"methods": []
|
|
3207
|
+
},
|
|
3208
|
+
"MenuSubmenuOpenChangeEvent": {
|
|
3209
|
+
"description": "Event fired when the menu's open state changes.",
|
|
3210
|
+
"relatedProp": "",
|
|
3211
|
+
"extendedTypes": "UseMenuSubmenuOpenChangeEvent",
|
|
3212
|
+
"props": [
|
|
3213
|
+
{
|
|
3214
|
+
"name": "originalEvent",
|
|
3215
|
+
"type": "Event",
|
|
3216
|
+
"default": "",
|
|
3217
|
+
"description": "The original browser event that triggered the change."
|
|
3218
|
+
},
|
|
3219
|
+
{
|
|
3220
|
+
"name": "open",
|
|
3221
|
+
"type": "boolean",
|
|
3222
|
+
"default": "",
|
|
3223
|
+
"description": "The open state of the submenu."
|
|
3224
|
+
}
|
|
3225
|
+
],
|
|
3226
|
+
"methods": []
|
|
3227
|
+
},
|
|
3228
|
+
"MenuSubmenuProps": {
|
|
3229
|
+
"description": "Defines valid properties in MenuSubmenu component.",
|
|
3230
|
+
"relatedProp": "",
|
|
3231
|
+
"extendedTypes": "BaseComponentProps<MenuSubmenuInstance, Omit<UseMenuSubmenuProps, \"onOpenChange\">, MenuSubmenuPassThrough>",
|
|
3232
|
+
"props": [
|
|
3233
|
+
{
|
|
3234
|
+
"name": "ref",
|
|
3235
|
+
"type": "Ref<unknown>",
|
|
3236
|
+
"default": "",
|
|
3237
|
+
"description": "The reference to the component instance."
|
|
3238
|
+
},
|
|
3239
|
+
{
|
|
3240
|
+
"name": "pIf",
|
|
3241
|
+
"type": "boolean",
|
|
3242
|
+
"default": "true",
|
|
3243
|
+
"description": "Whether the component should be rendered."
|
|
3244
|
+
},
|
|
3245
|
+
{
|
|
3246
|
+
"name": "style",
|
|
3247
|
+
"type": "CSSProperties | ((instance?: MenuSubmenuInstance) => CSSProperties)",
|
|
3248
|
+
"default": "",
|
|
3249
|
+
"description": "The style to apply to the component."
|
|
3250
|
+
},
|
|
3251
|
+
{
|
|
3252
|
+
"name": "className",
|
|
3253
|
+
"type": "string | ((instance?: MenuSubmenuInstance) => string)",
|
|
3254
|
+
"default": "",
|
|
3255
|
+
"description": "The class name to apply to the component."
|
|
3256
|
+
},
|
|
3257
|
+
{
|
|
3258
|
+
"name": "as",
|
|
3259
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3260
|
+
"default": "",
|
|
3261
|
+
"description": "The component type to render."
|
|
3262
|
+
},
|
|
3263
|
+
{
|
|
3264
|
+
"name": "asChild",
|
|
3265
|
+
"type": "boolean",
|
|
3266
|
+
"default": "false",
|
|
3267
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3268
|
+
},
|
|
3269
|
+
{
|
|
3270
|
+
"name": "instance",
|
|
3271
|
+
"type": "MenuSubmenuInstance",
|
|
3272
|
+
"default": "",
|
|
3273
|
+
"description": "The instance to pass to the component."
|
|
3274
|
+
},
|
|
3275
|
+
{
|
|
3276
|
+
"name": "pt",
|
|
3277
|
+
"type": "SafeRecord<MenuSubmenuPassThrough>",
|
|
3278
|
+
"default": "",
|
|
3279
|
+
"description": "The pass-through props to pass to the component."
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"name": "ptOptions",
|
|
3283
|
+
"type": "PassThroughOptions",
|
|
3284
|
+
"default": "",
|
|
3285
|
+
"description": "The pass-through options to pass to the component."
|
|
3286
|
+
},
|
|
3287
|
+
{
|
|
3288
|
+
"name": "unstyled",
|
|
3289
|
+
"type": "boolean",
|
|
3290
|
+
"default": "",
|
|
3291
|
+
"description": "Whether the component should be rendered without classes."
|
|
3292
|
+
},
|
|
3293
|
+
{
|
|
3294
|
+
"name": "dt",
|
|
3295
|
+
"type": "unknown",
|
|
3296
|
+
"default": "",
|
|
3297
|
+
"description": "The design token to use for the component."
|
|
3298
|
+
},
|
|
3299
|
+
{
|
|
3300
|
+
"name": "styles",
|
|
3301
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3302
|
+
"default": "",
|
|
3303
|
+
"description": "The styles to use for the component."
|
|
3304
|
+
},
|
|
3305
|
+
{
|
|
3306
|
+
"name": "render",
|
|
3307
|
+
"type": "(instance: MenuSubmenuInstance) => ReactNode",
|
|
3308
|
+
"default": "",
|
|
3309
|
+
"description": "The render function to render the component with instance access."
|
|
3310
|
+
},
|
|
3311
|
+
{
|
|
3312
|
+
"name": "children",
|
|
3313
|
+
"type": "any",
|
|
3314
|
+
"default": "",
|
|
3315
|
+
"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."
|
|
3316
|
+
},
|
|
3317
|
+
{
|
|
3318
|
+
"name": "open",
|
|
3319
|
+
"type": "boolean",
|
|
3320
|
+
"default": "",
|
|
3321
|
+
"description": "Controlled open state of the submenu."
|
|
3322
|
+
},
|
|
3323
|
+
{
|
|
3324
|
+
"name": "defaultOpen",
|
|
3325
|
+
"type": "boolean",
|
|
3326
|
+
"default": "false",
|
|
3327
|
+
"description": "Default open state for uncontrolled mode."
|
|
3328
|
+
},
|
|
3329
|
+
{
|
|
3330
|
+
"name": "openDelay",
|
|
3331
|
+
"type": "number",
|
|
3332
|
+
"default": "100",
|
|
3333
|
+
"description": "The delay in milliseconds before opening the submenu when hovering the subtrigger.\nOnly applies when `openOnHover` is true."
|
|
3334
|
+
},
|
|
3335
|
+
{
|
|
3336
|
+
"name": "closeDelay",
|
|
3337
|
+
"type": "number",
|
|
3338
|
+
"default": "0",
|
|
3339
|
+
"description": "The delay in milliseconds before closing the submenu when the pointer leaves the subtrigger.\nOnly applies when `openOnHover` is true."
|
|
3340
|
+
},
|
|
3341
|
+
{
|
|
3342
|
+
"name": "openOnHover",
|
|
3343
|
+
"type": "boolean",
|
|
3344
|
+
"default": "true",
|
|
3345
|
+
"description": "When true, the submenu opens on pointer hover over the subtrigger."
|
|
3346
|
+
},
|
|
3347
|
+
{
|
|
3348
|
+
"name": "disabled",
|
|
3349
|
+
"type": "boolean",
|
|
3350
|
+
"default": "false",
|
|
3351
|
+
"description": "Whether the submenu is disabled."
|
|
3352
|
+
},
|
|
3353
|
+
{
|
|
3354
|
+
"name": "onOpenChange",
|
|
3355
|
+
"type": "(event: MenuSubmenuOpenChangeEvent) => void",
|
|
3356
|
+
"default": "",
|
|
3357
|
+
"description": "Callback fired when the submenu's open state changes."
|
|
3358
|
+
},
|
|
3359
|
+
{
|
|
3360
|
+
"name": "[key: string]",
|
|
3361
|
+
"type": "any",
|
|
3362
|
+
"description": ""
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
"name": "pt-{optionName}-*",
|
|
3366
|
+
"type": "-",
|
|
3367
|
+
"default": "",
|
|
3368
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3369
|
+
"deprecated": false
|
|
3370
|
+
}
|
|
3371
|
+
],
|
|
3372
|
+
"methods": []
|
|
3373
|
+
},
|
|
3374
|
+
"MenuSubmenuState": {
|
|
3375
|
+
"description": "Defines valid state in MenuSubmenu component.",
|
|
3376
|
+
"relatedProp": "",
|
|
3377
|
+
"extendedTypes": "UseMenuSubmenuState",
|
|
3378
|
+
"props": [
|
|
3379
|
+
{
|
|
3380
|
+
"name": "open",
|
|
3381
|
+
"type": "boolean",
|
|
3382
|
+
"default": "",
|
|
3383
|
+
"description": "Whether the submenu is open."
|
|
3384
|
+
}
|
|
3385
|
+
],
|
|
3386
|
+
"methods": []
|
|
3387
|
+
},
|
|
3388
|
+
"MenuSubmenuExposes": {
|
|
3389
|
+
"description": "Defines the methods and properties exposed by MenuSubmenu component.",
|
|
3390
|
+
"relatedProp": "",
|
|
3391
|
+
"extendedTypes": "UseMenuSubmenuExposes",
|
|
3392
|
+
"props": [
|
|
3393
|
+
{
|
|
3394
|
+
"name": "state",
|
|
3395
|
+
"type": "UseMenuSubmenuState",
|
|
3396
|
+
"default": "",
|
|
3397
|
+
"description": "The state of the useMenuSubmenu."
|
|
3398
|
+
},
|
|
3399
|
+
{
|
|
3400
|
+
"name": "popover",
|
|
3401
|
+
"type": "UsePopoverExposes",
|
|
3402
|
+
"default": "",
|
|
3403
|
+
"description": "The popover instance for managing popup state and positioning."
|
|
3404
|
+
},
|
|
3405
|
+
{
|
|
3406
|
+
"name": "listRef",
|
|
3407
|
+
"type": "RefObject<HTMLDivElement>",
|
|
3408
|
+
"default": "",
|
|
3409
|
+
"description": "Reference to the list element."
|
|
3410
|
+
},
|
|
3411
|
+
{
|
|
3412
|
+
"name": "subtriggerProps",
|
|
3413
|
+
"type": "{ ref: (node: HTMLElement) => void }",
|
|
3414
|
+
"default": "",
|
|
3415
|
+
"description": "Props for the subtrigger element."
|
|
3416
|
+
},
|
|
3417
|
+
{
|
|
3418
|
+
"name": "subProps",
|
|
3419
|
+
"type": "UseMenuSubmenuWrapperProps",
|
|
3420
|
+
"default": "",
|
|
3421
|
+
"description": "Props for the sub wrapper element."
|
|
3422
|
+
},
|
|
3423
|
+
{
|
|
3424
|
+
"name": "listProps",
|
|
3425
|
+
"type": "UseMenuSubmenuListProps",
|
|
3426
|
+
"default": "",
|
|
3427
|
+
"description": "Props for the list element."
|
|
3428
|
+
},
|
|
3429
|
+
{
|
|
3430
|
+
"name": "toggle",
|
|
3431
|
+
"type": "() => void",
|
|
3432
|
+
"default": "",
|
|
3433
|
+
"description": "Toggle the submenu open/close state."
|
|
3434
|
+
},
|
|
3435
|
+
{
|
|
3436
|
+
"name": "open",
|
|
3437
|
+
"type": "() => void",
|
|
3438
|
+
"default": "",
|
|
3439
|
+
"description": "Open the submenu (composite mode)."
|
|
3440
|
+
},
|
|
3441
|
+
{
|
|
3442
|
+
"name": "close",
|
|
3443
|
+
"type": "() => void",
|
|
3444
|
+
"default": "",
|
|
3445
|
+
"description": "Close the submenu (composite mode)."
|
|
3446
|
+
},
|
|
3447
|
+
{
|
|
3448
|
+
"name": "openDelay",
|
|
3449
|
+
"type": "number",
|
|
3450
|
+
"default": "",
|
|
3451
|
+
"description": "Open delay in ms (echoed for the parent Menu's hover handler)."
|
|
3452
|
+
},
|
|
3453
|
+
{
|
|
3454
|
+
"name": "closeDelay",
|
|
3455
|
+
"type": "number",
|
|
3456
|
+
"default": "",
|
|
3457
|
+
"description": "Close delay in ms (echoed for the parent Menu's hover handler)."
|
|
3458
|
+
},
|
|
3459
|
+
{
|
|
3460
|
+
"name": "openOnHover",
|
|
3461
|
+
"type": "boolean",
|
|
3462
|
+
"default": "",
|
|
3463
|
+
"description": "Whether hover should trigger open/close (echoed for the parent Menu's\nhover handler)."
|
|
3464
|
+
},
|
|
3465
|
+
{
|
|
3466
|
+
"name": "menu",
|
|
3467
|
+
"type": "MenuRootInstance",
|
|
3468
|
+
"default": "",
|
|
3469
|
+
"description": "The Menu component instance."
|
|
3470
|
+
}
|
|
3471
|
+
],
|
|
3472
|
+
"methods": []
|
|
3473
|
+
}
|
|
3474
|
+
},
|
|
3475
|
+
"types": {
|
|
3476
|
+
"MenuSubmenuPassThroughType": {
|
|
3477
|
+
"description": "Defines passthrough(pt) options type in MenuSubmenu component.",
|
|
3478
|
+
"values": "PassThroughType<MenuSubmenuInstance, E>"
|
|
3479
|
+
},
|
|
3480
|
+
"MenuSubmenuInstance": {
|
|
3481
|
+
"description": "Instance of MenuSubmenu component.",
|
|
3482
|
+
"values": "ComponentInstance<MenuSubmenuProps, MenuSubmenuState, MenuSubmenuExposes>"
|
|
3483
|
+
}
|
|
3484
|
+
},
|
|
3485
|
+
"variables": {}
|
|
3486
|
+
}
|
|
3487
|
+
},
|
|
3488
|
+
{
|
|
3489
|
+
"name": "MenuSubmenuTrigger",
|
|
3490
|
+
"source": "apps/showcase/assets/apidoc/menusubmenutrigger.json",
|
|
3491
|
+
"data": {
|
|
3492
|
+
"description": "MenuSubmenuTrigger is a component that displays the trigger for a submenu item.",
|
|
3493
|
+
"interfaces": {
|
|
3494
|
+
"MenuSubmenuTriggerPassThrough": {
|
|
3495
|
+
"description": "Defines passthrough(pt) options of MenuSubmenuTrigger component.",
|
|
3496
|
+
"relatedProp": "",
|
|
3497
|
+
"props": [
|
|
3498
|
+
{
|
|
3499
|
+
"name": "root",
|
|
3500
|
+
"type": "MenuSubmenuTriggerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
3501
|
+
"default": "",
|
|
3502
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3503
|
+
}
|
|
3504
|
+
],
|
|
3505
|
+
"methods": []
|
|
3506
|
+
},
|
|
3507
|
+
"MenuSubmenuTriggerProps": {
|
|
3508
|
+
"description": "Defines valid properties in MenuSubmenuTrigger component.",
|
|
3509
|
+
"relatedProp": "",
|
|
3510
|
+
"extendedTypes": "BaseComponentProps<MenuSubmenuTriggerInstance, unknown, MenuSubmenuTriggerPassThrough>",
|
|
3511
|
+
"props": [
|
|
3512
|
+
{
|
|
3513
|
+
"name": "ref",
|
|
3514
|
+
"type": "Ref<unknown>",
|
|
3515
|
+
"default": "",
|
|
3516
|
+
"description": "The reference to the component instance."
|
|
3517
|
+
},
|
|
3518
|
+
{
|
|
3519
|
+
"name": "pIf",
|
|
3520
|
+
"type": "boolean",
|
|
3521
|
+
"default": "true",
|
|
3522
|
+
"description": "Whether the component should be rendered."
|
|
3523
|
+
},
|
|
3524
|
+
{
|
|
3525
|
+
"name": "style",
|
|
3526
|
+
"type": "CSSProperties | ((instance?: MenuSubmenuTriggerInstance) => CSSProperties)",
|
|
3527
|
+
"default": "",
|
|
3528
|
+
"description": "The style to apply to the component."
|
|
3529
|
+
},
|
|
3530
|
+
{
|
|
3531
|
+
"name": "className",
|
|
3532
|
+
"type": "string | ((instance?: MenuSubmenuTriggerInstance) => string)",
|
|
3533
|
+
"default": "",
|
|
3534
|
+
"description": "The class name to apply to the component."
|
|
3535
|
+
},
|
|
3536
|
+
{
|
|
3537
|
+
"name": "as",
|
|
3538
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3539
|
+
"default": "",
|
|
3540
|
+
"description": "The component type to render."
|
|
3541
|
+
},
|
|
3542
|
+
{
|
|
3543
|
+
"name": "asChild",
|
|
3544
|
+
"type": "boolean",
|
|
3545
|
+
"default": "false",
|
|
3546
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3547
|
+
},
|
|
3548
|
+
{
|
|
3549
|
+
"name": "instance",
|
|
3550
|
+
"type": "MenuSubmenuTriggerInstance",
|
|
3551
|
+
"default": "",
|
|
3552
|
+
"description": "The instance to pass to the component."
|
|
3553
|
+
},
|
|
3554
|
+
{
|
|
3555
|
+
"name": "pt",
|
|
3556
|
+
"type": "SafeRecord<MenuSubmenuTriggerPassThrough>",
|
|
3557
|
+
"default": "",
|
|
3558
|
+
"description": "The pass-through props to pass to the component."
|
|
3559
|
+
},
|
|
3560
|
+
{
|
|
3561
|
+
"name": "ptOptions",
|
|
3562
|
+
"type": "PassThroughOptions",
|
|
3563
|
+
"default": "",
|
|
3564
|
+
"description": "The pass-through options to pass to the component."
|
|
3565
|
+
},
|
|
3566
|
+
{
|
|
3567
|
+
"name": "unstyled",
|
|
3568
|
+
"type": "boolean",
|
|
3569
|
+
"default": "",
|
|
3570
|
+
"description": "Whether the component should be rendered without classes."
|
|
3571
|
+
},
|
|
3572
|
+
{
|
|
3573
|
+
"name": "dt",
|
|
3574
|
+
"type": "unknown",
|
|
3575
|
+
"default": "",
|
|
3576
|
+
"description": "The design token to use for the component."
|
|
3577
|
+
},
|
|
3578
|
+
{
|
|
3579
|
+
"name": "styles",
|
|
3580
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3581
|
+
"default": "",
|
|
3582
|
+
"description": "The styles to use for the component."
|
|
3583
|
+
},
|
|
3584
|
+
{
|
|
3585
|
+
"name": "render",
|
|
3586
|
+
"type": "(instance: MenuSubmenuTriggerInstance) => ReactNode",
|
|
3587
|
+
"default": "",
|
|
3588
|
+
"description": "The render function to render the component with instance access."
|
|
3589
|
+
},
|
|
3590
|
+
{
|
|
3591
|
+
"name": "children",
|
|
3592
|
+
"type": "any",
|
|
3593
|
+
"default": "",
|
|
3594
|
+
"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."
|
|
3595
|
+
},
|
|
3596
|
+
{
|
|
3597
|
+
"name": "value",
|
|
3598
|
+
"type": "string",
|
|
3599
|
+
"default": "",
|
|
3600
|
+
"description": "Semantic value that uniquely identifies this submenu trigger within the\nouter menu. Used to generate a deterministic DOM id; auto-generated when\nnot provided."
|
|
3601
|
+
},
|
|
3602
|
+
{
|
|
3603
|
+
"name": "[key: string]",
|
|
3604
|
+
"type": "any",
|
|
3605
|
+
"description": ""
|
|
3606
|
+
},
|
|
3607
|
+
{
|
|
3608
|
+
"name": "pt-{optionName}-*",
|
|
3609
|
+
"type": "-",
|
|
3610
|
+
"default": "",
|
|
3611
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3612
|
+
"deprecated": false
|
|
3613
|
+
}
|
|
3614
|
+
],
|
|
3615
|
+
"methods": []
|
|
3616
|
+
},
|
|
3617
|
+
"MenuSubmenuTriggerState": {
|
|
3618
|
+
"description": "Defines valid state in MenuSubmenuTrigger component.",
|
|
3619
|
+
"relatedProp": "",
|
|
3620
|
+
"props": [],
|
|
3621
|
+
"methods": []
|
|
3622
|
+
},
|
|
3623
|
+
"MenuSubmenuTriggerExposes": {
|
|
3624
|
+
"description": "Defines the methods and properties exposed by MenuSubmenuTrigger component.",
|
|
3625
|
+
"relatedProp": "",
|
|
3626
|
+
"props": [
|
|
3627
|
+
{
|
|
3628
|
+
"name": "menu",
|
|
3629
|
+
"type": "MenuRootInstance",
|
|
3630
|
+
"default": "",
|
|
3631
|
+
"description": "Instance of the Menu component."
|
|
3632
|
+
},
|
|
3633
|
+
{
|
|
3634
|
+
"name": "submenu",
|
|
3635
|
+
"type": "MenuSubmenuInstance",
|
|
3636
|
+
"default": "",
|
|
3637
|
+
"description": "Instance of the MenuSubmenu component."
|
|
3638
|
+
},
|
|
3639
|
+
{
|
|
3640
|
+
"name": "portal",
|
|
3641
|
+
"type": "MenuPortalInstance",
|
|
3642
|
+
"default": "",
|
|
3643
|
+
"description": "Instance of the MenuPortal component."
|
|
3644
|
+
},
|
|
3645
|
+
{
|
|
3646
|
+
"name": "itemId",
|
|
3647
|
+
"type": "string",
|
|
3648
|
+
"default": "",
|
|
3649
|
+
"description": "Identifier of the menu item."
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
"name": "focused",
|
|
3653
|
+
"type": "boolean",
|
|
3654
|
+
"default": "",
|
|
3655
|
+
"description": "Whether the menu item is focused."
|
|
3656
|
+
},
|
|
3657
|
+
{
|
|
3658
|
+
"name": "isDisabled",
|
|
3659
|
+
"type": "boolean",
|
|
3660
|
+
"default": "",
|
|
3661
|
+
"description": "Whether the menu item is disabled."
|
|
3662
|
+
}
|
|
3663
|
+
],
|
|
3664
|
+
"methods": []
|
|
3665
|
+
}
|
|
3666
|
+
},
|
|
3667
|
+
"types": {
|
|
3668
|
+
"MenuSubmenuTriggerPassThroughType": {
|
|
3669
|
+
"description": "Defines passthrough(pt) options type in MenuSubmenuTrigger component.",
|
|
3670
|
+
"values": "PassThroughType<MenuSubmenuTriggerInstance, E>"
|
|
3671
|
+
},
|
|
3672
|
+
"MenuSubmenuTriggerInstance": {
|
|
3673
|
+
"description": "Instance of MenuSubmenuTrigger component.",
|
|
3674
|
+
"values": "ComponentInstance<MenuSubmenuTriggerProps, MenuSubmenuTriggerState, MenuSubmenuTriggerExposes>"
|
|
3675
|
+
}
|
|
3676
|
+
},
|
|
3677
|
+
"variables": {}
|
|
3678
|
+
}
|
|
3679
|
+
},
|
|
3680
|
+
{
|
|
3681
|
+
"name": "MenuTrigger",
|
|
3682
|
+
"source": "apps/showcase/assets/apidoc/menutrigger.json",
|
|
3683
|
+
"data": {
|
|
3684
|
+
"description": "MenuTrigger is a component that displays a trigger button to open/close the menu.",
|
|
3685
|
+
"interfaces": {
|
|
3686
|
+
"MenuTriggerPassThrough": {
|
|
3687
|
+
"description": "Defines passthrough(pt) options of MenuTrigger component.",
|
|
3688
|
+
"relatedProp": "",
|
|
3689
|
+
"props": [
|
|
3690
|
+
{
|
|
3691
|
+
"name": "root",
|
|
3692
|
+
"type": "MenuTriggerPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
3693
|
+
"default": "",
|
|
3694
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3695
|
+
}
|
|
3696
|
+
],
|
|
3697
|
+
"methods": []
|
|
3698
|
+
},
|
|
3699
|
+
"MenuTriggerProps": {
|
|
3700
|
+
"description": "Defines valid properties in MenuTrigger component.",
|
|
3701
|
+
"relatedProp": "",
|
|
3702
|
+
"extendedTypes": "BaseComponentProps<MenuTriggerInstance, unknown, MenuTriggerPassThrough>",
|
|
3703
|
+
"props": [
|
|
3704
|
+
{
|
|
3705
|
+
"name": "ref",
|
|
3706
|
+
"type": "Ref<unknown>",
|
|
3707
|
+
"default": "",
|
|
3708
|
+
"description": "The reference to the component instance."
|
|
3709
|
+
},
|
|
3710
|
+
{
|
|
3711
|
+
"name": "pIf",
|
|
3712
|
+
"type": "boolean",
|
|
3713
|
+
"default": "true",
|
|
3714
|
+
"description": "Whether the component should be rendered."
|
|
3715
|
+
},
|
|
3716
|
+
{
|
|
3717
|
+
"name": "style",
|
|
3718
|
+
"type": "CSSProperties | ((instance?: MenuTriggerInstance) => CSSProperties)",
|
|
3719
|
+
"default": "",
|
|
3720
|
+
"description": "The style to apply to the component."
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"name": "className",
|
|
3724
|
+
"type": "string | ((instance?: MenuTriggerInstance) => string)",
|
|
3725
|
+
"default": "",
|
|
3726
|
+
"description": "The class name to apply to the component."
|
|
3727
|
+
},
|
|
3728
|
+
{
|
|
3729
|
+
"name": "as",
|
|
3730
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3731
|
+
"default": "",
|
|
3732
|
+
"description": "The component type to render."
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
"name": "asChild",
|
|
3736
|
+
"type": "boolean",
|
|
3737
|
+
"default": "false",
|
|
3738
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"name": "instance",
|
|
3742
|
+
"type": "MenuTriggerInstance",
|
|
3743
|
+
"default": "",
|
|
3744
|
+
"description": "The instance to pass to the component."
|
|
3745
|
+
},
|
|
3746
|
+
{
|
|
3747
|
+
"name": "pt",
|
|
3748
|
+
"type": "SafeRecord<MenuTriggerPassThrough>",
|
|
3749
|
+
"default": "",
|
|
3750
|
+
"description": "The pass-through props to pass to the component."
|
|
3751
|
+
},
|
|
3752
|
+
{
|
|
3753
|
+
"name": "ptOptions",
|
|
3754
|
+
"type": "PassThroughOptions",
|
|
3755
|
+
"default": "",
|
|
3756
|
+
"description": "The pass-through options to pass to the component."
|
|
3757
|
+
},
|
|
3758
|
+
{
|
|
3759
|
+
"name": "unstyled",
|
|
3760
|
+
"type": "boolean",
|
|
3761
|
+
"default": "",
|
|
3762
|
+
"description": "Whether the component should be rendered without classes."
|
|
3763
|
+
},
|
|
3764
|
+
{
|
|
3765
|
+
"name": "dt",
|
|
3766
|
+
"type": "unknown",
|
|
3767
|
+
"default": "",
|
|
3768
|
+
"description": "The design token to use for the component."
|
|
3769
|
+
},
|
|
3770
|
+
{
|
|
3771
|
+
"name": "styles",
|
|
3772
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3773
|
+
"default": "",
|
|
3774
|
+
"description": "The styles to use for the component."
|
|
3775
|
+
},
|
|
3776
|
+
{
|
|
3777
|
+
"name": "render",
|
|
3778
|
+
"type": "(instance: MenuTriggerInstance) => ReactNode",
|
|
3779
|
+
"default": "",
|
|
3780
|
+
"description": "The render function to render the component with instance access."
|
|
3781
|
+
},
|
|
3782
|
+
{
|
|
3783
|
+
"name": "children",
|
|
3784
|
+
"type": "any",
|
|
3785
|
+
"default": "",
|
|
3786
|
+
"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."
|
|
3787
|
+
},
|
|
3788
|
+
{
|
|
3789
|
+
"name": "[key: string]",
|
|
3790
|
+
"type": "any",
|
|
3791
|
+
"description": ""
|
|
3792
|
+
},
|
|
3793
|
+
{
|
|
3794
|
+
"name": "pt-{optionName}-*",
|
|
3795
|
+
"type": "-",
|
|
3796
|
+
"default": "",
|
|
3797
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3798
|
+
"deprecated": false
|
|
3799
|
+
}
|
|
3800
|
+
],
|
|
3801
|
+
"methods": []
|
|
3802
|
+
},
|
|
3803
|
+
"MenuTriggerState": {
|
|
3804
|
+
"description": "Defines valid state in MenuTrigger component.",
|
|
3805
|
+
"relatedProp": "",
|
|
3806
|
+
"props": [],
|
|
3807
|
+
"methods": []
|
|
3808
|
+
},
|
|
3809
|
+
"MenuTriggerExposes": {
|
|
3810
|
+
"description": "Defines the methods and properties exposed by MenuTrigger component.",
|
|
3811
|
+
"relatedProp": "",
|
|
3812
|
+
"props": [
|
|
3813
|
+
{
|
|
3814
|
+
"name": "menu",
|
|
3815
|
+
"type": "MenuRootInstance",
|
|
3816
|
+
"default": "",
|
|
3817
|
+
"description": "Instance of the Menu component."
|
|
3818
|
+
}
|
|
3819
|
+
],
|
|
3820
|
+
"methods": []
|
|
3821
|
+
}
|
|
3822
|
+
},
|
|
3823
|
+
"types": {
|
|
3824
|
+
"MenuTriggerPassThroughType": {
|
|
3825
|
+
"description": "Defines passthrough(pt) options type in MenuTrigger component.",
|
|
3826
|
+
"values": "PassThroughType<MenuTriggerInstance, E>"
|
|
3827
|
+
},
|
|
3828
|
+
"MenuTriggerInstance": {
|
|
3829
|
+
"description": "Instance of MenuTrigger component.",
|
|
3830
|
+
"values": "ComponentInstance<MenuTriggerProps, MenuTriggerState, MenuTriggerExposes>"
|
|
3831
|
+
}
|
|
3832
|
+
},
|
|
3833
|
+
"variables": {}
|
|
3834
|
+
}
|
|
3835
|
+
}
|
|
3836
|
+
]
|