@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,3167 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "SelectArrow",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/selectarrow.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "SelectArrow is a component that displays the arrow of a select popup.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"SelectArrowPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of SelectArrow component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "SelectArrowPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"SelectArrowProps": {
|
|
22
|
+
"description": "Defines valid properties in SelectArrow component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<SelectArrowInstance, unknown, SelectArrowPassThrough>",
|
|
25
|
+
"props": [
|
|
26
|
+
{
|
|
27
|
+
"name": "ref",
|
|
28
|
+
"type": "Ref<unknown>",
|
|
29
|
+
"default": "",
|
|
30
|
+
"description": "The reference to the component instance."
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "pIf",
|
|
34
|
+
"type": "boolean",
|
|
35
|
+
"default": "true",
|
|
36
|
+
"description": "Whether the component should be rendered."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "style",
|
|
40
|
+
"type": "CSSProperties | ((instance?: SelectArrowInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: SelectArrowInstance) => string)",
|
|
47
|
+
"default": "",
|
|
48
|
+
"description": "The class name to apply to the component."
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "as",
|
|
52
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
53
|
+
"default": "",
|
|
54
|
+
"description": "The component type to render."
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "asChild",
|
|
58
|
+
"type": "boolean",
|
|
59
|
+
"default": "false",
|
|
60
|
+
"description": "Whether the component should be rendered as a child component."
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "instance",
|
|
64
|
+
"type": "SelectArrowInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<SelectArrowPassThrough>",
|
|
71
|
+
"default": "",
|
|
72
|
+
"description": "The pass-through props to pass to the component."
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "ptOptions",
|
|
76
|
+
"type": "PassThroughOptions",
|
|
77
|
+
"default": "",
|
|
78
|
+
"description": "The pass-through options to pass to the component."
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "unstyled",
|
|
82
|
+
"type": "boolean",
|
|
83
|
+
"default": "",
|
|
84
|
+
"description": "Whether the component should be rendered without classes."
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "dt",
|
|
88
|
+
"type": "unknown",
|
|
89
|
+
"default": "",
|
|
90
|
+
"description": "The design token to use for the component."
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "styles",
|
|
94
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
95
|
+
"default": "",
|
|
96
|
+
"description": "The styles to use for the component."
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "render",
|
|
100
|
+
"type": "(instance: SelectArrowInstance) => ReactNode",
|
|
101
|
+
"default": "",
|
|
102
|
+
"description": "The render function to render the component with instance access."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "children",
|
|
106
|
+
"type": "any",
|
|
107
|
+
"default": "",
|
|
108
|
+
"description": "The children to render.\n\nAccepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access.\nTyped as `any` to avoid JSX type errors when used directly in templates."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"name": "[key: string]",
|
|
112
|
+
"type": "any",
|
|
113
|
+
"description": ""
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "pt-{optionName}-*",
|
|
117
|
+
"type": "-",
|
|
118
|
+
"default": "",
|
|
119
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
120
|
+
"deprecated": false
|
|
121
|
+
}
|
|
122
|
+
],
|
|
123
|
+
"methods": []
|
|
124
|
+
},
|
|
125
|
+
"SelectArrowState": {
|
|
126
|
+
"description": "Defines valid state in SelectArrow component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"SelectArrowExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by SelectArrow component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "select",
|
|
137
|
+
"type": "SelectRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Select component instance."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"SelectArrowPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in SelectArrow component.",
|
|
148
|
+
"values": "PassThroughType<SelectArrowInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"SelectArrowInstance": {
|
|
151
|
+
"description": "Instance of SelectArrow component.",
|
|
152
|
+
"values": "ComponentInstance<SelectArrowProps, SelectArrowState, SelectArrowExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "SelectClear",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/selectclear.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "SelectClear is the clear button for the Select component.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"SelectClearPassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of SelectClear component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "SelectClearPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"SelectClearProps": {
|
|
178
|
+
"description": "Defines valid properties in SelectClear component.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "BaseComponentProps<SelectClearInstance, unknown, SelectClearPassThrough>",
|
|
181
|
+
"props": [
|
|
182
|
+
{
|
|
183
|
+
"name": "ref",
|
|
184
|
+
"type": "Ref<unknown>",
|
|
185
|
+
"default": "",
|
|
186
|
+
"description": "The reference to the component instance."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "pIf",
|
|
190
|
+
"type": "boolean",
|
|
191
|
+
"default": "true",
|
|
192
|
+
"description": "Whether the component should be rendered."
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "style",
|
|
196
|
+
"type": "CSSProperties | ((instance?: SelectClearInstance) => CSSProperties)",
|
|
197
|
+
"default": "",
|
|
198
|
+
"description": "The style to apply to the component."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "className",
|
|
202
|
+
"type": "string | ((instance?: SelectClearInstance) => string)",
|
|
203
|
+
"default": "",
|
|
204
|
+
"description": "The class name to apply to the component."
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "as",
|
|
208
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
209
|
+
"default": "",
|
|
210
|
+
"description": "The component type to render."
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "asChild",
|
|
214
|
+
"type": "boolean",
|
|
215
|
+
"default": "false",
|
|
216
|
+
"description": "Whether the component should be rendered as a child component."
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "instance",
|
|
220
|
+
"type": "SelectClearInstance",
|
|
221
|
+
"default": "",
|
|
222
|
+
"description": "The instance to pass to the component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "pt",
|
|
226
|
+
"type": "SafeRecord<SelectClearPassThrough>",
|
|
227
|
+
"default": "",
|
|
228
|
+
"description": "The pass-through props to pass to the component."
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "ptOptions",
|
|
232
|
+
"type": "PassThroughOptions",
|
|
233
|
+
"default": "",
|
|
234
|
+
"description": "The pass-through options to pass to the component."
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "unstyled",
|
|
238
|
+
"type": "boolean",
|
|
239
|
+
"default": "",
|
|
240
|
+
"description": "Whether the component should be rendered without classes."
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"name": "dt",
|
|
244
|
+
"type": "unknown",
|
|
245
|
+
"default": "",
|
|
246
|
+
"description": "The design token to use for the component."
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "styles",
|
|
250
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
251
|
+
"default": "",
|
|
252
|
+
"description": "The styles to use for the component."
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "render",
|
|
256
|
+
"type": "(instance: SelectClearInstance) => ReactNode",
|
|
257
|
+
"default": "",
|
|
258
|
+
"description": "The render function to render the component with instance access."
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "children",
|
|
262
|
+
"type": "any",
|
|
263
|
+
"default": "",
|
|
264
|
+
"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."
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "[key: string]",
|
|
268
|
+
"type": "any",
|
|
269
|
+
"description": ""
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "pt-{optionName}-*",
|
|
273
|
+
"type": "-",
|
|
274
|
+
"default": "",
|
|
275
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
276
|
+
"deprecated": false
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"methods": []
|
|
280
|
+
},
|
|
281
|
+
"SelectClearState": {
|
|
282
|
+
"description": "Defines valid state in SelectClear component.",
|
|
283
|
+
"relatedProp": "",
|
|
284
|
+
"props": [],
|
|
285
|
+
"methods": []
|
|
286
|
+
},
|
|
287
|
+
"SelectClearExposes": {
|
|
288
|
+
"description": "Defines the methods and properties exposed by SelectClear component.",
|
|
289
|
+
"relatedProp": "",
|
|
290
|
+
"props": [
|
|
291
|
+
{
|
|
292
|
+
"name": "select",
|
|
293
|
+
"type": "SelectRootInstance",
|
|
294
|
+
"default": "",
|
|
295
|
+
"description": "The Select component instance."
|
|
296
|
+
}
|
|
297
|
+
],
|
|
298
|
+
"methods": []
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"types": {
|
|
302
|
+
"SelectClearPassThroughType": {
|
|
303
|
+
"description": "Defines passthrough(pt) options type in SelectClear component.",
|
|
304
|
+
"values": "PassThroughType<SelectClearInstance, E>"
|
|
305
|
+
},
|
|
306
|
+
"SelectClearInstance": {
|
|
307
|
+
"description": "Instance of SelectClear component.",
|
|
308
|
+
"values": "ComponentInstance<SelectClearProps, SelectClearState, SelectClearExposes>"
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"variables": {}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "SelectEmpty",
|
|
316
|
+
"source": "apps/showcase/assets/apidoc/selectempty.json",
|
|
317
|
+
"data": {
|
|
318
|
+
"description": "SelectEmpty is displayed when no options match in the Select component.",
|
|
319
|
+
"interfaces": {
|
|
320
|
+
"SelectEmptyPassThrough": {
|
|
321
|
+
"description": "Defines passthrough(pt) options of SelectEmpty component.",
|
|
322
|
+
"relatedProp": "",
|
|
323
|
+
"props": [
|
|
324
|
+
{
|
|
325
|
+
"name": "root",
|
|
326
|
+
"type": "SelectEmptyPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
327
|
+
"default": "",
|
|
328
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"methods": []
|
|
332
|
+
},
|
|
333
|
+
"SelectEmptyProps": {
|
|
334
|
+
"description": "Defines valid properties in SelectEmpty component.",
|
|
335
|
+
"relatedProp": "",
|
|
336
|
+
"extendedTypes": "BaseComponentProps<SelectEmptyInstance, unknown, SelectEmptyPassThrough>",
|
|
337
|
+
"props": [
|
|
338
|
+
{
|
|
339
|
+
"name": "ref",
|
|
340
|
+
"type": "Ref<unknown>",
|
|
341
|
+
"default": "",
|
|
342
|
+
"description": "The reference to the component instance."
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "pIf",
|
|
346
|
+
"type": "boolean",
|
|
347
|
+
"default": "true",
|
|
348
|
+
"description": "Whether the component should be rendered."
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "style",
|
|
352
|
+
"type": "CSSProperties | ((instance?: SelectEmptyInstance) => CSSProperties)",
|
|
353
|
+
"default": "",
|
|
354
|
+
"description": "The style to apply to the component."
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "className",
|
|
358
|
+
"type": "string | ((instance?: SelectEmptyInstance) => string)",
|
|
359
|
+
"default": "",
|
|
360
|
+
"description": "The class name to apply to the component."
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "as",
|
|
364
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
365
|
+
"default": "",
|
|
366
|
+
"description": "The component type to render."
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "asChild",
|
|
370
|
+
"type": "boolean",
|
|
371
|
+
"default": "false",
|
|
372
|
+
"description": "Whether the component should be rendered as a child component."
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "instance",
|
|
376
|
+
"type": "SelectEmptyInstance",
|
|
377
|
+
"default": "",
|
|
378
|
+
"description": "The instance to pass to the component."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "pt",
|
|
382
|
+
"type": "SafeRecord<SelectEmptyPassThrough>",
|
|
383
|
+
"default": "",
|
|
384
|
+
"description": "The pass-through props to pass to the component."
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "ptOptions",
|
|
388
|
+
"type": "PassThroughOptions",
|
|
389
|
+
"default": "",
|
|
390
|
+
"description": "The pass-through options to pass to the component."
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "unstyled",
|
|
394
|
+
"type": "boolean",
|
|
395
|
+
"default": "",
|
|
396
|
+
"description": "Whether the component should be rendered without classes."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "dt",
|
|
400
|
+
"type": "unknown",
|
|
401
|
+
"default": "",
|
|
402
|
+
"description": "The design token to use for the component."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "styles",
|
|
406
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
407
|
+
"default": "",
|
|
408
|
+
"description": "The styles to use for the component."
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"name": "render",
|
|
412
|
+
"type": "(instance: SelectEmptyInstance) => ReactNode",
|
|
413
|
+
"default": "",
|
|
414
|
+
"description": "The render function to render the component with instance access."
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "children",
|
|
418
|
+
"type": "any",
|
|
419
|
+
"default": "",
|
|
420
|
+
"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."
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "[key: string]",
|
|
424
|
+
"type": "any",
|
|
425
|
+
"description": ""
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "pt-{optionName}-*",
|
|
429
|
+
"type": "-",
|
|
430
|
+
"default": "",
|
|
431
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
432
|
+
"deprecated": false
|
|
433
|
+
}
|
|
434
|
+
],
|
|
435
|
+
"methods": []
|
|
436
|
+
},
|
|
437
|
+
"SelectEmptyState": {
|
|
438
|
+
"description": "Defines valid state in SelectEmpty component.",
|
|
439
|
+
"relatedProp": "",
|
|
440
|
+
"props": [],
|
|
441
|
+
"methods": []
|
|
442
|
+
},
|
|
443
|
+
"SelectEmptyExposes": {
|
|
444
|
+
"description": "Defines the methods and properties exposed by SelectEmpty component.",
|
|
445
|
+
"relatedProp": "",
|
|
446
|
+
"props": [
|
|
447
|
+
{
|
|
448
|
+
"name": "select",
|
|
449
|
+
"type": "SelectRootInstance",
|
|
450
|
+
"default": "",
|
|
451
|
+
"description": "The Select component instance."
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
"methods": []
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"types": {
|
|
458
|
+
"SelectEmptyPassThroughType": {
|
|
459
|
+
"description": "Defines passthrough(pt) options type in SelectEmpty component.",
|
|
460
|
+
"values": "PassThroughType<SelectEmptyInstance, E>"
|
|
461
|
+
},
|
|
462
|
+
"SelectEmptyInstance": {
|
|
463
|
+
"description": "Instance of SelectEmpty component.",
|
|
464
|
+
"values": "ComponentInstance<SelectEmptyProps, SelectEmptyState, SelectEmptyExposes>"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"variables": {}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "SelectFilter",
|
|
472
|
+
"source": "apps/showcase/assets/apidoc/selectfilter.json",
|
|
473
|
+
"data": {
|
|
474
|
+
"description": "SelectFilter is the filter input for the Select component.",
|
|
475
|
+
"interfaces": {
|
|
476
|
+
"SelectFilterPassThrough": {
|
|
477
|
+
"description": "Defines passthrough(pt) options of SelectFilter component.",
|
|
478
|
+
"relatedProp": "",
|
|
479
|
+
"props": [
|
|
480
|
+
{
|
|
481
|
+
"name": "root",
|
|
482
|
+
"type": "SelectFilterPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
483
|
+
"default": "",
|
|
484
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"name": "input",
|
|
488
|
+
"type": "SelectFilterPassThroughType<HTMLAttributes<HTMLInputElement>>",
|
|
489
|
+
"default": "",
|
|
490
|
+
"description": "Used to pass attributes to the input's DOM element."
|
|
491
|
+
}
|
|
492
|
+
],
|
|
493
|
+
"methods": []
|
|
494
|
+
},
|
|
495
|
+
"SelectFilterProps": {
|
|
496
|
+
"description": "Defines valid properties in SelectFilter component.",
|
|
497
|
+
"relatedProp": "",
|
|
498
|
+
"extendedTypes": "BaseComponentProps<SelectFilterInstance, unknown, SelectFilterPassThrough>",
|
|
499
|
+
"props": [
|
|
500
|
+
{
|
|
501
|
+
"name": "ref",
|
|
502
|
+
"type": "Ref<unknown>",
|
|
503
|
+
"default": "",
|
|
504
|
+
"description": "The reference to the component instance."
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "pIf",
|
|
508
|
+
"type": "boolean",
|
|
509
|
+
"default": "true",
|
|
510
|
+
"description": "Whether the component should be rendered."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "style",
|
|
514
|
+
"type": "CSSProperties | ((instance?: SelectFilterInstance) => CSSProperties)",
|
|
515
|
+
"default": "",
|
|
516
|
+
"description": "The style to apply to the component."
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "className",
|
|
520
|
+
"type": "string | ((instance?: SelectFilterInstance) => string)",
|
|
521
|
+
"default": "",
|
|
522
|
+
"description": "The class name to apply to the component."
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"name": "as",
|
|
526
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
527
|
+
"default": "",
|
|
528
|
+
"description": "The component type to render."
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "asChild",
|
|
532
|
+
"type": "boolean",
|
|
533
|
+
"default": "false",
|
|
534
|
+
"description": "Whether the component should be rendered as a child component."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "instance",
|
|
538
|
+
"type": "SelectFilterInstance",
|
|
539
|
+
"default": "",
|
|
540
|
+
"description": "The instance to pass to the component."
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"name": "pt",
|
|
544
|
+
"type": "SafeRecord<SelectFilterPassThrough>",
|
|
545
|
+
"default": "",
|
|
546
|
+
"description": "The pass-through props to pass to the component."
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "ptOptions",
|
|
550
|
+
"type": "PassThroughOptions",
|
|
551
|
+
"default": "",
|
|
552
|
+
"description": "The pass-through options to pass to the component."
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "unstyled",
|
|
556
|
+
"type": "boolean",
|
|
557
|
+
"default": "",
|
|
558
|
+
"description": "Whether the component should be rendered without classes."
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"name": "dt",
|
|
562
|
+
"type": "unknown",
|
|
563
|
+
"default": "",
|
|
564
|
+
"description": "The design token to use for the component."
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"name": "styles",
|
|
568
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
569
|
+
"default": "",
|
|
570
|
+
"description": "The styles to use for the component."
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "render",
|
|
574
|
+
"type": "(instance: SelectFilterInstance) => ReactNode",
|
|
575
|
+
"default": "",
|
|
576
|
+
"description": "The render function to render the component with instance access."
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"name": "children",
|
|
580
|
+
"type": "any",
|
|
581
|
+
"default": "",
|
|
582
|
+
"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."
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "placeholder",
|
|
586
|
+
"type": "string",
|
|
587
|
+
"default": "",
|
|
588
|
+
"description": "Placeholder text for the filter input."
|
|
589
|
+
},
|
|
590
|
+
{
|
|
591
|
+
"name": "[key: string]",
|
|
592
|
+
"type": "any",
|
|
593
|
+
"description": ""
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "pt-{optionName}-*",
|
|
597
|
+
"type": "-",
|
|
598
|
+
"default": "",
|
|
599
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
600
|
+
"deprecated": false
|
|
601
|
+
}
|
|
602
|
+
],
|
|
603
|
+
"methods": []
|
|
604
|
+
},
|
|
605
|
+
"SelectFilterState": {
|
|
606
|
+
"description": "Defines valid state in SelectFilter component.",
|
|
607
|
+
"relatedProp": "",
|
|
608
|
+
"props": [],
|
|
609
|
+
"methods": []
|
|
610
|
+
},
|
|
611
|
+
"SelectFilterExposes": {
|
|
612
|
+
"description": "Defines the methods and properties exposed by SelectFilter component.",
|
|
613
|
+
"relatedProp": "",
|
|
614
|
+
"props": [
|
|
615
|
+
{
|
|
616
|
+
"name": "select",
|
|
617
|
+
"type": "SelectRootInstance",
|
|
618
|
+
"default": "",
|
|
619
|
+
"description": "The Select component instance."
|
|
620
|
+
}
|
|
621
|
+
],
|
|
622
|
+
"methods": []
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
"types": {
|
|
626
|
+
"SelectFilterPassThroughType": {
|
|
627
|
+
"description": "Defines passthrough(pt) options type in SelectFilter component.",
|
|
628
|
+
"values": "PassThroughType<SelectFilterInstance, E>"
|
|
629
|
+
},
|
|
630
|
+
"SelectFilterInstance": {
|
|
631
|
+
"description": "Instance of SelectFilter component.",
|
|
632
|
+
"values": "ComponentInstance<SelectFilterProps, SelectFilterState, SelectFilterExposes>"
|
|
633
|
+
}
|
|
634
|
+
},
|
|
635
|
+
"variables": {}
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "SelectFooter",
|
|
640
|
+
"source": "apps/showcase/assets/apidoc/selectfooter.json",
|
|
641
|
+
"data": {
|
|
642
|
+
"description": "SelectFooter is the footer container for the Select footer.",
|
|
643
|
+
"interfaces": {
|
|
644
|
+
"SelectFooterPassThrough": {
|
|
645
|
+
"description": "Defines passthrough(pt) options of SelectFooter component.",
|
|
646
|
+
"relatedProp": "",
|
|
647
|
+
"props": [
|
|
648
|
+
{
|
|
649
|
+
"name": "root",
|
|
650
|
+
"type": "SelectFooterPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
651
|
+
"default": "",
|
|
652
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
653
|
+
}
|
|
654
|
+
],
|
|
655
|
+
"methods": []
|
|
656
|
+
},
|
|
657
|
+
"SelectFooterProps": {
|
|
658
|
+
"description": "Defines valid properties in SelectFooter component.",
|
|
659
|
+
"relatedProp": "",
|
|
660
|
+
"extendedTypes": "BaseComponentProps<SelectFooterInstance, unknown, SelectFooterPassThrough>",
|
|
661
|
+
"props": [
|
|
662
|
+
{
|
|
663
|
+
"name": "ref",
|
|
664
|
+
"type": "Ref<unknown>",
|
|
665
|
+
"default": "",
|
|
666
|
+
"description": "The reference to the component instance."
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "pIf",
|
|
670
|
+
"type": "boolean",
|
|
671
|
+
"default": "true",
|
|
672
|
+
"description": "Whether the component should be rendered."
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"name": "style",
|
|
676
|
+
"type": "CSSProperties | ((instance?: SelectFooterInstance) => CSSProperties)",
|
|
677
|
+
"default": "",
|
|
678
|
+
"description": "The style to apply to the component."
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "className",
|
|
682
|
+
"type": "string | ((instance?: SelectFooterInstance) => string)",
|
|
683
|
+
"default": "",
|
|
684
|
+
"description": "The class name to apply to the component."
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "as",
|
|
688
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
689
|
+
"default": "",
|
|
690
|
+
"description": "The component type to render."
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"name": "asChild",
|
|
694
|
+
"type": "boolean",
|
|
695
|
+
"default": "false",
|
|
696
|
+
"description": "Whether the component should be rendered as a child component."
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "instance",
|
|
700
|
+
"type": "SelectFooterInstance",
|
|
701
|
+
"default": "",
|
|
702
|
+
"description": "The instance to pass to the component."
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "pt",
|
|
706
|
+
"type": "SafeRecord<SelectFooterPassThrough>",
|
|
707
|
+
"default": "",
|
|
708
|
+
"description": "The pass-through props to pass to the component."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "ptOptions",
|
|
712
|
+
"type": "PassThroughOptions",
|
|
713
|
+
"default": "",
|
|
714
|
+
"description": "The pass-through options to pass to the component."
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
"name": "unstyled",
|
|
718
|
+
"type": "boolean",
|
|
719
|
+
"default": "",
|
|
720
|
+
"description": "Whether the component should be rendered without classes."
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "dt",
|
|
724
|
+
"type": "unknown",
|
|
725
|
+
"default": "",
|
|
726
|
+
"description": "The design token to use for the component."
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"name": "styles",
|
|
730
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
731
|
+
"default": "",
|
|
732
|
+
"description": "The styles to use for the component."
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "render",
|
|
736
|
+
"type": "(instance: SelectFooterInstance) => ReactNode",
|
|
737
|
+
"default": "",
|
|
738
|
+
"description": "The render function to render the component with instance access."
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"name": "children",
|
|
742
|
+
"type": "any",
|
|
743
|
+
"default": "",
|
|
744
|
+
"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."
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
"name": "[key: string]",
|
|
748
|
+
"type": "any",
|
|
749
|
+
"description": ""
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"name": "pt-{optionName}-*",
|
|
753
|
+
"type": "-",
|
|
754
|
+
"default": "",
|
|
755
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
756
|
+
"deprecated": false
|
|
757
|
+
}
|
|
758
|
+
],
|
|
759
|
+
"methods": []
|
|
760
|
+
},
|
|
761
|
+
"SelectFooterState": {
|
|
762
|
+
"description": "Defines valid state in SelectFooter component.",
|
|
763
|
+
"relatedProp": "",
|
|
764
|
+
"props": [],
|
|
765
|
+
"methods": []
|
|
766
|
+
},
|
|
767
|
+
"SelectFooterExposes": {
|
|
768
|
+
"description": "Defines the methods and properties exposed by SelectFooter component.",
|
|
769
|
+
"relatedProp": "",
|
|
770
|
+
"props": [
|
|
771
|
+
{
|
|
772
|
+
"name": "select",
|
|
773
|
+
"type": "SelectRootInstance",
|
|
774
|
+
"default": "",
|
|
775
|
+
"description": "The Select component instance."
|
|
776
|
+
}
|
|
777
|
+
],
|
|
778
|
+
"methods": []
|
|
779
|
+
}
|
|
780
|
+
},
|
|
781
|
+
"types": {
|
|
782
|
+
"SelectFooterPassThroughType": {
|
|
783
|
+
"description": "Defines passthrough(pt) options type in SelectFooter component.",
|
|
784
|
+
"values": "PassThroughType<SelectFooterInstance, E>"
|
|
785
|
+
},
|
|
786
|
+
"SelectFooterInstance": {
|
|
787
|
+
"description": "Instance of SelectFooter component.",
|
|
788
|
+
"values": "ComponentInstance<SelectFooterProps, SelectFooterState, SelectFooterExposes>"
|
|
789
|
+
}
|
|
790
|
+
},
|
|
791
|
+
"variables": {}
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "SelectHeader",
|
|
796
|
+
"source": "apps/showcase/assets/apidoc/selectheader.json",
|
|
797
|
+
"data": {
|
|
798
|
+
"description": "SelectHeader is the header container for the Select header.",
|
|
799
|
+
"interfaces": {
|
|
800
|
+
"SelectHeaderPassThrough": {
|
|
801
|
+
"description": "Defines passthrough(pt) options of SelectHeader component.",
|
|
802
|
+
"relatedProp": "",
|
|
803
|
+
"props": [
|
|
804
|
+
{
|
|
805
|
+
"name": "root",
|
|
806
|
+
"type": "SelectHeaderPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
807
|
+
"default": "",
|
|
808
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
809
|
+
}
|
|
810
|
+
],
|
|
811
|
+
"methods": []
|
|
812
|
+
},
|
|
813
|
+
"SelectHeaderProps": {
|
|
814
|
+
"description": "Defines valid properties in SelectHeader component.",
|
|
815
|
+
"relatedProp": "",
|
|
816
|
+
"extendedTypes": "BaseComponentProps<SelectHeaderInstance, unknown, SelectHeaderPassThrough>",
|
|
817
|
+
"props": [
|
|
818
|
+
{
|
|
819
|
+
"name": "ref",
|
|
820
|
+
"type": "Ref<unknown>",
|
|
821
|
+
"default": "",
|
|
822
|
+
"description": "The reference to the component instance."
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"name": "pIf",
|
|
826
|
+
"type": "boolean",
|
|
827
|
+
"default": "true",
|
|
828
|
+
"description": "Whether the component should be rendered."
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "style",
|
|
832
|
+
"type": "CSSProperties | ((instance?: SelectHeaderInstance) => CSSProperties)",
|
|
833
|
+
"default": "",
|
|
834
|
+
"description": "The style to apply to the component."
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "className",
|
|
838
|
+
"type": "string | ((instance?: SelectHeaderInstance) => string)",
|
|
839
|
+
"default": "",
|
|
840
|
+
"description": "The class name to apply to the component."
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "as",
|
|
844
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
845
|
+
"default": "",
|
|
846
|
+
"description": "The component type to render."
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "asChild",
|
|
850
|
+
"type": "boolean",
|
|
851
|
+
"default": "false",
|
|
852
|
+
"description": "Whether the component should be rendered as a child component."
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"name": "instance",
|
|
856
|
+
"type": "SelectHeaderInstance",
|
|
857
|
+
"default": "",
|
|
858
|
+
"description": "The instance to pass to the component."
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "pt",
|
|
862
|
+
"type": "SafeRecord<SelectHeaderPassThrough>",
|
|
863
|
+
"default": "",
|
|
864
|
+
"description": "The pass-through props to pass to the component."
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "ptOptions",
|
|
868
|
+
"type": "PassThroughOptions",
|
|
869
|
+
"default": "",
|
|
870
|
+
"description": "The pass-through options to pass to the component."
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "unstyled",
|
|
874
|
+
"type": "boolean",
|
|
875
|
+
"default": "",
|
|
876
|
+
"description": "Whether the component should be rendered without classes."
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "dt",
|
|
880
|
+
"type": "unknown",
|
|
881
|
+
"default": "",
|
|
882
|
+
"description": "The design token to use for the component."
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "styles",
|
|
886
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
887
|
+
"default": "",
|
|
888
|
+
"description": "The styles to use for the component."
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"name": "render",
|
|
892
|
+
"type": "(instance: SelectHeaderInstance) => ReactNode",
|
|
893
|
+
"default": "",
|
|
894
|
+
"description": "The render function to render the component with instance access."
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
"name": "children",
|
|
898
|
+
"type": "any",
|
|
899
|
+
"default": "",
|
|
900
|
+
"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."
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"name": "[key: string]",
|
|
904
|
+
"type": "any",
|
|
905
|
+
"description": ""
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"name": "pt-{optionName}-*",
|
|
909
|
+
"type": "-",
|
|
910
|
+
"default": "",
|
|
911
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
912
|
+
"deprecated": false
|
|
913
|
+
}
|
|
914
|
+
],
|
|
915
|
+
"methods": []
|
|
916
|
+
},
|
|
917
|
+
"SelectHeaderState": {
|
|
918
|
+
"description": "Defines valid state in SelectHeader component.",
|
|
919
|
+
"relatedProp": "",
|
|
920
|
+
"props": [],
|
|
921
|
+
"methods": []
|
|
922
|
+
},
|
|
923
|
+
"SelectHeaderExposes": {
|
|
924
|
+
"description": "Defines the methods and properties exposed by SelectHeader component.",
|
|
925
|
+
"relatedProp": "",
|
|
926
|
+
"props": [
|
|
927
|
+
{
|
|
928
|
+
"name": "select",
|
|
929
|
+
"type": "SelectRootInstance",
|
|
930
|
+
"default": "",
|
|
931
|
+
"description": "The Select component instance."
|
|
932
|
+
}
|
|
933
|
+
],
|
|
934
|
+
"methods": []
|
|
935
|
+
}
|
|
936
|
+
},
|
|
937
|
+
"types": {
|
|
938
|
+
"SelectHeaderPassThroughType": {
|
|
939
|
+
"description": "Defines passthrough(pt) options type in SelectHeader component.",
|
|
940
|
+
"values": "PassThroughType<SelectHeaderInstance, E>"
|
|
941
|
+
},
|
|
942
|
+
"SelectHeaderInstance": {
|
|
943
|
+
"description": "Instance of SelectHeader component.",
|
|
944
|
+
"values": "ComponentInstance<SelectHeaderProps, SelectHeaderState, SelectHeaderExposes>"
|
|
945
|
+
}
|
|
946
|
+
},
|
|
947
|
+
"variables": {}
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "SelectIndicator",
|
|
952
|
+
"source": "apps/showcase/assets/apidoc/selectindicator.json",
|
|
953
|
+
"data": {
|
|
954
|
+
"description": "SelectIndicator is the dropdown indicator element for the Select component.",
|
|
955
|
+
"interfaces": {
|
|
956
|
+
"SelectIndicatorPassThrough": {
|
|
957
|
+
"description": "Defines passthrough(pt) options of SelectIndicator component.",
|
|
958
|
+
"relatedProp": "",
|
|
959
|
+
"props": [
|
|
960
|
+
{
|
|
961
|
+
"name": "root",
|
|
962
|
+
"type": "SelectIndicatorPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
963
|
+
"default": "",
|
|
964
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
965
|
+
}
|
|
966
|
+
],
|
|
967
|
+
"methods": []
|
|
968
|
+
},
|
|
969
|
+
"SelectIndicatorProps": {
|
|
970
|
+
"description": "Defines valid properties in SelectIndicator component.",
|
|
971
|
+
"relatedProp": "",
|
|
972
|
+
"extendedTypes": "BaseComponentProps<SelectIndicatorInstance, unknown, SelectIndicatorPassThrough>",
|
|
973
|
+
"props": [
|
|
974
|
+
{
|
|
975
|
+
"name": "ref",
|
|
976
|
+
"type": "Ref<unknown>",
|
|
977
|
+
"default": "",
|
|
978
|
+
"description": "The reference to the component instance."
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "pIf",
|
|
982
|
+
"type": "boolean",
|
|
983
|
+
"default": "true",
|
|
984
|
+
"description": "Whether the component should be rendered."
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "style",
|
|
988
|
+
"type": "CSSProperties | ((instance?: SelectIndicatorInstance) => CSSProperties)",
|
|
989
|
+
"default": "",
|
|
990
|
+
"description": "The style to apply to the component."
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "className",
|
|
994
|
+
"type": "string | ((instance?: SelectIndicatorInstance) => string)",
|
|
995
|
+
"default": "",
|
|
996
|
+
"description": "The class name to apply to the component."
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "as",
|
|
1000
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1001
|
+
"default": "",
|
|
1002
|
+
"description": "The component type to render."
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "asChild",
|
|
1006
|
+
"type": "boolean",
|
|
1007
|
+
"default": "false",
|
|
1008
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "instance",
|
|
1012
|
+
"type": "SelectIndicatorInstance",
|
|
1013
|
+
"default": "",
|
|
1014
|
+
"description": "The instance to pass to the component."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "pt",
|
|
1018
|
+
"type": "SafeRecord<SelectIndicatorPassThrough>",
|
|
1019
|
+
"default": "",
|
|
1020
|
+
"description": "The pass-through props to pass to the component."
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "ptOptions",
|
|
1024
|
+
"type": "PassThroughOptions",
|
|
1025
|
+
"default": "",
|
|
1026
|
+
"description": "The pass-through options to pass to the component."
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "unstyled",
|
|
1030
|
+
"type": "boolean",
|
|
1031
|
+
"default": "",
|
|
1032
|
+
"description": "Whether the component should be rendered without classes."
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "dt",
|
|
1036
|
+
"type": "unknown",
|
|
1037
|
+
"default": "",
|
|
1038
|
+
"description": "The design token to use for the component."
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "styles",
|
|
1042
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1043
|
+
"default": "",
|
|
1044
|
+
"description": "The styles to use for the component."
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "render",
|
|
1048
|
+
"type": "(instance: SelectIndicatorInstance) => ReactNode",
|
|
1049
|
+
"default": "",
|
|
1050
|
+
"description": "The render function to render the component with instance access."
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "children",
|
|
1054
|
+
"type": "any",
|
|
1055
|
+
"default": "",
|
|
1056
|
+
"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."
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "match",
|
|
1060
|
+
"type": "\"always\" | \"open\" | \"closed\"",
|
|
1061
|
+
"default": "",
|
|
1062
|
+
"description": "Determines the visibility of the indicator based on the state of the select.\n- \"open\": Indicator is visible when the dropdown is open.\n- \"closed\": Indicator is visible when the dropdown is closed.\n- \"always\": Indicator is always visible."
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "[key: string]",
|
|
1066
|
+
"type": "any",
|
|
1067
|
+
"description": ""
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"name": "pt-{optionName}-*",
|
|
1071
|
+
"type": "-",
|
|
1072
|
+
"default": "",
|
|
1073
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1074
|
+
"deprecated": false
|
|
1075
|
+
}
|
|
1076
|
+
],
|
|
1077
|
+
"methods": []
|
|
1078
|
+
},
|
|
1079
|
+
"SelectIndicatorState": {
|
|
1080
|
+
"description": "Defines valid state in SelectIndicator component.",
|
|
1081
|
+
"relatedProp": "",
|
|
1082
|
+
"props": [],
|
|
1083
|
+
"methods": []
|
|
1084
|
+
},
|
|
1085
|
+
"SelectIndicatorExposes": {
|
|
1086
|
+
"description": "Defines the methods and properties exposed by SelectIndicator component.",
|
|
1087
|
+
"relatedProp": "",
|
|
1088
|
+
"props": [
|
|
1089
|
+
{
|
|
1090
|
+
"name": "select",
|
|
1091
|
+
"type": "SelectRootInstance",
|
|
1092
|
+
"default": "",
|
|
1093
|
+
"description": "The Select component instance."
|
|
1094
|
+
}
|
|
1095
|
+
],
|
|
1096
|
+
"methods": []
|
|
1097
|
+
}
|
|
1098
|
+
},
|
|
1099
|
+
"types": {
|
|
1100
|
+
"SelectIndicatorPassThroughType": {
|
|
1101
|
+
"description": "Defines passthrough(pt) options type in SelectIndicator component.",
|
|
1102
|
+
"values": "PassThroughType<SelectIndicatorInstance, E>"
|
|
1103
|
+
},
|
|
1104
|
+
"SelectIndicatorInstance": {
|
|
1105
|
+
"description": "Instance of SelectIndicator component.",
|
|
1106
|
+
"values": "ComponentInstance<SelectIndicatorProps, SelectIndicatorState, SelectIndicatorExposes>"
|
|
1107
|
+
}
|
|
1108
|
+
},
|
|
1109
|
+
"variables": {}
|
|
1110
|
+
}
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "SelectList",
|
|
1114
|
+
"source": "apps/showcase/assets/apidoc/selectlist.json",
|
|
1115
|
+
"data": {
|
|
1116
|
+
"description": "SelectList is the list container for the Select component options.",
|
|
1117
|
+
"interfaces": {
|
|
1118
|
+
"SelectListPassThrough": {
|
|
1119
|
+
"description": "Defines passthrough(pt) options of SelectList component.",
|
|
1120
|
+
"relatedProp": "",
|
|
1121
|
+
"props": [
|
|
1122
|
+
{
|
|
1123
|
+
"name": "root",
|
|
1124
|
+
"type": "SelectListPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1125
|
+
"default": "",
|
|
1126
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1127
|
+
}
|
|
1128
|
+
],
|
|
1129
|
+
"methods": []
|
|
1130
|
+
},
|
|
1131
|
+
"SelectListProps": {
|
|
1132
|
+
"description": "Defines valid properties in SelectList component.",
|
|
1133
|
+
"relatedProp": "",
|
|
1134
|
+
"extendedTypes": "BaseComponentProps<SelectListInstance, unknown, SelectListPassThrough>",
|
|
1135
|
+
"props": [
|
|
1136
|
+
{
|
|
1137
|
+
"name": "ref",
|
|
1138
|
+
"type": "Ref<unknown>",
|
|
1139
|
+
"default": "",
|
|
1140
|
+
"description": "The reference to the component instance."
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"name": "pIf",
|
|
1144
|
+
"type": "boolean",
|
|
1145
|
+
"default": "true",
|
|
1146
|
+
"description": "Whether the component should be rendered."
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "style",
|
|
1150
|
+
"type": "CSSProperties | ((instance?: SelectListInstance) => CSSProperties)",
|
|
1151
|
+
"default": "",
|
|
1152
|
+
"description": "The style to apply to the component."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "className",
|
|
1156
|
+
"type": "string | ((instance?: SelectListInstance) => string)",
|
|
1157
|
+
"default": "",
|
|
1158
|
+
"description": "The class name to apply to the component."
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "as",
|
|
1162
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1163
|
+
"default": "",
|
|
1164
|
+
"description": "The component type to render."
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "asChild",
|
|
1168
|
+
"type": "boolean",
|
|
1169
|
+
"default": "false",
|
|
1170
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"name": "instance",
|
|
1174
|
+
"type": "SelectListInstance",
|
|
1175
|
+
"default": "",
|
|
1176
|
+
"description": "The instance to pass to the component."
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"name": "pt",
|
|
1180
|
+
"type": "SafeRecord<SelectListPassThrough>",
|
|
1181
|
+
"default": "",
|
|
1182
|
+
"description": "The pass-through props to pass to the component."
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
"name": "ptOptions",
|
|
1186
|
+
"type": "PassThroughOptions",
|
|
1187
|
+
"default": "",
|
|
1188
|
+
"description": "The pass-through options to pass to the component."
|
|
1189
|
+
},
|
|
1190
|
+
{
|
|
1191
|
+
"name": "unstyled",
|
|
1192
|
+
"type": "boolean",
|
|
1193
|
+
"default": "",
|
|
1194
|
+
"description": "Whether the component should be rendered without classes."
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"name": "dt",
|
|
1198
|
+
"type": "unknown",
|
|
1199
|
+
"default": "",
|
|
1200
|
+
"description": "The design token to use for the component."
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "styles",
|
|
1204
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1205
|
+
"default": "",
|
|
1206
|
+
"description": "The styles to use for the component."
|
|
1207
|
+
},
|
|
1208
|
+
{
|
|
1209
|
+
"name": "render",
|
|
1210
|
+
"type": "(instance: SelectListInstance) => ReactNode",
|
|
1211
|
+
"default": "",
|
|
1212
|
+
"description": "The render function to render the component with instance access."
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "children",
|
|
1216
|
+
"type": "any",
|
|
1217
|
+
"default": "",
|
|
1218
|
+
"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."
|
|
1219
|
+
},
|
|
1220
|
+
{
|
|
1221
|
+
"name": "[key: string]",
|
|
1222
|
+
"type": "any",
|
|
1223
|
+
"description": ""
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
"name": "pt-{optionName}-*",
|
|
1227
|
+
"type": "-",
|
|
1228
|
+
"default": "",
|
|
1229
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1230
|
+
"deprecated": false
|
|
1231
|
+
}
|
|
1232
|
+
],
|
|
1233
|
+
"methods": []
|
|
1234
|
+
},
|
|
1235
|
+
"SelectListState": {
|
|
1236
|
+
"description": "Defines valid state in SelectList component.",
|
|
1237
|
+
"relatedProp": "",
|
|
1238
|
+
"props": [],
|
|
1239
|
+
"methods": []
|
|
1240
|
+
},
|
|
1241
|
+
"SelectListExposes": {
|
|
1242
|
+
"description": "Defines the methods and properties exposed by SelectList component.",
|
|
1243
|
+
"relatedProp": "",
|
|
1244
|
+
"props": [
|
|
1245
|
+
{
|
|
1246
|
+
"name": "select",
|
|
1247
|
+
"type": "SelectRootInstance",
|
|
1248
|
+
"default": "",
|
|
1249
|
+
"description": "The Select component instance."
|
|
1250
|
+
}
|
|
1251
|
+
],
|
|
1252
|
+
"methods": []
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
"types": {
|
|
1256
|
+
"SelectListPassThroughType": {
|
|
1257
|
+
"description": "Defines passthrough(pt) options type in SelectList component.",
|
|
1258
|
+
"values": "PassThroughType<SelectListInstance, E>"
|
|
1259
|
+
},
|
|
1260
|
+
"SelectListInstance": {
|
|
1261
|
+
"description": "Instance of SelectList component.",
|
|
1262
|
+
"values": "ComponentInstance<SelectListProps, SelectListState, SelectListExposes>"
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
"variables": {}
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
{
|
|
1269
|
+
"name": "SelectOption",
|
|
1270
|
+
"source": "apps/showcase/assets/apidoc/selectoption.json",
|
|
1271
|
+
"data": {
|
|
1272
|
+
"description": "SelectOption is an individual option item in the Select component.",
|
|
1273
|
+
"interfaces": {
|
|
1274
|
+
"SelectOptionPassThrough": {
|
|
1275
|
+
"description": "Defines passthrough(pt) options of SelectOption component.",
|
|
1276
|
+
"relatedProp": "",
|
|
1277
|
+
"props": [
|
|
1278
|
+
{
|
|
1279
|
+
"name": "root",
|
|
1280
|
+
"type": "SelectOptionPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
1281
|
+
"default": "",
|
|
1282
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1283
|
+
}
|
|
1284
|
+
],
|
|
1285
|
+
"methods": []
|
|
1286
|
+
},
|
|
1287
|
+
"SelectOptionProps": {
|
|
1288
|
+
"description": "Defines valid properties in SelectOption component.",
|
|
1289
|
+
"relatedProp": "",
|
|
1290
|
+
"extendedTypes": "BaseComponentProps<SelectOptionInstance, unknown, SelectOptionPassThrough>",
|
|
1291
|
+
"props": [
|
|
1292
|
+
{
|
|
1293
|
+
"name": "ref",
|
|
1294
|
+
"type": "Ref<unknown>",
|
|
1295
|
+
"default": "",
|
|
1296
|
+
"description": "The reference to the component instance."
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "pIf",
|
|
1300
|
+
"type": "boolean",
|
|
1301
|
+
"default": "true",
|
|
1302
|
+
"description": "Whether the component should be rendered."
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
"name": "style",
|
|
1306
|
+
"type": "CSSProperties | ((instance?: SelectOptionInstance) => CSSProperties)",
|
|
1307
|
+
"default": "",
|
|
1308
|
+
"description": "The style to apply to the component."
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"name": "className",
|
|
1312
|
+
"type": "string | ((instance?: SelectOptionInstance) => string)",
|
|
1313
|
+
"default": "",
|
|
1314
|
+
"description": "The class name to apply to the component."
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "as",
|
|
1318
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1319
|
+
"default": "",
|
|
1320
|
+
"description": "The component type to render."
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
"name": "asChild",
|
|
1324
|
+
"type": "boolean",
|
|
1325
|
+
"default": "false",
|
|
1326
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "instance",
|
|
1330
|
+
"type": "SelectOptionInstance",
|
|
1331
|
+
"default": "",
|
|
1332
|
+
"description": "The instance to pass to the component."
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "pt",
|
|
1336
|
+
"type": "SafeRecord<SelectOptionPassThrough>",
|
|
1337
|
+
"default": "",
|
|
1338
|
+
"description": "The pass-through props to pass to the component."
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"name": "ptOptions",
|
|
1342
|
+
"type": "PassThroughOptions",
|
|
1343
|
+
"default": "",
|
|
1344
|
+
"description": "The pass-through options to pass to the component."
|
|
1345
|
+
},
|
|
1346
|
+
{
|
|
1347
|
+
"name": "unstyled",
|
|
1348
|
+
"type": "boolean",
|
|
1349
|
+
"default": "",
|
|
1350
|
+
"description": "Whether the component should be rendered without classes."
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "dt",
|
|
1354
|
+
"type": "unknown",
|
|
1355
|
+
"default": "",
|
|
1356
|
+
"description": "The design token to use for the component."
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "styles",
|
|
1360
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1361
|
+
"default": "",
|
|
1362
|
+
"description": "The styles to use for the component."
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
"name": "render",
|
|
1366
|
+
"type": "(instance: SelectOptionInstance) => ReactNode",
|
|
1367
|
+
"default": "",
|
|
1368
|
+
"description": "The render function to render the component with instance access."
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"name": "children",
|
|
1372
|
+
"type": "any",
|
|
1373
|
+
"default": "",
|
|
1374
|
+
"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."
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "option",
|
|
1378
|
+
"type": "unknown",
|
|
1379
|
+
"default": "",
|
|
1380
|
+
"description": "The option data object."
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "index",
|
|
1384
|
+
"type": "number",
|
|
1385
|
+
"default": "",
|
|
1386
|
+
"description": "The index of the option in the list."
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"name": "selected",
|
|
1390
|
+
"type": "boolean",
|
|
1391
|
+
"default": "",
|
|
1392
|
+
"description": "Whether the option is selected."
|
|
1393
|
+
},
|
|
1394
|
+
{
|
|
1395
|
+
"name": "focused",
|
|
1396
|
+
"type": "boolean",
|
|
1397
|
+
"default": "",
|
|
1398
|
+
"description": "Whether the option is focused."
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"name": "disabled",
|
|
1402
|
+
"type": "boolean",
|
|
1403
|
+
"default": "",
|
|
1404
|
+
"description": "Whether the option is disabled."
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
"name": "[key: string]",
|
|
1408
|
+
"type": "any",
|
|
1409
|
+
"description": ""
|
|
1410
|
+
},
|
|
1411
|
+
{
|
|
1412
|
+
"name": "pt-{optionName}-*",
|
|
1413
|
+
"type": "-",
|
|
1414
|
+
"default": "",
|
|
1415
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1416
|
+
"deprecated": false
|
|
1417
|
+
}
|
|
1418
|
+
],
|
|
1419
|
+
"methods": []
|
|
1420
|
+
},
|
|
1421
|
+
"SelectOptionState": {
|
|
1422
|
+
"description": "Defines valid state in SelectOption component.",
|
|
1423
|
+
"relatedProp": "",
|
|
1424
|
+
"props": [],
|
|
1425
|
+
"methods": []
|
|
1426
|
+
},
|
|
1427
|
+
"SelectOptionExposes": {
|
|
1428
|
+
"description": "Defines the methods and properties exposed by SelectOption component.",
|
|
1429
|
+
"relatedProp": "",
|
|
1430
|
+
"props": [
|
|
1431
|
+
{
|
|
1432
|
+
"name": "select",
|
|
1433
|
+
"type": "SelectRootInstance",
|
|
1434
|
+
"default": "",
|
|
1435
|
+
"description": "The Select component instance."
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"name": "listbox",
|
|
1439
|
+
"type": "UseListboxInstance",
|
|
1440
|
+
"default": "",
|
|
1441
|
+
"description": "The Listbox component instance."
|
|
1442
|
+
},
|
|
1443
|
+
{
|
|
1444
|
+
"name": "listboxOption",
|
|
1445
|
+
"type": "UseListboxOptionInstance",
|
|
1446
|
+
"default": "",
|
|
1447
|
+
"description": "The useListboxOption hook instance."
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"name": "option",
|
|
1451
|
+
"type": "unknown",
|
|
1452
|
+
"default": "",
|
|
1453
|
+
"description": "The option data object."
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "index",
|
|
1457
|
+
"type": "number",
|
|
1458
|
+
"default": "",
|
|
1459
|
+
"description": "The index of the option."
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "group",
|
|
1463
|
+
"type": "boolean",
|
|
1464
|
+
"default": "",
|
|
1465
|
+
"description": "Whether this is a group header option."
|
|
1466
|
+
},
|
|
1467
|
+
{
|
|
1468
|
+
"name": "selected",
|
|
1469
|
+
"type": "boolean",
|
|
1470
|
+
"default": "",
|
|
1471
|
+
"description": "Whether the option is selected."
|
|
1472
|
+
}
|
|
1473
|
+
],
|
|
1474
|
+
"methods": []
|
|
1475
|
+
}
|
|
1476
|
+
},
|
|
1477
|
+
"types": {
|
|
1478
|
+
"SelectOptionPassThroughType": {
|
|
1479
|
+
"description": "Defines passthrough(pt) options type in SelectOption component.",
|
|
1480
|
+
"values": "PassThroughType<SelectOptionInstance, E>"
|
|
1481
|
+
},
|
|
1482
|
+
"SelectOptionInstance": {
|
|
1483
|
+
"description": "Instance of SelectOption component.",
|
|
1484
|
+
"values": "ComponentInstance<SelectOptionProps, SelectOptionState, SelectOptionExposes>"
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
"variables": {}
|
|
1488
|
+
}
|
|
1489
|
+
},
|
|
1490
|
+
{
|
|
1491
|
+
"name": "SelectOptionIndicator",
|
|
1492
|
+
"source": "apps/showcase/assets/apidoc/selectoptionindicator.json",
|
|
1493
|
+
"data": {
|
|
1494
|
+
"description": "SelectOptionIndicator is the selection indicator within an option for the Select component.",
|
|
1495
|
+
"interfaces": {
|
|
1496
|
+
"SelectOptionIndicatorPassThrough": {
|
|
1497
|
+
"description": "Defines passthrough(pt) options of SelectOptionIndicator component.",
|
|
1498
|
+
"relatedProp": "",
|
|
1499
|
+
"props": [
|
|
1500
|
+
{
|
|
1501
|
+
"name": "root",
|
|
1502
|
+
"type": "SelectOptionIndicatorPassThroughType<HTMLAttributes<HTMLElement>>",
|
|
1503
|
+
"default": "",
|
|
1504
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1505
|
+
}
|
|
1506
|
+
],
|
|
1507
|
+
"methods": []
|
|
1508
|
+
},
|
|
1509
|
+
"SelectOptionIndicatorProps": {
|
|
1510
|
+
"description": "Defines valid properties in SelectOptionIndicator component.",
|
|
1511
|
+
"relatedProp": "",
|
|
1512
|
+
"extendedTypes": "BaseComponentProps<SelectOptionIndicatorInstance, unknown, SelectOptionIndicatorPassThrough>",
|
|
1513
|
+
"props": [
|
|
1514
|
+
{
|
|
1515
|
+
"name": "ref",
|
|
1516
|
+
"type": "Ref<unknown>",
|
|
1517
|
+
"default": "",
|
|
1518
|
+
"description": "The reference to the component instance."
|
|
1519
|
+
},
|
|
1520
|
+
{
|
|
1521
|
+
"name": "pIf",
|
|
1522
|
+
"type": "boolean",
|
|
1523
|
+
"default": "true",
|
|
1524
|
+
"description": "Whether the component should be rendered."
|
|
1525
|
+
},
|
|
1526
|
+
{
|
|
1527
|
+
"name": "style",
|
|
1528
|
+
"type": "CSSProperties | ((instance?: SelectOptionIndicatorInstance) => CSSProperties)",
|
|
1529
|
+
"default": "",
|
|
1530
|
+
"description": "The style to apply to the component."
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"name": "className",
|
|
1534
|
+
"type": "string | ((instance?: SelectOptionIndicatorInstance) => string)",
|
|
1535
|
+
"default": "",
|
|
1536
|
+
"description": "The class name to apply to the component."
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
"name": "as",
|
|
1540
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1541
|
+
"default": "",
|
|
1542
|
+
"description": "The component type to render."
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"name": "asChild",
|
|
1546
|
+
"type": "boolean",
|
|
1547
|
+
"default": "false",
|
|
1548
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"name": "instance",
|
|
1552
|
+
"type": "SelectOptionIndicatorInstance",
|
|
1553
|
+
"default": "",
|
|
1554
|
+
"description": "The instance to pass to the component."
|
|
1555
|
+
},
|
|
1556
|
+
{
|
|
1557
|
+
"name": "pt",
|
|
1558
|
+
"type": "SafeRecord<SelectOptionIndicatorPassThrough>",
|
|
1559
|
+
"default": "",
|
|
1560
|
+
"description": "The pass-through props to pass to the component."
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "ptOptions",
|
|
1564
|
+
"type": "PassThroughOptions",
|
|
1565
|
+
"default": "",
|
|
1566
|
+
"description": "The pass-through options to pass to the component."
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
"name": "unstyled",
|
|
1570
|
+
"type": "boolean",
|
|
1571
|
+
"default": "",
|
|
1572
|
+
"description": "Whether the component should be rendered without classes."
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "dt",
|
|
1576
|
+
"type": "unknown",
|
|
1577
|
+
"default": "",
|
|
1578
|
+
"description": "The design token to use for the component."
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"name": "styles",
|
|
1582
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1583
|
+
"default": "",
|
|
1584
|
+
"description": "The styles to use for the component."
|
|
1585
|
+
},
|
|
1586
|
+
{
|
|
1587
|
+
"name": "render",
|
|
1588
|
+
"type": "(instance: SelectOptionIndicatorInstance) => ReactNode",
|
|
1589
|
+
"default": "",
|
|
1590
|
+
"description": "The render function to render the component with instance access."
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"name": "children",
|
|
1594
|
+
"type": "any",
|
|
1595
|
+
"default": "",
|
|
1596
|
+
"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."
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "[key: string]",
|
|
1600
|
+
"type": "any",
|
|
1601
|
+
"description": ""
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "pt-{optionName}-*",
|
|
1605
|
+
"type": "-",
|
|
1606
|
+
"default": "",
|
|
1607
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1608
|
+
"deprecated": false
|
|
1609
|
+
}
|
|
1610
|
+
],
|
|
1611
|
+
"methods": []
|
|
1612
|
+
},
|
|
1613
|
+
"SelectOptionIndicatorState": {
|
|
1614
|
+
"description": "Defines valid state in SelectOptionIndicator component.",
|
|
1615
|
+
"relatedProp": "",
|
|
1616
|
+
"props": [],
|
|
1617
|
+
"methods": []
|
|
1618
|
+
},
|
|
1619
|
+
"SelectOptionIndicatorExposes": {
|
|
1620
|
+
"description": "Defines the methods and properties exposed by SelectOptionIndicator component.",
|
|
1621
|
+
"relatedProp": "",
|
|
1622
|
+
"props": [
|
|
1623
|
+
{
|
|
1624
|
+
"name": "select",
|
|
1625
|
+
"type": "SelectRootInstance",
|
|
1626
|
+
"default": "",
|
|
1627
|
+
"description": "The Select component instance."
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
"name": "listbox",
|
|
1631
|
+
"type": "ListboxRootInstance",
|
|
1632
|
+
"default": "",
|
|
1633
|
+
"description": "The Listbox component instance."
|
|
1634
|
+
}
|
|
1635
|
+
],
|
|
1636
|
+
"methods": []
|
|
1637
|
+
}
|
|
1638
|
+
},
|
|
1639
|
+
"types": {
|
|
1640
|
+
"SelectOptionIndicatorPassThroughType": {
|
|
1641
|
+
"description": "Defines passthrough(pt) options type in SelectOptionIndicator component.",
|
|
1642
|
+
"values": "PassThroughType<SelectOptionIndicatorInstance, E>"
|
|
1643
|
+
},
|
|
1644
|
+
"SelectOptionIndicatorInstance": {
|
|
1645
|
+
"description": "Instance of SelectOptionIndicator component.",
|
|
1646
|
+
"values": "ComponentInstance<SelectOptionIndicatorProps, SelectOptionIndicatorState, SelectOptionIndicatorExposes>"
|
|
1647
|
+
}
|
|
1648
|
+
},
|
|
1649
|
+
"variables": {}
|
|
1650
|
+
}
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "SelectPopup",
|
|
1654
|
+
"source": "apps/showcase/assets/apidoc/selectpopup.json",
|
|
1655
|
+
"data": {
|
|
1656
|
+
"description": "SelectPopup is the popup container that wraps the dropdown content inside the positioner.",
|
|
1657
|
+
"interfaces": {
|
|
1658
|
+
"SelectPopupPassThrough": {
|
|
1659
|
+
"description": "Defines passthrough(pt) options of SelectPopup component.",
|
|
1660
|
+
"relatedProp": "",
|
|
1661
|
+
"props": [
|
|
1662
|
+
{
|
|
1663
|
+
"name": "root",
|
|
1664
|
+
"type": "SelectPopupPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1665
|
+
"default": "",
|
|
1666
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1667
|
+
}
|
|
1668
|
+
],
|
|
1669
|
+
"methods": []
|
|
1670
|
+
},
|
|
1671
|
+
"SelectPopupProps": {
|
|
1672
|
+
"description": "Defines valid properties in SelectPopup component.",
|
|
1673
|
+
"relatedProp": "",
|
|
1674
|
+
"extendedTypes": "BaseComponentProps<SelectPopupInstance, unknown, SelectPopupPassThrough>",
|
|
1675
|
+
"props": [
|
|
1676
|
+
{
|
|
1677
|
+
"name": "ref",
|
|
1678
|
+
"type": "Ref<unknown>",
|
|
1679
|
+
"default": "",
|
|
1680
|
+
"description": "The reference to the component instance."
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"name": "pIf",
|
|
1684
|
+
"type": "boolean",
|
|
1685
|
+
"default": "true",
|
|
1686
|
+
"description": "Whether the component should be rendered."
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
"name": "style",
|
|
1690
|
+
"type": "CSSProperties | ((instance?: SelectPopupInstance) => CSSProperties)",
|
|
1691
|
+
"default": "",
|
|
1692
|
+
"description": "The style to apply to the component."
|
|
1693
|
+
},
|
|
1694
|
+
{
|
|
1695
|
+
"name": "className",
|
|
1696
|
+
"type": "string | ((instance?: SelectPopupInstance) => string)",
|
|
1697
|
+
"default": "",
|
|
1698
|
+
"description": "The class name to apply to the component."
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"name": "as",
|
|
1702
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1703
|
+
"default": "",
|
|
1704
|
+
"description": "The component type to render."
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"name": "asChild",
|
|
1708
|
+
"type": "boolean",
|
|
1709
|
+
"default": "false",
|
|
1710
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1711
|
+
},
|
|
1712
|
+
{
|
|
1713
|
+
"name": "instance",
|
|
1714
|
+
"type": "SelectPopupInstance",
|
|
1715
|
+
"default": "",
|
|
1716
|
+
"description": "The instance to pass to the component."
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"name": "pt",
|
|
1720
|
+
"type": "SafeRecord<SelectPopupPassThrough>",
|
|
1721
|
+
"default": "",
|
|
1722
|
+
"description": "The pass-through props to pass to the component."
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"name": "ptOptions",
|
|
1726
|
+
"type": "PassThroughOptions",
|
|
1727
|
+
"default": "",
|
|
1728
|
+
"description": "The pass-through options to pass to the component."
|
|
1729
|
+
},
|
|
1730
|
+
{
|
|
1731
|
+
"name": "unstyled",
|
|
1732
|
+
"type": "boolean",
|
|
1733
|
+
"default": "",
|
|
1734
|
+
"description": "Whether the component should be rendered without classes."
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"name": "dt",
|
|
1738
|
+
"type": "unknown",
|
|
1739
|
+
"default": "",
|
|
1740
|
+
"description": "The design token to use for the component."
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"name": "styles",
|
|
1744
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1745
|
+
"default": "",
|
|
1746
|
+
"description": "The styles to use for the component."
|
|
1747
|
+
},
|
|
1748
|
+
{
|
|
1749
|
+
"name": "render",
|
|
1750
|
+
"type": "(instance: SelectPopupInstance) => ReactNode",
|
|
1751
|
+
"default": "",
|
|
1752
|
+
"description": "The render function to render the component with instance access."
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "children",
|
|
1756
|
+
"type": "any",
|
|
1757
|
+
"default": "",
|
|
1758
|
+
"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."
|
|
1759
|
+
},
|
|
1760
|
+
{
|
|
1761
|
+
"name": "motionProps",
|
|
1762
|
+
"type": "UseMotionProps",
|
|
1763
|
+
"default": "",
|
|
1764
|
+
"description": "Used to apply motion to the popup element. It accepts the same properties as useMotion hook."
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "[key: string]",
|
|
1768
|
+
"type": "any",
|
|
1769
|
+
"description": ""
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
"name": "pt-{optionName}-*",
|
|
1773
|
+
"type": "-",
|
|
1774
|
+
"default": "",
|
|
1775
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1776
|
+
"deprecated": false
|
|
1777
|
+
}
|
|
1778
|
+
],
|
|
1779
|
+
"methods": []
|
|
1780
|
+
},
|
|
1781
|
+
"SelectPopupState": {
|
|
1782
|
+
"description": "Defines valid state in SelectPopup component.",
|
|
1783
|
+
"relatedProp": "",
|
|
1784
|
+
"props": [],
|
|
1785
|
+
"methods": []
|
|
1786
|
+
},
|
|
1787
|
+
"SelectPopupExposes": {
|
|
1788
|
+
"description": "Defines the methods and properties exposed by SelectPopup component.",
|
|
1789
|
+
"relatedProp": "",
|
|
1790
|
+
"props": [
|
|
1791
|
+
{
|
|
1792
|
+
"name": "select",
|
|
1793
|
+
"type": "SelectRootInstance",
|
|
1794
|
+
"default": "",
|
|
1795
|
+
"description": "The Select component instance."
|
|
1796
|
+
}
|
|
1797
|
+
],
|
|
1798
|
+
"methods": []
|
|
1799
|
+
}
|
|
1800
|
+
},
|
|
1801
|
+
"types": {
|
|
1802
|
+
"SelectPopupPassThroughType": {
|
|
1803
|
+
"description": "Defines passthrough(pt) options type in SelectPopup component.",
|
|
1804
|
+
"values": "PassThroughType<SelectPopupInstance, E>"
|
|
1805
|
+
},
|
|
1806
|
+
"SelectPopupInstance": {
|
|
1807
|
+
"description": "Instance of SelectPopup component.",
|
|
1808
|
+
"values": "ComponentInstance<SelectPopupProps, SelectPopupState, SelectPopupExposes>"
|
|
1809
|
+
}
|
|
1810
|
+
},
|
|
1811
|
+
"variables": {}
|
|
1812
|
+
}
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "SelectPortal",
|
|
1816
|
+
"source": "apps/showcase/assets/apidoc/selectportal.json",
|
|
1817
|
+
"data": {
|
|
1818
|
+
"description": "SelectPortal is the overlay container for the Select component.",
|
|
1819
|
+
"interfaces": {
|
|
1820
|
+
"SelectPortalPassThrough": {
|
|
1821
|
+
"description": "Defines passthrough(pt) options of SelectPortal component.",
|
|
1822
|
+
"relatedProp": "",
|
|
1823
|
+
"props": [
|
|
1824
|
+
{
|
|
1825
|
+
"name": "root",
|
|
1826
|
+
"type": "SelectPortalPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1827
|
+
"default": "",
|
|
1828
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1829
|
+
}
|
|
1830
|
+
],
|
|
1831
|
+
"methods": []
|
|
1832
|
+
},
|
|
1833
|
+
"SelectPortalProps": {
|
|
1834
|
+
"description": "Defines valid properties in SelectPortal component.",
|
|
1835
|
+
"relatedProp": "",
|
|
1836
|
+
"extendedTypes": "BaseComponentProps<SelectPortalInstance, PortalProps, SelectPortalPassThrough>",
|
|
1837
|
+
"props": [
|
|
1838
|
+
{
|
|
1839
|
+
"name": "ref",
|
|
1840
|
+
"type": "Ref<unknown>",
|
|
1841
|
+
"default": "",
|
|
1842
|
+
"description": "The reference to the component instance."
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
"name": "pIf",
|
|
1846
|
+
"type": "boolean",
|
|
1847
|
+
"default": "true",
|
|
1848
|
+
"description": "Whether the component should be rendered."
|
|
1849
|
+
},
|
|
1850
|
+
{
|
|
1851
|
+
"name": "style",
|
|
1852
|
+
"type": "(CSSProperties | ((instance?: PortalInstance) => CSSProperties)) & (CSSProperties | ((instance?: SelectPortalInstance) => CSSProperties))",
|
|
1853
|
+
"default": "",
|
|
1854
|
+
"description": "The style to apply to the component."
|
|
1855
|
+
},
|
|
1856
|
+
{
|
|
1857
|
+
"name": "className",
|
|
1858
|
+
"type": "(string | ((instance?: PortalInstance) => string)) & (string | ((instance?: SelectPortalInstance) => string))",
|
|
1859
|
+
"default": "",
|
|
1860
|
+
"description": "The class name to apply to the component."
|
|
1861
|
+
},
|
|
1862
|
+
{
|
|
1863
|
+
"name": "as",
|
|
1864
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1865
|
+
"default": "",
|
|
1866
|
+
"description": "The component type to render."
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"name": "asChild",
|
|
1870
|
+
"type": "boolean",
|
|
1871
|
+
"default": "false",
|
|
1872
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1873
|
+
},
|
|
1874
|
+
{
|
|
1875
|
+
"name": "instance",
|
|
1876
|
+
"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<SelectPortalProps>, unknown, HTMLElement> & { props: SafeRecord<SafeRecord<SelectPortalProps>>; attrs: Omit<SafeRecord<SafeRecord<SelectPortalProps>>, string | number | symbol> & Record<PropertyKey, unknown> } & { state: SafeRecord; $computedSetup: SafeRecord } & SelectPortalExposes",
|
|
1877
|
+
"default": "",
|
|
1878
|
+
"description": "The instance to pass to the component."
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"name": "pt",
|
|
1882
|
+
"type": "PortalPassThrough & Record<PropertyKey, unknown> & SelectPortalPassThrough",
|
|
1883
|
+
"default": "",
|
|
1884
|
+
"description": "The pass-through props to pass to the component."
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
"name": "ptOptions",
|
|
1888
|
+
"type": "PassThroughOptions",
|
|
1889
|
+
"default": "",
|
|
1890
|
+
"description": "The pass-through options to pass to the component."
|
|
1891
|
+
},
|
|
1892
|
+
{
|
|
1893
|
+
"name": "unstyled",
|
|
1894
|
+
"type": "boolean",
|
|
1895
|
+
"default": "",
|
|
1896
|
+
"description": "Whether the component should be rendered without classes."
|
|
1897
|
+
},
|
|
1898
|
+
{
|
|
1899
|
+
"name": "dt",
|
|
1900
|
+
"type": "unknown",
|
|
1901
|
+
"default": "",
|
|
1902
|
+
"description": "The design token to use for the component."
|
|
1903
|
+
},
|
|
1904
|
+
{
|
|
1905
|
+
"name": "styles",
|
|
1906
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1907
|
+
"default": "",
|
|
1908
|
+
"description": "The styles to use for the component."
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"name": "render",
|
|
1912
|
+
"type": "(instance: PortalInstance) => ReactNode & (instance: SelectPortalInstance) => ReactNode",
|
|
1913
|
+
"default": "",
|
|
1914
|
+
"description": "The render function to render the component with instance access."
|
|
1915
|
+
},
|
|
1916
|
+
{
|
|
1917
|
+
"name": "children",
|
|
1918
|
+
"type": "any",
|
|
1919
|
+
"default": "",
|
|
1920
|
+
"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."
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"name": "onMounted",
|
|
1924
|
+
"type": "() => void",
|
|
1925
|
+
"default": "",
|
|
1926
|
+
"description": "Callback function to invoke when the portal is mounted."
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"name": "onUnmounted",
|
|
1930
|
+
"type": "() => void",
|
|
1931
|
+
"default": "",
|
|
1932
|
+
"description": "Callback function to invoke when the portal is unmounted."
|
|
1933
|
+
},
|
|
1934
|
+
{
|
|
1935
|
+
"name": "element",
|
|
1936
|
+
"type": "HTMLElement | ReactNode",
|
|
1937
|
+
"default": "",
|
|
1938
|
+
"description": "The element to be rendered as the portal."
|
|
1939
|
+
},
|
|
1940
|
+
{
|
|
1941
|
+
"name": "elementRef",
|
|
1942
|
+
"type": "RefObject<HTMLElement>",
|
|
1943
|
+
"default": "",
|
|
1944
|
+
"description": "The element reference to be rendered as the portal."
|
|
1945
|
+
},
|
|
1946
|
+
{
|
|
1947
|
+
"name": "appendTo",
|
|
1948
|
+
"type": "string | HTMLElement | ((instance: PortalInstance) => HTMLElement)",
|
|
1949
|
+
"default": "'body'",
|
|
1950
|
+
"description": "The DOM element where the portal should be appended to."
|
|
1951
|
+
},
|
|
1952
|
+
{
|
|
1953
|
+
"name": "[key: string]",
|
|
1954
|
+
"type": "any",
|
|
1955
|
+
"description": ""
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
"name": "pt-{optionName}-*",
|
|
1959
|
+
"type": "-",
|
|
1960
|
+
"default": "",
|
|
1961
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1962
|
+
"deprecated": false
|
|
1963
|
+
}
|
|
1964
|
+
],
|
|
1965
|
+
"methods": []
|
|
1966
|
+
},
|
|
1967
|
+
"SelectPortalState": {
|
|
1968
|
+
"description": "Defines valid state in SelectPortal component.",
|
|
1969
|
+
"relatedProp": "",
|
|
1970
|
+
"props": [],
|
|
1971
|
+
"methods": []
|
|
1972
|
+
},
|
|
1973
|
+
"SelectPortalExposes": {
|
|
1974
|
+
"description": "Defines the methods and properties exposed by SelectPortal component.",
|
|
1975
|
+
"relatedProp": "",
|
|
1976
|
+
"props": [
|
|
1977
|
+
{
|
|
1978
|
+
"name": "select",
|
|
1979
|
+
"type": "SelectRootInstance",
|
|
1980
|
+
"default": "",
|
|
1981
|
+
"description": "The Select component instance."
|
|
1982
|
+
}
|
|
1983
|
+
],
|
|
1984
|
+
"methods": []
|
|
1985
|
+
}
|
|
1986
|
+
},
|
|
1987
|
+
"types": {
|
|
1988
|
+
"SelectPortalPassThroughType": {
|
|
1989
|
+
"description": "Defines passthrough(pt) options type in SelectPortal component.",
|
|
1990
|
+
"values": "PassThroughType<SelectPortalInstance, E>"
|
|
1991
|
+
},
|
|
1992
|
+
"SelectPortalInstance": {
|
|
1993
|
+
"description": "Instance of SelectPortal component.",
|
|
1994
|
+
"values": "ComponentInstance<SelectPortalProps, SelectPortalState, SelectPortalExposes>"
|
|
1995
|
+
}
|
|
1996
|
+
},
|
|
1997
|
+
"variables": {}
|
|
1998
|
+
}
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"name": "SelectPositioner",
|
|
2002
|
+
"source": "apps/showcase/assets/apidoc/selectpositioner.json",
|
|
2003
|
+
"data": {
|
|
2004
|
+
"description": "SelectPositioner is a component that positions the select dropdown relative to its trigger.",
|
|
2005
|
+
"interfaces": {
|
|
2006
|
+
"SelectPositionerPassThrough": {
|
|
2007
|
+
"description": "Defines passthrough(pt) options of SelectPositioner component.",
|
|
2008
|
+
"relatedProp": "",
|
|
2009
|
+
"props": [
|
|
2010
|
+
{
|
|
2011
|
+
"name": "root",
|
|
2012
|
+
"type": "SelectPositionerPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2013
|
+
"default": "",
|
|
2014
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2015
|
+
}
|
|
2016
|
+
],
|
|
2017
|
+
"methods": []
|
|
2018
|
+
},
|
|
2019
|
+
"SelectPositionerProps": {
|
|
2020
|
+
"description": "Defines valid properties in SelectPositioner component.",
|
|
2021
|
+
"relatedProp": "",
|
|
2022
|
+
"extendedTypes": "BaseComponentProps<SelectPositionerInstance, UsePositionerProps, SelectPositionerPassThrough>",
|
|
2023
|
+
"props": [
|
|
2024
|
+
{
|
|
2025
|
+
"name": "ref",
|
|
2026
|
+
"type": "Ref<unknown>",
|
|
2027
|
+
"default": "",
|
|
2028
|
+
"description": "The reference to the component instance."
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "pIf",
|
|
2032
|
+
"type": "boolean",
|
|
2033
|
+
"default": "true",
|
|
2034
|
+
"description": "Whether the component should be rendered."
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"name": "style",
|
|
2038
|
+
"type": "CSSProperties | ((instance?: SelectPositionerInstance) => CSSProperties)",
|
|
2039
|
+
"default": "",
|
|
2040
|
+
"description": "The style to apply to the component."
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "className",
|
|
2044
|
+
"type": "string | ((instance?: SelectPositionerInstance) => string)",
|
|
2045
|
+
"default": "",
|
|
2046
|
+
"description": "The class name to apply to the component."
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"name": "as",
|
|
2050
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2051
|
+
"default": "",
|
|
2052
|
+
"description": "The component type to render."
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "asChild",
|
|
2056
|
+
"type": "boolean",
|
|
2057
|
+
"default": "false",
|
|
2058
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"name": "instance",
|
|
2062
|
+
"type": "SelectPositionerInstance",
|
|
2063
|
+
"default": "",
|
|
2064
|
+
"description": "The instance to pass to the component."
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
"name": "pt",
|
|
2068
|
+
"type": "SafeRecord<SelectPositionerPassThrough>",
|
|
2069
|
+
"default": "",
|
|
2070
|
+
"description": "The pass-through props to pass to the component."
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"name": "ptOptions",
|
|
2074
|
+
"type": "PassThroughOptions",
|
|
2075
|
+
"default": "",
|
|
2076
|
+
"description": "The pass-through options to pass to the component."
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"name": "unstyled",
|
|
2080
|
+
"type": "boolean",
|
|
2081
|
+
"default": "",
|
|
2082
|
+
"description": "Whether the component should be rendered without classes."
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"name": "dt",
|
|
2086
|
+
"type": "unknown",
|
|
2087
|
+
"default": "",
|
|
2088
|
+
"description": "The design token to use for the component."
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "styles",
|
|
2092
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2093
|
+
"default": "",
|
|
2094
|
+
"description": "The styles to use for the component."
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
"name": "render",
|
|
2098
|
+
"type": "(instance: SelectPositionerInstance) => ReactNode",
|
|
2099
|
+
"default": "",
|
|
2100
|
+
"description": "The render function to render the component with instance access."
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "children",
|
|
2104
|
+
"type": "any",
|
|
2105
|
+
"default": "",
|
|
2106
|
+
"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."
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"name": "side",
|
|
2110
|
+
"type": "SideType",
|
|
2111
|
+
"default": "",
|
|
2112
|
+
"description": "The side of the positioner."
|
|
2113
|
+
},
|
|
2114
|
+
{
|
|
2115
|
+
"name": "align",
|
|
2116
|
+
"type": "AlignType",
|
|
2117
|
+
"default": "",
|
|
2118
|
+
"description": "The align of the positioner."
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
"name": "sideOffset",
|
|
2122
|
+
"type": "number",
|
|
2123
|
+
"default": "",
|
|
2124
|
+
"description": "The side offset of the positioner."
|
|
2125
|
+
},
|
|
2126
|
+
{
|
|
2127
|
+
"name": "alignOffset",
|
|
2128
|
+
"type": "number",
|
|
2129
|
+
"default": "",
|
|
2130
|
+
"description": "The align offset of the positioner."
|
|
2131
|
+
},
|
|
2132
|
+
{
|
|
2133
|
+
"name": "flip",
|
|
2134
|
+
"type": "boolean",
|
|
2135
|
+
"default": "",
|
|
2136
|
+
"description": "Whether to flip the positioner."
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
"name": "shift",
|
|
2140
|
+
"type": "boolean",
|
|
2141
|
+
"default": "",
|
|
2142
|
+
"description": "Whether to shift the positioner."
|
|
2143
|
+
},
|
|
2144
|
+
{
|
|
2145
|
+
"name": "hideWhenDetached",
|
|
2146
|
+
"type": "boolean",
|
|
2147
|
+
"default": "",
|
|
2148
|
+
"description": "Whether to hide the positioner when detached."
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "strategy",
|
|
2152
|
+
"type": "\"fixed\" | \"absolute\"",
|
|
2153
|
+
"default": "'fixed'",
|
|
2154
|
+
"description": "The positioning strategy."
|
|
2155
|
+
},
|
|
2156
|
+
{
|
|
2157
|
+
"name": "boundary",
|
|
2158
|
+
"type": "HTMLElement",
|
|
2159
|
+
"default": "",
|
|
2160
|
+
"description": "The boundary element that constrains the positioner placement.\nUsed in JS fallback mode only; CSS Anchor mode uses the containing block."
|
|
2161
|
+
},
|
|
2162
|
+
{
|
|
2163
|
+
"name": "anchor",
|
|
2164
|
+
"type": "HTMLElement",
|
|
2165
|
+
"default": "",
|
|
2166
|
+
"description": "The anchor element."
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"name": "content",
|
|
2170
|
+
"type": "HTMLDivElement",
|
|
2171
|
+
"default": "",
|
|
2172
|
+
"description": "The content element."
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"name": "arrow",
|
|
2176
|
+
"type": "HTMLDivElement",
|
|
2177
|
+
"default": "",
|
|
2178
|
+
"description": "The arrow element."
|
|
2179
|
+
},
|
|
2180
|
+
{
|
|
2181
|
+
"name": "autoZIndex",
|
|
2182
|
+
"type": "boolean",
|
|
2183
|
+
"default": "true",
|
|
2184
|
+
"description": "Whether to automatically manage layering."
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"name": "baseZIndex",
|
|
2188
|
+
"type": "number",
|
|
2189
|
+
"default": "0",
|
|
2190
|
+
"description": "Base zIndex value to use in layering."
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "onPlacementChange",
|
|
2194
|
+
"type": "(placement: { side: SideType; align: AlignType }) => void",
|
|
2195
|
+
"default": "",
|
|
2196
|
+
"description": "Callback invoked when the actual placement changes due to flip or shift."
|
|
2197
|
+
},
|
|
2198
|
+
{
|
|
2199
|
+
"name": "[key: string]",
|
|
2200
|
+
"type": "any",
|
|
2201
|
+
"description": ""
|
|
2202
|
+
},
|
|
2203
|
+
{
|
|
2204
|
+
"name": "pt-{optionName}-*",
|
|
2205
|
+
"type": "-",
|
|
2206
|
+
"default": "",
|
|
2207
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2208
|
+
"deprecated": false
|
|
2209
|
+
}
|
|
2210
|
+
],
|
|
2211
|
+
"methods": []
|
|
2212
|
+
},
|
|
2213
|
+
"SelectPositionerState": {
|
|
2214
|
+
"description": "Defines valid state in SelectPositioner component.",
|
|
2215
|
+
"relatedProp": "",
|
|
2216
|
+
"props": [],
|
|
2217
|
+
"methods": []
|
|
2218
|
+
},
|
|
2219
|
+
"SelectPositionerExposes": {
|
|
2220
|
+
"description": "Defines the methods and properties exposed by SelectPositioner component.",
|
|
2221
|
+
"relatedProp": "",
|
|
2222
|
+
"props": [
|
|
2223
|
+
{
|
|
2224
|
+
"name": "select",
|
|
2225
|
+
"type": "SelectRootInstance",
|
|
2226
|
+
"default": "",
|
|
2227
|
+
"description": "The Select component instance."
|
|
2228
|
+
}
|
|
2229
|
+
],
|
|
2230
|
+
"methods": []
|
|
2231
|
+
}
|
|
2232
|
+
},
|
|
2233
|
+
"types": {
|
|
2234
|
+
"SelectPositionerPassThroughType": {
|
|
2235
|
+
"description": "Defines passthrough(pt) options type in SelectPositioner component.",
|
|
2236
|
+
"values": "PassThroughType<SelectPositionerInstance, E>"
|
|
2237
|
+
},
|
|
2238
|
+
"SelectPositionerInstance": {
|
|
2239
|
+
"description": "Instance of SelectPositioner component.",
|
|
2240
|
+
"values": "ComponentInstance<SelectPositionerProps, SelectPositionerState, SelectPositionerExposes>"
|
|
2241
|
+
}
|
|
2242
|
+
},
|
|
2243
|
+
"variables": {}
|
|
2244
|
+
}
|
|
2245
|
+
},
|
|
2246
|
+
{
|
|
2247
|
+
"name": "SelectRoot",
|
|
2248
|
+
"source": "apps/showcase/assets/apidoc/selectroot.json",
|
|
2249
|
+
"data": {
|
|
2250
|
+
"description": "Select is a dropdown component for selecting a single value from a list.",
|
|
2251
|
+
"interfaces": {
|
|
2252
|
+
"SelectRootPassThrough": {
|
|
2253
|
+
"description": "Defines passthrough(pt) options of Select component.",
|
|
2254
|
+
"relatedProp": "",
|
|
2255
|
+
"props": [
|
|
2256
|
+
{
|
|
2257
|
+
"name": "root",
|
|
2258
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2259
|
+
"default": "",
|
|
2260
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
"name": "trigger",
|
|
2264
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2265
|
+
"default": "",
|
|
2266
|
+
"description": "Used to pass attributes to the trigger's DOM element."
|
|
2267
|
+
},
|
|
2268
|
+
{
|
|
2269
|
+
"name": "value",
|
|
2270
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2271
|
+
"default": "",
|
|
2272
|
+
"description": "Used to pass attributes to the value's DOM element."
|
|
2273
|
+
},
|
|
2274
|
+
{
|
|
2275
|
+
"name": "clearIcon",
|
|
2276
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2277
|
+
"default": "",
|
|
2278
|
+
"description": "Used to pass attributes to the clear icon's DOM element."
|
|
2279
|
+
},
|
|
2280
|
+
{
|
|
2281
|
+
"name": "icon",
|
|
2282
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2283
|
+
"default": "",
|
|
2284
|
+
"description": "Used to pass attributes to the icon's DOM element."
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
"name": "positioner",
|
|
2288
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2289
|
+
"default": "",
|
|
2290
|
+
"description": "Used to pass attributes to the positioner's DOM element."
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
"name": "panel",
|
|
2294
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2295
|
+
"default": "",
|
|
2296
|
+
"description": "Used to pass attributes to the panel's DOM element."
|
|
2297
|
+
},
|
|
2298
|
+
{
|
|
2299
|
+
"name": "filter",
|
|
2300
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLInputElement>>",
|
|
2301
|
+
"default": "",
|
|
2302
|
+
"description": "Used to pass attributes to the filter's DOM element."
|
|
2303
|
+
},
|
|
2304
|
+
{
|
|
2305
|
+
"name": "list",
|
|
2306
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2307
|
+
"default": "",
|
|
2308
|
+
"description": "Used to pass attributes to the list's DOM element."
|
|
2309
|
+
},
|
|
2310
|
+
{
|
|
2311
|
+
"name": "options",
|
|
2312
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLUListElement>>",
|
|
2313
|
+
"default": "",
|
|
2314
|
+
"description": "Used to pass attributes to the options' DOM element."
|
|
2315
|
+
},
|
|
2316
|
+
{
|
|
2317
|
+
"name": "option",
|
|
2318
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
2319
|
+
"default": "",
|
|
2320
|
+
"description": "Used to pass attributes to the option's DOM element."
|
|
2321
|
+
},
|
|
2322
|
+
{
|
|
2323
|
+
"name": "selection",
|
|
2324
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLElement>>",
|
|
2325
|
+
"default": "",
|
|
2326
|
+
"description": "Used to pass attributes to the selection's DOM element."
|
|
2327
|
+
},
|
|
2328
|
+
{
|
|
2329
|
+
"name": "header",
|
|
2330
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2331
|
+
"default": "",
|
|
2332
|
+
"description": "Used to pass attributes to the header's DOM element."
|
|
2333
|
+
},
|
|
2334
|
+
{
|
|
2335
|
+
"name": "footer",
|
|
2336
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2337
|
+
"default": "",
|
|
2338
|
+
"description": "Used to pass attributes to the footer's DOM element."
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
"name": "empty",
|
|
2342
|
+
"type": "SelectRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2343
|
+
"default": "",
|
|
2344
|
+
"description": "Used to pass attributes to the empty's DOM element."
|
|
2345
|
+
}
|
|
2346
|
+
],
|
|
2347
|
+
"methods": []
|
|
2348
|
+
},
|
|
2349
|
+
"SelectRootProps": {
|
|
2350
|
+
"description": "Defines valid properties in Select component.",
|
|
2351
|
+
"relatedProp": "",
|
|
2352
|
+
"extendedTypes": "BaseComponentProps<SelectRootInstance, Omit<UseSelectProps, \"onValueChange\" | \"onFilterValueChange\">, SelectRootPassThrough>",
|
|
2353
|
+
"props": [
|
|
2354
|
+
{
|
|
2355
|
+
"name": "ref",
|
|
2356
|
+
"type": "Ref<unknown>",
|
|
2357
|
+
"default": "",
|
|
2358
|
+
"description": "The reference to the component instance."
|
|
2359
|
+
},
|
|
2360
|
+
{
|
|
2361
|
+
"name": "pIf",
|
|
2362
|
+
"type": "boolean",
|
|
2363
|
+
"default": "true",
|
|
2364
|
+
"description": "Whether the component should be rendered."
|
|
2365
|
+
},
|
|
2366
|
+
{
|
|
2367
|
+
"name": "style",
|
|
2368
|
+
"type": "CSSProperties | ((instance?: SelectRootInstance) => CSSProperties)",
|
|
2369
|
+
"default": "",
|
|
2370
|
+
"description": "The style to apply to the component."
|
|
2371
|
+
},
|
|
2372
|
+
{
|
|
2373
|
+
"name": "className",
|
|
2374
|
+
"type": "string | ((instance?: SelectRootInstance) => string)",
|
|
2375
|
+
"default": "",
|
|
2376
|
+
"description": "The class name to apply to the component."
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"name": "as",
|
|
2380
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2381
|
+
"default": "",
|
|
2382
|
+
"description": "The component type to render."
|
|
2383
|
+
},
|
|
2384
|
+
{
|
|
2385
|
+
"name": "asChild",
|
|
2386
|
+
"type": "boolean",
|
|
2387
|
+
"default": "false",
|
|
2388
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2389
|
+
},
|
|
2390
|
+
{
|
|
2391
|
+
"name": "instance",
|
|
2392
|
+
"type": "SelectRootInstance",
|
|
2393
|
+
"default": "",
|
|
2394
|
+
"description": "The instance to pass to the component."
|
|
2395
|
+
},
|
|
2396
|
+
{
|
|
2397
|
+
"name": "pt",
|
|
2398
|
+
"type": "SafeRecord<SelectRootPassThrough>",
|
|
2399
|
+
"default": "",
|
|
2400
|
+
"description": "The pass-through props to pass to the component."
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
"name": "ptOptions",
|
|
2404
|
+
"type": "PassThroughOptions",
|
|
2405
|
+
"default": "",
|
|
2406
|
+
"description": "The pass-through options to pass to the component."
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"name": "unstyled",
|
|
2410
|
+
"type": "boolean",
|
|
2411
|
+
"default": "",
|
|
2412
|
+
"description": "Whether the component should be rendered without classes."
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
"name": "dt",
|
|
2416
|
+
"type": "unknown",
|
|
2417
|
+
"default": "",
|
|
2418
|
+
"description": "The design token to use for the component."
|
|
2419
|
+
},
|
|
2420
|
+
{
|
|
2421
|
+
"name": "styles",
|
|
2422
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2423
|
+
"default": "",
|
|
2424
|
+
"description": "The styles to use for the component."
|
|
2425
|
+
},
|
|
2426
|
+
{
|
|
2427
|
+
"name": "render",
|
|
2428
|
+
"type": "(instance: SelectRootInstance) => ReactNode",
|
|
2429
|
+
"default": "",
|
|
2430
|
+
"description": "The render function to render the component with instance access."
|
|
2431
|
+
},
|
|
2432
|
+
{
|
|
2433
|
+
"name": "children",
|
|
2434
|
+
"type": "any",
|
|
2435
|
+
"default": "",
|
|
2436
|
+
"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."
|
|
2437
|
+
},
|
|
2438
|
+
{
|
|
2439
|
+
"name": "value",
|
|
2440
|
+
"type": "unknown",
|
|
2441
|
+
"default": "",
|
|
2442
|
+
"description": "The current selected value of the select."
|
|
2443
|
+
},
|
|
2444
|
+
{
|
|
2445
|
+
"name": "defaultValue",
|
|
2446
|
+
"type": "unknown",
|
|
2447
|
+
"default": "",
|
|
2448
|
+
"description": "The default selected value when used in uncontrolled mode."
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
"name": "defaultFilterValue",
|
|
2452
|
+
"type": "string",
|
|
2453
|
+
"default": "",
|
|
2454
|
+
"description": "The default filter text value when used in uncontrolled mode."
|
|
2455
|
+
},
|
|
2456
|
+
{
|
|
2457
|
+
"name": "open",
|
|
2458
|
+
"type": "boolean",
|
|
2459
|
+
"default": "",
|
|
2460
|
+
"description": "Controlled open state of the select overlay."
|
|
2461
|
+
},
|
|
2462
|
+
{
|
|
2463
|
+
"name": "defaultOpen",
|
|
2464
|
+
"type": "boolean",
|
|
2465
|
+
"default": "",
|
|
2466
|
+
"description": "Default open state for uncontrolled mode."
|
|
2467
|
+
},
|
|
2468
|
+
{
|
|
2469
|
+
"name": "options",
|
|
2470
|
+
"type": "unknown[]",
|
|
2471
|
+
"default": "",
|
|
2472
|
+
"description": "An array of options to display."
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
"name": "optionKey",
|
|
2476
|
+
"type": "string",
|
|
2477
|
+
"default": "",
|
|
2478
|
+
"description": "Unique key for each option."
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "optionLabel",
|
|
2482
|
+
"type": "string",
|
|
2483
|
+
"default": "",
|
|
2484
|
+
"description": "Label field for each option."
|
|
2485
|
+
},
|
|
2486
|
+
{
|
|
2487
|
+
"name": "optionValue",
|
|
2488
|
+
"type": "string",
|
|
2489
|
+
"default": "",
|
|
2490
|
+
"description": "Value field for each option."
|
|
2491
|
+
},
|
|
2492
|
+
{
|
|
2493
|
+
"name": "optionDisabled",
|
|
2494
|
+
"type": "string",
|
|
2495
|
+
"default": "",
|
|
2496
|
+
"description": "Field to check if an option is disabled."
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
"name": "optionGroupLabel",
|
|
2500
|
+
"type": "string",
|
|
2501
|
+
"default": "",
|
|
2502
|
+
"description": "Label field for option groups."
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"name": "optionGroupChildren",
|
|
2506
|
+
"type": "string",
|
|
2507
|
+
"default": "",
|
|
2508
|
+
"description": "Field that contains the children options in a group."
|
|
2509
|
+
},
|
|
2510
|
+
{
|
|
2511
|
+
"name": "locale",
|
|
2512
|
+
"type": "string",
|
|
2513
|
+
"default": "",
|
|
2514
|
+
"description": "The locale to use for localization."
|
|
2515
|
+
},
|
|
2516
|
+
{
|
|
2517
|
+
"name": "autoOptionFocus",
|
|
2518
|
+
"type": "boolean",
|
|
2519
|
+
"default": "",
|
|
2520
|
+
"description": "When enabled, the focused option is automatically highlighted."
|
|
2521
|
+
},
|
|
2522
|
+
{
|
|
2523
|
+
"name": "selectOnFocus",
|
|
2524
|
+
"type": "boolean",
|
|
2525
|
+
"default": "",
|
|
2526
|
+
"description": "When enabled, the focused option is automatically selected."
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
"name": "focusOnHover",
|
|
2530
|
+
"type": "boolean",
|
|
2531
|
+
"default": "",
|
|
2532
|
+
"description": "When enabled, the focused option changes on hover."
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
"name": "metaKeySelection",
|
|
2536
|
+
"type": "boolean",
|
|
2537
|
+
"default": "",
|
|
2538
|
+
"description": "When enabled, requires holding the meta key to select/deselect."
|
|
2539
|
+
},
|
|
2540
|
+
{
|
|
2541
|
+
"name": "filter",
|
|
2542
|
+
"type": "boolean",
|
|
2543
|
+
"default": "",
|
|
2544
|
+
"description": "When enabled, displays a filter input in the dropdown."
|
|
2545
|
+
},
|
|
2546
|
+
{
|
|
2547
|
+
"name": "filterMatchMode",
|
|
2548
|
+
"type": "\"endsWith\" | \"startsWith\" | \"contains\" | \"equals\"",
|
|
2549
|
+
"default": "",
|
|
2550
|
+
"description": "Defines how the filter should match options."
|
|
2551
|
+
},
|
|
2552
|
+
{
|
|
2553
|
+
"name": "appendTo",
|
|
2554
|
+
"type": "\"body\" | HTMLElement | \"self\"",
|
|
2555
|
+
"default": "",
|
|
2556
|
+
"description": "A valid query selector or an HTMLElement to specify where the overlay gets attached."
|
|
2557
|
+
},
|
|
2558
|
+
{
|
|
2559
|
+
"name": "tabIndex",
|
|
2560
|
+
"type": "number",
|
|
2561
|
+
"default": "",
|
|
2562
|
+
"description": "Index of the element in tabbing order."
|
|
2563
|
+
},
|
|
2564
|
+
{
|
|
2565
|
+
"name": "ariaLabel",
|
|
2566
|
+
"type": "string",
|
|
2567
|
+
"default": "",
|
|
2568
|
+
"description": "Used to define a string that labels the input element."
|
|
2569
|
+
},
|
|
2570
|
+
{
|
|
2571
|
+
"name": "ariaLabelledBy",
|
|
2572
|
+
"type": "string",
|
|
2573
|
+
"default": "",
|
|
2574
|
+
"description": "Identifier of the underlying input element."
|
|
2575
|
+
},
|
|
2576
|
+
{
|
|
2577
|
+
"name": "closeOnEscape",
|
|
2578
|
+
"type": "boolean",
|
|
2579
|
+
"default": "",
|
|
2580
|
+
"description": "When enabled, the overlay closes when Escape key is pressed."
|
|
2581
|
+
},
|
|
2582
|
+
{
|
|
2583
|
+
"name": "autoFocus",
|
|
2584
|
+
"type": "boolean",
|
|
2585
|
+
"default": "",
|
|
2586
|
+
"description": "When enabled, the overlay receives focus automatically when opened."
|
|
2587
|
+
},
|
|
2588
|
+
{
|
|
2589
|
+
"name": "trapped",
|
|
2590
|
+
"type": "boolean",
|
|
2591
|
+
"default": "",
|
|
2592
|
+
"description": "When enabled, focus is trapped within the overlay."
|
|
2593
|
+
},
|
|
2594
|
+
{
|
|
2595
|
+
"name": "onOpenChange",
|
|
2596
|
+
"type": "(event: UseSelectOpenChangeEvent) => void",
|
|
2597
|
+
"default": "",
|
|
2598
|
+
"description": "Callback to invoke when the open state changes."
|
|
2599
|
+
},
|
|
2600
|
+
{
|
|
2601
|
+
"name": "multiple",
|
|
2602
|
+
"type": "boolean",
|
|
2603
|
+
"default": "",
|
|
2604
|
+
"description": "When enabled, allows multiple items to be selected."
|
|
2605
|
+
},
|
|
2606
|
+
{
|
|
2607
|
+
"name": "invalid",
|
|
2608
|
+
"type": "boolean",
|
|
2609
|
+
"default": "",
|
|
2610
|
+
"description": "When present, it specifies that the component should have invalid state style."
|
|
2611
|
+
},
|
|
2612
|
+
{
|
|
2613
|
+
"name": "variant",
|
|
2614
|
+
"type": "\"outlined\" | \"filled\"",
|
|
2615
|
+
"default": "",
|
|
2616
|
+
"description": "Specifies the input variant of the component."
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
"name": "filterValue",
|
|
2620
|
+
"type": "string",
|
|
2621
|
+
"default": "",
|
|
2622
|
+
"description": ""
|
|
2623
|
+
},
|
|
2624
|
+
{
|
|
2625
|
+
"name": "fluid",
|
|
2626
|
+
"type": "boolean",
|
|
2627
|
+
"default": "",
|
|
2628
|
+
"description": "Spans 100% width of the container when enabled."
|
|
2629
|
+
},
|
|
2630
|
+
{
|
|
2631
|
+
"name": "disabled",
|
|
2632
|
+
"type": "boolean",
|
|
2633
|
+
"default": "false",
|
|
2634
|
+
"description": "When present, it specifies that the element should be disabled."
|
|
2635
|
+
},
|
|
2636
|
+
{
|
|
2637
|
+
"name": "size",
|
|
2638
|
+
"type": "\"small\" | \"large\"",
|
|
2639
|
+
"default": "",
|
|
2640
|
+
"description": "Defines the size of the component."
|
|
2641
|
+
},
|
|
2642
|
+
{
|
|
2643
|
+
"name": "onValueChange",
|
|
2644
|
+
"type": "(event: SelectValueChangeEvent) => void",
|
|
2645
|
+
"default": "",
|
|
2646
|
+
"description": "Callback fired when the select's value is changed."
|
|
2647
|
+
},
|
|
2648
|
+
{
|
|
2649
|
+
"name": "onFilterValueChange",
|
|
2650
|
+
"type": "(event: SelectFilterValueChangeEvent) => void",
|
|
2651
|
+
"default": "",
|
|
2652
|
+
"description": "Callback fired when the select's filter value is changed."
|
|
2653
|
+
},
|
|
2654
|
+
{
|
|
2655
|
+
"name": "[key: string]",
|
|
2656
|
+
"type": "any",
|
|
2657
|
+
"description": ""
|
|
2658
|
+
},
|
|
2659
|
+
{
|
|
2660
|
+
"name": "pt-{optionName}-*",
|
|
2661
|
+
"type": "-",
|
|
2662
|
+
"default": "",
|
|
2663
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2664
|
+
"deprecated": false
|
|
2665
|
+
}
|
|
2666
|
+
],
|
|
2667
|
+
"methods": []
|
|
2668
|
+
},
|
|
2669
|
+
"SelectRootState": {
|
|
2670
|
+
"description": "Defines valid state in Select component.",
|
|
2671
|
+
"relatedProp": "",
|
|
2672
|
+
"extendedTypes": "UseSelectState",
|
|
2673
|
+
"props": [
|
|
2674
|
+
{
|
|
2675
|
+
"name": "value",
|
|
2676
|
+
"type": "unknown",
|
|
2677
|
+
"default": "",
|
|
2678
|
+
"description": "The current selected value."
|
|
2679
|
+
},
|
|
2680
|
+
{
|
|
2681
|
+
"name": "opened",
|
|
2682
|
+
"type": "boolean",
|
|
2683
|
+
"default": "",
|
|
2684
|
+
"description": "Whether the overlay is open."
|
|
2685
|
+
},
|
|
2686
|
+
{
|
|
2687
|
+
"name": "focused",
|
|
2688
|
+
"type": "boolean",
|
|
2689
|
+
"default": "",
|
|
2690
|
+
"description": "Whether the trigger is focused."
|
|
2691
|
+
},
|
|
2692
|
+
{
|
|
2693
|
+
"name": "focusedOptionIndex",
|
|
2694
|
+
"type": "number",
|
|
2695
|
+
"default": "",
|
|
2696
|
+
"description": "The index of the currently focused option. -1 if no option is focused."
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
"name": "anchorElement",
|
|
2700
|
+
"type": "HTMLElement",
|
|
2701
|
+
"default": "",
|
|
2702
|
+
"description": "The anchor (trigger) element."
|
|
2703
|
+
},
|
|
2704
|
+
{
|
|
2705
|
+
"name": "positionerElement",
|
|
2706
|
+
"type": "HTMLDivElement",
|
|
2707
|
+
"default": "",
|
|
2708
|
+
"description": "The positioner element."
|
|
2709
|
+
},
|
|
2710
|
+
{
|
|
2711
|
+
"name": "popupElement",
|
|
2712
|
+
"type": "HTMLElement",
|
|
2713
|
+
"default": "",
|
|
2714
|
+
"description": "The popup element."
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "arrowElement",
|
|
2718
|
+
"type": "HTMLDivElement",
|
|
2719
|
+
"default": "",
|
|
2720
|
+
"description": "The arrow element."
|
|
2721
|
+
},
|
|
2722
|
+
{
|
|
2723
|
+
"name": "rendered",
|
|
2724
|
+
"type": "boolean",
|
|
2725
|
+
"default": "",
|
|
2726
|
+
"description": "Whether the overlay has been rendered (mounted to DOM)."
|
|
2727
|
+
}
|
|
2728
|
+
],
|
|
2729
|
+
"methods": []
|
|
2730
|
+
},
|
|
2731
|
+
"SelectRootExposes": {
|
|
2732
|
+
"description": "Defines the methods and properties exposed by Select component.",
|
|
2733
|
+
"relatedProp": "",
|
|
2734
|
+
"extendedTypes": "UseSelectExposes",
|
|
2735
|
+
"props": [
|
|
2736
|
+
{
|
|
2737
|
+
"name": "state",
|
|
2738
|
+
"type": "UseSelectState",
|
|
2739
|
+
"default": "",
|
|
2740
|
+
"description": "The state of the useSelect."
|
|
2741
|
+
},
|
|
2742
|
+
{
|
|
2743
|
+
"name": "listbox",
|
|
2744
|
+
"type": "UseListboxInstance",
|
|
2745
|
+
"default": "",
|
|
2746
|
+
"description": "The listbox instance used internally for option management."
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"name": "setRendered",
|
|
2750
|
+
"type": "(value: boolean) => void",
|
|
2751
|
+
"default": "",
|
|
2752
|
+
"description": "Sets the rendered state."
|
|
2753
|
+
},
|
|
2754
|
+
{
|
|
2755
|
+
"name": "rootProps",
|
|
2756
|
+
"type": "UseSelectRootProps",
|
|
2757
|
+
"default": "",
|
|
2758
|
+
"description": "Pre-built props for the root element.\nIncludes id and data attributes."
|
|
2759
|
+
},
|
|
2760
|
+
{
|
|
2761
|
+
"name": "listProps",
|
|
2762
|
+
"type": "UseSelectListProps",
|
|
2763
|
+
"default": "",
|
|
2764
|
+
"description": "Pre-built props for the list element.\nIncludes id, tabIndex, role, ARIA attributes, and event handlers."
|
|
2765
|
+
},
|
|
2766
|
+
{
|
|
2767
|
+
"name": "triggerProps",
|
|
2768
|
+
"type": "UseSelectTriggerProps",
|
|
2769
|
+
"default": "",
|
|
2770
|
+
"description": "Pre-built props for the trigger element.\nIncludes role, ARIA attributes, event handlers, and data attributes."
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"name": "filterProps",
|
|
2774
|
+
"type": "UseSelectFilterProps",
|
|
2775
|
+
"default": "",
|
|
2776
|
+
"description": "Pre-built props for the filter input element.\nIncludes role, ARIA attributes, and event handlers."
|
|
2777
|
+
},
|
|
2778
|
+
{
|
|
2779
|
+
"name": "indicatorProps",
|
|
2780
|
+
"type": "UseSelectIndicatorProps",
|
|
2781
|
+
"default": "",
|
|
2782
|
+
"description": "Pre-built props for the indicator element."
|
|
2783
|
+
},
|
|
2784
|
+
{
|
|
2785
|
+
"name": "clearProps",
|
|
2786
|
+
"type": "UseSelectClearProps",
|
|
2787
|
+
"default": "",
|
|
2788
|
+
"description": "Pre-built props for the clear button element."
|
|
2789
|
+
},
|
|
2790
|
+
{
|
|
2791
|
+
"name": "popupProps",
|
|
2792
|
+
"type": "UseSelectPopupProps",
|
|
2793
|
+
"default": "",
|
|
2794
|
+
"description": "Pre-built props for the popup element."
|
|
2795
|
+
},
|
|
2796
|
+
{
|
|
2797
|
+
"name": "getSelectedOptionLabel",
|
|
2798
|
+
"type": "() => unknown",
|
|
2799
|
+
"default": "",
|
|
2800
|
+
"description": "Gets the label of the currently selected option."
|
|
2801
|
+
},
|
|
2802
|
+
{
|
|
2803
|
+
"name": "hasValue",
|
|
2804
|
+
"type": "() => boolean",
|
|
2805
|
+
"default": "",
|
|
2806
|
+
"description": "Checks if there is a selected value."
|
|
2807
|
+
},
|
|
2808
|
+
{
|
|
2809
|
+
"name": "show",
|
|
2810
|
+
"type": "() => void",
|
|
2811
|
+
"default": "",
|
|
2812
|
+
"description": "Shows the overlay."
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"name": "hide",
|
|
2816
|
+
"type": "() => void",
|
|
2817
|
+
"default": "",
|
|
2818
|
+
"description": "Hides the overlay."
|
|
2819
|
+
},
|
|
2820
|
+
{
|
|
2821
|
+
"name": "toggle",
|
|
2822
|
+
"type": "() => void",
|
|
2823
|
+
"default": "",
|
|
2824
|
+
"description": "Toggles the overlay visibility."
|
|
2825
|
+
},
|
|
2826
|
+
{
|
|
2827
|
+
"name": "focus",
|
|
2828
|
+
"type": "() => void",
|
|
2829
|
+
"default": "",
|
|
2830
|
+
"description": "Moves focus to the trigger element."
|
|
2831
|
+
}
|
|
2832
|
+
],
|
|
2833
|
+
"methods": []
|
|
2834
|
+
}
|
|
2835
|
+
},
|
|
2836
|
+
"types": {
|
|
2837
|
+
"SelectRootPassThroughType": {
|
|
2838
|
+
"description": "Defines passthrough(pt) options type in Select component.",
|
|
2839
|
+
"values": "PassThroughType<SelectRootInstance, E>"
|
|
2840
|
+
},
|
|
2841
|
+
"SelectRootInstance": {
|
|
2842
|
+
"description": "Instance of SelectRoot component.",
|
|
2843
|
+
"values": "ComponentInstance<SelectRootProps, SelectRootState, SelectRootExposes>"
|
|
2844
|
+
}
|
|
2845
|
+
},
|
|
2846
|
+
"variables": {}
|
|
2847
|
+
}
|
|
2848
|
+
},
|
|
2849
|
+
{
|
|
2850
|
+
"name": "SelectTrigger",
|
|
2851
|
+
"source": "apps/showcase/assets/apidoc/selecttrigger.json",
|
|
2852
|
+
"data": {
|
|
2853
|
+
"description": "SelectTrigger is the dropdown trigger button for the Select component.",
|
|
2854
|
+
"interfaces": {
|
|
2855
|
+
"SelectTriggerPassThrough": {
|
|
2856
|
+
"description": "Defines passthrough(pt) options of SelectTrigger component.",
|
|
2857
|
+
"relatedProp": "",
|
|
2858
|
+
"props": [
|
|
2859
|
+
{
|
|
2860
|
+
"name": "root",
|
|
2861
|
+
"type": "SelectTriggerPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2862
|
+
"default": "",
|
|
2863
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2864
|
+
}
|
|
2865
|
+
],
|
|
2866
|
+
"methods": []
|
|
2867
|
+
},
|
|
2868
|
+
"SelectTriggerProps": {
|
|
2869
|
+
"description": "Defines valid properties in SelectTrigger component.",
|
|
2870
|
+
"relatedProp": "",
|
|
2871
|
+
"extendedTypes": "BaseComponentProps<SelectTriggerInstance, unknown, SelectTriggerPassThrough>",
|
|
2872
|
+
"props": [
|
|
2873
|
+
{
|
|
2874
|
+
"name": "ref",
|
|
2875
|
+
"type": "Ref<unknown>",
|
|
2876
|
+
"default": "",
|
|
2877
|
+
"description": "The reference to the component instance."
|
|
2878
|
+
},
|
|
2879
|
+
{
|
|
2880
|
+
"name": "pIf",
|
|
2881
|
+
"type": "boolean",
|
|
2882
|
+
"default": "true",
|
|
2883
|
+
"description": "Whether the component should be rendered."
|
|
2884
|
+
},
|
|
2885
|
+
{
|
|
2886
|
+
"name": "style",
|
|
2887
|
+
"type": "CSSProperties | ((instance?: SelectTriggerInstance) => CSSProperties)",
|
|
2888
|
+
"default": "",
|
|
2889
|
+
"description": "The style to apply to the component."
|
|
2890
|
+
},
|
|
2891
|
+
{
|
|
2892
|
+
"name": "className",
|
|
2893
|
+
"type": "string | ((instance?: SelectTriggerInstance) => string)",
|
|
2894
|
+
"default": "",
|
|
2895
|
+
"description": "The class name to apply to the component."
|
|
2896
|
+
},
|
|
2897
|
+
{
|
|
2898
|
+
"name": "as",
|
|
2899
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2900
|
+
"default": "",
|
|
2901
|
+
"description": "The component type to render."
|
|
2902
|
+
},
|
|
2903
|
+
{
|
|
2904
|
+
"name": "asChild",
|
|
2905
|
+
"type": "boolean",
|
|
2906
|
+
"default": "false",
|
|
2907
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2908
|
+
},
|
|
2909
|
+
{
|
|
2910
|
+
"name": "instance",
|
|
2911
|
+
"type": "SelectTriggerInstance",
|
|
2912
|
+
"default": "",
|
|
2913
|
+
"description": "The instance to pass to the component."
|
|
2914
|
+
},
|
|
2915
|
+
{
|
|
2916
|
+
"name": "pt",
|
|
2917
|
+
"type": "SafeRecord<SelectTriggerPassThrough>",
|
|
2918
|
+
"default": "",
|
|
2919
|
+
"description": "The pass-through props to pass to the component."
|
|
2920
|
+
},
|
|
2921
|
+
{
|
|
2922
|
+
"name": "ptOptions",
|
|
2923
|
+
"type": "PassThroughOptions",
|
|
2924
|
+
"default": "",
|
|
2925
|
+
"description": "The pass-through options to pass to the component."
|
|
2926
|
+
},
|
|
2927
|
+
{
|
|
2928
|
+
"name": "unstyled",
|
|
2929
|
+
"type": "boolean",
|
|
2930
|
+
"default": "",
|
|
2931
|
+
"description": "Whether the component should be rendered without classes."
|
|
2932
|
+
},
|
|
2933
|
+
{
|
|
2934
|
+
"name": "dt",
|
|
2935
|
+
"type": "unknown",
|
|
2936
|
+
"default": "",
|
|
2937
|
+
"description": "The design token to use for the component."
|
|
2938
|
+
},
|
|
2939
|
+
{
|
|
2940
|
+
"name": "styles",
|
|
2941
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2942
|
+
"default": "",
|
|
2943
|
+
"description": "The styles to use for the component."
|
|
2944
|
+
},
|
|
2945
|
+
{
|
|
2946
|
+
"name": "render",
|
|
2947
|
+
"type": "(instance: SelectTriggerInstance) => ReactNode",
|
|
2948
|
+
"default": "",
|
|
2949
|
+
"description": "The render function to render the component with instance access."
|
|
2950
|
+
},
|
|
2951
|
+
{
|
|
2952
|
+
"name": "children",
|
|
2953
|
+
"type": "any",
|
|
2954
|
+
"default": "",
|
|
2955
|
+
"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."
|
|
2956
|
+
},
|
|
2957
|
+
{
|
|
2958
|
+
"name": "[key: string]",
|
|
2959
|
+
"type": "any",
|
|
2960
|
+
"description": ""
|
|
2961
|
+
},
|
|
2962
|
+
{
|
|
2963
|
+
"name": "pt-{optionName}-*",
|
|
2964
|
+
"type": "-",
|
|
2965
|
+
"default": "",
|
|
2966
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2967
|
+
"deprecated": false
|
|
2968
|
+
}
|
|
2969
|
+
],
|
|
2970
|
+
"methods": []
|
|
2971
|
+
},
|
|
2972
|
+
"SelectTriggerState": {
|
|
2973
|
+
"description": "Defines valid state in SelectTrigger component.",
|
|
2974
|
+
"relatedProp": "",
|
|
2975
|
+
"props": [],
|
|
2976
|
+
"methods": []
|
|
2977
|
+
},
|
|
2978
|
+
"SelectTriggerExposes": {
|
|
2979
|
+
"description": "Defines the methods and properties exposed by SelectTrigger component.",
|
|
2980
|
+
"relatedProp": "",
|
|
2981
|
+
"props": [
|
|
2982
|
+
{
|
|
2983
|
+
"name": "select",
|
|
2984
|
+
"type": "SelectRootInstance",
|
|
2985
|
+
"default": "",
|
|
2986
|
+
"description": "The Select component instance."
|
|
2987
|
+
}
|
|
2988
|
+
],
|
|
2989
|
+
"methods": []
|
|
2990
|
+
}
|
|
2991
|
+
},
|
|
2992
|
+
"types": {
|
|
2993
|
+
"SelectTriggerPassThroughType": {
|
|
2994
|
+
"description": "Defines passthrough(pt) options type in SelectTrigger component.",
|
|
2995
|
+
"values": "PassThroughType<SelectTriggerInstance, E>"
|
|
2996
|
+
},
|
|
2997
|
+
"SelectTriggerInstance": {
|
|
2998
|
+
"description": "Instance of SelectTrigger component.",
|
|
2999
|
+
"values": "ComponentInstance<SelectTriggerProps, SelectTriggerState, SelectTriggerExposes>"
|
|
3000
|
+
}
|
|
3001
|
+
},
|
|
3002
|
+
"variables": {}
|
|
3003
|
+
}
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"name": "SelectValue",
|
|
3007
|
+
"source": "apps/showcase/assets/apidoc/selectvalue.json",
|
|
3008
|
+
"data": {
|
|
3009
|
+
"description": "SelectValue displays the selected value or placeholder in the Select trigger.",
|
|
3010
|
+
"interfaces": {
|
|
3011
|
+
"SelectValuePassThrough": {
|
|
3012
|
+
"description": "Defines passthrough(pt) options of SelectValue component.",
|
|
3013
|
+
"relatedProp": "",
|
|
3014
|
+
"props": [
|
|
3015
|
+
{
|
|
3016
|
+
"name": "root",
|
|
3017
|
+
"type": "SelectValuePassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
3018
|
+
"default": "",
|
|
3019
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3020
|
+
}
|
|
3021
|
+
],
|
|
3022
|
+
"methods": []
|
|
3023
|
+
},
|
|
3024
|
+
"SelectValueProps": {
|
|
3025
|
+
"description": "Defines valid properties in SelectValue component.",
|
|
3026
|
+
"relatedProp": "",
|
|
3027
|
+
"extendedTypes": "BaseComponentProps<SelectValueInstance, unknown, SelectValuePassThrough>",
|
|
3028
|
+
"props": [
|
|
3029
|
+
{
|
|
3030
|
+
"name": "ref",
|
|
3031
|
+
"type": "Ref<unknown>",
|
|
3032
|
+
"default": "",
|
|
3033
|
+
"description": "The reference to the component instance."
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
"name": "pIf",
|
|
3037
|
+
"type": "boolean",
|
|
3038
|
+
"default": "true",
|
|
3039
|
+
"description": "Whether the component should be rendered."
|
|
3040
|
+
},
|
|
3041
|
+
{
|
|
3042
|
+
"name": "style",
|
|
3043
|
+
"type": "CSSProperties | ((instance?: SelectValueInstance) => CSSProperties)",
|
|
3044
|
+
"default": "",
|
|
3045
|
+
"description": "The style to apply to the component."
|
|
3046
|
+
},
|
|
3047
|
+
{
|
|
3048
|
+
"name": "className",
|
|
3049
|
+
"type": "string | ((instance?: SelectValueInstance) => string)",
|
|
3050
|
+
"default": "",
|
|
3051
|
+
"description": "The class name to apply to the component."
|
|
3052
|
+
},
|
|
3053
|
+
{
|
|
3054
|
+
"name": "as",
|
|
3055
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3056
|
+
"default": "",
|
|
3057
|
+
"description": "The component type to render."
|
|
3058
|
+
},
|
|
3059
|
+
{
|
|
3060
|
+
"name": "asChild",
|
|
3061
|
+
"type": "boolean",
|
|
3062
|
+
"default": "false",
|
|
3063
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
"name": "instance",
|
|
3067
|
+
"type": "SelectValueInstance",
|
|
3068
|
+
"default": "",
|
|
3069
|
+
"description": "The instance to pass to the component."
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"name": "pt",
|
|
3073
|
+
"type": "SafeRecord<SelectValuePassThrough>",
|
|
3074
|
+
"default": "",
|
|
3075
|
+
"description": "The pass-through props to pass to the component."
|
|
3076
|
+
},
|
|
3077
|
+
{
|
|
3078
|
+
"name": "ptOptions",
|
|
3079
|
+
"type": "PassThroughOptions",
|
|
3080
|
+
"default": "",
|
|
3081
|
+
"description": "The pass-through options to pass to the component."
|
|
3082
|
+
},
|
|
3083
|
+
{
|
|
3084
|
+
"name": "unstyled",
|
|
3085
|
+
"type": "boolean",
|
|
3086
|
+
"default": "",
|
|
3087
|
+
"description": "Whether the component should be rendered without classes."
|
|
3088
|
+
},
|
|
3089
|
+
{
|
|
3090
|
+
"name": "dt",
|
|
3091
|
+
"type": "unknown",
|
|
3092
|
+
"default": "",
|
|
3093
|
+
"description": "The design token to use for the component."
|
|
3094
|
+
},
|
|
3095
|
+
{
|
|
3096
|
+
"name": "styles",
|
|
3097
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3098
|
+
"default": "",
|
|
3099
|
+
"description": "The styles to use for the component."
|
|
3100
|
+
},
|
|
3101
|
+
{
|
|
3102
|
+
"name": "render",
|
|
3103
|
+
"type": "(instance: SelectValueInstance) => ReactNode",
|
|
3104
|
+
"default": "",
|
|
3105
|
+
"description": "The render function to render the component with instance access."
|
|
3106
|
+
},
|
|
3107
|
+
{
|
|
3108
|
+
"name": "children",
|
|
3109
|
+
"type": "any",
|
|
3110
|
+
"default": "",
|
|
3111
|
+
"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."
|
|
3112
|
+
},
|
|
3113
|
+
{
|
|
3114
|
+
"name": "placeholder",
|
|
3115
|
+
"type": "string",
|
|
3116
|
+
"default": "",
|
|
3117
|
+
"description": "Placeholder text to display when no option is selected."
|
|
3118
|
+
},
|
|
3119
|
+
{
|
|
3120
|
+
"name": "[key: string]",
|
|
3121
|
+
"type": "any",
|
|
3122
|
+
"description": ""
|
|
3123
|
+
},
|
|
3124
|
+
{
|
|
3125
|
+
"name": "pt-{optionName}-*",
|
|
3126
|
+
"type": "-",
|
|
3127
|
+
"default": "",
|
|
3128
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3129
|
+
"deprecated": false
|
|
3130
|
+
}
|
|
3131
|
+
],
|
|
3132
|
+
"methods": []
|
|
3133
|
+
},
|
|
3134
|
+
"SelectValueState": {
|
|
3135
|
+
"description": "Defines valid state in SelectValue component.",
|
|
3136
|
+
"relatedProp": "",
|
|
3137
|
+
"props": [],
|
|
3138
|
+
"methods": []
|
|
3139
|
+
},
|
|
3140
|
+
"SelectValueExposes": {
|
|
3141
|
+
"description": "Defines the methods and properties exposed by SelectValue component.",
|
|
3142
|
+
"relatedProp": "",
|
|
3143
|
+
"props": [
|
|
3144
|
+
{
|
|
3145
|
+
"name": "select",
|
|
3146
|
+
"type": "SelectRootInstance",
|
|
3147
|
+
"default": "",
|
|
3148
|
+
"description": "The Select component instance."
|
|
3149
|
+
}
|
|
3150
|
+
],
|
|
3151
|
+
"methods": []
|
|
3152
|
+
}
|
|
3153
|
+
},
|
|
3154
|
+
"types": {
|
|
3155
|
+
"SelectValuePassThroughType": {
|
|
3156
|
+
"description": "Defines passthrough(pt) options type in SelectValue component.",
|
|
3157
|
+
"values": "PassThroughType<SelectValueInstance, E>"
|
|
3158
|
+
},
|
|
3159
|
+
"SelectValueInstance": {
|
|
3160
|
+
"description": "Instance of SelectValue component.",
|
|
3161
|
+
"values": "ComponentInstance<SelectValueProps, SelectValueState, SelectValueExposes>"
|
|
3162
|
+
}
|
|
3163
|
+
},
|
|
3164
|
+
"variables": {}
|
|
3165
|
+
}
|
|
3166
|
+
}
|
|
3167
|
+
]
|