@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,3454 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "ContextMenuArrow",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/contextmenuarrow.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "ContextMenuArrow is a component that displays an arrow pointing to the anchor element.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"ContextMenuArrowPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of ContextMenuArrow component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"extendedTypes": "MenuArrowPassThrough",
|
|
12
|
+
"props": [
|
|
13
|
+
{
|
|
14
|
+
"name": "root",
|
|
15
|
+
"type": "MenuArrowPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
16
|
+
"default": "",
|
|
17
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"methods": []
|
|
21
|
+
},
|
|
22
|
+
"ContextMenuArrowProps": {
|
|
23
|
+
"description": "Defines valid properties in ContextMenuArrow component.",
|
|
24
|
+
"relatedProp": "",
|
|
25
|
+
"extendedTypes": "BaseComponentProps<ContextMenuArrowInstance, unknown, ContextMenuArrowPassThrough>",
|
|
26
|
+
"props": [
|
|
27
|
+
{
|
|
28
|
+
"name": "ref",
|
|
29
|
+
"type": "Ref<unknown>",
|
|
30
|
+
"default": "",
|
|
31
|
+
"description": "The reference to the component instance."
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "pIf",
|
|
35
|
+
"type": "boolean",
|
|
36
|
+
"default": "true",
|
|
37
|
+
"description": "Whether the component should be rendered."
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "style",
|
|
41
|
+
"type": "CSSProperties | ((instance?: ContextMenuArrowInstance) => CSSProperties)",
|
|
42
|
+
"default": "",
|
|
43
|
+
"description": "The style to apply to the component."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "className",
|
|
47
|
+
"type": "string | ((instance?: ContextMenuArrowInstance) => string)",
|
|
48
|
+
"default": "",
|
|
49
|
+
"description": "The class name to apply to the component."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "as",
|
|
53
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
54
|
+
"default": "",
|
|
55
|
+
"description": "The component type to render."
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"name": "asChild",
|
|
59
|
+
"type": "boolean",
|
|
60
|
+
"default": "false",
|
|
61
|
+
"description": "Whether the component should be rendered as a child component."
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "instance",
|
|
65
|
+
"type": "ContextMenuArrowInstance",
|
|
66
|
+
"default": "",
|
|
67
|
+
"description": "The instance to pass to the component."
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "pt",
|
|
71
|
+
"type": "SafeRecord<ContextMenuArrowPassThrough>",
|
|
72
|
+
"default": "",
|
|
73
|
+
"description": "The pass-through props to pass to the component."
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"name": "ptOptions",
|
|
77
|
+
"type": "PassThroughOptions",
|
|
78
|
+
"default": "",
|
|
79
|
+
"description": "The pass-through options to pass to the component."
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "unstyled",
|
|
83
|
+
"type": "boolean",
|
|
84
|
+
"default": "",
|
|
85
|
+
"description": "Whether the component should be rendered without classes."
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "dt",
|
|
89
|
+
"type": "unknown",
|
|
90
|
+
"default": "",
|
|
91
|
+
"description": "The design token to use for the component."
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "styles",
|
|
95
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
96
|
+
"default": "",
|
|
97
|
+
"description": "The styles to use for the component."
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "render",
|
|
101
|
+
"type": "(instance: ContextMenuArrowInstance) => ReactNode",
|
|
102
|
+
"default": "",
|
|
103
|
+
"description": "The render function to render the component with instance access."
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "children",
|
|
107
|
+
"type": "any",
|
|
108
|
+
"default": "",
|
|
109
|
+
"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."
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "[key: string]",
|
|
113
|
+
"type": "any",
|
|
114
|
+
"description": ""
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "pt-{optionName}-*",
|
|
118
|
+
"type": "-",
|
|
119
|
+
"default": "",
|
|
120
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
121
|
+
"deprecated": false
|
|
122
|
+
}
|
|
123
|
+
],
|
|
124
|
+
"methods": []
|
|
125
|
+
},
|
|
126
|
+
"ContextMenuArrowState": {
|
|
127
|
+
"description": "Defines valid state in ContextMenuArrow component.",
|
|
128
|
+
"relatedProp": "",
|
|
129
|
+
"props": [],
|
|
130
|
+
"methods": []
|
|
131
|
+
},
|
|
132
|
+
"ContextMenuArrowExposes": {
|
|
133
|
+
"description": "Defines the methods and properties exposed by ContextMenuArrow component.",
|
|
134
|
+
"relatedProp": "",
|
|
135
|
+
"props": [
|
|
136
|
+
{
|
|
137
|
+
"name": "contextmenu",
|
|
138
|
+
"type": "ContextMenuRootInstance",
|
|
139
|
+
"default": "",
|
|
140
|
+
"description": "The ContextMenu component instance."
|
|
141
|
+
}
|
|
142
|
+
],
|
|
143
|
+
"methods": []
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"types": {
|
|
147
|
+
"ContextMenuArrowPassThroughType": {
|
|
148
|
+
"description": "Defines passthrough(pt) options type in ContextMenuArrow component.",
|
|
149
|
+
"values": "PassThroughType<ContextMenuArrowInstance, E>"
|
|
150
|
+
},
|
|
151
|
+
"ContextMenuArrowInstance": {
|
|
152
|
+
"description": "Instance of ContextMenuArrow component.",
|
|
153
|
+
"values": "ComponentInstance<ContextMenuArrowProps, ContextMenuArrowState, ContextMenuArrowExposes>"
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"variables": {}
|
|
157
|
+
}
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "ContextMenuIndicator",
|
|
161
|
+
"source": "apps/showcase/assets/apidoc/contextmenuindicator.json",
|
|
162
|
+
"data": {
|
|
163
|
+
"description": "ContextMenuIndicator is a component that conditionally renders content based on the state of the parent menu element.",
|
|
164
|
+
"interfaces": {
|
|
165
|
+
"ContextMenuIndicatorPassThrough": {
|
|
166
|
+
"description": "Defines passthrough(pt) options of ContextMenuIndicator component.",
|
|
167
|
+
"relatedProp": "",
|
|
168
|
+
"extendedTypes": "MenuIndicatorPassThrough",
|
|
169
|
+
"props": [
|
|
170
|
+
{
|
|
171
|
+
"name": "root",
|
|
172
|
+
"type": "MenuIndicatorPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
173
|
+
"default": "",
|
|
174
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
175
|
+
}
|
|
176
|
+
],
|
|
177
|
+
"methods": []
|
|
178
|
+
},
|
|
179
|
+
"ContextMenuIndicatorProps": {
|
|
180
|
+
"description": "Defines valid properties in ContextMenuIndicator component.",
|
|
181
|
+
"relatedProp": "",
|
|
182
|
+
"extendedTypes": "BaseComponentProps<ContextMenuIndicatorInstance, unknown, ContextMenuIndicatorPassThrough>",
|
|
183
|
+
"props": [
|
|
184
|
+
{
|
|
185
|
+
"name": "ref",
|
|
186
|
+
"type": "Ref<unknown>",
|
|
187
|
+
"default": "",
|
|
188
|
+
"description": "The reference to the component instance."
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "pIf",
|
|
192
|
+
"type": "boolean",
|
|
193
|
+
"default": "true",
|
|
194
|
+
"description": "Whether the component should be rendered."
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "style",
|
|
198
|
+
"type": "CSSProperties | ((instance?: ContextMenuIndicatorInstance) => CSSProperties)",
|
|
199
|
+
"default": "",
|
|
200
|
+
"description": "The style to apply to the component."
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "className",
|
|
204
|
+
"type": "string | ((instance?: ContextMenuIndicatorInstance) => string)",
|
|
205
|
+
"default": "",
|
|
206
|
+
"description": "The class name to apply to the component."
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "as",
|
|
210
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
211
|
+
"default": "",
|
|
212
|
+
"description": "The component type to render."
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "asChild",
|
|
216
|
+
"type": "boolean",
|
|
217
|
+
"default": "false",
|
|
218
|
+
"description": "Whether the component should be rendered as a child component."
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "instance",
|
|
222
|
+
"type": "ContextMenuIndicatorInstance",
|
|
223
|
+
"default": "",
|
|
224
|
+
"description": "The instance to pass to the component."
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "pt",
|
|
228
|
+
"type": "SafeRecord<ContextMenuIndicatorPassThrough>",
|
|
229
|
+
"default": "",
|
|
230
|
+
"description": "The pass-through props to pass to the component."
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "ptOptions",
|
|
234
|
+
"type": "PassThroughOptions",
|
|
235
|
+
"default": "",
|
|
236
|
+
"description": "The pass-through options to pass to the component."
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "unstyled",
|
|
240
|
+
"type": "boolean",
|
|
241
|
+
"default": "",
|
|
242
|
+
"description": "Whether the component should be rendered without classes."
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"name": "dt",
|
|
246
|
+
"type": "unknown",
|
|
247
|
+
"default": "",
|
|
248
|
+
"description": "The design token to use for the component."
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "styles",
|
|
252
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
253
|
+
"default": "",
|
|
254
|
+
"description": "The styles to use for the component."
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "render",
|
|
258
|
+
"type": "(instance: ContextMenuIndicatorInstance) => ReactNode",
|
|
259
|
+
"default": "",
|
|
260
|
+
"description": "The render function to render the component with instance access."
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "children",
|
|
264
|
+
"type": "any",
|
|
265
|
+
"default": "",
|
|
266
|
+
"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."
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "match",
|
|
270
|
+
"type": "\"checked\" | \"unchecked\" | \"open\" | \"closed\"",
|
|
271
|
+
"default": "",
|
|
272
|
+
"description": "Determines which state the indicator should match to render its content."
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "[key: string]",
|
|
276
|
+
"type": "any",
|
|
277
|
+
"description": ""
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "pt-{optionName}-*",
|
|
281
|
+
"type": "-",
|
|
282
|
+
"default": "",
|
|
283
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
284
|
+
"deprecated": false
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"methods": []
|
|
288
|
+
},
|
|
289
|
+
"ContextMenuIndicatorState": {
|
|
290
|
+
"description": "Defines valid state in ContextMenuIndicator component.",
|
|
291
|
+
"relatedProp": "",
|
|
292
|
+
"props": [],
|
|
293
|
+
"methods": []
|
|
294
|
+
},
|
|
295
|
+
"ContextMenuIndicatorExposes": {
|
|
296
|
+
"description": "Defines the methods and properties exposed by ContextMenuIndicator component.",
|
|
297
|
+
"relatedProp": "",
|
|
298
|
+
"props": [
|
|
299
|
+
{
|
|
300
|
+
"name": "contextmenu",
|
|
301
|
+
"type": "ContextMenuRootInstance",
|
|
302
|
+
"default": "",
|
|
303
|
+
"description": "The ContextMenu component instance."
|
|
304
|
+
}
|
|
305
|
+
],
|
|
306
|
+
"methods": []
|
|
307
|
+
}
|
|
308
|
+
},
|
|
309
|
+
"types": {
|
|
310
|
+
"ContextMenuIndicatorPassThroughType": {
|
|
311
|
+
"description": "Defines passthrough(pt) options type in ContextMenuIndicator component.",
|
|
312
|
+
"values": "PassThroughType<ContextMenuIndicatorInstance, E>"
|
|
313
|
+
},
|
|
314
|
+
"ContextMenuIndicatorInstance": {
|
|
315
|
+
"description": "Instance of ContextMenuIndicator component.",
|
|
316
|
+
"values": "ComponentInstance<ContextMenuIndicatorProps, ContextMenuIndicatorState, ContextMenuIndicatorExposes>"
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
"variables": {}
|
|
320
|
+
}
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "ContextMenuItem",
|
|
324
|
+
"source": "apps/showcase/assets/apidoc/contextmenuitem.json",
|
|
325
|
+
"data": {
|
|
326
|
+
"description": "ContextMenuItem is a pure context menu item.\nFor checkable items use ContextMenuCheckboxItem or ContextMenuRadioItem.",
|
|
327
|
+
"interfaces": {
|
|
328
|
+
"ContextMenuItemPassThrough": {
|
|
329
|
+
"description": "Defines passthrough(pt) options of ContextMenuItem component.",
|
|
330
|
+
"relatedProp": "",
|
|
331
|
+
"props": [
|
|
332
|
+
{
|
|
333
|
+
"name": "root",
|
|
334
|
+
"type": "ContextMenuItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
335
|
+
"default": "",
|
|
336
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
337
|
+
}
|
|
338
|
+
],
|
|
339
|
+
"methods": []
|
|
340
|
+
},
|
|
341
|
+
"ContextMenuItemProps": {
|
|
342
|
+
"description": "Defines valid properties in ContextMenuItem component.",
|
|
343
|
+
"relatedProp": "",
|
|
344
|
+
"extendedTypes": "BaseComponentProps<ContextMenuItemInstance, unknown, ContextMenuItemPassThrough>",
|
|
345
|
+
"props": [
|
|
346
|
+
{
|
|
347
|
+
"name": "ref",
|
|
348
|
+
"type": "Ref<unknown>",
|
|
349
|
+
"default": "",
|
|
350
|
+
"description": "The reference to the component instance."
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"name": "pIf",
|
|
354
|
+
"type": "boolean",
|
|
355
|
+
"default": "true",
|
|
356
|
+
"description": "Whether the component should be rendered."
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "style",
|
|
360
|
+
"type": "CSSProperties | ((instance?: ContextMenuItemInstance) => CSSProperties)",
|
|
361
|
+
"default": "",
|
|
362
|
+
"description": "The style to apply to the component."
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"name": "className",
|
|
366
|
+
"type": "string | ((instance?: ContextMenuItemInstance) => string)",
|
|
367
|
+
"default": "",
|
|
368
|
+
"description": "The class name to apply to the component."
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "as",
|
|
372
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
373
|
+
"default": "",
|
|
374
|
+
"description": "The component type to render."
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"name": "asChild",
|
|
378
|
+
"type": "boolean",
|
|
379
|
+
"default": "false",
|
|
380
|
+
"description": "Whether the component should be rendered as a child component."
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "instance",
|
|
384
|
+
"type": "ContextMenuItemInstance",
|
|
385
|
+
"default": "",
|
|
386
|
+
"description": "The instance to pass to the component."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "pt",
|
|
390
|
+
"type": "SafeRecord<ContextMenuItemPassThrough>",
|
|
391
|
+
"default": "",
|
|
392
|
+
"description": "The pass-through props to pass to the component."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "ptOptions",
|
|
396
|
+
"type": "PassThroughOptions",
|
|
397
|
+
"default": "",
|
|
398
|
+
"description": "The pass-through options to pass to the component."
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "unstyled",
|
|
402
|
+
"type": "boolean",
|
|
403
|
+
"default": "",
|
|
404
|
+
"description": "Whether the component should be rendered without classes."
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "dt",
|
|
408
|
+
"type": "unknown",
|
|
409
|
+
"default": "",
|
|
410
|
+
"description": "The design token to use for the component."
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "styles",
|
|
414
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
415
|
+
"default": "",
|
|
416
|
+
"description": "The styles to use for the component."
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "render",
|
|
420
|
+
"type": "(instance: ContextMenuItemInstance) => ReactNode",
|
|
421
|
+
"default": "",
|
|
422
|
+
"description": "The render function to render the component with instance access."
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "children",
|
|
426
|
+
"type": "any",
|
|
427
|
+
"default": "",
|
|
428
|
+
"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."
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "disabled",
|
|
432
|
+
"type": "boolean",
|
|
433
|
+
"default": "",
|
|
434
|
+
"description": "When present, it specifies that the item should be disabled."
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"name": "value",
|
|
438
|
+
"type": "string",
|
|
439
|
+
"default": "",
|
|
440
|
+
"description": "Semantic value that uniquely identifies this item within the menu.\nUsed to generate a deterministic DOM id. When not provided, auto-generated."
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "closeOnSelect",
|
|
444
|
+
"type": "boolean",
|
|
445
|
+
"default": "true",
|
|
446
|
+
"description": "Whether the menu should close when this item is activated. Overrides the\n `closeOnSelect` setting on `ContextMenu.Root` for this item only."
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "onSelect",
|
|
450
|
+
"type": "(event: MenuItemSelectEvent) => void",
|
|
451
|
+
"default": "",
|
|
452
|
+
"description": "Callback fired when the item is activated (click or keyboard). Calling\n `event.preventDefault()` keeps the menu open regardless of\n `closeOnSelect` ."
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "[key: string]",
|
|
456
|
+
"type": "any",
|
|
457
|
+
"description": ""
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "pt-{optionName}-*",
|
|
461
|
+
"type": "-",
|
|
462
|
+
"default": "",
|
|
463
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
464
|
+
"deprecated": false
|
|
465
|
+
}
|
|
466
|
+
],
|
|
467
|
+
"methods": []
|
|
468
|
+
},
|
|
469
|
+
"ContextMenuItemState": {
|
|
470
|
+
"description": "Defines valid state in ContextMenuItem component.",
|
|
471
|
+
"relatedProp": "",
|
|
472
|
+
"props": [],
|
|
473
|
+
"methods": []
|
|
474
|
+
},
|
|
475
|
+
"ContextMenuItemExposes": {
|
|
476
|
+
"description": "Defines the methods and properties exposed by ContextMenuItem component.",
|
|
477
|
+
"relatedProp": "",
|
|
478
|
+
"props": [
|
|
479
|
+
{
|
|
480
|
+
"name": "contextmenu",
|
|
481
|
+
"type": "ContextMenuRootInstance",
|
|
482
|
+
"default": "",
|
|
483
|
+
"description": "Instance of the ContextMenu component."
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "submenu",
|
|
487
|
+
"type": "ContextMenuSubmenuInstance",
|
|
488
|
+
"default": "",
|
|
489
|
+
"description": "Instance of the ContextMenuSubmenu component."
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"name": "portal",
|
|
493
|
+
"type": "ContextMenuPortalInstance",
|
|
494
|
+
"default": "",
|
|
495
|
+
"description": "Instance of the ContextMenuPortal component."
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"name": "itemId",
|
|
499
|
+
"type": "string",
|
|
500
|
+
"default": "",
|
|
501
|
+
"description": "ID of the item element."
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"name": "focused",
|
|
505
|
+
"type": "boolean",
|
|
506
|
+
"default": "",
|
|
507
|
+
"description": "Whether the item is focused or not."
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "isDisabled",
|
|
511
|
+
"type": "boolean",
|
|
512
|
+
"default": "",
|
|
513
|
+
"description": "Whether the item is disabled or not."
|
|
514
|
+
}
|
|
515
|
+
],
|
|
516
|
+
"methods": []
|
|
517
|
+
}
|
|
518
|
+
},
|
|
519
|
+
"types": {
|
|
520
|
+
"ContextMenuItemPassThroughType": {
|
|
521
|
+
"description": "Defines passthrough(pt) options type in ContextMenuItem component.",
|
|
522
|
+
"values": "PassThroughType<ContextMenuItemInstance, E>"
|
|
523
|
+
},
|
|
524
|
+
"ContextMenuItemInstance": {
|
|
525
|
+
"description": "Instance of ContextMenuItem component.",
|
|
526
|
+
"values": "ComponentInstance<ContextMenuItemProps, ContextMenuItemState, ContextMenuItemExposes>"
|
|
527
|
+
}
|
|
528
|
+
},
|
|
529
|
+
"variables": {}
|
|
530
|
+
}
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "ContextMenuLabel",
|
|
534
|
+
"source": "apps/showcase/assets/apidoc/contextmenulabel.json",
|
|
535
|
+
"data": {
|
|
536
|
+
"description": "ContextMenuLabel is a component that displays label.",
|
|
537
|
+
"interfaces": {
|
|
538
|
+
"ContextMenuLabelPassThrough": {
|
|
539
|
+
"description": "Defines passthrough(pt) options of ContextMenuLabel component.",
|
|
540
|
+
"relatedProp": "",
|
|
541
|
+
"extendedTypes": "MenuLabelPassThrough",
|
|
542
|
+
"props": [
|
|
543
|
+
{
|
|
544
|
+
"name": "root",
|
|
545
|
+
"type": "MenuLabelPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
546
|
+
"default": "",
|
|
547
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
548
|
+
}
|
|
549
|
+
],
|
|
550
|
+
"methods": []
|
|
551
|
+
},
|
|
552
|
+
"ContextMenuLabelProps": {
|
|
553
|
+
"description": "Defines valid properties in ContextMenuLabel component.",
|
|
554
|
+
"relatedProp": "",
|
|
555
|
+
"extendedTypes": "BaseComponentProps<ContextMenuLabelInstance, unknown, ContextMenuLabelPassThrough>",
|
|
556
|
+
"props": [
|
|
557
|
+
{
|
|
558
|
+
"name": "ref",
|
|
559
|
+
"type": "Ref<unknown>",
|
|
560
|
+
"default": "",
|
|
561
|
+
"description": "The reference to the component instance."
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"name": "pIf",
|
|
565
|
+
"type": "boolean",
|
|
566
|
+
"default": "true",
|
|
567
|
+
"description": "Whether the component should be rendered."
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "style",
|
|
571
|
+
"type": "CSSProperties | ((instance?: ContextMenuLabelInstance) => CSSProperties)",
|
|
572
|
+
"default": "",
|
|
573
|
+
"description": "The style to apply to the component."
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"name": "className",
|
|
577
|
+
"type": "string | ((instance?: ContextMenuLabelInstance) => string)",
|
|
578
|
+
"default": "",
|
|
579
|
+
"description": "The class name to apply to the component."
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"name": "as",
|
|
583
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
584
|
+
"default": "",
|
|
585
|
+
"description": "The component type to render."
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "asChild",
|
|
589
|
+
"type": "boolean",
|
|
590
|
+
"default": "false",
|
|
591
|
+
"description": "Whether the component should be rendered as a child component."
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
"name": "instance",
|
|
595
|
+
"type": "ContextMenuLabelInstance",
|
|
596
|
+
"default": "",
|
|
597
|
+
"description": "The instance to pass to the component."
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "pt",
|
|
601
|
+
"type": "SafeRecord<ContextMenuLabelPassThrough>",
|
|
602
|
+
"default": "",
|
|
603
|
+
"description": "The pass-through props to pass to the component."
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"name": "ptOptions",
|
|
607
|
+
"type": "PassThroughOptions",
|
|
608
|
+
"default": "",
|
|
609
|
+
"description": "The pass-through options to pass to the component."
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"name": "unstyled",
|
|
613
|
+
"type": "boolean",
|
|
614
|
+
"default": "",
|
|
615
|
+
"description": "Whether the component should be rendered without classes."
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "dt",
|
|
619
|
+
"type": "unknown",
|
|
620
|
+
"default": "",
|
|
621
|
+
"description": "The design token to use for the component."
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "styles",
|
|
625
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
626
|
+
"default": "",
|
|
627
|
+
"description": "The styles to use for the component."
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "render",
|
|
631
|
+
"type": "(instance: ContextMenuLabelInstance) => ReactNode",
|
|
632
|
+
"default": "",
|
|
633
|
+
"description": "The render function to render the component with instance access."
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "children",
|
|
637
|
+
"type": "any",
|
|
638
|
+
"default": "",
|
|
639
|
+
"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."
|
|
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
|
+
"ContextMenuLabelState": {
|
|
657
|
+
"description": "Defines valid state in ContextMenuLabel component.",
|
|
658
|
+
"relatedProp": "",
|
|
659
|
+
"props": [],
|
|
660
|
+
"methods": []
|
|
661
|
+
},
|
|
662
|
+
"ContextMenuLabelExposes": {
|
|
663
|
+
"description": "Defines the methods and properties exposed by ContextMenuLabel component.",
|
|
664
|
+
"relatedProp": "",
|
|
665
|
+
"props": [
|
|
666
|
+
{
|
|
667
|
+
"name": "contextmenu",
|
|
668
|
+
"type": "ContextMenuRootInstance",
|
|
669
|
+
"default": "",
|
|
670
|
+
"description": "The ContextMenu component instance."
|
|
671
|
+
}
|
|
672
|
+
],
|
|
673
|
+
"methods": []
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
"types": {
|
|
677
|
+
"ContextMenuLabelPassThroughType": {
|
|
678
|
+
"description": "Defines passthrough(pt) options type in ContextMenuLabel component.",
|
|
679
|
+
"values": "PassThroughType<ContextMenuLabelInstance, E>"
|
|
680
|
+
},
|
|
681
|
+
"ContextMenuLabelInstance": {
|
|
682
|
+
"description": "Instance of ContextMenuLabel component.",
|
|
683
|
+
"values": "ComponentInstance<ContextMenuLabelProps, ContextMenuLabelState, ContextMenuLabelExposes>"
|
|
684
|
+
}
|
|
685
|
+
},
|
|
686
|
+
"variables": {}
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
"name": "ContextMenuList",
|
|
691
|
+
"source": "apps/showcase/assets/apidoc/contextmenulist.json",
|
|
692
|
+
"data": {
|
|
693
|
+
"description": "ContextMenuList is a component that displays list.",
|
|
694
|
+
"interfaces": {
|
|
695
|
+
"ContextMenuListPassThrough": {
|
|
696
|
+
"description": "Defines passthrough(pt) options of ContextMenuList component.",
|
|
697
|
+
"relatedProp": "",
|
|
698
|
+
"extendedTypes": "MenuListPassThrough",
|
|
699
|
+
"props": [
|
|
700
|
+
{
|
|
701
|
+
"name": "root",
|
|
702
|
+
"type": "MenuListPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
703
|
+
"default": "",
|
|
704
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "content",
|
|
708
|
+
"type": "MenuListPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
709
|
+
"default": "",
|
|
710
|
+
"description": "Used to pass attributes to the content's DOM element."
|
|
711
|
+
}
|
|
712
|
+
],
|
|
713
|
+
"methods": []
|
|
714
|
+
},
|
|
715
|
+
"ContextMenuListProps": {
|
|
716
|
+
"description": "Defines valid properties in ContextMenuList component.",
|
|
717
|
+
"relatedProp": "",
|
|
718
|
+
"extendedTypes": "BaseComponentProps<ContextMenuListInstance, unknown, ContextMenuListPassThrough>",
|
|
719
|
+
"props": [
|
|
720
|
+
{
|
|
721
|
+
"name": "ref",
|
|
722
|
+
"type": "Ref<unknown>",
|
|
723
|
+
"default": "",
|
|
724
|
+
"description": "The reference to the component instance."
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
"name": "pIf",
|
|
728
|
+
"type": "boolean",
|
|
729
|
+
"default": "true",
|
|
730
|
+
"description": "Whether the component should be rendered."
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"name": "style",
|
|
734
|
+
"type": "CSSProperties | ((instance?: ContextMenuListInstance) => CSSProperties)",
|
|
735
|
+
"default": "",
|
|
736
|
+
"description": "The style to apply to the component."
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "className",
|
|
740
|
+
"type": "string | ((instance?: ContextMenuListInstance) => string)",
|
|
741
|
+
"default": "",
|
|
742
|
+
"description": "The class name to apply to the component."
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "as",
|
|
746
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
747
|
+
"default": "",
|
|
748
|
+
"description": "The component type to render."
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"name": "asChild",
|
|
752
|
+
"type": "boolean",
|
|
753
|
+
"default": "false",
|
|
754
|
+
"description": "Whether the component should be rendered as a child component."
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "instance",
|
|
758
|
+
"type": "ContextMenuListInstance",
|
|
759
|
+
"default": "",
|
|
760
|
+
"description": "The instance to pass to the component."
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
"name": "pt",
|
|
764
|
+
"type": "SafeRecord<ContextMenuListPassThrough>",
|
|
765
|
+
"default": "",
|
|
766
|
+
"description": "The pass-through props to pass to the component."
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"name": "ptOptions",
|
|
770
|
+
"type": "PassThroughOptions",
|
|
771
|
+
"default": "",
|
|
772
|
+
"description": "The pass-through options to pass to the component."
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"name": "unstyled",
|
|
776
|
+
"type": "boolean",
|
|
777
|
+
"default": "",
|
|
778
|
+
"description": "Whether the component should be rendered without classes."
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
"name": "dt",
|
|
782
|
+
"type": "unknown",
|
|
783
|
+
"default": "",
|
|
784
|
+
"description": "The design token to use for the component."
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "styles",
|
|
788
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
789
|
+
"default": "",
|
|
790
|
+
"description": "The styles to use for the component."
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"name": "render",
|
|
794
|
+
"type": "(instance: ContextMenuListInstance) => ReactNode",
|
|
795
|
+
"default": "",
|
|
796
|
+
"description": "The render function to render the component with instance access."
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"name": "children",
|
|
800
|
+
"type": "any",
|
|
801
|
+
"default": "",
|
|
802
|
+
"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."
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
"name": "[key: string]",
|
|
806
|
+
"type": "any",
|
|
807
|
+
"description": ""
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "pt-{optionName}-*",
|
|
811
|
+
"type": "-",
|
|
812
|
+
"default": "",
|
|
813
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
814
|
+
"deprecated": false
|
|
815
|
+
}
|
|
816
|
+
],
|
|
817
|
+
"methods": []
|
|
818
|
+
},
|
|
819
|
+
"ContextMenuListState": {
|
|
820
|
+
"description": "Defines valid state in ContextMenuList component.",
|
|
821
|
+
"relatedProp": "",
|
|
822
|
+
"props": [],
|
|
823
|
+
"methods": []
|
|
824
|
+
},
|
|
825
|
+
"ContextMenuListExposes": {
|
|
826
|
+
"description": "Defines the methods and properties exposed by ContextMenuList component.",
|
|
827
|
+
"relatedProp": "",
|
|
828
|
+
"props": [
|
|
829
|
+
{
|
|
830
|
+
"name": "contextmenu",
|
|
831
|
+
"type": "ContextMenuRootInstance",
|
|
832
|
+
"default": "",
|
|
833
|
+
"description": "The ContextMenu component instance."
|
|
834
|
+
}
|
|
835
|
+
],
|
|
836
|
+
"methods": []
|
|
837
|
+
}
|
|
838
|
+
},
|
|
839
|
+
"types": {
|
|
840
|
+
"ContextMenuListPassThroughType": {
|
|
841
|
+
"description": "Defines passthrough(pt) options type in ContextMenuList component.",
|
|
842
|
+
"values": "PassThroughType<ContextMenuListInstance, E>"
|
|
843
|
+
},
|
|
844
|
+
"ContextMenuListInstance": {
|
|
845
|
+
"description": "Instance of ContextMenuList component.",
|
|
846
|
+
"values": "ComponentInstance<ContextMenuListProps, ContextMenuListState, ContextMenuListExposes>"
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"variables": {}
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "ContextMenuPopup",
|
|
854
|
+
"source": "apps/showcase/assets/apidoc/contextmenupopup.json",
|
|
855
|
+
"data": {
|
|
856
|
+
"description": "ContextMenuPopup is a component that displays the popup content of a contextmenu.",
|
|
857
|
+
"interfaces": {
|
|
858
|
+
"ContextMenuPopupPassThrough": {
|
|
859
|
+
"description": "Defines passthrough(pt) options of ContextMenuPopup component.",
|
|
860
|
+
"relatedProp": "",
|
|
861
|
+
"extendedTypes": "MenuPopupPassThrough",
|
|
862
|
+
"props": [
|
|
863
|
+
{
|
|
864
|
+
"name": "root",
|
|
865
|
+
"type": "MenuPopupPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
866
|
+
"default": "",
|
|
867
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
868
|
+
}
|
|
869
|
+
],
|
|
870
|
+
"methods": []
|
|
871
|
+
},
|
|
872
|
+
"ContextMenuPopupProps": {
|
|
873
|
+
"description": "Defines valid properties in ContextMenuPopup component.",
|
|
874
|
+
"relatedProp": "",
|
|
875
|
+
"extendedTypes": "BaseComponentProps<ContextMenuPopupInstance, unknown, ContextMenuPopupPassThrough>",
|
|
876
|
+
"props": [
|
|
877
|
+
{
|
|
878
|
+
"name": "ref",
|
|
879
|
+
"type": "Ref<unknown>",
|
|
880
|
+
"default": "",
|
|
881
|
+
"description": "The reference to the component instance."
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"name": "pIf",
|
|
885
|
+
"type": "boolean",
|
|
886
|
+
"default": "true",
|
|
887
|
+
"description": "Whether the component should be rendered."
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
"name": "style",
|
|
891
|
+
"type": "CSSProperties | ((instance?: ContextMenuPopupInstance) => CSSProperties)",
|
|
892
|
+
"default": "",
|
|
893
|
+
"description": "The style to apply to the component."
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "className",
|
|
897
|
+
"type": "string | ((instance?: ContextMenuPopupInstance) => string)",
|
|
898
|
+
"default": "",
|
|
899
|
+
"description": "The class name to apply to the component."
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"name": "as",
|
|
903
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
904
|
+
"default": "",
|
|
905
|
+
"description": "The component type to render."
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"name": "asChild",
|
|
909
|
+
"type": "boolean",
|
|
910
|
+
"default": "false",
|
|
911
|
+
"description": "Whether the component should be rendered as a child component."
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"name": "instance",
|
|
915
|
+
"type": "ContextMenuPopupInstance",
|
|
916
|
+
"default": "",
|
|
917
|
+
"description": "The instance to pass to the component."
|
|
918
|
+
},
|
|
919
|
+
{
|
|
920
|
+
"name": "pt",
|
|
921
|
+
"type": "SafeRecord<ContextMenuPopupPassThrough>",
|
|
922
|
+
"default": "",
|
|
923
|
+
"description": "The pass-through props to pass to the component."
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "ptOptions",
|
|
927
|
+
"type": "PassThroughOptions",
|
|
928
|
+
"default": "",
|
|
929
|
+
"description": "The pass-through options to pass to the component."
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
"name": "unstyled",
|
|
933
|
+
"type": "boolean",
|
|
934
|
+
"default": "",
|
|
935
|
+
"description": "Whether the component should be rendered without classes."
|
|
936
|
+
},
|
|
937
|
+
{
|
|
938
|
+
"name": "dt",
|
|
939
|
+
"type": "unknown",
|
|
940
|
+
"default": "",
|
|
941
|
+
"description": "The design token to use for the component."
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"name": "styles",
|
|
945
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
946
|
+
"default": "",
|
|
947
|
+
"description": "The styles to use for the component."
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"name": "render",
|
|
951
|
+
"type": "(instance: ContextMenuPopupInstance) => ReactNode",
|
|
952
|
+
"default": "",
|
|
953
|
+
"description": "The render function to render the component with instance access."
|
|
954
|
+
},
|
|
955
|
+
{
|
|
956
|
+
"name": "children",
|
|
957
|
+
"type": "any",
|
|
958
|
+
"default": "",
|
|
959
|
+
"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."
|
|
960
|
+
},
|
|
961
|
+
{
|
|
962
|
+
"name": "motionProps",
|
|
963
|
+
"type": "UseMotionProps",
|
|
964
|
+
"default": "",
|
|
965
|
+
"description": "Motion properties for the popup animation."
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
"name": "[key: string]",
|
|
969
|
+
"type": "any",
|
|
970
|
+
"description": ""
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "pt-{optionName}-*",
|
|
974
|
+
"type": "-",
|
|
975
|
+
"default": "",
|
|
976
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
977
|
+
"deprecated": false
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"methods": []
|
|
981
|
+
},
|
|
982
|
+
"ContextMenuPopupState": {
|
|
983
|
+
"description": "Defines valid state in ContextMenuPopup component.",
|
|
984
|
+
"relatedProp": "",
|
|
985
|
+
"props": [],
|
|
986
|
+
"methods": []
|
|
987
|
+
},
|
|
988
|
+
"ContextMenuPopupExposes": {
|
|
989
|
+
"description": "Defines the methods and properties exposed by ContextMenuPopup component.",
|
|
990
|
+
"relatedProp": "",
|
|
991
|
+
"props": [
|
|
992
|
+
{
|
|
993
|
+
"name": "contextmenu",
|
|
994
|
+
"type": "ContextMenuRootInstance",
|
|
995
|
+
"default": "",
|
|
996
|
+
"description": "The ContextMenu component instance."
|
|
997
|
+
}
|
|
998
|
+
],
|
|
999
|
+
"methods": []
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
"types": {
|
|
1003
|
+
"ContextMenuPopupPassThroughType": {
|
|
1004
|
+
"description": "Defines passthrough(pt) options type in ContextMenuPopup component.",
|
|
1005
|
+
"values": "PassThroughType<ContextMenuPopupInstance, E>"
|
|
1006
|
+
},
|
|
1007
|
+
"ContextMenuPopupInstance": {
|
|
1008
|
+
"description": "Instance of ContextMenuPopup component.",
|
|
1009
|
+
"values": "ComponentInstance<ContextMenuPopupProps, ContextMenuPopupState, ContextMenuPopupExposes>"
|
|
1010
|
+
}
|
|
1011
|
+
},
|
|
1012
|
+
"variables": {}
|
|
1013
|
+
}
|
|
1014
|
+
},
|
|
1015
|
+
{
|
|
1016
|
+
"name": "ContextMenuPortal",
|
|
1017
|
+
"source": "apps/showcase/assets/apidoc/contextmenuportal.json",
|
|
1018
|
+
"data": {
|
|
1019
|
+
"description": "ContextMenuPortal is a component that displays portal.",
|
|
1020
|
+
"interfaces": {
|
|
1021
|
+
"ContextMenuPortalPassThrough": {
|
|
1022
|
+
"description": "Defines passthrough(pt) options of ContextMenuPortal component.",
|
|
1023
|
+
"relatedProp": "",
|
|
1024
|
+
"extendedTypes": "MenuPortalPassThrough",
|
|
1025
|
+
"props": [
|
|
1026
|
+
{
|
|
1027
|
+
"name": "root",
|
|
1028
|
+
"type": "MenuPortalPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1029
|
+
"default": "",
|
|
1030
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1031
|
+
}
|
|
1032
|
+
],
|
|
1033
|
+
"methods": []
|
|
1034
|
+
},
|
|
1035
|
+
"ContextMenuPortalProps": {
|
|
1036
|
+
"description": "Defines valid properties in ContextMenuPortal component.",
|
|
1037
|
+
"relatedProp": "",
|
|
1038
|
+
"extendedTypes": "BaseComponentProps<ContextMenuPortalInstance, PortalProps, ContextMenuPortalPassThrough>",
|
|
1039
|
+
"props": [
|
|
1040
|
+
{
|
|
1041
|
+
"name": "ref",
|
|
1042
|
+
"type": "Ref<unknown>",
|
|
1043
|
+
"default": "",
|
|
1044
|
+
"description": "The reference to the component instance."
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "pIf",
|
|
1048
|
+
"type": "boolean",
|
|
1049
|
+
"default": "true",
|
|
1050
|
+
"description": "Whether the component should be rendered."
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "style",
|
|
1054
|
+
"type": "(CSSProperties | ((instance?: PortalInstance) => CSSProperties)) & (CSSProperties | ((instance?: ContextMenuPortalInstance) => CSSProperties))",
|
|
1055
|
+
"default": "",
|
|
1056
|
+
"description": "The style to apply to the component."
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "className",
|
|
1060
|
+
"type": "(string | ((instance?: PortalInstance) => string)) & (string | ((instance?: ContextMenuPortalInstance) => string))",
|
|
1061
|
+
"default": "",
|
|
1062
|
+
"description": "The class name to apply to the component."
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "as",
|
|
1066
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1067
|
+
"default": "",
|
|
1068
|
+
"description": "The component type to render."
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "asChild",
|
|
1072
|
+
"type": "boolean",
|
|
1073
|
+
"default": "false",
|
|
1074
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"name": "instance",
|
|
1078
|
+
"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<ContextMenuPortalProps>, unknown, HTMLElement> & { props: SafeRecord<SafeRecord<ContextMenuPortalProps>>; attrs: Omit<SafeRecord<SafeRecord<ContextMenuPortalProps>>, string | number | symbol> & Record<PropertyKey, unknown> } & { state: SafeRecord; $computedSetup: SafeRecord } & ContextMenuPortalExposes",
|
|
1079
|
+
"default": "",
|
|
1080
|
+
"description": "The instance to pass to the component."
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "pt",
|
|
1084
|
+
"type": "PortalPassThrough & Record<PropertyKey, unknown> & ContextMenuPortalPassThrough",
|
|
1085
|
+
"default": "",
|
|
1086
|
+
"description": "The pass-through props to pass to the component."
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "ptOptions",
|
|
1090
|
+
"type": "PassThroughOptions",
|
|
1091
|
+
"default": "",
|
|
1092
|
+
"description": "The pass-through options to pass to the component."
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "unstyled",
|
|
1096
|
+
"type": "boolean",
|
|
1097
|
+
"default": "",
|
|
1098
|
+
"description": "Whether the component should be rendered without classes."
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "dt",
|
|
1102
|
+
"type": "unknown",
|
|
1103
|
+
"default": "",
|
|
1104
|
+
"description": "The design token to use for the component."
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"name": "styles",
|
|
1108
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1109
|
+
"default": "",
|
|
1110
|
+
"description": "The styles to use for the component."
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "render",
|
|
1114
|
+
"type": "(instance: PortalInstance) => ReactNode & (instance: ContextMenuPortalInstance) => ReactNode",
|
|
1115
|
+
"default": "",
|
|
1116
|
+
"description": "The render function to render the component with instance access."
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"name": "children",
|
|
1120
|
+
"type": "any",
|
|
1121
|
+
"default": "",
|
|
1122
|
+
"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."
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "onMounted",
|
|
1126
|
+
"type": "() => void",
|
|
1127
|
+
"default": "",
|
|
1128
|
+
"description": "Callback function to invoke when the portal is mounted."
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "onUnmounted",
|
|
1132
|
+
"type": "() => void",
|
|
1133
|
+
"default": "",
|
|
1134
|
+
"description": "Callback function to invoke when the portal is unmounted."
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "element",
|
|
1138
|
+
"type": "HTMLElement | ReactNode",
|
|
1139
|
+
"default": "",
|
|
1140
|
+
"description": "The element to be rendered as the portal."
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"name": "elementRef",
|
|
1144
|
+
"type": "RefObject<HTMLElement>",
|
|
1145
|
+
"default": "",
|
|
1146
|
+
"description": "The element reference to be rendered as the portal."
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "appendTo",
|
|
1150
|
+
"type": "string | HTMLElement | ((instance: PortalInstance) => HTMLElement)",
|
|
1151
|
+
"default": "'body'",
|
|
1152
|
+
"description": "The DOM element where the portal should be appended to."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "[key: string]",
|
|
1156
|
+
"type": "any",
|
|
1157
|
+
"description": ""
|
|
1158
|
+
},
|
|
1159
|
+
{
|
|
1160
|
+
"name": "pt-{optionName}-*",
|
|
1161
|
+
"type": "-",
|
|
1162
|
+
"default": "",
|
|
1163
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1164
|
+
"deprecated": false
|
|
1165
|
+
}
|
|
1166
|
+
],
|
|
1167
|
+
"methods": []
|
|
1168
|
+
},
|
|
1169
|
+
"ContextMenuPortalState": {
|
|
1170
|
+
"description": "Defines valid state in ContextMenuPortal component.",
|
|
1171
|
+
"relatedProp": "",
|
|
1172
|
+
"props": [],
|
|
1173
|
+
"methods": []
|
|
1174
|
+
},
|
|
1175
|
+
"ContextMenuPortalExposes": {
|
|
1176
|
+
"description": "Defines the methods and properties exposed by ContextMenuPortal component.",
|
|
1177
|
+
"relatedProp": "",
|
|
1178
|
+
"props": [
|
|
1179
|
+
{
|
|
1180
|
+
"name": "contextmenu",
|
|
1181
|
+
"type": "ContextMenuRootInstance",
|
|
1182
|
+
"default": "",
|
|
1183
|
+
"description": "The ContextMenu component instance."
|
|
1184
|
+
}
|
|
1185
|
+
],
|
|
1186
|
+
"methods": []
|
|
1187
|
+
}
|
|
1188
|
+
},
|
|
1189
|
+
"types": {
|
|
1190
|
+
"ContextMenuPortalPassThroughType": {
|
|
1191
|
+
"description": "Defines passthrough(pt) options type in ContextMenuPortal component.",
|
|
1192
|
+
"values": "PassThroughType<ContextMenuPortalInstance, E>"
|
|
1193
|
+
},
|
|
1194
|
+
"ContextMenuPortalInstance": {
|
|
1195
|
+
"description": "Instance of ContextMenuPortal component.",
|
|
1196
|
+
"values": "ComponentInstance<ContextMenuPortalProps, ContextMenuPortalState, ContextMenuPortalExposes>"
|
|
1197
|
+
}
|
|
1198
|
+
},
|
|
1199
|
+
"variables": {}
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "ContextMenuPositioner",
|
|
1204
|
+
"source": "apps/showcase/assets/apidoc/contextmenupositioner.json",
|
|
1205
|
+
"data": {
|
|
1206
|
+
"description": "ContextMenuPositioner is a component that positions the contextmenu popup relative to the anchor element.",
|
|
1207
|
+
"interfaces": {
|
|
1208
|
+
"ContextMenuPositionerPassThrough": {
|
|
1209
|
+
"description": "Defines passthrough(pt) options of ContextMenuPositioner component.",
|
|
1210
|
+
"relatedProp": "",
|
|
1211
|
+
"extendedTypes": "MenuPositionerPassThrough",
|
|
1212
|
+
"props": [
|
|
1213
|
+
{
|
|
1214
|
+
"name": "root",
|
|
1215
|
+
"type": "MenuPositionerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1216
|
+
"default": "",
|
|
1217
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1218
|
+
}
|
|
1219
|
+
],
|
|
1220
|
+
"methods": []
|
|
1221
|
+
},
|
|
1222
|
+
"ContextMenuPositionerProps": {
|
|
1223
|
+
"description": "Defines valid properties in ContextMenuPositioner component.",
|
|
1224
|
+
"relatedProp": "",
|
|
1225
|
+
"extendedTypes": "BaseComponentProps<ContextMenuPositionerInstance, UsePositionerProps, ContextMenuPositionerPassThrough>",
|
|
1226
|
+
"props": [
|
|
1227
|
+
{
|
|
1228
|
+
"name": "ref",
|
|
1229
|
+
"type": "Ref<unknown>",
|
|
1230
|
+
"default": "",
|
|
1231
|
+
"description": "The reference to the component instance."
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"name": "pIf",
|
|
1235
|
+
"type": "boolean",
|
|
1236
|
+
"default": "true",
|
|
1237
|
+
"description": "Whether the component should be rendered."
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
"name": "style",
|
|
1241
|
+
"type": "CSSProperties | ((instance?: ContextMenuPositionerInstance) => CSSProperties)",
|
|
1242
|
+
"default": "",
|
|
1243
|
+
"description": "The style to apply to the component."
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"name": "className",
|
|
1247
|
+
"type": "string | ((instance?: ContextMenuPositionerInstance) => string)",
|
|
1248
|
+
"default": "",
|
|
1249
|
+
"description": "The class name to apply to the component."
|
|
1250
|
+
},
|
|
1251
|
+
{
|
|
1252
|
+
"name": "as",
|
|
1253
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1254
|
+
"default": "",
|
|
1255
|
+
"description": "The component type to render."
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "asChild",
|
|
1259
|
+
"type": "boolean",
|
|
1260
|
+
"default": "false",
|
|
1261
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"name": "instance",
|
|
1265
|
+
"type": "ContextMenuPositionerInstance",
|
|
1266
|
+
"default": "",
|
|
1267
|
+
"description": "The instance to pass to the component."
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"name": "pt",
|
|
1271
|
+
"type": "SafeRecord<ContextMenuPositionerPassThrough>",
|
|
1272
|
+
"default": "",
|
|
1273
|
+
"description": "The pass-through props to pass to the component."
|
|
1274
|
+
},
|
|
1275
|
+
{
|
|
1276
|
+
"name": "ptOptions",
|
|
1277
|
+
"type": "PassThroughOptions",
|
|
1278
|
+
"default": "",
|
|
1279
|
+
"description": "The pass-through options to pass to the component."
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"name": "unstyled",
|
|
1283
|
+
"type": "boolean",
|
|
1284
|
+
"default": "",
|
|
1285
|
+
"description": "Whether the component should be rendered without classes."
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
"name": "dt",
|
|
1289
|
+
"type": "unknown",
|
|
1290
|
+
"default": "",
|
|
1291
|
+
"description": "The design token to use for the component."
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"name": "styles",
|
|
1295
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1296
|
+
"default": "",
|
|
1297
|
+
"description": "The styles to use for the component."
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"name": "render",
|
|
1301
|
+
"type": "(instance: ContextMenuPositionerInstance) => ReactNode",
|
|
1302
|
+
"default": "",
|
|
1303
|
+
"description": "The render function to render the component with instance access."
|
|
1304
|
+
},
|
|
1305
|
+
{
|
|
1306
|
+
"name": "children",
|
|
1307
|
+
"type": "any",
|
|
1308
|
+
"default": "",
|
|
1309
|
+
"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."
|
|
1310
|
+
},
|
|
1311
|
+
{
|
|
1312
|
+
"name": "side",
|
|
1313
|
+
"type": "SideType",
|
|
1314
|
+
"default": "",
|
|
1315
|
+
"description": "The side of the positioner."
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
"name": "align",
|
|
1319
|
+
"type": "AlignType",
|
|
1320
|
+
"default": "",
|
|
1321
|
+
"description": "The align of the positioner."
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"name": "sideOffset",
|
|
1325
|
+
"type": "number",
|
|
1326
|
+
"default": "",
|
|
1327
|
+
"description": "The side offset of the positioner."
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "alignOffset",
|
|
1331
|
+
"type": "number",
|
|
1332
|
+
"default": "",
|
|
1333
|
+
"description": "The align offset of the positioner."
|
|
1334
|
+
},
|
|
1335
|
+
{
|
|
1336
|
+
"name": "flip",
|
|
1337
|
+
"type": "boolean",
|
|
1338
|
+
"default": "",
|
|
1339
|
+
"description": "Whether to flip the positioner."
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"name": "shift",
|
|
1343
|
+
"type": "boolean",
|
|
1344
|
+
"default": "",
|
|
1345
|
+
"description": "Whether to shift the positioner."
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"name": "hideWhenDetached",
|
|
1349
|
+
"type": "boolean",
|
|
1350
|
+
"default": "",
|
|
1351
|
+
"description": "Whether to hide the positioner when detached."
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"name": "strategy",
|
|
1355
|
+
"type": "\"fixed\" | \"absolute\"",
|
|
1356
|
+
"default": "'fixed'",
|
|
1357
|
+
"description": "The positioning strategy."
|
|
1358
|
+
},
|
|
1359
|
+
{
|
|
1360
|
+
"name": "boundary",
|
|
1361
|
+
"type": "HTMLElement",
|
|
1362
|
+
"default": "",
|
|
1363
|
+
"description": "The boundary element that constrains the positioner placement.\nUsed in JS fallback mode only; CSS Anchor mode uses the containing block."
|
|
1364
|
+
},
|
|
1365
|
+
{
|
|
1366
|
+
"name": "anchor",
|
|
1367
|
+
"type": "HTMLElement",
|
|
1368
|
+
"default": "",
|
|
1369
|
+
"description": "The anchor element."
|
|
1370
|
+
},
|
|
1371
|
+
{
|
|
1372
|
+
"name": "content",
|
|
1373
|
+
"type": "HTMLDivElement",
|
|
1374
|
+
"default": "",
|
|
1375
|
+
"description": "The content element."
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"name": "arrow",
|
|
1379
|
+
"type": "HTMLDivElement",
|
|
1380
|
+
"default": "",
|
|
1381
|
+
"description": "The arrow element."
|
|
1382
|
+
},
|
|
1383
|
+
{
|
|
1384
|
+
"name": "autoZIndex",
|
|
1385
|
+
"type": "boolean",
|
|
1386
|
+
"default": "true",
|
|
1387
|
+
"description": "Whether to automatically manage layering."
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
"name": "baseZIndex",
|
|
1391
|
+
"type": "number",
|
|
1392
|
+
"default": "0",
|
|
1393
|
+
"description": "Base zIndex value to use in layering."
|
|
1394
|
+
},
|
|
1395
|
+
{
|
|
1396
|
+
"name": "onPlacementChange",
|
|
1397
|
+
"type": "(placement: { side: SideType; align: AlignType }) => void",
|
|
1398
|
+
"default": "",
|
|
1399
|
+
"description": "Callback invoked when the actual placement changes due to flip or shift."
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
"name": "[key: string]",
|
|
1403
|
+
"type": "any",
|
|
1404
|
+
"description": ""
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
"name": "pt-{optionName}-*",
|
|
1408
|
+
"type": "-",
|
|
1409
|
+
"default": "",
|
|
1410
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1411
|
+
"deprecated": false
|
|
1412
|
+
}
|
|
1413
|
+
],
|
|
1414
|
+
"methods": []
|
|
1415
|
+
},
|
|
1416
|
+
"ContextMenuPositionerState": {
|
|
1417
|
+
"description": "Defines valid state in ContextMenuPositioner component.",
|
|
1418
|
+
"relatedProp": "",
|
|
1419
|
+
"props": [],
|
|
1420
|
+
"methods": []
|
|
1421
|
+
},
|
|
1422
|
+
"ContextMenuPositionerExposes": {
|
|
1423
|
+
"description": "Defines the methods and properties exposed by ContextMenuPositioner component.",
|
|
1424
|
+
"relatedProp": "",
|
|
1425
|
+
"props": [
|
|
1426
|
+
{
|
|
1427
|
+
"name": "contextmenu",
|
|
1428
|
+
"type": "ContextMenuRootInstance",
|
|
1429
|
+
"default": "",
|
|
1430
|
+
"description": "The ContextMenu component instance."
|
|
1431
|
+
}
|
|
1432
|
+
],
|
|
1433
|
+
"methods": []
|
|
1434
|
+
}
|
|
1435
|
+
},
|
|
1436
|
+
"types": {
|
|
1437
|
+
"ContextMenuPositionerPassThroughType": {
|
|
1438
|
+
"description": "Defines passthrough(pt) options type in ContextMenuPositioner component.",
|
|
1439
|
+
"values": "PassThroughType<ContextMenuPositionerInstance, E>"
|
|
1440
|
+
},
|
|
1441
|
+
"ContextMenuPositionerInstance": {
|
|
1442
|
+
"description": "Instance of ContextMenuPositioner component.",
|
|
1443
|
+
"values": "ComponentInstance<ContextMenuPositionerProps, ContextMenuPositionerState, ContextMenuPositionerExposes>"
|
|
1444
|
+
}
|
|
1445
|
+
},
|
|
1446
|
+
"variables": {}
|
|
1447
|
+
}
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"name": "ContextMenuRadioGroup",
|
|
1451
|
+
"source": "apps/showcase/assets/apidoc/contextmenuradiogroup.json",
|
|
1452
|
+
"data": {
|
|
1453
|
+
"description": "ContextMenuRadioGroup is a component that displays radio group.",
|
|
1454
|
+
"interfaces": {
|
|
1455
|
+
"ContextMenuRadioGroupContextInterface": {
|
|
1456
|
+
"description": "Local mirror of the legacy MenuRadioGroup context shape, kept so existing\nContextMenu code continues to compile until ContextMenu is refactored to\nthe new RadioItemGroup/RadioItem pattern.",
|
|
1457
|
+
"relatedProp": "",
|
|
1458
|
+
"props": [
|
|
1459
|
+
{
|
|
1460
|
+
"name": "value",
|
|
1461
|
+
"type": "unknown",
|
|
1462
|
+
"default": ""
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"name": "onValueChange",
|
|
1466
|
+
"type": "(value: unknown) => void",
|
|
1467
|
+
"default": ""
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"name": "name",
|
|
1471
|
+
"type": "string",
|
|
1472
|
+
"default": ""
|
|
1473
|
+
}
|
|
1474
|
+
],
|
|
1475
|
+
"methods": []
|
|
1476
|
+
},
|
|
1477
|
+
"ContextMenuRadioGroupPassThrough": {
|
|
1478
|
+
"description": "Defines passthrough(pt) options of ContextMenuRadioGroup component.",
|
|
1479
|
+
"relatedProp": "",
|
|
1480
|
+
"props": [],
|
|
1481
|
+
"methods": []
|
|
1482
|
+
},
|
|
1483
|
+
"ContextMenuRadioGroupValueChangeEvent": {
|
|
1484
|
+
"description": "Event object for the onValueChange callback.",
|
|
1485
|
+
"relatedProp": "",
|
|
1486
|
+
"props": [
|
|
1487
|
+
{
|
|
1488
|
+
"name": "value",
|
|
1489
|
+
"type": "unknown",
|
|
1490
|
+
"default": "",
|
|
1491
|
+
"description": "The new selected value."
|
|
1492
|
+
}
|
|
1493
|
+
],
|
|
1494
|
+
"methods": []
|
|
1495
|
+
},
|
|
1496
|
+
"ContextMenuRadioGroupProps": {
|
|
1497
|
+
"description": "Defines valid properties in ContextMenuRadioGroup component.",
|
|
1498
|
+
"relatedProp": "",
|
|
1499
|
+
"extendedTypes": "BaseComponentProps<ContextMenuRadioGroupInstance, unknown, ContextMenuRadioGroupPassThrough>",
|
|
1500
|
+
"props": [
|
|
1501
|
+
{
|
|
1502
|
+
"name": "ref",
|
|
1503
|
+
"type": "Ref<unknown>",
|
|
1504
|
+
"default": "",
|
|
1505
|
+
"description": "The reference to the component instance."
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
"name": "pIf",
|
|
1509
|
+
"type": "boolean",
|
|
1510
|
+
"default": "true",
|
|
1511
|
+
"description": "Whether the component should be rendered."
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"name": "style",
|
|
1515
|
+
"type": "CSSProperties | ((instance?: ContextMenuRadioGroupInstance) => CSSProperties)",
|
|
1516
|
+
"default": "",
|
|
1517
|
+
"description": "The style to apply to the component."
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"name": "className",
|
|
1521
|
+
"type": "string | ((instance?: ContextMenuRadioGroupInstance) => string)",
|
|
1522
|
+
"default": "",
|
|
1523
|
+
"description": "The class name to apply to the component."
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "as",
|
|
1527
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1528
|
+
"default": "",
|
|
1529
|
+
"description": "The component type to render."
|
|
1530
|
+
},
|
|
1531
|
+
{
|
|
1532
|
+
"name": "asChild",
|
|
1533
|
+
"type": "boolean",
|
|
1534
|
+
"default": "false",
|
|
1535
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"name": "instance",
|
|
1539
|
+
"type": "ContextMenuRadioGroupInstance",
|
|
1540
|
+
"default": "",
|
|
1541
|
+
"description": "The instance to pass to the component."
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"name": "pt",
|
|
1545
|
+
"type": "SafeRecord<ContextMenuRadioGroupPassThrough>",
|
|
1546
|
+
"default": "",
|
|
1547
|
+
"description": "The pass-through props to pass to the component."
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"name": "ptOptions",
|
|
1551
|
+
"type": "PassThroughOptions",
|
|
1552
|
+
"default": "",
|
|
1553
|
+
"description": "The pass-through options to pass to the component."
|
|
1554
|
+
},
|
|
1555
|
+
{
|
|
1556
|
+
"name": "unstyled",
|
|
1557
|
+
"type": "boolean",
|
|
1558
|
+
"default": "",
|
|
1559
|
+
"description": "Whether the component should be rendered without classes."
|
|
1560
|
+
},
|
|
1561
|
+
{
|
|
1562
|
+
"name": "dt",
|
|
1563
|
+
"type": "unknown",
|
|
1564
|
+
"default": "",
|
|
1565
|
+
"description": "The design token to use for the component."
|
|
1566
|
+
},
|
|
1567
|
+
{
|
|
1568
|
+
"name": "styles",
|
|
1569
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1570
|
+
"default": "",
|
|
1571
|
+
"description": "The styles to use for the component."
|
|
1572
|
+
},
|
|
1573
|
+
{
|
|
1574
|
+
"name": "render",
|
|
1575
|
+
"type": "(instance: ContextMenuRadioGroupInstance) => ReactNode",
|
|
1576
|
+
"default": "",
|
|
1577
|
+
"description": "The render function to render the component with instance access."
|
|
1578
|
+
},
|
|
1579
|
+
{
|
|
1580
|
+
"name": "children",
|
|
1581
|
+
"type": "any",
|
|
1582
|
+
"default": "",
|
|
1583
|
+
"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."
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"name": "value",
|
|
1587
|
+
"type": "unknown",
|
|
1588
|
+
"default": "",
|
|
1589
|
+
"description": "Value of the selected radio item."
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"name": "defaultValue",
|
|
1593
|
+
"type": "unknown",
|
|
1594
|
+
"default": "",
|
|
1595
|
+
"description": "Default value of the selected radio item."
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"name": "name",
|
|
1599
|
+
"type": "string",
|
|
1600
|
+
"default": "",
|
|
1601
|
+
"description": "Name for the radio group."
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "onValueChange",
|
|
1605
|
+
"type": "(event: ContextMenuRadioGroupValueChangeEvent) => void",
|
|
1606
|
+
"default": "",
|
|
1607
|
+
"description": "Callback to invoke when value changes."
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
"name": "[key: string]",
|
|
1611
|
+
"type": "any",
|
|
1612
|
+
"description": ""
|
|
1613
|
+
}
|
|
1614
|
+
],
|
|
1615
|
+
"methods": []
|
|
1616
|
+
},
|
|
1617
|
+
"ContextMenuRadioGroupState": {
|
|
1618
|
+
"description": "Defines valid state in ContextMenuRadioGroup component.",
|
|
1619
|
+
"relatedProp": "",
|
|
1620
|
+
"props": [],
|
|
1621
|
+
"methods": []
|
|
1622
|
+
},
|
|
1623
|
+
"ContextMenuRadioGroupExposes": {
|
|
1624
|
+
"description": "Defines the methods and properties exposed by ContextMenuRadioGroup component.",
|
|
1625
|
+
"relatedProp": "",
|
|
1626
|
+
"props": [
|
|
1627
|
+
{
|
|
1628
|
+
"name": "contextmenu",
|
|
1629
|
+
"type": "ContextMenuRootInstance",
|
|
1630
|
+
"default": "",
|
|
1631
|
+
"description": "The ContextMenu component instance."
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "context",
|
|
1635
|
+
"type": "ContextMenuRadioGroupContextInterface",
|
|
1636
|
+
"default": "",
|
|
1637
|
+
"description": "Context value for the radio group containing the current selection state, change handler, and optional group name."
|
|
1638
|
+
}
|
|
1639
|
+
],
|
|
1640
|
+
"methods": []
|
|
1641
|
+
}
|
|
1642
|
+
},
|
|
1643
|
+
"types": {
|
|
1644
|
+
"ContextMenuRadioGroupPassThroughType": {
|
|
1645
|
+
"description": "Defines passthrough(pt) options type in ContextMenuRadioGroup component.",
|
|
1646
|
+
"values": "PassThroughType<ContextMenuRadioGroupInstance, E>"
|
|
1647
|
+
},
|
|
1648
|
+
"ContextMenuRadioGroupInstance": {
|
|
1649
|
+
"description": "Instance of ContextMenuRadioGroup component.",
|
|
1650
|
+
"values": "ComponentInstance<ContextMenuRadioGroupProps, ContextMenuRadioGroupState, ContextMenuRadioGroupExposes>"
|
|
1651
|
+
}
|
|
1652
|
+
},
|
|
1653
|
+
"variables": {}
|
|
1654
|
+
}
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"name": "ContextMenuRoot",
|
|
1658
|
+
"source": "apps/showcase/assets/apidoc/contextmenuroot.json",
|
|
1659
|
+
"data": {
|
|
1660
|
+
"description": "ContextMenu ContextMenu uses Menu component and displays an overlay menu to display actions related to a trigger.",
|
|
1661
|
+
"interfaces": {
|
|
1662
|
+
"ContextMenuRootPassThrough": {
|
|
1663
|
+
"description": "Defines passthrough(pt) options of ContextMenu component.",
|
|
1664
|
+
"relatedProp": "",
|
|
1665
|
+
"extendedTypes": "MenuRootPassThrough",
|
|
1666
|
+
"props": [
|
|
1667
|
+
{
|
|
1668
|
+
"name": "root",
|
|
1669
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1670
|
+
"default": "",
|
|
1671
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "list",
|
|
1675
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1676
|
+
"default": "",
|
|
1677
|
+
"description": "Used to pass attributes to the list's DOM element."
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "item",
|
|
1681
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1682
|
+
"default": "",
|
|
1683
|
+
"description": "Used to pass attributes to the item's DOM element."
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "label",
|
|
1687
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1688
|
+
"default": "",
|
|
1689
|
+
"description": "Used to pass attributes to the label's DOM element."
|
|
1690
|
+
},
|
|
1691
|
+
{
|
|
1692
|
+
"name": "sub",
|
|
1693
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1694
|
+
"default": "",
|
|
1695
|
+
"description": "Used to pass attributes to the submenu's DOM element."
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"name": "trigger",
|
|
1699
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
1700
|
+
"default": "",
|
|
1701
|
+
"description": "Used to pass attributes to the trigger's DOM element."
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "subtrigger",
|
|
1705
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1706
|
+
"default": "",
|
|
1707
|
+
"description": "Used to pass attributes to the subtrigger's DOM element."
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "checkboxItemIndicator",
|
|
1711
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1712
|
+
"default": "",
|
|
1713
|
+
"description": "Used to pass attributes to the checkbox item indicator's DOM element."
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"name": "radioItemIndicator",
|
|
1717
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1718
|
+
"default": "",
|
|
1719
|
+
"description": "Used to pass attributes to the radio item indicator's DOM element."
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"name": "submenuIndicator",
|
|
1723
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1724
|
+
"default": "",
|
|
1725
|
+
"description": "Used to pass attributes to the submenu indicator's DOM element."
|
|
1726
|
+
},
|
|
1727
|
+
{
|
|
1728
|
+
"name": "separator",
|
|
1729
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1730
|
+
"default": "",
|
|
1731
|
+
"description": "Used to pass attributes to the separator's DOM element."
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "popup",
|
|
1735
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1736
|
+
"default": "",
|
|
1737
|
+
"description": "Used to pass attributes to the popup's DOM element."
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "arrow",
|
|
1741
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1742
|
+
"default": "",
|
|
1743
|
+
"description": "Used to pass attributes to the arrow's DOM element."
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "positioner",
|
|
1747
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1748
|
+
"default": "",
|
|
1749
|
+
"description": "Used to pass attributes to the positioner's DOM element."
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "subpositioner",
|
|
1753
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1754
|
+
"default": "",
|
|
1755
|
+
"description": "Used to pass attributes to the subpositioner's DOM element."
|
|
1756
|
+
},
|
|
1757
|
+
{
|
|
1758
|
+
"name": "subpopup",
|
|
1759
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1760
|
+
"default": "",
|
|
1761
|
+
"description": "Used to pass attributes to the subpopup's DOM element."
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"name": "subportal",
|
|
1765
|
+
"type": "MenuRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1766
|
+
"default": "",
|
|
1767
|
+
"description": "Used to pass attributes to the subportal's DOM element."
|
|
1768
|
+
}
|
|
1769
|
+
],
|
|
1770
|
+
"methods": []
|
|
1771
|
+
},
|
|
1772
|
+
"ContextMenuRootChangeEvent": {
|
|
1773
|
+
"description": "Event fired when the contextmenu's open state changes.",
|
|
1774
|
+
"relatedProp": "",
|
|
1775
|
+
"extendedTypes": "UseContextMenuOpenChangeEvent",
|
|
1776
|
+
"props": [
|
|
1777
|
+
{
|
|
1778
|
+
"name": "originalEvent",
|
|
1779
|
+
"type": "Event",
|
|
1780
|
+
"default": "",
|
|
1781
|
+
"description": "The original browser event that triggered the change."
|
|
1782
|
+
},
|
|
1783
|
+
{
|
|
1784
|
+
"name": "open",
|
|
1785
|
+
"type": "boolean",
|
|
1786
|
+
"default": "",
|
|
1787
|
+
"description": "The open state of the menu."
|
|
1788
|
+
}
|
|
1789
|
+
],
|
|
1790
|
+
"methods": []
|
|
1791
|
+
},
|
|
1792
|
+
"ContextMenuRootProps": {
|
|
1793
|
+
"description": "Defines valid properties in ContextMenu component.",
|
|
1794
|
+
"relatedProp": "",
|
|
1795
|
+
"extendedTypes": "BaseComponentProps<ContextMenuRootInstance, Omit<UseContextMenuProps, \"onOpenChange\">, ContextMenuRootPassThrough>",
|
|
1796
|
+
"props": [
|
|
1797
|
+
{
|
|
1798
|
+
"name": "ref",
|
|
1799
|
+
"type": "Ref<unknown>",
|
|
1800
|
+
"default": "",
|
|
1801
|
+
"description": "The reference to the component instance."
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
"name": "pIf",
|
|
1805
|
+
"type": "boolean",
|
|
1806
|
+
"default": "true",
|
|
1807
|
+
"description": "Whether the component should be rendered."
|
|
1808
|
+
},
|
|
1809
|
+
{
|
|
1810
|
+
"name": "style",
|
|
1811
|
+
"type": "CSSProperties | ((instance?: ContextMenuRootInstance) => CSSProperties)",
|
|
1812
|
+
"default": "",
|
|
1813
|
+
"description": "The style to apply to the component."
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
"name": "className",
|
|
1817
|
+
"type": "string | ((instance?: ContextMenuRootInstance) => string)",
|
|
1818
|
+
"default": "",
|
|
1819
|
+
"description": "The class name to apply to the component."
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"name": "as",
|
|
1823
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1824
|
+
"default": "",
|
|
1825
|
+
"description": "The component type to render."
|
|
1826
|
+
},
|
|
1827
|
+
{
|
|
1828
|
+
"name": "asChild",
|
|
1829
|
+
"type": "boolean",
|
|
1830
|
+
"default": "false",
|
|
1831
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"name": "instance",
|
|
1835
|
+
"type": "ContextMenuRootInstance",
|
|
1836
|
+
"default": "",
|
|
1837
|
+
"description": "The instance to pass to the component."
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"name": "pt",
|
|
1841
|
+
"type": "SafeRecord<ContextMenuRootPassThrough>",
|
|
1842
|
+
"default": "",
|
|
1843
|
+
"description": "The pass-through props to pass to the component."
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"name": "ptOptions",
|
|
1847
|
+
"type": "PassThroughOptions",
|
|
1848
|
+
"default": "",
|
|
1849
|
+
"description": "The pass-through options to pass to the component."
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"name": "unstyled",
|
|
1853
|
+
"type": "boolean",
|
|
1854
|
+
"default": "",
|
|
1855
|
+
"description": "Whether the component should be rendered without classes."
|
|
1856
|
+
},
|
|
1857
|
+
{
|
|
1858
|
+
"name": "dt",
|
|
1859
|
+
"type": "unknown",
|
|
1860
|
+
"default": "",
|
|
1861
|
+
"description": "The design token to use for the component."
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"name": "styles",
|
|
1865
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1866
|
+
"default": "",
|
|
1867
|
+
"description": "The styles to use for the component."
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"name": "render",
|
|
1871
|
+
"type": "(instance: ContextMenuRootInstance) => ReactNode",
|
|
1872
|
+
"default": "",
|
|
1873
|
+
"description": "The render function to render the component with instance access."
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"name": "children",
|
|
1877
|
+
"type": "any",
|
|
1878
|
+
"default": "",
|
|
1879
|
+
"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."
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"name": "global",
|
|
1883
|
+
"type": "boolean",
|
|
1884
|
+
"default": "false",
|
|
1885
|
+
"description": "Attaches the menu to document instead of a particular element."
|
|
1886
|
+
},
|
|
1887
|
+
{
|
|
1888
|
+
"name": "open",
|
|
1889
|
+
"type": "boolean",
|
|
1890
|
+
"default": "",
|
|
1891
|
+
"description": "Controlled open state of the menu."
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"name": "defaultOpen",
|
|
1895
|
+
"type": "boolean",
|
|
1896
|
+
"default": "false",
|
|
1897
|
+
"description": "Default open state for uncontrolled mode."
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
"name": "appendTo",
|
|
1901
|
+
"type": "\"body\" | HTMLElement | \"self\"",
|
|
1902
|
+
"default": "'body'",
|
|
1903
|
+
"description": "The element to which the overlay is appended."
|
|
1904
|
+
},
|
|
1905
|
+
{
|
|
1906
|
+
"name": "baseZIndex",
|
|
1907
|
+
"type": "number",
|
|
1908
|
+
"default": "0",
|
|
1909
|
+
"description": "Base zIndex value to use in layering."
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"name": "autoZIndex",
|
|
1913
|
+
"type": "boolean",
|
|
1914
|
+
"default": "true",
|
|
1915
|
+
"description": "Whether to automatically manage layering."
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"name": "tabIndex",
|
|
1919
|
+
"type": "number",
|
|
1920
|
+
"default": "0",
|
|
1921
|
+
"description": "Index of the element in tabbing order."
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
"name": "openDelay",
|
|
1925
|
+
"type": "number",
|
|
1926
|
+
"default": "100",
|
|
1927
|
+
"description": "The delay in milliseconds before opening the menu when hovering the trigger.\nOnly applies when `openOnHover` is true."
|
|
1928
|
+
},
|
|
1929
|
+
{
|
|
1930
|
+
"name": "closeDelay",
|
|
1931
|
+
"type": "number",
|
|
1932
|
+
"default": "0",
|
|
1933
|
+
"description": "The delay in milliseconds before closing the menu when the pointer leaves the trigger.\nOnly applies when `openOnHover` is true."
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "openOnHover",
|
|
1937
|
+
"type": "boolean",
|
|
1938
|
+
"default": "false",
|
|
1939
|
+
"description": "When true, the menu opens on pointer hover over the trigger (in addition to click)."
|
|
1940
|
+
},
|
|
1941
|
+
{
|
|
1942
|
+
"name": "context",
|
|
1943
|
+
"type": "UseMenuSubmenuExposes",
|
|
1944
|
+
"default": "",
|
|
1945
|
+
"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."
|
|
1946
|
+
},
|
|
1947
|
+
{
|
|
1948
|
+
"name": "navigationmenu",
|
|
1949
|
+
"type": "UseNavigationMenuExposes",
|
|
1950
|
+
"default": "",
|
|
1951
|
+
"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` ."
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"name": "navigationmenuMenuId",
|
|
1955
|
+
"type": "string",
|
|
1956
|
+
"default": "",
|
|
1957
|
+
"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\"."
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "onOpenChange",
|
|
1961
|
+
"type": "(event: ContextMenuRootChangeEvent) => void",
|
|
1962
|
+
"default": "",
|
|
1963
|
+
"description": "Callback function that is called when the trigger is clicked."
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"name": "[key: string]",
|
|
1967
|
+
"type": "any",
|
|
1968
|
+
"description": ""
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"name": "pt-{optionName}-*",
|
|
1972
|
+
"type": "-",
|
|
1973
|
+
"default": "",
|
|
1974
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1975
|
+
"deprecated": false
|
|
1976
|
+
}
|
|
1977
|
+
],
|
|
1978
|
+
"methods": []
|
|
1979
|
+
},
|
|
1980
|
+
"ContextMenuRootState": {
|
|
1981
|
+
"description": "Defines valid state in ContextMenu component.",
|
|
1982
|
+
"relatedProp": "",
|
|
1983
|
+
"extendedTypes": "UseContextMenuState",
|
|
1984
|
+
"props": [
|
|
1985
|
+
{
|
|
1986
|
+
"name": "open",
|
|
1987
|
+
"type": "boolean",
|
|
1988
|
+
"default": "",
|
|
1989
|
+
"description": "Whether the menu is open."
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"name": "focused",
|
|
1993
|
+
"type": "boolean",
|
|
1994
|
+
"default": "",
|
|
1995
|
+
"description": "Whether the menu is focused."
|
|
1996
|
+
},
|
|
1997
|
+
{
|
|
1998
|
+
"name": "focusedOptionId",
|
|
1999
|
+
"type": "string | string[]",
|
|
2000
|
+
"default": "",
|
|
2001
|
+
"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."
|
|
2002
|
+
}
|
|
2003
|
+
],
|
|
2004
|
+
"methods": []
|
|
2005
|
+
},
|
|
2006
|
+
"ContextMenuRootExposes": {
|
|
2007
|
+
"description": "Defines the methods and properties exposed by ContextMenu component.",
|
|
2008
|
+
"relatedProp": "",
|
|
2009
|
+
"extendedTypes": "UseContextMenuExposes",
|
|
2010
|
+
"props": [
|
|
2011
|
+
{
|
|
2012
|
+
"name": "state",
|
|
2013
|
+
"type": "UseMenuState",
|
|
2014
|
+
"default": "",
|
|
2015
|
+
"description": "The state of the context menu."
|
|
2016
|
+
},
|
|
2017
|
+
{
|
|
2018
|
+
"name": "menu",
|
|
2019
|
+
"type": "UseMenuExposes",
|
|
2020
|
+
"default": "",
|
|
2021
|
+
"description": "The underlying menu instance."
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
"name": "popover",
|
|
2025
|
+
"type": "UsePopoverExposes",
|
|
2026
|
+
"default": "",
|
|
2027
|
+
"description": "The popover instance for managing popup state and positioning."
|
|
2028
|
+
},
|
|
2029
|
+
{
|
|
2030
|
+
"name": "triggerProps",
|
|
2031
|
+
"type": "UseContextMenuTriggerProps",
|
|
2032
|
+
"default": "",
|
|
2033
|
+
"description": "Props for the trigger element."
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "rootProps",
|
|
2037
|
+
"type": "UseContextMenuRootProps",
|
|
2038
|
+
"default": "",
|
|
2039
|
+
"description": "Props for the root element."
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"name": "arrowProps",
|
|
2043
|
+
"type": "UsePopoverArrowProps",
|
|
2044
|
+
"default": "",
|
|
2045
|
+
"description": "Props for the arrow element."
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"name": "popupProps",
|
|
2049
|
+
"type": "UsePopoverPopupProps",
|
|
2050
|
+
"default": "",
|
|
2051
|
+
"description": "Props for the popup element."
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
"name": "positionerProps",
|
|
2055
|
+
"type": "UsePopoverPositionerProps",
|
|
2056
|
+
"default": "",
|
|
2057
|
+
"description": "Props for the positioner element."
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"name": "getListProps",
|
|
2061
|
+
"type": "(input?: UseMenuGetListPropsInput) => UseMenuGetListPropsReturn",
|
|
2062
|
+
"default": "",
|
|
2063
|
+
"description": "Get props for a list element."
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"name": "getIndicatorProps",
|
|
2067
|
+
"type": "(input: UseMenuGetIndicatorPropsInput) => UseMenuGetIndicatorPropsReturn",
|
|
2068
|
+
"default": "",
|
|
2069
|
+
"description": "Get props for an indicator element."
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"name": "getSubTriggerProps",
|
|
2073
|
+
"type": "(input: UseMenuGetSubTriggerPropsInput) => UseMenuGetSubTriggerPropsReturn",
|
|
2074
|
+
"default": "",
|
|
2075
|
+
"description": "Get props for a subtrigger element."
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "getItemProps",
|
|
2079
|
+
"type": "(input: UseMenuGetItemPropsInput) => UseMenuGetItemPropsReturn",
|
|
2080
|
+
"default": "",
|
|
2081
|
+
"description": "Get props for an item element."
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"name": "onTriggerClick",
|
|
2085
|
+
"type": "() => void",
|
|
2086
|
+
"default": "",
|
|
2087
|
+
"description": "Click handler to close the context menu."
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "onContextMenu",
|
|
2091
|
+
"type": "(event: MouseEvent | MouseEvent<Element, MouseEvent>) => void",
|
|
2092
|
+
"default": "",
|
|
2093
|
+
"description": "Handles the context menu event by creating a virtual anchor element at the click position and opening the menu."
|
|
2094
|
+
}
|
|
2095
|
+
],
|
|
2096
|
+
"methods": []
|
|
2097
|
+
}
|
|
2098
|
+
},
|
|
2099
|
+
"types": {
|
|
2100
|
+
"ContextMenuRootPassThroughType": {
|
|
2101
|
+
"description": "Defines passthrough(pt) options type in ContextMenu component.",
|
|
2102
|
+
"values": "PassThroughType<ContextMenuRootInstance, E>"
|
|
2103
|
+
},
|
|
2104
|
+
"ContextMenuRootInstance": {
|
|
2105
|
+
"description": "Instance of ContextMenu component.",
|
|
2106
|
+
"values": "ComponentInstance<ContextMenuRootProps, ContextMenuRootState, ContextMenuRootExposes>"
|
|
2107
|
+
}
|
|
2108
|
+
},
|
|
2109
|
+
"variables": {}
|
|
2110
|
+
}
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"name": "ContextMenuSeparator",
|
|
2114
|
+
"source": "apps/showcase/assets/apidoc/contextmenuseparator.json",
|
|
2115
|
+
"data": {
|
|
2116
|
+
"description": "ContextMenuSeparator is a component that displays separator.",
|
|
2117
|
+
"interfaces": {
|
|
2118
|
+
"ContextMenuSeparatorPassThrough": {
|
|
2119
|
+
"description": "Defines passthrough(pt) options of ContextMenuSeparator component.",
|
|
2120
|
+
"relatedProp": "",
|
|
2121
|
+
"extendedTypes": "MenuSeparatorPassThrough",
|
|
2122
|
+
"props": [
|
|
2123
|
+
{
|
|
2124
|
+
"name": "root",
|
|
2125
|
+
"type": "MenuSeparatorPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2126
|
+
"default": "",
|
|
2127
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2128
|
+
}
|
|
2129
|
+
],
|
|
2130
|
+
"methods": []
|
|
2131
|
+
},
|
|
2132
|
+
"ContextMenuSeparatorProps": {
|
|
2133
|
+
"description": "Defines valid properties in ContextMenuSeparator component.",
|
|
2134
|
+
"relatedProp": "",
|
|
2135
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSeparatorInstance, unknown, ContextMenuSeparatorPassThrough>",
|
|
2136
|
+
"props": [
|
|
2137
|
+
{
|
|
2138
|
+
"name": "ref",
|
|
2139
|
+
"type": "Ref<unknown>",
|
|
2140
|
+
"default": "",
|
|
2141
|
+
"description": "The reference to the component instance."
|
|
2142
|
+
},
|
|
2143
|
+
{
|
|
2144
|
+
"name": "pIf",
|
|
2145
|
+
"type": "boolean",
|
|
2146
|
+
"default": "true",
|
|
2147
|
+
"description": "Whether the component should be rendered."
|
|
2148
|
+
},
|
|
2149
|
+
{
|
|
2150
|
+
"name": "style",
|
|
2151
|
+
"type": "CSSProperties | ((instance?: ContextMenuSeparatorInstance) => CSSProperties)",
|
|
2152
|
+
"default": "",
|
|
2153
|
+
"description": "The style to apply to the component."
|
|
2154
|
+
},
|
|
2155
|
+
{
|
|
2156
|
+
"name": "className",
|
|
2157
|
+
"type": "string | ((instance?: ContextMenuSeparatorInstance) => string)",
|
|
2158
|
+
"default": "",
|
|
2159
|
+
"description": "The class name to apply to the component."
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"name": "as",
|
|
2163
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2164
|
+
"default": "",
|
|
2165
|
+
"description": "The component type to render."
|
|
2166
|
+
},
|
|
2167
|
+
{
|
|
2168
|
+
"name": "asChild",
|
|
2169
|
+
"type": "boolean",
|
|
2170
|
+
"default": "false",
|
|
2171
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"name": "instance",
|
|
2175
|
+
"type": "ContextMenuSeparatorInstance",
|
|
2176
|
+
"default": "",
|
|
2177
|
+
"description": "The instance to pass to the component."
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
"name": "pt",
|
|
2181
|
+
"type": "SafeRecord<ContextMenuSeparatorPassThrough>",
|
|
2182
|
+
"default": "",
|
|
2183
|
+
"description": "The pass-through props to pass to the component."
|
|
2184
|
+
},
|
|
2185
|
+
{
|
|
2186
|
+
"name": "ptOptions",
|
|
2187
|
+
"type": "PassThroughOptions",
|
|
2188
|
+
"default": "",
|
|
2189
|
+
"description": "The pass-through options to pass to the component."
|
|
2190
|
+
},
|
|
2191
|
+
{
|
|
2192
|
+
"name": "unstyled",
|
|
2193
|
+
"type": "boolean",
|
|
2194
|
+
"default": "",
|
|
2195
|
+
"description": "Whether the component should be rendered without classes."
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"name": "dt",
|
|
2199
|
+
"type": "unknown",
|
|
2200
|
+
"default": "",
|
|
2201
|
+
"description": "The design token to use for the component."
|
|
2202
|
+
},
|
|
2203
|
+
{
|
|
2204
|
+
"name": "styles",
|
|
2205
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2206
|
+
"default": "",
|
|
2207
|
+
"description": "The styles to use for the component."
|
|
2208
|
+
},
|
|
2209
|
+
{
|
|
2210
|
+
"name": "render",
|
|
2211
|
+
"type": "(instance: ContextMenuSeparatorInstance) => ReactNode",
|
|
2212
|
+
"default": "",
|
|
2213
|
+
"description": "The render function to render the component with instance access."
|
|
2214
|
+
},
|
|
2215
|
+
{
|
|
2216
|
+
"name": "children",
|
|
2217
|
+
"type": "any",
|
|
2218
|
+
"default": "",
|
|
2219
|
+
"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."
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
"name": "[key: string]",
|
|
2223
|
+
"type": "any",
|
|
2224
|
+
"description": ""
|
|
2225
|
+
},
|
|
2226
|
+
{
|
|
2227
|
+
"name": "pt-{optionName}-*",
|
|
2228
|
+
"type": "-",
|
|
2229
|
+
"default": "",
|
|
2230
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2231
|
+
"deprecated": false
|
|
2232
|
+
}
|
|
2233
|
+
],
|
|
2234
|
+
"methods": []
|
|
2235
|
+
},
|
|
2236
|
+
"ContextMenuSeparatorState": {
|
|
2237
|
+
"description": "Defines valid state in ContextMenuSeparator component.",
|
|
2238
|
+
"relatedProp": "",
|
|
2239
|
+
"props": [],
|
|
2240
|
+
"methods": []
|
|
2241
|
+
},
|
|
2242
|
+
"ContextMenuSeparatorExposes": {
|
|
2243
|
+
"description": "Defines the methods and properties exposed by ContextMenuSeparator component.",
|
|
2244
|
+
"relatedProp": "",
|
|
2245
|
+
"props": [
|
|
2246
|
+
{
|
|
2247
|
+
"name": "contextmenu",
|
|
2248
|
+
"type": "ContextMenuRootInstance",
|
|
2249
|
+
"default": "",
|
|
2250
|
+
"description": "The ContextMenu component instance."
|
|
2251
|
+
}
|
|
2252
|
+
],
|
|
2253
|
+
"methods": []
|
|
2254
|
+
}
|
|
2255
|
+
},
|
|
2256
|
+
"types": {
|
|
2257
|
+
"ContextMenuSeparatorPassThroughType": {
|
|
2258
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSeparator component.",
|
|
2259
|
+
"values": "PassThroughType<ContextMenuSeparatorInstance, E>"
|
|
2260
|
+
},
|
|
2261
|
+
"ContextMenuSeparatorInstance": {
|
|
2262
|
+
"description": "Instance of ContextMenuSeparator component.",
|
|
2263
|
+
"values": "ComponentInstance<ContextMenuSeparatorProps, ContextMenuSeparatorState, ContextMenuSeparatorExposes>"
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
"variables": {}
|
|
2267
|
+
}
|
|
2268
|
+
},
|
|
2269
|
+
{
|
|
2270
|
+
"name": "ContextMenuSubmenu",
|
|
2271
|
+
"source": "apps/showcase/assets/apidoc/contextmenusubmenu.json",
|
|
2272
|
+
"data": {
|
|
2273
|
+
"description": "ContextMenuSubmenu is a component that displays sub.",
|
|
2274
|
+
"interfaces": {
|
|
2275
|
+
"ContextMenuSubmenuPassThrough": {
|
|
2276
|
+
"description": "Defines passthrough(pt) options of ContextMenuSubmenu component.",
|
|
2277
|
+
"relatedProp": "",
|
|
2278
|
+
"extendedTypes": "MenuSubmenuPassThrough",
|
|
2279
|
+
"props": [
|
|
2280
|
+
{
|
|
2281
|
+
"name": "root",
|
|
2282
|
+
"type": "MenuSubmenuPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2283
|
+
"default": "",
|
|
2284
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2285
|
+
}
|
|
2286
|
+
],
|
|
2287
|
+
"methods": []
|
|
2288
|
+
},
|
|
2289
|
+
"ContextMenuSubmenuOpenChangeEvent": {
|
|
2290
|
+
"description": "Event fired when the context menu submenu's open state changes.",
|
|
2291
|
+
"relatedProp": "",
|
|
2292
|
+
"extendedTypes": "UseContextMenuSubmenuOpenChangeEvent",
|
|
2293
|
+
"props": [
|
|
2294
|
+
{
|
|
2295
|
+
"name": "originalEvent",
|
|
2296
|
+
"type": "Event",
|
|
2297
|
+
"default": "",
|
|
2298
|
+
"description": "The original browser event that triggered the change."
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
"name": "open",
|
|
2302
|
+
"type": "boolean",
|
|
2303
|
+
"default": "",
|
|
2304
|
+
"description": "The open state of the submenu."
|
|
2305
|
+
}
|
|
2306
|
+
],
|
|
2307
|
+
"methods": []
|
|
2308
|
+
},
|
|
2309
|
+
"ContextMenuSubmenuProps": {
|
|
2310
|
+
"description": "Defines valid properties in ContextMenuSubmenu component.",
|
|
2311
|
+
"relatedProp": "",
|
|
2312
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSubmenuInstance, unknown, ContextMenuSubmenuPassThrough>",
|
|
2313
|
+
"props": [
|
|
2314
|
+
{
|
|
2315
|
+
"name": "ref",
|
|
2316
|
+
"type": "Ref<unknown>",
|
|
2317
|
+
"default": "",
|
|
2318
|
+
"description": "The reference to the component instance."
|
|
2319
|
+
},
|
|
2320
|
+
{
|
|
2321
|
+
"name": "pIf",
|
|
2322
|
+
"type": "boolean",
|
|
2323
|
+
"default": "true",
|
|
2324
|
+
"description": "Whether the component should be rendered."
|
|
2325
|
+
},
|
|
2326
|
+
{
|
|
2327
|
+
"name": "style",
|
|
2328
|
+
"type": "CSSProperties | ((instance?: ContextMenuSubmenuInstance) => CSSProperties)",
|
|
2329
|
+
"default": "",
|
|
2330
|
+
"description": "The style to apply to the component."
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"name": "className",
|
|
2334
|
+
"type": "string | ((instance?: ContextMenuSubmenuInstance) => string)",
|
|
2335
|
+
"default": "",
|
|
2336
|
+
"description": "The class name to apply to the component."
|
|
2337
|
+
},
|
|
2338
|
+
{
|
|
2339
|
+
"name": "as",
|
|
2340
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2341
|
+
"default": "",
|
|
2342
|
+
"description": "The component type to render."
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
"name": "asChild",
|
|
2346
|
+
"type": "boolean",
|
|
2347
|
+
"default": "false",
|
|
2348
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"name": "instance",
|
|
2352
|
+
"type": "ContextMenuSubmenuInstance",
|
|
2353
|
+
"default": "",
|
|
2354
|
+
"description": "The instance to pass to the component."
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"name": "pt",
|
|
2358
|
+
"type": "SafeRecord<ContextMenuSubmenuPassThrough>",
|
|
2359
|
+
"default": "",
|
|
2360
|
+
"description": "The pass-through props to pass to the component."
|
|
2361
|
+
},
|
|
2362
|
+
{
|
|
2363
|
+
"name": "ptOptions",
|
|
2364
|
+
"type": "PassThroughOptions",
|
|
2365
|
+
"default": "",
|
|
2366
|
+
"description": "The pass-through options to pass to the component."
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"name": "unstyled",
|
|
2370
|
+
"type": "boolean",
|
|
2371
|
+
"default": "",
|
|
2372
|
+
"description": "Whether the component should be rendered without classes."
|
|
2373
|
+
},
|
|
2374
|
+
{
|
|
2375
|
+
"name": "dt",
|
|
2376
|
+
"type": "unknown",
|
|
2377
|
+
"default": "",
|
|
2378
|
+
"description": "The design token to use for the component."
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"name": "styles",
|
|
2382
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2383
|
+
"default": "",
|
|
2384
|
+
"description": "The styles to use for the component."
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"name": "render",
|
|
2388
|
+
"type": "(instance: ContextMenuSubmenuInstance) => ReactNode",
|
|
2389
|
+
"default": "",
|
|
2390
|
+
"description": "The render function to render the component with instance access."
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
"name": "children",
|
|
2394
|
+
"type": "any",
|
|
2395
|
+
"default": "",
|
|
2396
|
+
"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."
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "value",
|
|
2400
|
+
"type": "string",
|
|
2401
|
+
"default": "",
|
|
2402
|
+
"description": "Semantic value identifying this submenu."
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"name": "disabled",
|
|
2406
|
+
"type": "boolean",
|
|
2407
|
+
"default": "false",
|
|
2408
|
+
"description": "Whether the submenu is disabled."
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"name": "onOpenChange",
|
|
2412
|
+
"type": "(event: ContextMenuSubmenuOpenChangeEvent) => void",
|
|
2413
|
+
"default": "",
|
|
2414
|
+
"description": "Callback fired when the submenu's open state changes."
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"name": "[key: string]",
|
|
2418
|
+
"type": "any",
|
|
2419
|
+
"description": ""
|
|
2420
|
+
},
|
|
2421
|
+
{
|
|
2422
|
+
"name": "pt-{optionName}-*",
|
|
2423
|
+
"type": "-",
|
|
2424
|
+
"default": "",
|
|
2425
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2426
|
+
"deprecated": false
|
|
2427
|
+
}
|
|
2428
|
+
],
|
|
2429
|
+
"methods": []
|
|
2430
|
+
},
|
|
2431
|
+
"ContextMenuSubmenuState": {
|
|
2432
|
+
"description": "Defines valid state in ContextMenuSubmenu component.",
|
|
2433
|
+
"relatedProp": "",
|
|
2434
|
+
"extendedTypes": "UseContextMenuSubmenuState",
|
|
2435
|
+
"props": [
|
|
2436
|
+
{
|
|
2437
|
+
"name": "open",
|
|
2438
|
+
"type": "boolean",
|
|
2439
|
+
"default": "",
|
|
2440
|
+
"description": "Whether the submenu is open."
|
|
2441
|
+
}
|
|
2442
|
+
],
|
|
2443
|
+
"methods": []
|
|
2444
|
+
},
|
|
2445
|
+
"ContextMenuSubmenuExposes": {
|
|
2446
|
+
"description": "Defines the methods and properties exposed by ContextMenuSubmenu component.",
|
|
2447
|
+
"relatedProp": "",
|
|
2448
|
+
"props": [
|
|
2449
|
+
{
|
|
2450
|
+
"name": "contextmenu",
|
|
2451
|
+
"type": "ContextMenuRootInstance",
|
|
2452
|
+
"default": "",
|
|
2453
|
+
"description": "The ContextMenu component instance."
|
|
2454
|
+
},
|
|
2455
|
+
{
|
|
2456
|
+
"name": "menusub",
|
|
2457
|
+
"type": "UseMenuSubmenuExposes",
|
|
2458
|
+
"default": "",
|
|
2459
|
+
"description": "The underlying menusub headless instance."
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
"name": "subtriggerProps",
|
|
2463
|
+
"type": "{ ref: (node: HTMLElement) => void }",
|
|
2464
|
+
"default": "",
|
|
2465
|
+
"description": "Props for the subtrigger element."
|
|
2466
|
+
},
|
|
2467
|
+
{
|
|
2468
|
+
"name": "subProps",
|
|
2469
|
+
"type": "{ data-open?: \"\"; data-scope: \"menu\"; data-part: \"sub\" }",
|
|
2470
|
+
"default": "",
|
|
2471
|
+
"description": "Props for the sub wrapper element."
|
|
2472
|
+
},
|
|
2473
|
+
{
|
|
2474
|
+
"name": "listProps",
|
|
2475
|
+
"type": "{ ref: (node: HTMLDivElement) => void; data-scope: \"menu\"; data-part: \"list\" }",
|
|
2476
|
+
"default": "",
|
|
2477
|
+
"description": "Props for the list element."
|
|
2478
|
+
},
|
|
2479
|
+
{
|
|
2480
|
+
"name": "toggle",
|
|
2481
|
+
"type": "() => void",
|
|
2482
|
+
"default": "",
|
|
2483
|
+
"description": "Toggle the submenu open/close state."
|
|
2484
|
+
},
|
|
2485
|
+
{
|
|
2486
|
+
"name": "open",
|
|
2487
|
+
"type": "() => void",
|
|
2488
|
+
"default": "",
|
|
2489
|
+
"description": "Open the submenu."
|
|
2490
|
+
},
|
|
2491
|
+
{
|
|
2492
|
+
"name": "close",
|
|
2493
|
+
"type": "() => void",
|
|
2494
|
+
"default": "",
|
|
2495
|
+
"description": "Close the submenu."
|
|
2496
|
+
}
|
|
2497
|
+
],
|
|
2498
|
+
"methods": []
|
|
2499
|
+
}
|
|
2500
|
+
},
|
|
2501
|
+
"types": {
|
|
2502
|
+
"ContextMenuSubmenuPassThroughType": {
|
|
2503
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSubmenu component.",
|
|
2504
|
+
"values": "PassThroughType<ContextMenuSubmenuInstance, E>"
|
|
2505
|
+
},
|
|
2506
|
+
"ContextMenuSubmenuInstance": {
|
|
2507
|
+
"description": "Instance of ContextMenuSubmenu component.",
|
|
2508
|
+
"values": "ComponentInstance<ContextMenuSubmenuProps, ContextMenuSubmenuState, ContextMenuSubmenuExposes>"
|
|
2509
|
+
}
|
|
2510
|
+
},
|
|
2511
|
+
"variables": {}
|
|
2512
|
+
}
|
|
2513
|
+
},
|
|
2514
|
+
{
|
|
2515
|
+
"name": "ContextMenuSubmenuPopup",
|
|
2516
|
+
"source": "apps/showcase/assets/apidoc/contextmenusubpopup.json",
|
|
2517
|
+
"data": {
|
|
2518
|
+
"description": "ContextMenuSubPopup is a component that displays the popup content of a submenu with motion support.",
|
|
2519
|
+
"interfaces": {
|
|
2520
|
+
"ContextMenuSubPopupPassThrough": {
|
|
2521
|
+
"description": "Defines passthrough(pt) options of ContextMenuSubPopup component.",
|
|
2522
|
+
"relatedProp": "",
|
|
2523
|
+
"extendedTypes": "MenuSubPopupPassThrough",
|
|
2524
|
+
"props": [
|
|
2525
|
+
{
|
|
2526
|
+
"name": "root",
|
|
2527
|
+
"type": "MenuSubPopupPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2528
|
+
"default": "",
|
|
2529
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2530
|
+
}
|
|
2531
|
+
],
|
|
2532
|
+
"methods": []
|
|
2533
|
+
},
|
|
2534
|
+
"ContextMenuSubPopupProps": {
|
|
2535
|
+
"description": "Defines valid properties in ContextMenuSubPopup component.",
|
|
2536
|
+
"relatedProp": "",
|
|
2537
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSubPopupInstance, unknown, ContextMenuSubPopupPassThrough>",
|
|
2538
|
+
"props": [
|
|
2539
|
+
{
|
|
2540
|
+
"name": "ref",
|
|
2541
|
+
"type": "Ref<unknown>",
|
|
2542
|
+
"default": "",
|
|
2543
|
+
"description": "The reference to the component instance."
|
|
2544
|
+
},
|
|
2545
|
+
{
|
|
2546
|
+
"name": "pIf",
|
|
2547
|
+
"type": "boolean",
|
|
2548
|
+
"default": "true",
|
|
2549
|
+
"description": "Whether the component should be rendered."
|
|
2550
|
+
},
|
|
2551
|
+
{
|
|
2552
|
+
"name": "style",
|
|
2553
|
+
"type": "CSSProperties | ((instance?: ContextMenuSubPopupInstance) => CSSProperties)",
|
|
2554
|
+
"default": "",
|
|
2555
|
+
"description": "The style to apply to the component."
|
|
2556
|
+
},
|
|
2557
|
+
{
|
|
2558
|
+
"name": "className",
|
|
2559
|
+
"type": "string | ((instance?: ContextMenuSubPopupInstance) => string)",
|
|
2560
|
+
"default": "",
|
|
2561
|
+
"description": "The class name to apply to the component."
|
|
2562
|
+
},
|
|
2563
|
+
{
|
|
2564
|
+
"name": "as",
|
|
2565
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2566
|
+
"default": "",
|
|
2567
|
+
"description": "The component type to render."
|
|
2568
|
+
},
|
|
2569
|
+
{
|
|
2570
|
+
"name": "asChild",
|
|
2571
|
+
"type": "boolean",
|
|
2572
|
+
"default": "false",
|
|
2573
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2574
|
+
},
|
|
2575
|
+
{
|
|
2576
|
+
"name": "instance",
|
|
2577
|
+
"type": "ContextMenuSubPopupInstance",
|
|
2578
|
+
"default": "",
|
|
2579
|
+
"description": "The instance to pass to the component."
|
|
2580
|
+
},
|
|
2581
|
+
{
|
|
2582
|
+
"name": "pt",
|
|
2583
|
+
"type": "SafeRecord<ContextMenuSubPopupPassThrough>",
|
|
2584
|
+
"default": "",
|
|
2585
|
+
"description": "The pass-through props to pass to the component."
|
|
2586
|
+
},
|
|
2587
|
+
{
|
|
2588
|
+
"name": "ptOptions",
|
|
2589
|
+
"type": "PassThroughOptions",
|
|
2590
|
+
"default": "",
|
|
2591
|
+
"description": "The pass-through options to pass to the component."
|
|
2592
|
+
},
|
|
2593
|
+
{
|
|
2594
|
+
"name": "unstyled",
|
|
2595
|
+
"type": "boolean",
|
|
2596
|
+
"default": "",
|
|
2597
|
+
"description": "Whether the component should be rendered without classes."
|
|
2598
|
+
},
|
|
2599
|
+
{
|
|
2600
|
+
"name": "dt",
|
|
2601
|
+
"type": "unknown",
|
|
2602
|
+
"default": "",
|
|
2603
|
+
"description": "The design token to use for the component."
|
|
2604
|
+
},
|
|
2605
|
+
{
|
|
2606
|
+
"name": "styles",
|
|
2607
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2608
|
+
"default": "",
|
|
2609
|
+
"description": "The styles to use for the component."
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"name": "render",
|
|
2613
|
+
"type": "(instance: ContextMenuSubPopupInstance) => ReactNode",
|
|
2614
|
+
"default": "",
|
|
2615
|
+
"description": "The render function to render the component with instance access."
|
|
2616
|
+
},
|
|
2617
|
+
{
|
|
2618
|
+
"name": "children",
|
|
2619
|
+
"type": "any",
|
|
2620
|
+
"default": "",
|
|
2621
|
+
"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."
|
|
2622
|
+
},
|
|
2623
|
+
{
|
|
2624
|
+
"name": "motionProps",
|
|
2625
|
+
"type": "useMotionProps",
|
|
2626
|
+
"default": "",
|
|
2627
|
+
"description": "Used to apply motion to the subpopup element. It accepts the same properties as useMotion hook."
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"name": "[key: string]",
|
|
2631
|
+
"type": "any",
|
|
2632
|
+
"description": ""
|
|
2633
|
+
},
|
|
2634
|
+
{
|
|
2635
|
+
"name": "pt-{optionName}-*",
|
|
2636
|
+
"type": "-",
|
|
2637
|
+
"default": "",
|
|
2638
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2639
|
+
"deprecated": false
|
|
2640
|
+
}
|
|
2641
|
+
],
|
|
2642
|
+
"methods": []
|
|
2643
|
+
},
|
|
2644
|
+
"ContextMenuSubPopupState": {
|
|
2645
|
+
"description": "Defines valid state in ContextMenuSubPopup component.",
|
|
2646
|
+
"relatedProp": "",
|
|
2647
|
+
"props": [],
|
|
2648
|
+
"methods": []
|
|
2649
|
+
},
|
|
2650
|
+
"ContextMenuSubPopupExposes": {
|
|
2651
|
+
"description": "Defines the methods and properties exposed by ContextMenuSubPopup component.",
|
|
2652
|
+
"relatedProp": "",
|
|
2653
|
+
"props": [
|
|
2654
|
+
{
|
|
2655
|
+
"name": "contextmenu",
|
|
2656
|
+
"type": "ContextMenuRootInstance",
|
|
2657
|
+
"default": "",
|
|
2658
|
+
"description": "The ContextMenu component instance."
|
|
2659
|
+
},
|
|
2660
|
+
{
|
|
2661
|
+
"name": "subcontextmenu",
|
|
2662
|
+
"type": "ContextMenuSubInstance",
|
|
2663
|
+
"default": "",
|
|
2664
|
+
"description": "The ContextMenuSub component instance."
|
|
2665
|
+
}
|
|
2666
|
+
],
|
|
2667
|
+
"methods": []
|
|
2668
|
+
}
|
|
2669
|
+
},
|
|
2670
|
+
"types": {
|
|
2671
|
+
"ContextMenuSubPopupPassThroughType": {
|
|
2672
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSubPopup component.",
|
|
2673
|
+
"values": "PassThroughType<ContextMenuSubPopupInstance, E>"
|
|
2674
|
+
},
|
|
2675
|
+
"ContextMenuSubPopupInstance": {
|
|
2676
|
+
"description": "Instance of ContextMenuSubPopup component.",
|
|
2677
|
+
"values": "ComponentInstance<ContextMenuSubPopupProps, ContextMenuSubPopupState, ContextMenuSubPopupExposes>"
|
|
2678
|
+
}
|
|
2679
|
+
},
|
|
2680
|
+
"variables": {}
|
|
2681
|
+
}
|
|
2682
|
+
},
|
|
2683
|
+
{
|
|
2684
|
+
"name": "ContextMenuSubmenuPortal",
|
|
2685
|
+
"source": "apps/showcase/assets/apidoc/contextmenusubportal.json",
|
|
2686
|
+
"data": {
|
|
2687
|
+
"description": "ContextMenuSubPortal is a component that renders submenu content in a portal.",
|
|
2688
|
+
"interfaces": {
|
|
2689
|
+
"ContextMenuSubPortalPassThrough": {
|
|
2690
|
+
"description": "Defines passthrough(pt) options of ContextMenuSubPortal component.",
|
|
2691
|
+
"relatedProp": "",
|
|
2692
|
+
"extendedTypes": "MenuSubPortalPassThrough",
|
|
2693
|
+
"props": [
|
|
2694
|
+
{
|
|
2695
|
+
"name": "root",
|
|
2696
|
+
"type": "MenuSubPortalPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2697
|
+
"default": "",
|
|
2698
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2699
|
+
}
|
|
2700
|
+
],
|
|
2701
|
+
"methods": []
|
|
2702
|
+
},
|
|
2703
|
+
"ContextMenuSubPortalProps": {
|
|
2704
|
+
"description": "Defines valid properties in ContextMenuSubPortal component.",
|
|
2705
|
+
"relatedProp": "",
|
|
2706
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSubPortalInstance, PortalProps, ContextMenuSubPortalPassThrough>",
|
|
2707
|
+
"props": [
|
|
2708
|
+
{
|
|
2709
|
+
"name": "ref",
|
|
2710
|
+
"type": "Ref<unknown>",
|
|
2711
|
+
"default": "",
|
|
2712
|
+
"description": "The reference to the component instance."
|
|
2713
|
+
},
|
|
2714
|
+
{
|
|
2715
|
+
"name": "pIf",
|
|
2716
|
+
"type": "boolean",
|
|
2717
|
+
"default": "true",
|
|
2718
|
+
"description": "Whether the component should be rendered."
|
|
2719
|
+
},
|
|
2720
|
+
{
|
|
2721
|
+
"name": "style",
|
|
2722
|
+
"type": "(CSSProperties | ((instance?: PortalInstance) => CSSProperties)) & (CSSProperties | ((instance?: ContextMenuSubPortalInstance) => CSSProperties))",
|
|
2723
|
+
"default": "",
|
|
2724
|
+
"description": "The style to apply to the component."
|
|
2725
|
+
},
|
|
2726
|
+
{
|
|
2727
|
+
"name": "className",
|
|
2728
|
+
"type": "(string | ((instance?: PortalInstance) => string)) & (string | ((instance?: ContextMenuSubPortalInstance) => string))",
|
|
2729
|
+
"default": "",
|
|
2730
|
+
"description": "The class name to apply to the component."
|
|
2731
|
+
},
|
|
2732
|
+
{
|
|
2733
|
+
"name": "as",
|
|
2734
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2735
|
+
"default": "",
|
|
2736
|
+
"description": "The component type to render."
|
|
2737
|
+
},
|
|
2738
|
+
{
|
|
2739
|
+
"name": "asChild",
|
|
2740
|
+
"type": "boolean",
|
|
2741
|
+
"default": "false",
|
|
2742
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2743
|
+
},
|
|
2744
|
+
{
|
|
2745
|
+
"name": "instance",
|
|
2746
|
+
"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<ContextMenuSubPortalProps>, unknown, HTMLElement> & { props: SafeRecord<SafeRecord<ContextMenuSubPortalProps>>; attrs: Omit<SafeRecord<SafeRecord<ContextMenuSubPortalProps>>, string | number | symbol> & Record<PropertyKey, unknown> } & { state: SafeRecord; $computedSetup: SafeRecord } & ContextMenuSubPortalExposes",
|
|
2747
|
+
"default": "",
|
|
2748
|
+
"description": "The instance to pass to the component."
|
|
2749
|
+
},
|
|
2750
|
+
{
|
|
2751
|
+
"name": "pt",
|
|
2752
|
+
"type": "PortalPassThrough & Record<PropertyKey, unknown> & ContextMenuSubPortalPassThrough",
|
|
2753
|
+
"default": "",
|
|
2754
|
+
"description": "The pass-through props to pass to the component."
|
|
2755
|
+
},
|
|
2756
|
+
{
|
|
2757
|
+
"name": "ptOptions",
|
|
2758
|
+
"type": "PassThroughOptions",
|
|
2759
|
+
"default": "",
|
|
2760
|
+
"description": "The pass-through options to pass to the component."
|
|
2761
|
+
},
|
|
2762
|
+
{
|
|
2763
|
+
"name": "unstyled",
|
|
2764
|
+
"type": "boolean",
|
|
2765
|
+
"default": "",
|
|
2766
|
+
"description": "Whether the component should be rendered without classes."
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
"name": "dt",
|
|
2770
|
+
"type": "unknown",
|
|
2771
|
+
"default": "",
|
|
2772
|
+
"description": "The design token to use for the component."
|
|
2773
|
+
},
|
|
2774
|
+
{
|
|
2775
|
+
"name": "styles",
|
|
2776
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2777
|
+
"default": "",
|
|
2778
|
+
"description": "The styles to use for the component."
|
|
2779
|
+
},
|
|
2780
|
+
{
|
|
2781
|
+
"name": "render",
|
|
2782
|
+
"type": "(instance: PortalInstance) => ReactNode & (instance: ContextMenuSubPortalInstance) => ReactNode",
|
|
2783
|
+
"default": "",
|
|
2784
|
+
"description": "The render function to render the component with instance access."
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
"name": "children",
|
|
2788
|
+
"type": "any",
|
|
2789
|
+
"default": "",
|
|
2790
|
+
"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."
|
|
2791
|
+
},
|
|
2792
|
+
{
|
|
2793
|
+
"name": "onMounted",
|
|
2794
|
+
"type": "() => void",
|
|
2795
|
+
"default": "",
|
|
2796
|
+
"description": "Callback function to invoke when the portal is mounted."
|
|
2797
|
+
},
|
|
2798
|
+
{
|
|
2799
|
+
"name": "onUnmounted",
|
|
2800
|
+
"type": "() => void",
|
|
2801
|
+
"default": "",
|
|
2802
|
+
"description": "Callback function to invoke when the portal is unmounted."
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
"name": "element",
|
|
2806
|
+
"type": "HTMLElement | ReactNode",
|
|
2807
|
+
"default": "",
|
|
2808
|
+
"description": "The element to be rendered as the portal."
|
|
2809
|
+
},
|
|
2810
|
+
{
|
|
2811
|
+
"name": "elementRef",
|
|
2812
|
+
"type": "RefObject<HTMLElement>",
|
|
2813
|
+
"default": "",
|
|
2814
|
+
"description": "The element reference to be rendered as the portal."
|
|
2815
|
+
},
|
|
2816
|
+
{
|
|
2817
|
+
"name": "appendTo",
|
|
2818
|
+
"type": "string | HTMLElement | ((instance: PortalInstance) => HTMLElement)",
|
|
2819
|
+
"default": "'body'",
|
|
2820
|
+
"description": "The DOM element where the portal should be appended to."
|
|
2821
|
+
},
|
|
2822
|
+
{
|
|
2823
|
+
"name": "[key: string]",
|
|
2824
|
+
"type": "any",
|
|
2825
|
+
"description": ""
|
|
2826
|
+
},
|
|
2827
|
+
{
|
|
2828
|
+
"name": "pt-{optionName}-*",
|
|
2829
|
+
"type": "-",
|
|
2830
|
+
"default": "",
|
|
2831
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2832
|
+
"deprecated": false
|
|
2833
|
+
}
|
|
2834
|
+
],
|
|
2835
|
+
"methods": []
|
|
2836
|
+
},
|
|
2837
|
+
"ContextMenuSubPortalState": {
|
|
2838
|
+
"description": "Defines valid state in ContextMenuSubPortal component.",
|
|
2839
|
+
"relatedProp": "",
|
|
2840
|
+
"props": [],
|
|
2841
|
+
"methods": []
|
|
2842
|
+
},
|
|
2843
|
+
"ContextMenuSubPortalExposes": {
|
|
2844
|
+
"description": "Defines the methods and properties exposed by ContextMenuSubPortal component.",
|
|
2845
|
+
"relatedProp": "",
|
|
2846
|
+
"props": [
|
|
2847
|
+
{
|
|
2848
|
+
"name": "contextmenu",
|
|
2849
|
+
"type": "ContextMenuRootInstance",
|
|
2850
|
+
"default": "",
|
|
2851
|
+
"description": "The ContextMenu component instance."
|
|
2852
|
+
},
|
|
2853
|
+
{
|
|
2854
|
+
"name": "subcontextmenu",
|
|
2855
|
+
"type": "ContextMenuSubInstance",
|
|
2856
|
+
"default": "",
|
|
2857
|
+
"description": "The ContextMenuSub component instance."
|
|
2858
|
+
}
|
|
2859
|
+
],
|
|
2860
|
+
"methods": []
|
|
2861
|
+
}
|
|
2862
|
+
},
|
|
2863
|
+
"types": {
|
|
2864
|
+
"ContextMenuSubPortalPassThroughType": {
|
|
2865
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSubPortal component.",
|
|
2866
|
+
"values": "PassThroughType<ContextMenuSubPortalInstance, E>"
|
|
2867
|
+
},
|
|
2868
|
+
"ContextMenuSubPortalInstance": {
|
|
2869
|
+
"description": "Instance of ContextMenuSubPortal component.",
|
|
2870
|
+
"values": "ComponentInstance<ContextMenuSubPortalProps, ContextMenuSubPortalState, ContextMenuSubPortalExposes>"
|
|
2871
|
+
}
|
|
2872
|
+
},
|
|
2873
|
+
"variables": {}
|
|
2874
|
+
}
|
|
2875
|
+
},
|
|
2876
|
+
{
|
|
2877
|
+
"name": "ContextMenuSubmenuPositioner",
|
|
2878
|
+
"source": "apps/showcase/assets/apidoc/contextmenusubpositioner.json",
|
|
2879
|
+
"data": {
|
|
2880
|
+
"description": "ContextMenuSubPositioner is a component that positions the submenu list relative to the subtrigger element using usePositioner.",
|
|
2881
|
+
"interfaces": {
|
|
2882
|
+
"ContextMenuSubPositionerPassThrough": {
|
|
2883
|
+
"description": "Defines passthrough(pt) options of ContextMenuSubPositioner component.",
|
|
2884
|
+
"relatedProp": "",
|
|
2885
|
+
"extendedTypes": "MenuSubPositionerPassThrough",
|
|
2886
|
+
"props": [
|
|
2887
|
+
{
|
|
2888
|
+
"name": "root",
|
|
2889
|
+
"type": "MenuSubPositionerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2890
|
+
"default": "",
|
|
2891
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2892
|
+
}
|
|
2893
|
+
],
|
|
2894
|
+
"methods": []
|
|
2895
|
+
},
|
|
2896
|
+
"ContextMenuSubPositionerProps": {
|
|
2897
|
+
"description": "Defines valid properties in ContextMenuSubPositioner component.",
|
|
2898
|
+
"relatedProp": "",
|
|
2899
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSubPositionerInstance, usePositionerProps, ContextMenuSubPositionerPassThrough>",
|
|
2900
|
+
"props": [
|
|
2901
|
+
{
|
|
2902
|
+
"name": "ref",
|
|
2903
|
+
"type": "Ref<unknown>",
|
|
2904
|
+
"default": "",
|
|
2905
|
+
"description": "The reference to the component instance."
|
|
2906
|
+
},
|
|
2907
|
+
{
|
|
2908
|
+
"name": "pIf",
|
|
2909
|
+
"type": "boolean",
|
|
2910
|
+
"default": "true",
|
|
2911
|
+
"description": "Whether the component should be rendered."
|
|
2912
|
+
},
|
|
2913
|
+
{
|
|
2914
|
+
"name": "style",
|
|
2915
|
+
"type": "CSSProperties | ((instance?: ContextMenuSubPositionerInstance) => CSSProperties)",
|
|
2916
|
+
"default": "",
|
|
2917
|
+
"description": "The style to apply to the component."
|
|
2918
|
+
},
|
|
2919
|
+
{
|
|
2920
|
+
"name": "className",
|
|
2921
|
+
"type": "string | ((instance?: ContextMenuSubPositionerInstance) => string)",
|
|
2922
|
+
"default": "",
|
|
2923
|
+
"description": "The class name to apply to the component."
|
|
2924
|
+
},
|
|
2925
|
+
{
|
|
2926
|
+
"name": "as",
|
|
2927
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2928
|
+
"default": "",
|
|
2929
|
+
"description": "The component type to render."
|
|
2930
|
+
},
|
|
2931
|
+
{
|
|
2932
|
+
"name": "asChild",
|
|
2933
|
+
"type": "boolean",
|
|
2934
|
+
"default": "false",
|
|
2935
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2936
|
+
},
|
|
2937
|
+
{
|
|
2938
|
+
"name": "instance",
|
|
2939
|
+
"type": "ContextMenuSubPositionerInstance",
|
|
2940
|
+
"default": "",
|
|
2941
|
+
"description": "The instance to pass to the component."
|
|
2942
|
+
},
|
|
2943
|
+
{
|
|
2944
|
+
"name": "pt",
|
|
2945
|
+
"type": "SafeRecord<ContextMenuSubPositionerPassThrough>",
|
|
2946
|
+
"default": "",
|
|
2947
|
+
"description": "The pass-through props to pass to the component."
|
|
2948
|
+
},
|
|
2949
|
+
{
|
|
2950
|
+
"name": "ptOptions",
|
|
2951
|
+
"type": "PassThroughOptions",
|
|
2952
|
+
"default": "",
|
|
2953
|
+
"description": "The pass-through options to pass to the component."
|
|
2954
|
+
},
|
|
2955
|
+
{
|
|
2956
|
+
"name": "unstyled",
|
|
2957
|
+
"type": "boolean",
|
|
2958
|
+
"default": "",
|
|
2959
|
+
"description": "Whether the component should be rendered without classes."
|
|
2960
|
+
},
|
|
2961
|
+
{
|
|
2962
|
+
"name": "dt",
|
|
2963
|
+
"type": "unknown",
|
|
2964
|
+
"default": "",
|
|
2965
|
+
"description": "The design token to use for the component."
|
|
2966
|
+
},
|
|
2967
|
+
{
|
|
2968
|
+
"name": "styles",
|
|
2969
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2970
|
+
"default": "",
|
|
2971
|
+
"description": "The styles to use for the component."
|
|
2972
|
+
},
|
|
2973
|
+
{
|
|
2974
|
+
"name": "render",
|
|
2975
|
+
"type": "(instance: ContextMenuSubPositionerInstance) => ReactNode",
|
|
2976
|
+
"default": "",
|
|
2977
|
+
"description": "The render function to render the component with instance access."
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"name": "children",
|
|
2981
|
+
"type": "any",
|
|
2982
|
+
"default": "",
|
|
2983
|
+
"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."
|
|
2984
|
+
},
|
|
2985
|
+
{
|
|
2986
|
+
"name": "side",
|
|
2987
|
+
"type": "SideType",
|
|
2988
|
+
"default": "",
|
|
2989
|
+
"description": "The side of the positioner."
|
|
2990
|
+
},
|
|
2991
|
+
{
|
|
2992
|
+
"name": "align",
|
|
2993
|
+
"type": "AlignType",
|
|
2994
|
+
"default": "",
|
|
2995
|
+
"description": "The align of the positioner."
|
|
2996
|
+
},
|
|
2997
|
+
{
|
|
2998
|
+
"name": "sideOffset",
|
|
2999
|
+
"type": "number",
|
|
3000
|
+
"default": "",
|
|
3001
|
+
"description": "The side offset of the positioner."
|
|
3002
|
+
},
|
|
3003
|
+
{
|
|
3004
|
+
"name": "alignOffset",
|
|
3005
|
+
"type": "number",
|
|
3006
|
+
"default": "",
|
|
3007
|
+
"description": "The align offset of the positioner."
|
|
3008
|
+
},
|
|
3009
|
+
{
|
|
3010
|
+
"name": "flip",
|
|
3011
|
+
"type": "boolean",
|
|
3012
|
+
"default": "",
|
|
3013
|
+
"description": "Whether to flip the positioner."
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
"name": "shift",
|
|
3017
|
+
"type": "boolean",
|
|
3018
|
+
"default": "",
|
|
3019
|
+
"description": "Whether to shift the positioner."
|
|
3020
|
+
},
|
|
3021
|
+
{
|
|
3022
|
+
"name": "hideWhenDetached",
|
|
3023
|
+
"type": "boolean",
|
|
3024
|
+
"default": "",
|
|
3025
|
+
"description": "Whether to hide the positioner when detached."
|
|
3026
|
+
},
|
|
3027
|
+
{
|
|
3028
|
+
"name": "strategy",
|
|
3029
|
+
"type": "\"fixed\" | \"absolute\"",
|
|
3030
|
+
"default": "'fixed'",
|
|
3031
|
+
"description": "The positioning strategy."
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
"name": "boundary",
|
|
3035
|
+
"type": "HTMLElement",
|
|
3036
|
+
"default": "",
|
|
3037
|
+
"description": "The boundary element that constrains the positioner placement.\nUsed in JS fallback mode only; CSS Anchor mode uses the containing block."
|
|
3038
|
+
},
|
|
3039
|
+
{
|
|
3040
|
+
"name": "anchor",
|
|
3041
|
+
"type": "HTMLElement",
|
|
3042
|
+
"default": "",
|
|
3043
|
+
"description": "The anchor element."
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
"name": "content",
|
|
3047
|
+
"type": "HTMLDivElement",
|
|
3048
|
+
"default": "",
|
|
3049
|
+
"description": "The content element."
|
|
3050
|
+
},
|
|
3051
|
+
{
|
|
3052
|
+
"name": "arrow",
|
|
3053
|
+
"type": "HTMLDivElement",
|
|
3054
|
+
"default": "",
|
|
3055
|
+
"description": "The arrow element."
|
|
3056
|
+
},
|
|
3057
|
+
{
|
|
3058
|
+
"name": "autoZIndex",
|
|
3059
|
+
"type": "boolean",
|
|
3060
|
+
"default": "true",
|
|
3061
|
+
"description": "Whether to automatically manage layering."
|
|
3062
|
+
},
|
|
3063
|
+
{
|
|
3064
|
+
"name": "baseZIndex",
|
|
3065
|
+
"type": "number",
|
|
3066
|
+
"default": "0",
|
|
3067
|
+
"description": "Base zIndex value to use in layering."
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"name": "onPlacementChange",
|
|
3071
|
+
"type": "(placement: { side: SideType; align: AlignType }) => void",
|
|
3072
|
+
"default": "",
|
|
3073
|
+
"description": "Callback invoked when the actual placement changes due to flip or shift."
|
|
3074
|
+
},
|
|
3075
|
+
{
|
|
3076
|
+
"name": "[key: string]",
|
|
3077
|
+
"type": "any",
|
|
3078
|
+
"description": ""
|
|
3079
|
+
},
|
|
3080
|
+
{
|
|
3081
|
+
"name": "pt-{optionName}-*",
|
|
3082
|
+
"type": "-",
|
|
3083
|
+
"default": "",
|
|
3084
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3085
|
+
"deprecated": false
|
|
3086
|
+
}
|
|
3087
|
+
],
|
|
3088
|
+
"methods": []
|
|
3089
|
+
},
|
|
3090
|
+
"ContextMenuSubPositionerState": {
|
|
3091
|
+
"description": "Defines valid state in ContextMenuSubPositioner component.",
|
|
3092
|
+
"relatedProp": "",
|
|
3093
|
+
"props": [],
|
|
3094
|
+
"methods": []
|
|
3095
|
+
},
|
|
3096
|
+
"ContextMenuSubPositionerExposes": {
|
|
3097
|
+
"description": "Defines the methods and properties exposed by ContextMenuSubPositioner component.",
|
|
3098
|
+
"relatedProp": "",
|
|
3099
|
+
"props": [
|
|
3100
|
+
{
|
|
3101
|
+
"name": "contextmenu",
|
|
3102
|
+
"type": "ContextMenuRootInstance",
|
|
3103
|
+
"default": "",
|
|
3104
|
+
"description": "The ContextMenu component instance."
|
|
3105
|
+
},
|
|
3106
|
+
{
|
|
3107
|
+
"name": "subcontextmenu",
|
|
3108
|
+
"type": "ContextMenuSubInstance",
|
|
3109
|
+
"default": "",
|
|
3110
|
+
"description": "The ContextMenuSub component instance."
|
|
3111
|
+
},
|
|
3112
|
+
{
|
|
3113
|
+
"name": "positioner",
|
|
3114
|
+
"type": "usePositionerExposes",
|
|
3115
|
+
"default": "",
|
|
3116
|
+
"description": "The positioner instance."
|
|
3117
|
+
}
|
|
3118
|
+
],
|
|
3119
|
+
"methods": []
|
|
3120
|
+
}
|
|
3121
|
+
},
|
|
3122
|
+
"types": {
|
|
3123
|
+
"ContextMenuSubPositionerPassThroughType": {
|
|
3124
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSubPositioner component.",
|
|
3125
|
+
"values": "PassThroughType<ContextMenuSubPositionerInstance, E>"
|
|
3126
|
+
},
|
|
3127
|
+
"ContextMenuSubPositionerInstance": {
|
|
3128
|
+
"description": "Instance of ContextMenuSubPositioner component.",
|
|
3129
|
+
"values": "ComponentInstance<ContextMenuSubPositionerProps, ContextMenuSubPositionerState, ContextMenuSubPositionerExposes>"
|
|
3130
|
+
}
|
|
3131
|
+
},
|
|
3132
|
+
"variables": {}
|
|
3133
|
+
}
|
|
3134
|
+
},
|
|
3135
|
+
{
|
|
3136
|
+
"name": "ContextMenuSubmenuTrigger",
|
|
3137
|
+
"source": "apps/showcase/assets/apidoc/contextmenusubmenutrigger.json",
|
|
3138
|
+
"data": {
|
|
3139
|
+
"description": "ContextMenuSubmenuTrigger is a component that displays the trigger for a submenu item.",
|
|
3140
|
+
"interfaces": {
|
|
3141
|
+
"ContextMenuSubmenuTriggerPassThrough": {
|
|
3142
|
+
"description": "Defines passthrough(pt) options of ContextMenuSubmenuTrigger component.",
|
|
3143
|
+
"relatedProp": "",
|
|
3144
|
+
"extendedTypes": "MenuSubmenuTriggerPassThrough",
|
|
3145
|
+
"props": [
|
|
3146
|
+
{
|
|
3147
|
+
"name": "root",
|
|
3148
|
+
"type": "MenuSubmenuTriggerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
3149
|
+
"default": "",
|
|
3150
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3151
|
+
}
|
|
3152
|
+
],
|
|
3153
|
+
"methods": []
|
|
3154
|
+
},
|
|
3155
|
+
"ContextMenuSubmenuTriggerProps": {
|
|
3156
|
+
"description": "Defines valid properties in ContextMenuSubmenuTrigger component.",
|
|
3157
|
+
"relatedProp": "",
|
|
3158
|
+
"extendedTypes": "BaseComponentProps<ContextMenuSubmenuTriggerInstance, unknown, ContextMenuSubmenuTriggerPassThrough>",
|
|
3159
|
+
"props": [
|
|
3160
|
+
{
|
|
3161
|
+
"name": "ref",
|
|
3162
|
+
"type": "Ref<unknown>",
|
|
3163
|
+
"default": "",
|
|
3164
|
+
"description": "The reference to the component instance."
|
|
3165
|
+
},
|
|
3166
|
+
{
|
|
3167
|
+
"name": "pIf",
|
|
3168
|
+
"type": "boolean",
|
|
3169
|
+
"default": "true",
|
|
3170
|
+
"description": "Whether the component should be rendered."
|
|
3171
|
+
},
|
|
3172
|
+
{
|
|
3173
|
+
"name": "style",
|
|
3174
|
+
"type": "CSSProperties | ((instance?: ContextMenuSubmenuTriggerInstance) => CSSProperties)",
|
|
3175
|
+
"default": "",
|
|
3176
|
+
"description": "The style to apply to the component."
|
|
3177
|
+
},
|
|
3178
|
+
{
|
|
3179
|
+
"name": "className",
|
|
3180
|
+
"type": "string | ((instance?: ContextMenuSubmenuTriggerInstance) => string)",
|
|
3181
|
+
"default": "",
|
|
3182
|
+
"description": "The class name to apply to the component."
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
"name": "as",
|
|
3186
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3187
|
+
"default": "",
|
|
3188
|
+
"description": "The component type to render."
|
|
3189
|
+
},
|
|
3190
|
+
{
|
|
3191
|
+
"name": "asChild",
|
|
3192
|
+
"type": "boolean",
|
|
3193
|
+
"default": "false",
|
|
3194
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3195
|
+
},
|
|
3196
|
+
{
|
|
3197
|
+
"name": "instance",
|
|
3198
|
+
"type": "ContextMenuSubmenuTriggerInstance",
|
|
3199
|
+
"default": "",
|
|
3200
|
+
"description": "The instance to pass to the component."
|
|
3201
|
+
},
|
|
3202
|
+
{
|
|
3203
|
+
"name": "pt",
|
|
3204
|
+
"type": "SafeRecord<ContextMenuSubmenuTriggerPassThrough>",
|
|
3205
|
+
"default": "",
|
|
3206
|
+
"description": "The pass-through props to pass to the component."
|
|
3207
|
+
},
|
|
3208
|
+
{
|
|
3209
|
+
"name": "ptOptions",
|
|
3210
|
+
"type": "PassThroughOptions",
|
|
3211
|
+
"default": "",
|
|
3212
|
+
"description": "The pass-through options to pass to the component."
|
|
3213
|
+
},
|
|
3214
|
+
{
|
|
3215
|
+
"name": "unstyled",
|
|
3216
|
+
"type": "boolean",
|
|
3217
|
+
"default": "",
|
|
3218
|
+
"description": "Whether the component should be rendered without classes."
|
|
3219
|
+
},
|
|
3220
|
+
{
|
|
3221
|
+
"name": "dt",
|
|
3222
|
+
"type": "unknown",
|
|
3223
|
+
"default": "",
|
|
3224
|
+
"description": "The design token to use for the component."
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
"name": "styles",
|
|
3228
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3229
|
+
"default": "",
|
|
3230
|
+
"description": "The styles to use for the component."
|
|
3231
|
+
},
|
|
3232
|
+
{
|
|
3233
|
+
"name": "render",
|
|
3234
|
+
"type": "(instance: ContextMenuSubmenuTriggerInstance) => ReactNode",
|
|
3235
|
+
"default": "",
|
|
3236
|
+
"description": "The render function to render the component with instance access."
|
|
3237
|
+
},
|
|
3238
|
+
{
|
|
3239
|
+
"name": "children",
|
|
3240
|
+
"type": "any",
|
|
3241
|
+
"default": "",
|
|
3242
|
+
"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."
|
|
3243
|
+
},
|
|
3244
|
+
{
|
|
3245
|
+
"name": "[key: string]",
|
|
3246
|
+
"type": "any",
|
|
3247
|
+
"description": ""
|
|
3248
|
+
},
|
|
3249
|
+
{
|
|
3250
|
+
"name": "pt-{optionName}-*",
|
|
3251
|
+
"type": "-",
|
|
3252
|
+
"default": "",
|
|
3253
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3254
|
+
"deprecated": false
|
|
3255
|
+
}
|
|
3256
|
+
],
|
|
3257
|
+
"methods": []
|
|
3258
|
+
},
|
|
3259
|
+
"ContextMenuSubmenuTriggerState": {
|
|
3260
|
+
"description": "Defines valid state in ContextMenuSubmenuTrigger component.",
|
|
3261
|
+
"relatedProp": "",
|
|
3262
|
+
"props": [],
|
|
3263
|
+
"methods": []
|
|
3264
|
+
},
|
|
3265
|
+
"ContextMenuSubmenuTriggerExposes": {
|
|
3266
|
+
"description": "Defines the methods and properties exposed by ContextMenuSubmenuTrigger component.",
|
|
3267
|
+
"relatedProp": "",
|
|
3268
|
+
"props": [
|
|
3269
|
+
{
|
|
3270
|
+
"name": "contextmenu",
|
|
3271
|
+
"type": "ContextMenuRootInstance",
|
|
3272
|
+
"default": "",
|
|
3273
|
+
"description": "The ContextMenu component instance."
|
|
3274
|
+
}
|
|
3275
|
+
],
|
|
3276
|
+
"methods": []
|
|
3277
|
+
}
|
|
3278
|
+
},
|
|
3279
|
+
"types": {
|
|
3280
|
+
"ContextMenuSubmenuTriggerPassThroughType": {
|
|
3281
|
+
"description": "Defines passthrough(pt) options type in ContextMenuSubmenuTrigger component.",
|
|
3282
|
+
"values": "PassThroughType<ContextMenuSubmenuTriggerInstance, E>"
|
|
3283
|
+
},
|
|
3284
|
+
"ContextMenuSubmenuTriggerInstance": {
|
|
3285
|
+
"description": "Instance of ContextMenuSubmenuTrigger component.",
|
|
3286
|
+
"values": "ComponentInstance<ContextMenuSubmenuTriggerProps, ContextMenuSubmenuTriggerState, ContextMenuSubmenuTriggerExposes>"
|
|
3287
|
+
}
|
|
3288
|
+
},
|
|
3289
|
+
"variables": {}
|
|
3290
|
+
}
|
|
3291
|
+
},
|
|
3292
|
+
{
|
|
3293
|
+
"name": "ContextMenuTrigger",
|
|
3294
|
+
"source": "apps/showcase/assets/apidoc/contextmenutrigger.json",
|
|
3295
|
+
"data": {
|
|
3296
|
+
"description": "ContextMenuTrigger is a component that displays trigger.",
|
|
3297
|
+
"interfaces": {
|
|
3298
|
+
"ContextMenuTriggerPassThrough": {
|
|
3299
|
+
"description": "Defines passthrough(pt) options of ContextMenuTrigger component.",
|
|
3300
|
+
"relatedProp": "",
|
|
3301
|
+
"props": [
|
|
3302
|
+
{
|
|
3303
|
+
"name": "root",
|
|
3304
|
+
"type": "ContextMenuTriggerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
3305
|
+
"default": "",
|
|
3306
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3307
|
+
}
|
|
3308
|
+
],
|
|
3309
|
+
"methods": []
|
|
3310
|
+
},
|
|
3311
|
+
"ContextMenuTriggerProps": {
|
|
3312
|
+
"description": "Defines valid properties in ContextMenuTrigger component.",
|
|
3313
|
+
"relatedProp": "",
|
|
3314
|
+
"extendedTypes": "BaseComponentProps<ContextMenuTriggerInstance, unknown, ContextMenuTriggerPassThrough>",
|
|
3315
|
+
"props": [
|
|
3316
|
+
{
|
|
3317
|
+
"name": "ref",
|
|
3318
|
+
"type": "Ref<unknown>",
|
|
3319
|
+
"default": "",
|
|
3320
|
+
"description": "The reference to the component instance."
|
|
3321
|
+
},
|
|
3322
|
+
{
|
|
3323
|
+
"name": "pIf",
|
|
3324
|
+
"type": "boolean",
|
|
3325
|
+
"default": "true",
|
|
3326
|
+
"description": "Whether the component should be rendered."
|
|
3327
|
+
},
|
|
3328
|
+
{
|
|
3329
|
+
"name": "style",
|
|
3330
|
+
"type": "CSSProperties | ((instance?: ContextMenuTriggerInstance) => CSSProperties)",
|
|
3331
|
+
"default": "",
|
|
3332
|
+
"description": "The style to apply to the component."
|
|
3333
|
+
},
|
|
3334
|
+
{
|
|
3335
|
+
"name": "className",
|
|
3336
|
+
"type": "string | ((instance?: ContextMenuTriggerInstance) => string)",
|
|
3337
|
+
"default": "",
|
|
3338
|
+
"description": "The class name to apply to the component."
|
|
3339
|
+
},
|
|
3340
|
+
{
|
|
3341
|
+
"name": "as",
|
|
3342
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3343
|
+
"default": "",
|
|
3344
|
+
"description": "The component type to render."
|
|
3345
|
+
},
|
|
3346
|
+
{
|
|
3347
|
+
"name": "asChild",
|
|
3348
|
+
"type": "boolean",
|
|
3349
|
+
"default": "false",
|
|
3350
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3351
|
+
},
|
|
3352
|
+
{
|
|
3353
|
+
"name": "instance",
|
|
3354
|
+
"type": "ContextMenuTriggerInstance",
|
|
3355
|
+
"default": "",
|
|
3356
|
+
"description": "The instance to pass to the component."
|
|
3357
|
+
},
|
|
3358
|
+
{
|
|
3359
|
+
"name": "pt",
|
|
3360
|
+
"type": "SafeRecord<ContextMenuTriggerPassThrough>",
|
|
3361
|
+
"default": "",
|
|
3362
|
+
"description": "The pass-through props to pass to the component."
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
"name": "ptOptions",
|
|
3366
|
+
"type": "PassThroughOptions",
|
|
3367
|
+
"default": "",
|
|
3368
|
+
"description": "The pass-through options to pass to the component."
|
|
3369
|
+
},
|
|
3370
|
+
{
|
|
3371
|
+
"name": "unstyled",
|
|
3372
|
+
"type": "boolean",
|
|
3373
|
+
"default": "",
|
|
3374
|
+
"description": "Whether the component should be rendered without classes."
|
|
3375
|
+
},
|
|
3376
|
+
{
|
|
3377
|
+
"name": "dt",
|
|
3378
|
+
"type": "unknown",
|
|
3379
|
+
"default": "",
|
|
3380
|
+
"description": "The design token to use for the component."
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "styles",
|
|
3384
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3385
|
+
"default": "",
|
|
3386
|
+
"description": "The styles to use for the component."
|
|
3387
|
+
},
|
|
3388
|
+
{
|
|
3389
|
+
"name": "render",
|
|
3390
|
+
"type": "(instance: ContextMenuTriggerInstance) => ReactNode",
|
|
3391
|
+
"default": "",
|
|
3392
|
+
"description": "The render function to render the component with instance access."
|
|
3393
|
+
},
|
|
3394
|
+
{
|
|
3395
|
+
"name": "children",
|
|
3396
|
+
"type": "any",
|
|
3397
|
+
"default": "",
|
|
3398
|
+
"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."
|
|
3399
|
+
},
|
|
3400
|
+
{
|
|
3401
|
+
"name": "[key: string]",
|
|
3402
|
+
"type": "any",
|
|
3403
|
+
"description": ""
|
|
3404
|
+
},
|
|
3405
|
+
{
|
|
3406
|
+
"name": "pt-{optionName}-*",
|
|
3407
|
+
"type": "-",
|
|
3408
|
+
"default": "",
|
|
3409
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3410
|
+
"deprecated": false
|
|
3411
|
+
}
|
|
3412
|
+
],
|
|
3413
|
+
"methods": []
|
|
3414
|
+
},
|
|
3415
|
+
"ContextMenuTriggerState": {
|
|
3416
|
+
"description": "Defines valid state in ContextMenuTrigger component.",
|
|
3417
|
+
"relatedProp": "",
|
|
3418
|
+
"props": [],
|
|
3419
|
+
"methods": []
|
|
3420
|
+
},
|
|
3421
|
+
"ContextMenuTriggerExposes": {
|
|
3422
|
+
"description": "Defines the methods and properties exposed by ContextMenuTrigger component.",
|
|
3423
|
+
"relatedProp": "",
|
|
3424
|
+
"props": [
|
|
3425
|
+
{
|
|
3426
|
+
"name": "contextmenu",
|
|
3427
|
+
"type": "ContextMenuRootInstance",
|
|
3428
|
+
"default": "",
|
|
3429
|
+
"description": "The ContextMenu component instance."
|
|
3430
|
+
},
|
|
3431
|
+
{
|
|
3432
|
+
"name": "menu",
|
|
3433
|
+
"type": "MenuRootInstance",
|
|
3434
|
+
"default": "",
|
|
3435
|
+
"description": "Instance of the Menu component."
|
|
3436
|
+
}
|
|
3437
|
+
],
|
|
3438
|
+
"methods": []
|
|
3439
|
+
}
|
|
3440
|
+
},
|
|
3441
|
+
"types": {
|
|
3442
|
+
"ContextMenuTriggerPassThroughType": {
|
|
3443
|
+
"description": "Defines passthrough(pt) options type in ContextMenuTrigger component.",
|
|
3444
|
+
"values": "PassThroughType<ContextMenuTriggerInstance, E>"
|
|
3445
|
+
},
|
|
3446
|
+
"ContextMenuTriggerInstance": {
|
|
3447
|
+
"description": "Instance of ContextMenuTrigger component.",
|
|
3448
|
+
"values": "ComponentInstance<ContextMenuTriggerProps, ContextMenuTriggerState, ContextMenuTriggerExposes>"
|
|
3449
|
+
}
|
|
3450
|
+
},
|
|
3451
|
+
"variables": {}
|
|
3452
|
+
}
|
|
3453
|
+
}
|
|
3454
|
+
]
|