@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,2952 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "TreeContent",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/treecontent.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "TreeContent is a container component that displays content at the content of a Tree.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"TreeContentPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of TreeContent component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "TreeContentPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"TreeContentProps": {
|
|
22
|
+
"description": "Defines valid properties in TreeContent component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<TreeContentInstance, unknown, TreeContentPassThrough>",
|
|
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?: TreeContentInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: TreeContentInstance) => 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": "TreeContentInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<TreeContentPassThrough>",
|
|
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: TreeContentInstance) => 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
|
+
"TreeContentState": {
|
|
126
|
+
"description": "Defines valid state in TreeContent component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"TreeContentExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by TreeContent component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "tree",
|
|
137
|
+
"type": "TreeRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Tree component instance."
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"name": "treenode",
|
|
143
|
+
"type": "TreeNodeInstance",
|
|
144
|
+
"default": "",
|
|
145
|
+
"description": "The TreeNode component instance."
|
|
146
|
+
}
|
|
147
|
+
],
|
|
148
|
+
"methods": []
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
"types": {
|
|
152
|
+
"TreeContentPassThroughType": {
|
|
153
|
+
"description": "Defines passthrough(pt) options type in TreeContent component.",
|
|
154
|
+
"values": "PassThroughType<TreeContentInstance, E>"
|
|
155
|
+
},
|
|
156
|
+
"TreeContentInstance": {
|
|
157
|
+
"description": "Instance of TreeContent component.",
|
|
158
|
+
"values": "ComponentInstance<TreeContentProps, TreeContentState, TreeContentExposes>"
|
|
159
|
+
}
|
|
160
|
+
},
|
|
161
|
+
"variables": {}
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"name": "TreeDropIndicator",
|
|
166
|
+
"source": "apps/showcase/assets/apidoc/treedropindicator.json",
|
|
167
|
+
"data": {
|
|
168
|
+
"description": "TreeDropIndicator renders a visual cue ( `before` / `inside` / `after` overlay)\nwhile a drag-and-drop operation is in progress over a node.",
|
|
169
|
+
"interfaces": {
|
|
170
|
+
"TreeDropIndicatorPassThrough": {
|
|
171
|
+
"description": "Defines passthrough(pt) options of TreeDropIndicator component.",
|
|
172
|
+
"relatedProp": "",
|
|
173
|
+
"props": [
|
|
174
|
+
{
|
|
175
|
+
"name": "root",
|
|
176
|
+
"type": "TreeDropIndicatorPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
177
|
+
"default": "",
|
|
178
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
179
|
+
}
|
|
180
|
+
],
|
|
181
|
+
"methods": []
|
|
182
|
+
},
|
|
183
|
+
"TreeDropIndicatorProps": {
|
|
184
|
+
"description": "Defines valid properties in TreeDropIndicator component.",
|
|
185
|
+
"relatedProp": "",
|
|
186
|
+
"extendedTypes": "BaseComponentProps<TreeDropIndicatorInstance, unknown, TreeDropIndicatorPassThrough>",
|
|
187
|
+
"props": [
|
|
188
|
+
{
|
|
189
|
+
"name": "ref",
|
|
190
|
+
"type": "Ref<unknown>",
|
|
191
|
+
"default": "",
|
|
192
|
+
"description": "The reference to the component instance."
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "pIf",
|
|
196
|
+
"type": "boolean",
|
|
197
|
+
"default": "true",
|
|
198
|
+
"description": "Whether the component should be rendered."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "style",
|
|
202
|
+
"type": "CSSProperties | ((instance?: TreeDropIndicatorInstance) => CSSProperties)",
|
|
203
|
+
"default": "",
|
|
204
|
+
"description": "The style to apply to the component."
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "className",
|
|
208
|
+
"type": "string | ((instance?: TreeDropIndicatorInstance) => string)",
|
|
209
|
+
"default": "",
|
|
210
|
+
"description": "The class name to apply to the component."
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "as",
|
|
214
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
215
|
+
"default": "",
|
|
216
|
+
"description": "The component type to render."
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "asChild",
|
|
220
|
+
"type": "boolean",
|
|
221
|
+
"default": "false",
|
|
222
|
+
"description": "Whether the component should be rendered as a child component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "instance",
|
|
226
|
+
"type": "TreeDropIndicatorInstance",
|
|
227
|
+
"default": "",
|
|
228
|
+
"description": "The instance to pass to the component."
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "pt",
|
|
232
|
+
"type": "SafeRecord<TreeDropIndicatorPassThrough>",
|
|
233
|
+
"default": "",
|
|
234
|
+
"description": "The pass-through props to pass to the component."
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "ptOptions",
|
|
238
|
+
"type": "PassThroughOptions",
|
|
239
|
+
"default": "",
|
|
240
|
+
"description": "The pass-through options to pass to the component."
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"name": "unstyled",
|
|
244
|
+
"type": "boolean",
|
|
245
|
+
"default": "",
|
|
246
|
+
"description": "Whether the component should be rendered without classes."
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "dt",
|
|
250
|
+
"type": "unknown",
|
|
251
|
+
"default": "",
|
|
252
|
+
"description": "The design token to use for the component."
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "styles",
|
|
256
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
257
|
+
"default": "",
|
|
258
|
+
"description": "The styles to use for the component."
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "render",
|
|
262
|
+
"type": "(instance: TreeDropIndicatorInstance) => ReactNode",
|
|
263
|
+
"default": "",
|
|
264
|
+
"description": "The render function to render the component with instance access."
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "children",
|
|
268
|
+
"type": "any",
|
|
269
|
+
"default": "",
|
|
270
|
+
"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."
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "position",
|
|
274
|
+
"type": "\"after\" | \"before\"",
|
|
275
|
+
"default": "",
|
|
276
|
+
"description": "Which drop point this indicator represents. Render two siblings of\n `Tree.Content` — one with `position=\"before\"` and one with `position=\"after\"` .\nEach renders only while its respective drop point is active."
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "[key: string]",
|
|
280
|
+
"type": "any",
|
|
281
|
+
"description": ""
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "pt-{optionName}-*",
|
|
285
|
+
"type": "-",
|
|
286
|
+
"default": "",
|
|
287
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
288
|
+
"deprecated": false
|
|
289
|
+
}
|
|
290
|
+
],
|
|
291
|
+
"methods": []
|
|
292
|
+
},
|
|
293
|
+
"TreeDropIndicatorState": {
|
|
294
|
+
"description": "Defines valid state in TreeDropIndicator component.",
|
|
295
|
+
"relatedProp": "",
|
|
296
|
+
"props": [],
|
|
297
|
+
"methods": []
|
|
298
|
+
},
|
|
299
|
+
"TreeDropIndicatorExposes": {
|
|
300
|
+
"description": "Defines the methods and properties exposed by TreeDropIndicator component.",
|
|
301
|
+
"relatedProp": "",
|
|
302
|
+
"props": [
|
|
303
|
+
{
|
|
304
|
+
"name": "tree",
|
|
305
|
+
"type": "TreeRootInstance",
|
|
306
|
+
"default": "",
|
|
307
|
+
"description": "The Tree component instance."
|
|
308
|
+
}
|
|
309
|
+
],
|
|
310
|
+
"methods": []
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"types": {
|
|
314
|
+
"TreeDropIndicatorPassThroughType": {
|
|
315
|
+
"description": "Defines passthrough(pt) options type in TreeDropIndicator component.",
|
|
316
|
+
"values": "PassThroughType<TreeDropIndicatorInstance, E>"
|
|
317
|
+
},
|
|
318
|
+
"TreeDropIndicatorInstance": {
|
|
319
|
+
"description": "Instance of TreeDropIndicator component.",
|
|
320
|
+
"values": "ComponentInstance<TreeDropIndicatorProps, TreeDropIndicatorState, TreeDropIndicatorExposes>"
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"variables": {}
|
|
324
|
+
}
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
"name": "TreeEmpty",
|
|
328
|
+
"source": "apps/showcase/assets/apidoc/treeempty.json",
|
|
329
|
+
"data": {
|
|
330
|
+
"description": "TreeEmpty is a component that displays a message when the tree is empty.",
|
|
331
|
+
"interfaces": {
|
|
332
|
+
"TreeEmptyPassThrough": {
|
|
333
|
+
"description": "Defines passthrough(pt) options of TreeEmpty component.",
|
|
334
|
+
"relatedProp": "",
|
|
335
|
+
"props": [
|
|
336
|
+
{
|
|
337
|
+
"name": "root",
|
|
338
|
+
"type": "TreeEmptyPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
339
|
+
"default": "",
|
|
340
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
341
|
+
}
|
|
342
|
+
],
|
|
343
|
+
"methods": []
|
|
344
|
+
},
|
|
345
|
+
"TreeEmptyProps": {
|
|
346
|
+
"description": "Defines valid properties in TreeEmpty component.",
|
|
347
|
+
"relatedProp": "",
|
|
348
|
+
"extendedTypes": "BaseComponentProps<TreeEmptyInstance, unknown, TreeEmptyPassThrough>",
|
|
349
|
+
"props": [
|
|
350
|
+
{
|
|
351
|
+
"name": "ref",
|
|
352
|
+
"type": "Ref<unknown>",
|
|
353
|
+
"default": "",
|
|
354
|
+
"description": "The reference to the component instance."
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "pIf",
|
|
358
|
+
"type": "boolean",
|
|
359
|
+
"default": "true",
|
|
360
|
+
"description": "Whether the component should be rendered."
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "style",
|
|
364
|
+
"type": "CSSProperties | ((instance?: TreeEmptyInstance) => CSSProperties)",
|
|
365
|
+
"default": "",
|
|
366
|
+
"description": "The style to apply to the component."
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "className",
|
|
370
|
+
"type": "string | ((instance?: TreeEmptyInstance) => string)",
|
|
371
|
+
"default": "",
|
|
372
|
+
"description": "The class name to apply to the component."
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "as",
|
|
376
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
377
|
+
"default": "",
|
|
378
|
+
"description": "The component type to render."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "asChild",
|
|
382
|
+
"type": "boolean",
|
|
383
|
+
"default": "false",
|
|
384
|
+
"description": "Whether the component should be rendered as a child component."
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "instance",
|
|
388
|
+
"type": "TreeEmptyInstance",
|
|
389
|
+
"default": "",
|
|
390
|
+
"description": "The instance to pass to the component."
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "pt",
|
|
394
|
+
"type": "SafeRecord<TreeEmptyPassThrough>",
|
|
395
|
+
"default": "",
|
|
396
|
+
"description": "The pass-through props to pass to the component."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "ptOptions",
|
|
400
|
+
"type": "PassThroughOptions",
|
|
401
|
+
"default": "",
|
|
402
|
+
"description": "The pass-through options to pass to the component."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "unstyled",
|
|
406
|
+
"type": "boolean",
|
|
407
|
+
"default": "",
|
|
408
|
+
"description": "Whether the component should be rendered without classes."
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"name": "dt",
|
|
412
|
+
"type": "unknown",
|
|
413
|
+
"default": "",
|
|
414
|
+
"description": "The design token to use for the component."
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "styles",
|
|
418
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
419
|
+
"default": "",
|
|
420
|
+
"description": "The styles to use for the component."
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "render",
|
|
424
|
+
"type": "(instance: TreeEmptyInstance) => ReactNode",
|
|
425
|
+
"default": "",
|
|
426
|
+
"description": "The render function to render the component with instance access."
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "children",
|
|
430
|
+
"type": "any",
|
|
431
|
+
"default": "",
|
|
432
|
+
"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."
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"name": "[key: string]",
|
|
436
|
+
"type": "any",
|
|
437
|
+
"description": ""
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"name": "pt-{optionName}-*",
|
|
441
|
+
"type": "-",
|
|
442
|
+
"default": "",
|
|
443
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
444
|
+
"deprecated": false
|
|
445
|
+
}
|
|
446
|
+
],
|
|
447
|
+
"methods": []
|
|
448
|
+
},
|
|
449
|
+
"TreeEmptyState": {
|
|
450
|
+
"description": "Defines valid state in TreeEmpty component.",
|
|
451
|
+
"relatedProp": "",
|
|
452
|
+
"props": [],
|
|
453
|
+
"methods": []
|
|
454
|
+
},
|
|
455
|
+
"TreeEmptyExposes": {
|
|
456
|
+
"description": "Defines the methods and properties exposed by TreeEmpty component.",
|
|
457
|
+
"relatedProp": "",
|
|
458
|
+
"props": [
|
|
459
|
+
{
|
|
460
|
+
"name": "tree",
|
|
461
|
+
"type": "TreeRootInstance",
|
|
462
|
+
"default": "",
|
|
463
|
+
"description": "The TreeEmpty component instance."
|
|
464
|
+
}
|
|
465
|
+
],
|
|
466
|
+
"methods": []
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"types": {
|
|
470
|
+
"TreeEmptyPassThroughType": {
|
|
471
|
+
"description": "Defines passthrough(pt) options type in TreeEmpty component.",
|
|
472
|
+
"values": "PassThroughType<TreeEmptyInstance, E>"
|
|
473
|
+
},
|
|
474
|
+
"TreeEmptyInstance": {
|
|
475
|
+
"description": "Instance of TreeEmpty component.",
|
|
476
|
+
"values": "ComponentInstance<TreeEmptyProps, TreeEmptyState, TreeEmptyExposes>"
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
"variables": {}
|
|
480
|
+
}
|
|
481
|
+
},
|
|
482
|
+
{
|
|
483
|
+
"name": "TreeFilter",
|
|
484
|
+
"source": "apps/showcase/assets/apidoc/treefilter.json",
|
|
485
|
+
"data": {
|
|
486
|
+
"description": "TreeFilter is a component that provides filtering capabilities to the Tree component.",
|
|
487
|
+
"interfaces": {
|
|
488
|
+
"TreeFilterPassThrough": {
|
|
489
|
+
"description": "Defines passthrough(pt) options of TreeFilter component.",
|
|
490
|
+
"relatedProp": "",
|
|
491
|
+
"props": [
|
|
492
|
+
{
|
|
493
|
+
"name": "root",
|
|
494
|
+
"type": "TreeFilterPassThroughType<HTMLAttributes<HTMLElement>>",
|
|
495
|
+
"default": "",
|
|
496
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
497
|
+
}
|
|
498
|
+
],
|
|
499
|
+
"methods": []
|
|
500
|
+
},
|
|
501
|
+
"TreeFilterProps": {
|
|
502
|
+
"description": "Defines valid properties in TreeFilter component.",
|
|
503
|
+
"relatedProp": "",
|
|
504
|
+
"extendedTypes": "BaseComponentProps<TreeFilterInstance, unknown, TreeFilterPassThrough>",
|
|
505
|
+
"props": [
|
|
506
|
+
{
|
|
507
|
+
"name": "ref",
|
|
508
|
+
"type": "Ref<unknown>",
|
|
509
|
+
"default": "",
|
|
510
|
+
"description": "The reference to the component instance."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "pIf",
|
|
514
|
+
"type": "boolean",
|
|
515
|
+
"default": "true",
|
|
516
|
+
"description": "Whether the component should be rendered."
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "style",
|
|
520
|
+
"type": "CSSProperties | ((instance?: TreeFilterInstance) => CSSProperties)",
|
|
521
|
+
"default": "",
|
|
522
|
+
"description": "The style to apply to the component."
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"name": "className",
|
|
526
|
+
"type": "string | ((instance?: TreeFilterInstance) => string)",
|
|
527
|
+
"default": "",
|
|
528
|
+
"description": "The class name to apply to the component."
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "as",
|
|
532
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
533
|
+
"default": "",
|
|
534
|
+
"description": "The component type to render."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "asChild",
|
|
538
|
+
"type": "boolean",
|
|
539
|
+
"default": "false",
|
|
540
|
+
"description": "Whether the component should be rendered as a child component."
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"name": "instance",
|
|
544
|
+
"type": "TreeFilterInstance",
|
|
545
|
+
"default": "",
|
|
546
|
+
"description": "The instance to pass to the component."
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "pt",
|
|
550
|
+
"type": "SafeRecord<TreeFilterPassThrough>",
|
|
551
|
+
"default": "",
|
|
552
|
+
"description": "The pass-through props to pass to the component."
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "ptOptions",
|
|
556
|
+
"type": "PassThroughOptions",
|
|
557
|
+
"default": "",
|
|
558
|
+
"description": "The pass-through options to pass to the component."
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"name": "unstyled",
|
|
562
|
+
"type": "boolean",
|
|
563
|
+
"default": "",
|
|
564
|
+
"description": "Whether the component should be rendered without classes."
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"name": "dt",
|
|
568
|
+
"type": "unknown",
|
|
569
|
+
"default": "",
|
|
570
|
+
"description": "The design token to use for the component."
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "styles",
|
|
574
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
575
|
+
"default": "",
|
|
576
|
+
"description": "The styles to use for the component."
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"name": "render",
|
|
580
|
+
"type": "(instance: TreeFilterInstance) => ReactNode",
|
|
581
|
+
"default": "",
|
|
582
|
+
"description": "The render function to render the component with instance access."
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "children",
|
|
586
|
+
"type": "any",
|
|
587
|
+
"default": "",
|
|
588
|
+
"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."
|
|
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
|
+
"TreeFilterState": {
|
|
606
|
+
"description": "Defines valid state in TreeFilter component.",
|
|
607
|
+
"relatedProp": "",
|
|
608
|
+
"props": [],
|
|
609
|
+
"methods": []
|
|
610
|
+
},
|
|
611
|
+
"TreeFilterExposes": {
|
|
612
|
+
"description": "Defines the methods and properties exposed by TreeFilter component.",
|
|
613
|
+
"relatedProp": "",
|
|
614
|
+
"props": [
|
|
615
|
+
{
|
|
616
|
+
"name": "tree",
|
|
617
|
+
"type": "TreeRootInstance",
|
|
618
|
+
"default": "",
|
|
619
|
+
"description": "The TreeFilter component instance."
|
|
620
|
+
}
|
|
621
|
+
],
|
|
622
|
+
"methods": []
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
"types": {
|
|
626
|
+
"TreeFilterPassThroughType": {
|
|
627
|
+
"description": "Defines passthrough(pt) options type in TreeFilter component.",
|
|
628
|
+
"values": "PassThroughType<TreeFilterInstance, E>"
|
|
629
|
+
},
|
|
630
|
+
"TreeFilterInstance": {
|
|
631
|
+
"description": "Instance of TreeFilter component.",
|
|
632
|
+
"values": "ComponentInstance<TreeFilterProps, TreeFilterState, TreeFilterExposes>"
|
|
633
|
+
}
|
|
634
|
+
},
|
|
635
|
+
"variables": {}
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "TreeFooter",
|
|
640
|
+
"source": "apps/showcase/assets/apidoc/treefooter.json",
|
|
641
|
+
"data": {
|
|
642
|
+
"description": "TreeFooter is a component that represents the footer section of the tree.",
|
|
643
|
+
"interfaces": {
|
|
644
|
+
"TreeFooterPassThrough": {
|
|
645
|
+
"description": "Defines passthrough(pt) options of TreeFooter component.",
|
|
646
|
+
"relatedProp": "",
|
|
647
|
+
"props": [
|
|
648
|
+
{
|
|
649
|
+
"name": "root",
|
|
650
|
+
"type": "TreeFooterPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
651
|
+
"default": "",
|
|
652
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
653
|
+
}
|
|
654
|
+
],
|
|
655
|
+
"methods": []
|
|
656
|
+
},
|
|
657
|
+
"TreeFooterProps": {
|
|
658
|
+
"description": "Defines valid properties in TreeFooter component.",
|
|
659
|
+
"relatedProp": "",
|
|
660
|
+
"extendedTypes": "BaseComponentProps<TreeFooterInstance, unknown, TreeFooterPassThrough>",
|
|
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?: TreeFooterInstance) => CSSProperties)",
|
|
677
|
+
"default": "",
|
|
678
|
+
"description": "The style to apply to the component."
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "className",
|
|
682
|
+
"type": "string | ((instance?: TreeFooterInstance) => 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": "TreeFooterInstance",
|
|
701
|
+
"default": "",
|
|
702
|
+
"description": "The instance to pass to the component."
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "pt",
|
|
706
|
+
"type": "SafeRecord<TreeFooterPassThrough>",
|
|
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: TreeFooterInstance) => 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
|
+
"TreeFooterState": {
|
|
762
|
+
"description": "Defines valid state in TreeFooter component.",
|
|
763
|
+
"relatedProp": "",
|
|
764
|
+
"props": [],
|
|
765
|
+
"methods": []
|
|
766
|
+
},
|
|
767
|
+
"TreeFooterExposes": {
|
|
768
|
+
"description": "Defines the methods and properties exposed by TreeFooter component.",
|
|
769
|
+
"relatedProp": "",
|
|
770
|
+
"props": [
|
|
771
|
+
{
|
|
772
|
+
"name": "tree",
|
|
773
|
+
"type": "TreeRootInstance",
|
|
774
|
+
"default": "",
|
|
775
|
+
"description": "The TreeFooter component instance."
|
|
776
|
+
}
|
|
777
|
+
],
|
|
778
|
+
"methods": []
|
|
779
|
+
}
|
|
780
|
+
},
|
|
781
|
+
"types": {
|
|
782
|
+
"TreeFooterPassThroughType": {
|
|
783
|
+
"description": "Defines passthrough(pt) options type in TreeFooter component.",
|
|
784
|
+
"values": "PassThroughType<TreeFooterInstance, E>"
|
|
785
|
+
},
|
|
786
|
+
"TreeFooterInstance": {
|
|
787
|
+
"description": "Instance of TreeFooter component.",
|
|
788
|
+
"values": "ComponentInstance<TreeFooterProps, TreeFooterState, TreeFooterExposes>"
|
|
789
|
+
}
|
|
790
|
+
},
|
|
791
|
+
"variables": {}
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "TreeHeader",
|
|
796
|
+
"source": "apps/showcase/assets/apidoc/treeheader.json",
|
|
797
|
+
"data": {
|
|
798
|
+
"description": "TreeHeader is a component that represents the header section of the tree.",
|
|
799
|
+
"interfaces": {
|
|
800
|
+
"TreeHeaderPassThrough": {
|
|
801
|
+
"description": "Defines passthrough(pt) options of TreeHeader component.",
|
|
802
|
+
"relatedProp": "",
|
|
803
|
+
"props": [
|
|
804
|
+
{
|
|
805
|
+
"name": "root",
|
|
806
|
+
"type": "TreeHeaderPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
807
|
+
"default": "",
|
|
808
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
809
|
+
}
|
|
810
|
+
],
|
|
811
|
+
"methods": []
|
|
812
|
+
},
|
|
813
|
+
"TreeHeaderProps": {
|
|
814
|
+
"description": "Defines valid properties in TreeHeader component.",
|
|
815
|
+
"relatedProp": "",
|
|
816
|
+
"extendedTypes": "BaseComponentProps<TreeHeaderInstance, unknown, TreeHeaderPassThrough>",
|
|
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?: TreeHeaderInstance) => CSSProperties)",
|
|
833
|
+
"default": "",
|
|
834
|
+
"description": "The style to apply to the component."
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "className",
|
|
838
|
+
"type": "string | ((instance?: TreeHeaderInstance) => 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": "TreeHeaderInstance",
|
|
857
|
+
"default": "",
|
|
858
|
+
"description": "The instance to pass to the component."
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "pt",
|
|
862
|
+
"type": "SafeRecord<TreeHeaderPassThrough>",
|
|
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: TreeHeaderInstance) => 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
|
+
"TreeHeaderState": {
|
|
918
|
+
"description": "Defines valid state in TreeHeader component.",
|
|
919
|
+
"relatedProp": "",
|
|
920
|
+
"props": [],
|
|
921
|
+
"methods": []
|
|
922
|
+
},
|
|
923
|
+
"TreeHeaderExposes": {
|
|
924
|
+
"description": "Defines the methods and properties exposed by TreeHeader component.",
|
|
925
|
+
"relatedProp": "",
|
|
926
|
+
"props": [
|
|
927
|
+
{
|
|
928
|
+
"name": "tree",
|
|
929
|
+
"type": "TreeRootInstance",
|
|
930
|
+
"default": "",
|
|
931
|
+
"description": "The TreeHeader component instance."
|
|
932
|
+
}
|
|
933
|
+
],
|
|
934
|
+
"methods": []
|
|
935
|
+
}
|
|
936
|
+
},
|
|
937
|
+
"types": {
|
|
938
|
+
"TreeHeaderPassThroughType": {
|
|
939
|
+
"description": "Defines passthrough(pt) options type in TreeHeader component.",
|
|
940
|
+
"values": "PassThroughType<TreeHeaderInstance, E>"
|
|
941
|
+
},
|
|
942
|
+
"TreeHeaderInstance": {
|
|
943
|
+
"description": "Instance of TreeHeader component.",
|
|
944
|
+
"values": "ComponentInstance<TreeHeaderProps, TreeHeaderState, TreeHeaderExposes>"
|
|
945
|
+
}
|
|
946
|
+
},
|
|
947
|
+
"variables": {}
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "TreeLabel",
|
|
952
|
+
"source": "apps/showcase/assets/apidoc/treelabel.json",
|
|
953
|
+
"data": {
|
|
954
|
+
"description": "TreeLabel is a container component that displays label at the label of a Tree.",
|
|
955
|
+
"interfaces": {
|
|
956
|
+
"TreeLabelPassThrough": {
|
|
957
|
+
"description": "Defines passthrough(pt) options of TreeLabel component.",
|
|
958
|
+
"relatedProp": "",
|
|
959
|
+
"props": [
|
|
960
|
+
{
|
|
961
|
+
"name": "root",
|
|
962
|
+
"type": "TreeLabelPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
963
|
+
"default": "",
|
|
964
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
965
|
+
}
|
|
966
|
+
],
|
|
967
|
+
"methods": []
|
|
968
|
+
},
|
|
969
|
+
"TreeLabelProps": {
|
|
970
|
+
"description": "Defines valid properties in TreeLabel component.",
|
|
971
|
+
"relatedProp": "",
|
|
972
|
+
"extendedTypes": "BaseComponentProps<TreeLabelInstance, unknown, TreeLabelPassThrough>",
|
|
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?: TreeLabelInstance) => CSSProperties)",
|
|
989
|
+
"default": "",
|
|
990
|
+
"description": "The style to apply to the component."
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "className",
|
|
994
|
+
"type": "string | ((instance?: TreeLabelInstance) => 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": "TreeLabelInstance",
|
|
1013
|
+
"default": "",
|
|
1014
|
+
"description": "The instance to pass to the component."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "pt",
|
|
1018
|
+
"type": "SafeRecord<TreeLabelPassThrough>",
|
|
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: TreeLabelInstance) => 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": "[key: string]",
|
|
1060
|
+
"type": "any",
|
|
1061
|
+
"description": ""
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "pt-{optionName}-*",
|
|
1065
|
+
"type": "-",
|
|
1066
|
+
"default": "",
|
|
1067
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1068
|
+
"deprecated": false
|
|
1069
|
+
}
|
|
1070
|
+
],
|
|
1071
|
+
"methods": []
|
|
1072
|
+
},
|
|
1073
|
+
"TreeLabelState": {
|
|
1074
|
+
"description": "Defines valid state in TreeLabel component.",
|
|
1075
|
+
"relatedProp": "",
|
|
1076
|
+
"props": [],
|
|
1077
|
+
"methods": []
|
|
1078
|
+
},
|
|
1079
|
+
"TreeLabelExposes": {
|
|
1080
|
+
"description": "Defines the methods and properties exposed by TreeLabel component.",
|
|
1081
|
+
"relatedProp": "",
|
|
1082
|
+
"props": [
|
|
1083
|
+
{
|
|
1084
|
+
"name": "tree",
|
|
1085
|
+
"type": "TreeRootInstance",
|
|
1086
|
+
"default": "",
|
|
1087
|
+
"description": "The Tree component instance."
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
"name": "treenode",
|
|
1091
|
+
"type": "TreeNodeInstance",
|
|
1092
|
+
"default": "",
|
|
1093
|
+
"description": "The TreeNode component instance."
|
|
1094
|
+
}
|
|
1095
|
+
],
|
|
1096
|
+
"methods": []
|
|
1097
|
+
}
|
|
1098
|
+
},
|
|
1099
|
+
"types": {
|
|
1100
|
+
"TreeLabelPassThroughType": {
|
|
1101
|
+
"description": "Defines passthrough(pt) options type in TreeLabel component.",
|
|
1102
|
+
"values": "PassThroughType<TreeLabelInstance, E>"
|
|
1103
|
+
},
|
|
1104
|
+
"TreeLabelInstance": {
|
|
1105
|
+
"description": "Instance of TreeLabel component.",
|
|
1106
|
+
"values": "ComponentInstance<TreeLabelProps, TreeLabelState, TreeLabelExposes>"
|
|
1107
|
+
}
|
|
1108
|
+
},
|
|
1109
|
+
"variables": {}
|
|
1110
|
+
}
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "TreeLoading",
|
|
1114
|
+
"source": "apps/showcase/assets/apidoc/treeloading.json",
|
|
1115
|
+
"data": {
|
|
1116
|
+
"description": "TreeLoading renders a loading overlay over the tree while `Tree.Root.loading` is true.",
|
|
1117
|
+
"interfaces": {
|
|
1118
|
+
"TreeLoadingPassThrough": {
|
|
1119
|
+
"description": "Defines passthrough(pt) options of TreeLoading component.",
|
|
1120
|
+
"relatedProp": "",
|
|
1121
|
+
"props": [
|
|
1122
|
+
{
|
|
1123
|
+
"name": "root",
|
|
1124
|
+
"type": "TreeLoadingPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1125
|
+
"default": "",
|
|
1126
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1127
|
+
}
|
|
1128
|
+
],
|
|
1129
|
+
"methods": []
|
|
1130
|
+
},
|
|
1131
|
+
"TreeLoadingProps": {
|
|
1132
|
+
"description": "Defines valid properties in TreeLoading component.",
|
|
1133
|
+
"relatedProp": "",
|
|
1134
|
+
"extendedTypes": "BaseComponentProps<TreeLoadingInstance, unknown, TreeLoadingPassThrough>",
|
|
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?: TreeLoadingInstance) => CSSProperties)",
|
|
1151
|
+
"default": "",
|
|
1152
|
+
"description": "The style to apply to the component."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "className",
|
|
1156
|
+
"type": "string | ((instance?: TreeLoadingInstance) => 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": "TreeLoadingInstance",
|
|
1175
|
+
"default": "",
|
|
1176
|
+
"description": "The instance to pass to the component."
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"name": "pt",
|
|
1180
|
+
"type": "SafeRecord<TreeLoadingPassThrough>",
|
|
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: TreeLoadingInstance) => 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
|
+
"TreeLoadingState": {
|
|
1236
|
+
"description": "Defines valid state in TreeLoading component.",
|
|
1237
|
+
"relatedProp": "",
|
|
1238
|
+
"props": [],
|
|
1239
|
+
"methods": []
|
|
1240
|
+
},
|
|
1241
|
+
"TreeLoadingExposes": {
|
|
1242
|
+
"description": "Defines the methods and properties exposed by TreeLoading component.",
|
|
1243
|
+
"relatedProp": "",
|
|
1244
|
+
"props": [
|
|
1245
|
+
{
|
|
1246
|
+
"name": "tree",
|
|
1247
|
+
"type": "TreeRootInstance",
|
|
1248
|
+
"default": "",
|
|
1249
|
+
"description": "The Tree component instance."
|
|
1250
|
+
}
|
|
1251
|
+
],
|
|
1252
|
+
"methods": []
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
"types": {
|
|
1256
|
+
"TreeLoadingPassThroughType": {
|
|
1257
|
+
"description": "Defines passthrough(pt) options type in TreeLoading component.",
|
|
1258
|
+
"values": "PassThroughType<TreeLoadingInstance, E>"
|
|
1259
|
+
},
|
|
1260
|
+
"TreeLoadingInstance": {
|
|
1261
|
+
"description": "Instance of TreeLoading component.",
|
|
1262
|
+
"values": "ComponentInstance<TreeLoadingProps, TreeLoadingState, TreeLoadingExposes>"
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
"variables": {}
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
{
|
|
1269
|
+
"name": "TreeNode",
|
|
1270
|
+
"source": "apps/showcase/assets/apidoc/treenode.json",
|
|
1271
|
+
"data": {
|
|
1272
|
+
"description": "TreeNode renders a single row inside a flat-iterated `Tree.Nodes` .",
|
|
1273
|
+
"interfaces": {
|
|
1274
|
+
"TreeNodePassThrough": {
|
|
1275
|
+
"description": "Defines passthrough(pt) options of TreeNode component.",
|
|
1276
|
+
"relatedProp": "",
|
|
1277
|
+
"props": [
|
|
1278
|
+
{
|
|
1279
|
+
"name": "root",
|
|
1280
|
+
"type": "TreeNodePassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
1281
|
+
"default": "",
|
|
1282
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1283
|
+
}
|
|
1284
|
+
],
|
|
1285
|
+
"methods": []
|
|
1286
|
+
},
|
|
1287
|
+
"TreeNodeProps": {
|
|
1288
|
+
"description": "Defines valid properties in TreeNode component.",
|
|
1289
|
+
"relatedProp": "",
|
|
1290
|
+
"extendedTypes": "BaseComponentProps<TreeNodeInstance, unknown, TreeNodePassThrough>",
|
|
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?: TreeNodeInstance) => CSSProperties)",
|
|
1307
|
+
"default": "",
|
|
1308
|
+
"description": "The style to apply to the component."
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"name": "className",
|
|
1312
|
+
"type": "string | ((instance?: TreeNodeInstance) => 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": "TreeNodeInstance",
|
|
1331
|
+
"default": "",
|
|
1332
|
+
"description": "The instance to pass to the component."
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "pt",
|
|
1336
|
+
"type": "SafeRecord<TreeNodePassThrough>",
|
|
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: TreeNodeInstance) => 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": "uKey",
|
|
1378
|
+
"type": "string",
|
|
1379
|
+
"default": "",
|
|
1380
|
+
"description": "The key of the node to render. Looked up in the parent `Tree.Root` 's `nodeMap` .\nIf the key is unknown (or omitted) a placeholder with `aria-busy` is rendered\nand a dev-mode warning is emitted."
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"name": "[key: string]",
|
|
1384
|
+
"type": "any",
|
|
1385
|
+
"description": ""
|
|
1386
|
+
},
|
|
1387
|
+
{
|
|
1388
|
+
"name": "pt-{optionName}-*",
|
|
1389
|
+
"type": "-",
|
|
1390
|
+
"default": "",
|
|
1391
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1392
|
+
"deprecated": false
|
|
1393
|
+
}
|
|
1394
|
+
],
|
|
1395
|
+
"methods": []
|
|
1396
|
+
},
|
|
1397
|
+
"TreeNodeState": {
|
|
1398
|
+
"description": "Defines valid state in TreeNode component.",
|
|
1399
|
+
"relatedProp": "",
|
|
1400
|
+
"props": [],
|
|
1401
|
+
"methods": []
|
|
1402
|
+
},
|
|
1403
|
+
"TreeNodeExposes": {
|
|
1404
|
+
"description": "Defines the methods and properties exposed by TreeNode component.",
|
|
1405
|
+
"relatedProp": "",
|
|
1406
|
+
"props": [
|
|
1407
|
+
{
|
|
1408
|
+
"name": "tree",
|
|
1409
|
+
"type": "TreeRootInstance",
|
|
1410
|
+
"default": "",
|
|
1411
|
+
"description": "The Tree component instance."
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
"name": "parentNode",
|
|
1415
|
+
"type": "TreeNodeInstance",
|
|
1416
|
+
"default": "",
|
|
1417
|
+
"description": "The parent TreeNode component instance (in the React tree, not the data tree)."
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"name": "node",
|
|
1421
|
+
"type": "TreeNodeData",
|
|
1422
|
+
"default": "",
|
|
1423
|
+
"description": "The underlying node data (looked up from `uKey` )."
|
|
1424
|
+
},
|
|
1425
|
+
{
|
|
1426
|
+
"name": "state",
|
|
1427
|
+
"type": "UseTreeNodeState",
|
|
1428
|
+
"default": "",
|
|
1429
|
+
"description": "The computed state from useTreeNode headless hook."
|
|
1430
|
+
},
|
|
1431
|
+
{
|
|
1432
|
+
"name": "nodeProps",
|
|
1433
|
+
"type": "UseTreeNodeProps",
|
|
1434
|
+
"default": "",
|
|
1435
|
+
"description": "Pre-built props for the node root element (li)."
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"name": "contentProps",
|
|
1439
|
+
"type": "UseTreeNodeContentElProps",
|
|
1440
|
+
"default": "",
|
|
1441
|
+
"description": "Pre-built props for the content element (div)."
|
|
1442
|
+
},
|
|
1443
|
+
{
|
|
1444
|
+
"name": "dropPointProps",
|
|
1445
|
+
"type": "UseTreeNodeDropPointElProps",
|
|
1446
|
+
"default": "",
|
|
1447
|
+
"description": "Pre-built props for drop point indicators."
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"name": "expanded",
|
|
1451
|
+
"type": "boolean",
|
|
1452
|
+
"default": "",
|
|
1453
|
+
"description": "Whether the node is expanded."
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "checked",
|
|
1457
|
+
"type": "boolean",
|
|
1458
|
+
"default": "",
|
|
1459
|
+
"description": "Whether the node is checked (for checkbox mode)."
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "partialChecked",
|
|
1463
|
+
"type": "boolean",
|
|
1464
|
+
"default": "",
|
|
1465
|
+
"description": "Whether the node is partially checked (for checkbox mode)."
|
|
1466
|
+
},
|
|
1467
|
+
{
|
|
1468
|
+
"name": "selected",
|
|
1469
|
+
"type": "boolean",
|
|
1470
|
+
"default": "",
|
|
1471
|
+
"description": "Whether the node is selected (for single/multiple mode)."
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"name": "leaf",
|
|
1475
|
+
"type": "boolean",
|
|
1476
|
+
"default": "",
|
|
1477
|
+
"description": "Whether the node is a leaf node (has no children)."
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"name": "setSize",
|
|
1481
|
+
"type": "number",
|
|
1482
|
+
"default": "",
|
|
1483
|
+
"description": "The total number of siblings at this level."
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"name": "posInSet",
|
|
1487
|
+
"type": "number",
|
|
1488
|
+
"default": "",
|
|
1489
|
+
"description": "The position of this node among its siblings (1-based)."
|
|
1490
|
+
},
|
|
1491
|
+
{
|
|
1492
|
+
"name": "level",
|
|
1493
|
+
"type": "number",
|
|
1494
|
+
"default": "",
|
|
1495
|
+
"description": "The depth level of the node in the tree (1-based)."
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
"name": "isNodeDropActive",
|
|
1499
|
+
"type": "boolean",
|
|
1500
|
+
"default": "",
|
|
1501
|
+
"description": "Whether this node is currently being dragged over (center zone)."
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"name": "isPrevDropPointActive",
|
|
1505
|
+
"type": "boolean",
|
|
1506
|
+
"default": "",
|
|
1507
|
+
"description": "Whether the previous drop point is active."
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "isNextDropPointActive",
|
|
1511
|
+
"type": "boolean",
|
|
1512
|
+
"default": "",
|
|
1513
|
+
"description": "Whether the next drop point is active."
|
|
1514
|
+
},
|
|
1515
|
+
{
|
|
1516
|
+
"name": "isDraggable",
|
|
1517
|
+
"type": "boolean",
|
|
1518
|
+
"default": "",
|
|
1519
|
+
"description": "Whether this node is draggable."
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"name": "nodeTouched",
|
|
1523
|
+
"type": "boolean",
|
|
1524
|
+
"default": "",
|
|
1525
|
+
"description": "Whether the node was touched (for mobile interactions)."
|
|
1526
|
+
}
|
|
1527
|
+
],
|
|
1528
|
+
"methods": []
|
|
1529
|
+
}
|
|
1530
|
+
},
|
|
1531
|
+
"types": {
|
|
1532
|
+
"TreeNodePassThroughType": {
|
|
1533
|
+
"description": "Defines passthrough(pt) options type in TreeNode component.",
|
|
1534
|
+
"values": "PassThroughType<TreeNodeInstance, E>"
|
|
1535
|
+
},
|
|
1536
|
+
"TreeNodeInstance": {
|
|
1537
|
+
"description": "Instance of TreeNode component.",
|
|
1538
|
+
"values": "ComponentInstance<TreeNodeProps, TreeNodeState, TreeNodeExposes>"
|
|
1539
|
+
}
|
|
1540
|
+
},
|
|
1541
|
+
"variables": {}
|
|
1542
|
+
}
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"name": "TreeNodes",
|
|
1546
|
+
"source": "apps/showcase/assets/apidoc/treenodes.json",
|
|
1547
|
+
"data": {
|
|
1548
|
+
"description": "TreeNodes is a flat iterator that renders one row per visible node.",
|
|
1549
|
+
"interfaces": {
|
|
1550
|
+
"TreeNodesPassThrough": {
|
|
1551
|
+
"description": "Defines passthrough(pt) options of TreeNodes component.",
|
|
1552
|
+
"relatedProp": "",
|
|
1553
|
+
"props": [
|
|
1554
|
+
{
|
|
1555
|
+
"name": "root",
|
|
1556
|
+
"type": "TreeNodesPassThroughType<HTMLAttributes<HTMLUListElement>>",
|
|
1557
|
+
"default": "",
|
|
1558
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1559
|
+
}
|
|
1560
|
+
],
|
|
1561
|
+
"methods": []
|
|
1562
|
+
},
|
|
1563
|
+
"TreeNodesProps": {
|
|
1564
|
+
"description": "Defines valid properties in TreeNodes component.",
|
|
1565
|
+
"relatedProp": "",
|
|
1566
|
+
"extendedTypes": "BaseComponentProps<TreeNodesInstance, unknown, TreeNodesPassThrough>",
|
|
1567
|
+
"props": [
|
|
1568
|
+
{
|
|
1569
|
+
"name": "ref",
|
|
1570
|
+
"type": "Ref<unknown>",
|
|
1571
|
+
"default": "",
|
|
1572
|
+
"description": "The reference to the component instance."
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "pIf",
|
|
1576
|
+
"type": "boolean",
|
|
1577
|
+
"default": "true",
|
|
1578
|
+
"description": "Whether the component should be rendered."
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"name": "style",
|
|
1582
|
+
"type": "CSSProperties | ((instance?: TreeNodesInstance) => CSSProperties)",
|
|
1583
|
+
"default": "",
|
|
1584
|
+
"description": "The style to apply to the component."
|
|
1585
|
+
},
|
|
1586
|
+
{
|
|
1587
|
+
"name": "className",
|
|
1588
|
+
"type": "string | ((instance?: TreeNodesInstance) => string)",
|
|
1589
|
+
"default": "",
|
|
1590
|
+
"description": "The class name to apply to the component."
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"name": "as",
|
|
1594
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1595
|
+
"default": "",
|
|
1596
|
+
"description": "The component type to render."
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "asChild",
|
|
1600
|
+
"type": "boolean",
|
|
1601
|
+
"default": "false",
|
|
1602
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1603
|
+
},
|
|
1604
|
+
{
|
|
1605
|
+
"name": "instance",
|
|
1606
|
+
"type": "TreeNodesInstance",
|
|
1607
|
+
"default": "",
|
|
1608
|
+
"description": "The instance to pass to the component."
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"name": "pt",
|
|
1612
|
+
"type": "SafeRecord<TreeNodesPassThrough>",
|
|
1613
|
+
"default": "",
|
|
1614
|
+
"description": "The pass-through props to pass to the component."
|
|
1615
|
+
},
|
|
1616
|
+
{
|
|
1617
|
+
"name": "ptOptions",
|
|
1618
|
+
"type": "PassThroughOptions",
|
|
1619
|
+
"default": "",
|
|
1620
|
+
"description": "The pass-through options to pass to the component."
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
"name": "unstyled",
|
|
1624
|
+
"type": "boolean",
|
|
1625
|
+
"default": "",
|
|
1626
|
+
"description": "Whether the component should be rendered without classes."
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"name": "dt",
|
|
1630
|
+
"type": "unknown",
|
|
1631
|
+
"default": "",
|
|
1632
|
+
"description": "The design token to use for the component."
|
|
1633
|
+
},
|
|
1634
|
+
{
|
|
1635
|
+
"name": "styles",
|
|
1636
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1637
|
+
"default": "",
|
|
1638
|
+
"description": "The styles to use for the component."
|
|
1639
|
+
},
|
|
1640
|
+
{
|
|
1641
|
+
"name": "render",
|
|
1642
|
+
"type": "(instance: TreeNodesInstance) => ReactNode",
|
|
1643
|
+
"default": "",
|
|
1644
|
+
"description": "The render function to render the component with instance access."
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
"name": "children",
|
|
1648
|
+
"type": "ReactNode | ((row: TreeNodeRow) => ReactNode)",
|
|
1649
|
+
"default": "",
|
|
1650
|
+
"description": "Render-prop invoked once per visible node. Receives a `TreeNodeRow` payload\ncarrying the node data plus its position and state in the tree."
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "[key: string]",
|
|
1654
|
+
"type": "any",
|
|
1655
|
+
"description": ""
|
|
1656
|
+
},
|
|
1657
|
+
{
|
|
1658
|
+
"name": "pt-{optionName}-*",
|
|
1659
|
+
"type": "-",
|
|
1660
|
+
"default": "",
|
|
1661
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1662
|
+
"deprecated": false
|
|
1663
|
+
}
|
|
1664
|
+
],
|
|
1665
|
+
"methods": []
|
|
1666
|
+
},
|
|
1667
|
+
"TreeNodesState": {
|
|
1668
|
+
"description": "Defines valid state in TreeNodes component.",
|
|
1669
|
+
"relatedProp": "",
|
|
1670
|
+
"props": [],
|
|
1671
|
+
"methods": []
|
|
1672
|
+
},
|
|
1673
|
+
"TreeNodesExposes": {
|
|
1674
|
+
"description": "Defines the methods and properties exposed by TreeNodes component.",
|
|
1675
|
+
"relatedProp": "",
|
|
1676
|
+
"props": [
|
|
1677
|
+
{
|
|
1678
|
+
"name": "tree",
|
|
1679
|
+
"type": "TreeRootInstance",
|
|
1680
|
+
"default": "",
|
|
1681
|
+
"description": "The Tree component instance."
|
|
1682
|
+
}
|
|
1683
|
+
],
|
|
1684
|
+
"methods": []
|
|
1685
|
+
}
|
|
1686
|
+
},
|
|
1687
|
+
"types": {
|
|
1688
|
+
"TreeNodesPassThroughType": {
|
|
1689
|
+
"description": "Defines passthrough(pt) options type in TreeNodes component.",
|
|
1690
|
+
"values": "PassThroughType<TreeNodesInstance, E>"
|
|
1691
|
+
},
|
|
1692
|
+
"TreeNodesInstance": {
|
|
1693
|
+
"description": "Instance of TreeNodes component.",
|
|
1694
|
+
"values": "ComponentInstance<TreeNodesProps, TreeNodesState, TreeNodesExposes>"
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
"variables": {}
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
"name": "TreeRoot",
|
|
1702
|
+
"source": "apps/showcase/assets/apidoc/treeroot.json",
|
|
1703
|
+
"data": {
|
|
1704
|
+
"description": "Tree is used to display hierarchical data.",
|
|
1705
|
+
"interfaces": {
|
|
1706
|
+
"TreeRootPassThrough": {
|
|
1707
|
+
"description": "Defines passthrough(pt) options of Tree component.",
|
|
1708
|
+
"relatedProp": "",
|
|
1709
|
+
"props": [
|
|
1710
|
+
{
|
|
1711
|
+
"name": "root",
|
|
1712
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1713
|
+
"default": "",
|
|
1714
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"name": "nodes",
|
|
1718
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLUListElement>>",
|
|
1719
|
+
"default": "",
|
|
1720
|
+
"description": "Used to pass attributes to the flat iterator's DOM element ( `<ul role=\"tree\">` )."
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"name": "node",
|
|
1724
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
1725
|
+
"default": "",
|
|
1726
|
+
"description": "Used to pass attributes to the node's DOM element ( `<li>` )."
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
"name": "content",
|
|
1730
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1731
|
+
"default": "",
|
|
1732
|
+
"description": "Used to pass attributes to the content's DOM element (clickable row)."
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "label",
|
|
1736
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1737
|
+
"default": "",
|
|
1738
|
+
"description": "Used to pass attributes to the label's DOM element."
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "toggle",
|
|
1742
|
+
"type": "TreeRootPassThroughType<ButtonHTMLAttributes<HTMLButtonElement>>",
|
|
1743
|
+
"default": "",
|
|
1744
|
+
"description": "Used to pass attributes to the toggle button's DOM element."
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"name": "toggleIndicator",
|
|
1748
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1749
|
+
"default": "",
|
|
1750
|
+
"description": "Used to pass attributes to the toggle indicator's DOM element (state-matched icon slot)."
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"name": "toggleSpacer",
|
|
1754
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1755
|
+
"default": "",
|
|
1756
|
+
"description": "Used to pass attributes to the toggle spacer rendered for leaf nodes."
|
|
1757
|
+
},
|
|
1758
|
+
{
|
|
1759
|
+
"name": "selection",
|
|
1760
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1761
|
+
"default": "",
|
|
1762
|
+
"description": "Used to pass attributes to the selection slot (wraps user-provided checkbox/radio)."
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
"name": "pcFilter",
|
|
1766
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLElement>>",
|
|
1767
|
+
"default": "",
|
|
1768
|
+
"description": "Used to pass attributes to the filter's DOM element."
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
"name": "header",
|
|
1772
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1773
|
+
"default": "",
|
|
1774
|
+
"description": "Used to pass attributes to the header's DOM element."
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "footer",
|
|
1778
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1779
|
+
"default": "",
|
|
1780
|
+
"description": "Used to pass attributes to the footer's DOM element."
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"name": "empty",
|
|
1784
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1785
|
+
"default": "",
|
|
1786
|
+
"description": "Used to pass attributes to the empty message's DOM element."
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"name": "dropIndicator",
|
|
1790
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1791
|
+
"default": "",
|
|
1792
|
+
"description": "Used to pass attributes to the drop indicator's DOM element."
|
|
1793
|
+
},
|
|
1794
|
+
{
|
|
1795
|
+
"name": "loading",
|
|
1796
|
+
"type": "TreeRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1797
|
+
"default": "",
|
|
1798
|
+
"description": "Used to pass attributes to the loading overlay's DOM element."
|
|
1799
|
+
}
|
|
1800
|
+
],
|
|
1801
|
+
"methods": []
|
|
1802
|
+
},
|
|
1803
|
+
"TreeRootExpandedChangeEvent": {
|
|
1804
|
+
"description": "Event fired when the tree's expanded keys state changes.",
|
|
1805
|
+
"relatedProp": "",
|
|
1806
|
+
"extendedTypes": "UseTreeExpandedChangeEvent",
|
|
1807
|
+
"props": [
|
|
1808
|
+
{
|
|
1809
|
+
"name": "originalEvent",
|
|
1810
|
+
"type": "SyntheticEvent",
|
|
1811
|
+
"default": "",
|
|
1812
|
+
"description": "The original event that triggered the expansion change."
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "node",
|
|
1816
|
+
"type": "TreeExpandedKeys",
|
|
1817
|
+
"default": "",
|
|
1818
|
+
"description": "The new expanded keys."
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
"name": "value",
|
|
1822
|
+
"type": "TreeExpandedKeys",
|
|
1823
|
+
"default": "",
|
|
1824
|
+
"description": "The new expanded keys."
|
|
1825
|
+
}
|
|
1826
|
+
],
|
|
1827
|
+
"methods": []
|
|
1828
|
+
},
|
|
1829
|
+
"TreeRootToggleEvent": {
|
|
1830
|
+
"description": "Event fired when a node is toggled.",
|
|
1831
|
+
"relatedProp": "",
|
|
1832
|
+
"extendedTypes": "UseTreeToggleEvent",
|
|
1833
|
+
"props": [
|
|
1834
|
+
{
|
|
1835
|
+
"name": "originalEvent",
|
|
1836
|
+
"type": "SyntheticEvent",
|
|
1837
|
+
"default": "",
|
|
1838
|
+
"description": "The original event that triggered the toggle."
|
|
1839
|
+
},
|
|
1840
|
+
{
|
|
1841
|
+
"name": "node",
|
|
1842
|
+
"type": "TreeNodeData",
|
|
1843
|
+
"default": "",
|
|
1844
|
+
"description": "The toggled node."
|
|
1845
|
+
}
|
|
1846
|
+
],
|
|
1847
|
+
"methods": []
|
|
1848
|
+
},
|
|
1849
|
+
"TreeRootExpandEvent": {
|
|
1850
|
+
"description": "Event fired when a node is expanded.",
|
|
1851
|
+
"relatedProp": "",
|
|
1852
|
+
"extendedTypes": "UseTreeExpandEvent",
|
|
1853
|
+
"props": [
|
|
1854
|
+
{
|
|
1855
|
+
"name": "originalEvent",
|
|
1856
|
+
"type": "SyntheticEvent",
|
|
1857
|
+
"default": "",
|
|
1858
|
+
"description": "The original event that triggered the toggle."
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"name": "node",
|
|
1862
|
+
"type": "TreeNodeData",
|
|
1863
|
+
"default": "",
|
|
1864
|
+
"description": "The expanded node."
|
|
1865
|
+
}
|
|
1866
|
+
],
|
|
1867
|
+
"methods": []
|
|
1868
|
+
},
|
|
1869
|
+
"TreeRootCollapseEvent": {
|
|
1870
|
+
"description": "Event fired when a node is collapsed.",
|
|
1871
|
+
"relatedProp": "",
|
|
1872
|
+
"extendedTypes": "UseTreeCollapseEvent",
|
|
1873
|
+
"props": [
|
|
1874
|
+
{
|
|
1875
|
+
"name": "originalEvent",
|
|
1876
|
+
"type": "SyntheticEvent",
|
|
1877
|
+
"default": "",
|
|
1878
|
+
"description": "The original event that triggered the collapse."
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"name": "node",
|
|
1882
|
+
"type": "TreeNodeData",
|
|
1883
|
+
"default": "",
|
|
1884
|
+
"description": "The collapsed node."
|
|
1885
|
+
}
|
|
1886
|
+
],
|
|
1887
|
+
"methods": []
|
|
1888
|
+
},
|
|
1889
|
+
"TreeRootSelectionChangeEvent": {
|
|
1890
|
+
"description": "Event fired when the tree's selection keys state changes.",
|
|
1891
|
+
"relatedProp": "",
|
|
1892
|
+
"extendedTypes": "UseTreeSelectionChangeEvent",
|
|
1893
|
+
"props": [
|
|
1894
|
+
{
|
|
1895
|
+
"name": "originalEvent",
|
|
1896
|
+
"type": "SyntheticEvent",
|
|
1897
|
+
"default": "",
|
|
1898
|
+
"description": "The original event that triggered the selection change."
|
|
1899
|
+
},
|
|
1900
|
+
{
|
|
1901
|
+
"name": "value",
|
|
1902
|
+
"type": "TreeSelectionKeys | TreeCheckboxSelectionKeys",
|
|
1903
|
+
"default": "",
|
|
1904
|
+
"description": "The new selection keys."
|
|
1905
|
+
}
|
|
1906
|
+
],
|
|
1907
|
+
"methods": []
|
|
1908
|
+
},
|
|
1909
|
+
"TreeRootMoveEvent": {
|
|
1910
|
+
"description": "Event fired when a drag-and-drop move completes.",
|
|
1911
|
+
"relatedProp": "",
|
|
1912
|
+
"extendedTypes": "UseTreeMoveEvent",
|
|
1913
|
+
"props": [
|
|
1914
|
+
{
|
|
1915
|
+
"name": "originalEvent",
|
|
1916
|
+
"type": "DragEvent",
|
|
1917
|
+
"default": "",
|
|
1918
|
+
"description": "The original drop event."
|
|
1919
|
+
},
|
|
1920
|
+
{
|
|
1921
|
+
"name": "value",
|
|
1922
|
+
"type": "TreeNodeData[]",
|
|
1923
|
+
"default": "",
|
|
1924
|
+
"description": "The updated tree value after the move."
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "dragNode",
|
|
1928
|
+
"type": "TreeNodeData",
|
|
1929
|
+
"default": "",
|
|
1930
|
+
"description": "The node being moved."
|
|
1931
|
+
},
|
|
1932
|
+
{
|
|
1933
|
+
"name": "dropNode",
|
|
1934
|
+
"type": "TreeNodeData",
|
|
1935
|
+
"default": "",
|
|
1936
|
+
"description": "The drop target node, or null if dropped at the root level."
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
"name": "dropIndex",
|
|
1940
|
+
"type": "number",
|
|
1941
|
+
"default": "",
|
|
1942
|
+
"description": "The destination index within the parent's children array."
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "dropPosition",
|
|
1946
|
+
"type": "TreeDropPosition",
|
|
1947
|
+
"default": "",
|
|
1948
|
+
"description": "Where in relation to `dropNode` the drop occurred."
|
|
1949
|
+
}
|
|
1950
|
+
],
|
|
1951
|
+
"methods": []
|
|
1952
|
+
},
|
|
1953
|
+
"TreeRootProps": {
|
|
1954
|
+
"description": "Defines valid properties in Tree component.",
|
|
1955
|
+
"relatedProp": "",
|
|
1956
|
+
"extendedTypes": "BaseComponentProps<TreeRootInstance, Omit<UseTreeProps, \"onExpandedChange\" | \"onSelectionChange\">, TreeRootPassThrough>",
|
|
1957
|
+
"props": [
|
|
1958
|
+
{
|
|
1959
|
+
"name": "ref",
|
|
1960
|
+
"type": "Ref<unknown>",
|
|
1961
|
+
"default": "",
|
|
1962
|
+
"description": "The reference to the component instance."
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "pIf",
|
|
1966
|
+
"type": "boolean",
|
|
1967
|
+
"default": "true",
|
|
1968
|
+
"description": "Whether the component should be rendered."
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"name": "style",
|
|
1972
|
+
"type": "CSSProperties | ((instance?: TreeRootInstance) => CSSProperties)",
|
|
1973
|
+
"default": "",
|
|
1974
|
+
"description": "The style to apply to the component."
|
|
1975
|
+
},
|
|
1976
|
+
{
|
|
1977
|
+
"name": "className",
|
|
1978
|
+
"type": "string | ((instance?: TreeRootInstance) => string)",
|
|
1979
|
+
"default": "",
|
|
1980
|
+
"description": "The class name to apply to the component."
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"name": "as",
|
|
1984
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1985
|
+
"default": "",
|
|
1986
|
+
"description": "The component type to render."
|
|
1987
|
+
},
|
|
1988
|
+
{
|
|
1989
|
+
"name": "asChild",
|
|
1990
|
+
"type": "boolean",
|
|
1991
|
+
"default": "false",
|
|
1992
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1993
|
+
},
|
|
1994
|
+
{
|
|
1995
|
+
"name": "instance",
|
|
1996
|
+
"type": "TreeRootInstance",
|
|
1997
|
+
"default": "",
|
|
1998
|
+
"description": "The instance to pass to the component."
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"name": "pt",
|
|
2002
|
+
"type": "SafeRecord<TreeRootPassThrough>",
|
|
2003
|
+
"default": "",
|
|
2004
|
+
"description": "The pass-through props to pass to the component."
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"name": "ptOptions",
|
|
2008
|
+
"type": "PassThroughOptions",
|
|
2009
|
+
"default": "",
|
|
2010
|
+
"description": "The pass-through options to pass to the component."
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"name": "unstyled",
|
|
2014
|
+
"type": "boolean",
|
|
2015
|
+
"default": "",
|
|
2016
|
+
"description": "Whether the component should be rendered without classes."
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"name": "dt",
|
|
2020
|
+
"type": "unknown",
|
|
2021
|
+
"default": "",
|
|
2022
|
+
"description": "The design token to use for the component."
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
"name": "styles",
|
|
2026
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2027
|
+
"default": "",
|
|
2028
|
+
"description": "The styles to use for the component."
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "render",
|
|
2032
|
+
"type": "(instance: TreeRootInstance) => ReactNode",
|
|
2033
|
+
"default": "",
|
|
2034
|
+
"description": "The render function to render the component with instance access."
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"name": "children",
|
|
2038
|
+
"type": "any",
|
|
2039
|
+
"default": "",
|
|
2040
|
+
"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."
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "value",
|
|
2044
|
+
"type": "TreeNodeData[]",
|
|
2045
|
+
"default": "",
|
|
2046
|
+
"description": "An array of treenodes."
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"name": "expandedKeys",
|
|
2050
|
+
"type": "TreeExpandedKeys",
|
|
2051
|
+
"default": "",
|
|
2052
|
+
"description": "A record of keys to represent the state of the tree expansion state in controlled mode."
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "defaultExpandedKeys",
|
|
2056
|
+
"type": "TreeExpandedKeys",
|
|
2057
|
+
"default": "",
|
|
2058
|
+
"description": "The default expanded keys when used in uncontrolled mode."
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"name": "selectionKeys",
|
|
2062
|
+
"type": "TreeSelectionKeys | TreeCheckboxSelectionKeys",
|
|
2063
|
+
"default": "",
|
|
2064
|
+
"description": "A record of keys to represent the selection state in controlled mode.\nFor single/multiple mode: Record<string, boolean>\nFor checkbox mode: Record<string, { checked: boolean, partialChecked: boolean }>"
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
"name": "defaultSelectionKeys",
|
|
2068
|
+
"type": "TreeSelectionKeys | TreeCheckboxSelectionKeys",
|
|
2069
|
+
"default": "",
|
|
2070
|
+
"description": "The default selected keys when used in uncontrolled mode."
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"name": "selectionMode",
|
|
2074
|
+
"type": "\"checkbox\" | \"multiple\" | \"single\"",
|
|
2075
|
+
"default": "",
|
|
2076
|
+
"description": "Defines the selection mode."
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"name": "metaKeySelection",
|
|
2080
|
+
"type": "boolean",
|
|
2081
|
+
"default": "false",
|
|
2082
|
+
"description": "Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect multiple items. When set to false selection of each item can be toggled individually."
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"name": "highlightOnSelect",
|
|
2086
|
+
"type": "boolean",
|
|
2087
|
+
"default": "false",
|
|
2088
|
+
"description": "Highlights automatically the first item."
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "draggable",
|
|
2092
|
+
"type": "boolean",
|
|
2093
|
+
"default": "",
|
|
2094
|
+
"description": "Whether the tree nodes can be dragged."
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
"name": "droppable",
|
|
2098
|
+
"type": "boolean",
|
|
2099
|
+
"default": "",
|
|
2100
|
+
"description": "Whether the tree can accept dropped nodes."
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "draggableScope",
|
|
2104
|
+
"type": "string | string[]",
|
|
2105
|
+
"default": "",
|
|
2106
|
+
"description": "Identifier(s) attached to nodes dragged out of this tree. Other trees use this\nvalue to decide whether they accept the drop (see `droppableScope` ).\nAccepts a string or an array of strings."
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"name": "droppableScope",
|
|
2110
|
+
"type": "string | string[]",
|
|
2111
|
+
"default": "",
|
|
2112
|
+
"description": "Scope(s) this tree accepts drops from. A drop is allowed when the dragged\nnode's `draggableScope` overlaps with this value. Accepts a string or an\narray of strings. When omitted, drops from any scope are accepted."
|
|
2113
|
+
},
|
|
2114
|
+
{
|
|
2115
|
+
"name": "onToggle",
|
|
2116
|
+
"type": "(event: UseTreeToggleEvent) => void",
|
|
2117
|
+
"default": "",
|
|
2118
|
+
"description": "Callback fired when a node is toggled (expanded or collapsed)."
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
"name": "onExpand",
|
|
2122
|
+
"type": "(event: UseTreeExpandEvent) => void",
|
|
2123
|
+
"default": "",
|
|
2124
|
+
"description": "Callback fired when a node is expanded."
|
|
2125
|
+
},
|
|
2126
|
+
{
|
|
2127
|
+
"name": "onCollapse",
|
|
2128
|
+
"type": "(event: UseTreeCollapseEvent) => void",
|
|
2129
|
+
"default": "",
|
|
2130
|
+
"description": "Callback fired when a node is collapsed."
|
|
2131
|
+
},
|
|
2132
|
+
{
|
|
2133
|
+
"name": "onClick",
|
|
2134
|
+
"type": "(event: UseTreeClickEvent) => void",
|
|
2135
|
+
"default": "",
|
|
2136
|
+
"description": "Callback fired when a node is clicked."
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
"name": "onSelect",
|
|
2140
|
+
"type": "(event: UseTreeSelectEvent) => void",
|
|
2141
|
+
"default": "",
|
|
2142
|
+
"description": "Callback fired when a node is selected."
|
|
2143
|
+
},
|
|
2144
|
+
{
|
|
2145
|
+
"name": "onUnselect",
|
|
2146
|
+
"type": "(event: UseTreeUnselectEvent) => void",
|
|
2147
|
+
"default": "",
|
|
2148
|
+
"description": "Callback fired when a node is unselected."
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "onMove",
|
|
2152
|
+
"type": "(event: UseTreeMoveEvent) => void",
|
|
2153
|
+
"default": "",
|
|
2154
|
+
"description": "Callback fired when a drag-and-drop move completes. Receives the updated tree value plus move metadata."
|
|
2155
|
+
},
|
|
2156
|
+
{
|
|
2157
|
+
"name": "validateMove",
|
|
2158
|
+
"type": "(event: UseTreeMoveEvent) => boolean | Promise<boolean>",
|
|
2159
|
+
"default": "",
|
|
2160
|
+
"description": "Optional validator invoked before a move is committed. Return `false` (sync or async) to cancel the move."
|
|
2161
|
+
},
|
|
2162
|
+
{
|
|
2163
|
+
"name": "onFocusedKeyChange",
|
|
2164
|
+
"type": "(event: UseTreeFocusedKeyChangeEvent) => void",
|
|
2165
|
+
"default": "",
|
|
2166
|
+
"description": "Callback fired when the focused key changes (keyboard navigation)."
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"name": "loading",
|
|
2170
|
+
"type": "boolean",
|
|
2171
|
+
"default": "",
|
|
2172
|
+
"description": "Displays a loading overlay over the tree. Pair with `Tree.Loading` to render\nthe spinner / message of your choice."
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"name": "onExpandedChange",
|
|
2176
|
+
"type": "(event: TreeRootExpandedChangeEvent) => void",
|
|
2177
|
+
"default": "",
|
|
2178
|
+
"description": "Callback fired when the tree's expanded keys state changes."
|
|
2179
|
+
},
|
|
2180
|
+
{
|
|
2181
|
+
"name": "onSelectionChange",
|
|
2182
|
+
"type": "(event: TreeRootSelectionChangeEvent) => void",
|
|
2183
|
+
"default": "",
|
|
2184
|
+
"description": "Callback fired when the tree's selection keys state changes."
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"name": "[key: string]",
|
|
2188
|
+
"type": "any",
|
|
2189
|
+
"description": ""
|
|
2190
|
+
},
|
|
2191
|
+
{
|
|
2192
|
+
"name": "pt-{optionName}-*",
|
|
2193
|
+
"type": "-",
|
|
2194
|
+
"default": "",
|
|
2195
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2196
|
+
"deprecated": false
|
|
2197
|
+
}
|
|
2198
|
+
],
|
|
2199
|
+
"methods": []
|
|
2200
|
+
},
|
|
2201
|
+
"TreeRootState": {
|
|
2202
|
+
"description": "Defines valid state in Tree component.",
|
|
2203
|
+
"relatedProp": "",
|
|
2204
|
+
"extendedTypes": "UseTreeState",
|
|
2205
|
+
"props": [
|
|
2206
|
+
{
|
|
2207
|
+
"name": "expandedKeys",
|
|
2208
|
+
"type": "TreeExpandedKeys",
|
|
2209
|
+
"default": "",
|
|
2210
|
+
"description": "The current expanded keys of the tree."
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
"name": "selectionKeys",
|
|
2214
|
+
"type": "TreeSelectionKeys | TreeCheckboxSelectionKeys",
|
|
2215
|
+
"default": "",
|
|
2216
|
+
"description": "The current selected keys of the tree."
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
"name": "focusedKey",
|
|
2220
|
+
"type": "string",
|
|
2221
|
+
"default": "",
|
|
2222
|
+
"description": "The key of the currently focused node, or null when none."
|
|
2223
|
+
},
|
|
2224
|
+
{
|
|
2225
|
+
"name": "dragHover",
|
|
2226
|
+
"type": "boolean",
|
|
2227
|
+
"default": "",
|
|
2228
|
+
"description": "Whether the tree is in drag hover state."
|
|
2229
|
+
}
|
|
2230
|
+
],
|
|
2231
|
+
"methods": []
|
|
2232
|
+
},
|
|
2233
|
+
"TreeRootExposes": {
|
|
2234
|
+
"description": "Defines the methods and properties exposed by Tree component.",
|
|
2235
|
+
"relatedProp": "",
|
|
2236
|
+
"extendedTypes": "UseTreeExposes",
|
|
2237
|
+
"props": [
|
|
2238
|
+
{
|
|
2239
|
+
"name": "state",
|
|
2240
|
+
"type": "UseTreeState",
|
|
2241
|
+
"default": "",
|
|
2242
|
+
"description": "The state of the useTree."
|
|
2243
|
+
},
|
|
2244
|
+
{
|
|
2245
|
+
"name": "nodeMap",
|
|
2246
|
+
"type": "Map<string, TreeNodeEntry>",
|
|
2247
|
+
"default": "",
|
|
2248
|
+
"description": "Map of every node keyed by `node.key` , carrying parent / level / posInSet / setSize. O(1) lookup."
|
|
2249
|
+
},
|
|
2250
|
+
{
|
|
2251
|
+
"name": "flatOrder",
|
|
2252
|
+
"type": "string[]",
|
|
2253
|
+
"default": "",
|
|
2254
|
+
"description": "All node keys in depth-first order, regardless of expansion."
|
|
2255
|
+
},
|
|
2256
|
+
{
|
|
2257
|
+
"name": "visibleKeys",
|
|
2258
|
+
"type": "string[]",
|
|
2259
|
+
"default": "",
|
|
2260
|
+
"description": "Keys of nodes whose ancestors are all expanded (i.e. currently visible in the DOM)."
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
"name": "visibleCount",
|
|
2264
|
+
"type": "number",
|
|
2265
|
+
"default": "",
|
|
2266
|
+
"description": "Convenience: `visibleKeys.length` ."
|
|
2267
|
+
},
|
|
2268
|
+
{
|
|
2269
|
+
"name": "findNodeByKey",
|
|
2270
|
+
"type": "(key: string) => TreeNodeData",
|
|
2271
|
+
"default": "",
|
|
2272
|
+
"description": "Look up a node by key in O(1)."
|
|
2273
|
+
},
|
|
2274
|
+
{
|
|
2275
|
+
"name": "findNodeInfo",
|
|
2276
|
+
"type": "(key: string) => { level: number; posInSet: number; setSize: number; parentKey: string }",
|
|
2277
|
+
"default": "",
|
|
2278
|
+
"description": "Look up a node's position metadata by key."
|
|
2279
|
+
},
|
|
2280
|
+
{
|
|
2281
|
+
"name": "getNodes",
|
|
2282
|
+
"type": "() => TreeNodeData[]",
|
|
2283
|
+
"default": "",
|
|
2284
|
+
"description": "Gets the list of tree nodes (the original `props.value` )."
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
"name": "setFocusedKey",
|
|
2288
|
+
"type": "(key: string) => void",
|
|
2289
|
+
"default": "",
|
|
2290
|
+
"description": "Set the focused key explicitly (e.g. from a click handler)."
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
"name": "setSelectionKeys",
|
|
2294
|
+
"type": "(keys: TreeSelectionKeys | TreeCheckboxSelectionKeys, event?: SyntheticEvent) => void",
|
|
2295
|
+
"default": "",
|
|
2296
|
+
"description": "Replace the entire selection map."
|
|
2297
|
+
},
|
|
2298
|
+
{
|
|
2299
|
+
"name": "onKeyDown",
|
|
2300
|
+
"type": "(event: KeyboardEvent, node: TreeNodeData, level: number, expanded: boolean, leaf: boolean) => void",
|
|
2301
|
+
"default": "",
|
|
2302
|
+
"description": "Handles keyboard navigation on tree nodes."
|
|
2303
|
+
},
|
|
2304
|
+
{
|
|
2305
|
+
"name": "onNodeToggle",
|
|
2306
|
+
"type": "(event: SyntheticEvent, node: TreeNodeData) => void",
|
|
2307
|
+
"default": "",
|
|
2308
|
+
"description": "Toggles the expansion state of a node."
|
|
2309
|
+
},
|
|
2310
|
+
{
|
|
2311
|
+
"name": "onNodeClick",
|
|
2312
|
+
"type": "(event: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>, node: TreeNodeData, nodeTouched?: boolean) => void",
|
|
2313
|
+
"default": "",
|
|
2314
|
+
"description": "Handles node click event."
|
|
2315
|
+
},
|
|
2316
|
+
{
|
|
2317
|
+
"name": "onClick",
|
|
2318
|
+
"type": "(event: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>, node: TreeNodeData, nodeTouched?: boolean) => void",
|
|
2319
|
+
"default": "",
|
|
2320
|
+
"description": "Handles content click event. Automatically delegates to checkbox or node click based on selection mode."
|
|
2321
|
+
},
|
|
2322
|
+
{
|
|
2323
|
+
"name": "onCheckboxChange",
|
|
2324
|
+
"type": "(event: SyntheticEvent, node: TreeNodeData) => void",
|
|
2325
|
+
"default": "",
|
|
2326
|
+
"description": "Handles checkbox state change for checkbox selection mode."
|
|
2327
|
+
},
|
|
2328
|
+
{
|
|
2329
|
+
"name": "isNodeSelected",
|
|
2330
|
+
"type": "(node: TreeNodeData) => boolean",
|
|
2331
|
+
"default": "",
|
|
2332
|
+
"description": "Checks if a node is selected."
|
|
2333
|
+
},
|
|
2334
|
+
{
|
|
2335
|
+
"name": "selection",
|
|
2336
|
+
"type": "UseTreeSelectionApi",
|
|
2337
|
+
"default": "",
|
|
2338
|
+
"description": "Selection query API consumed by `Tree.Selection` . Mirrors the DataTable selection contract."
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
"name": "allowDrop",
|
|
2342
|
+
"type": "(node: TreeNodeData) => boolean",
|
|
2343
|
+
"default": "",
|
|
2344
|
+
"description": "Checks if a node can be dropped based on drag-drop rules."
|
|
2345
|
+
},
|
|
2346
|
+
{
|
|
2347
|
+
"name": "getToggleProps",
|
|
2348
|
+
"type": "(node: TreeNodeData) => UseTreeToggleProps",
|
|
2349
|
+
"default": "",
|
|
2350
|
+
"description": "Returns pre-built props for a tree toggle button element."
|
|
2351
|
+
},
|
|
2352
|
+
{
|
|
2353
|
+
"name": "getToggleSpacerProps",
|
|
2354
|
+
"type": "() => UseTreeToggleSpacerProps",
|
|
2355
|
+
"default": "",
|
|
2356
|
+
"description": "Returns pre-built props for the leaf-row toggle spacer element."
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
"name": "getToggleIndicatorProps",
|
|
2360
|
+
"type": "() => UseTreeToggleIndicatorProps",
|
|
2361
|
+
"default": "",
|
|
2362
|
+
"description": "Returns pre-built props for a toggle indicator element."
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"name": "rootProps",
|
|
2366
|
+
"type": "UseTreeRootProps",
|
|
2367
|
+
"default": "",
|
|
2368
|
+
"description": "Returns pre-built props for the tree root element."
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
"name": "getNodeProps",
|
|
2372
|
+
"type": "(node: TreeNodeData, level: number, expanded: boolean, checked: boolean, selected: boolean, leaf: boolean, posInSet: number, setSize: number) => UseTreeNodeProps",
|
|
2373
|
+
"default": "",
|
|
2374
|
+
"description": "Returns pre-built props for a tree node element."
|
|
2375
|
+
},
|
|
2376
|
+
{
|
|
2377
|
+
"name": "filterProps",
|
|
2378
|
+
"type": "UseTreeFilterProps",
|
|
2379
|
+
"default": "",
|
|
2380
|
+
"description": "Returns pre-built props for the tree filter element."
|
|
2381
|
+
},
|
|
2382
|
+
{
|
|
2383
|
+
"name": "loadingProps",
|
|
2384
|
+
"type": "UseTreeLoadingProps",
|
|
2385
|
+
"default": "",
|
|
2386
|
+
"description": "Returns pre-built props for the tree loading status element."
|
|
2387
|
+
},
|
|
2388
|
+
{
|
|
2389
|
+
"name": "getNodesProps",
|
|
2390
|
+
"type": "() => UseTreeNodesProps",
|
|
2391
|
+
"default": "",
|
|
2392
|
+
"description": "Returns pre-built props for the flat iterator element."
|
|
2393
|
+
}
|
|
2394
|
+
],
|
|
2395
|
+
"methods": []
|
|
2396
|
+
}
|
|
2397
|
+
},
|
|
2398
|
+
"types": {
|
|
2399
|
+
"TreeRootPassThroughType": {
|
|
2400
|
+
"description": "Defines passthrough(pt) options type in Tree component.",
|
|
2401
|
+
"values": "PassThroughType<TreeRootInstance, E>"
|
|
2402
|
+
},
|
|
2403
|
+
"TreeRootInstance": {
|
|
2404
|
+
"description": "Instance of Tree component.",
|
|
2405
|
+
"values": "ComponentInstance<TreeRootProps, TreeRootState, TreeRootExposes>"
|
|
2406
|
+
}
|
|
2407
|
+
},
|
|
2408
|
+
"variables": {}
|
|
2409
|
+
}
|
|
2410
|
+
},
|
|
2411
|
+
{
|
|
2412
|
+
"name": "TreeSelection",
|
|
2413
|
+
"source": "apps/showcase/assets/apidoc/treeselection.json",
|
|
2414
|
+
"data": {
|
|
2415
|
+
"description": "TreeSelection exposes selection state and callbacks via render-prop,\nletting users compose their own selection UI (checkbox, radio, switch, ...).\nAutomatically detects header vs node context: rendered inside `Tree.Header` \nit yields aggregate fields ( `isAllSelected` , `toggleAll` ); inside a `Tree.Node` \nit yields per-row fields ( `isSelected` , `toggle` ).",
|
|
2416
|
+
"interfaces": {
|
|
2417
|
+
"TreeSelectionPassThrough": {
|
|
2418
|
+
"description": "Defines passthrough(pt) options of TreeSelection component.",
|
|
2419
|
+
"relatedProp": "",
|
|
2420
|
+
"props": [
|
|
2421
|
+
{
|
|
2422
|
+
"name": "root",
|
|
2423
|
+
"type": "TreeSelectionPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
2424
|
+
"default": "",
|
|
2425
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2426
|
+
}
|
|
2427
|
+
],
|
|
2428
|
+
"methods": []
|
|
2429
|
+
},
|
|
2430
|
+
"TreeSelectionProps": {
|
|
2431
|
+
"description": "Defines valid properties in TreeSelection component.",
|
|
2432
|
+
"relatedProp": "",
|
|
2433
|
+
"extendedTypes": "BaseComponentProps<TreeSelectionInstance, unknown, TreeSelectionPassThrough>",
|
|
2434
|
+
"props": [
|
|
2435
|
+
{
|
|
2436
|
+
"name": "ref",
|
|
2437
|
+
"type": "Ref<unknown>",
|
|
2438
|
+
"default": "",
|
|
2439
|
+
"description": "The reference to the component instance."
|
|
2440
|
+
},
|
|
2441
|
+
{
|
|
2442
|
+
"name": "pIf",
|
|
2443
|
+
"type": "boolean",
|
|
2444
|
+
"default": "true",
|
|
2445
|
+
"description": "Whether the component should be rendered."
|
|
2446
|
+
},
|
|
2447
|
+
{
|
|
2448
|
+
"name": "style",
|
|
2449
|
+
"type": "CSSProperties | ((instance?: TreeSelectionInstance) => CSSProperties)",
|
|
2450
|
+
"default": "",
|
|
2451
|
+
"description": "The style to apply to the component."
|
|
2452
|
+
},
|
|
2453
|
+
{
|
|
2454
|
+
"name": "className",
|
|
2455
|
+
"type": "string | ((instance?: TreeSelectionInstance) => string)",
|
|
2456
|
+
"default": "",
|
|
2457
|
+
"description": "The class name to apply to the component."
|
|
2458
|
+
},
|
|
2459
|
+
{
|
|
2460
|
+
"name": "as",
|
|
2461
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2462
|
+
"default": "",
|
|
2463
|
+
"description": "The component type to render."
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
"name": "asChild",
|
|
2467
|
+
"type": "boolean",
|
|
2468
|
+
"default": "false",
|
|
2469
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2470
|
+
},
|
|
2471
|
+
{
|
|
2472
|
+
"name": "instance",
|
|
2473
|
+
"type": "TreeSelectionInstance",
|
|
2474
|
+
"default": "",
|
|
2475
|
+
"description": "The instance to pass to the component."
|
|
2476
|
+
},
|
|
2477
|
+
{
|
|
2478
|
+
"name": "pt",
|
|
2479
|
+
"type": "SafeRecord<TreeSelectionPassThrough>",
|
|
2480
|
+
"default": "",
|
|
2481
|
+
"description": "The pass-through props to pass to the component."
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
"name": "ptOptions",
|
|
2485
|
+
"type": "PassThroughOptions",
|
|
2486
|
+
"default": "",
|
|
2487
|
+
"description": "The pass-through options to pass to the component."
|
|
2488
|
+
},
|
|
2489
|
+
{
|
|
2490
|
+
"name": "unstyled",
|
|
2491
|
+
"type": "boolean",
|
|
2492
|
+
"default": "",
|
|
2493
|
+
"description": "Whether the component should be rendered without classes."
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"name": "dt",
|
|
2497
|
+
"type": "unknown",
|
|
2498
|
+
"default": "",
|
|
2499
|
+
"description": "The design token to use for the component."
|
|
2500
|
+
},
|
|
2501
|
+
{
|
|
2502
|
+
"name": "styles",
|
|
2503
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2504
|
+
"default": "",
|
|
2505
|
+
"description": "The styles to use for the component."
|
|
2506
|
+
},
|
|
2507
|
+
{
|
|
2508
|
+
"name": "render",
|
|
2509
|
+
"type": "(instance: TreeSelectionInstance) => ReactNode",
|
|
2510
|
+
"default": "",
|
|
2511
|
+
"description": "The render function to render the component with instance access."
|
|
2512
|
+
},
|
|
2513
|
+
{
|
|
2514
|
+
"name": "children",
|
|
2515
|
+
"type": "any",
|
|
2516
|
+
"default": "",
|
|
2517
|
+
"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."
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"name": "mode",
|
|
2521
|
+
"type": "\"checkbox\" | \"radio\" | \"single\"",
|
|
2522
|
+
"default": "",
|
|
2523
|
+
"description": "Override the toggle mode used inside the render-prop.\n- 'radio': select only one node, no deselect on re-click.\n- 'checkbox': tri-state with cascade propagation.\n- 'single': select one node, deselect on re-click.\n\nWhen omitted, defaults to `'single'` for `selectionMode=\"single\"` ,\n `'checkbox'` for `selectionMode=\"checkbox\"` , otherwise `'checkbox'` ."
|
|
2524
|
+
},
|
|
2525
|
+
{
|
|
2526
|
+
"name": "[key: string]",
|
|
2527
|
+
"type": "any",
|
|
2528
|
+
"description": ""
|
|
2529
|
+
},
|
|
2530
|
+
{
|
|
2531
|
+
"name": "pt-{optionName}-*",
|
|
2532
|
+
"type": "-",
|
|
2533
|
+
"default": "",
|
|
2534
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2535
|
+
"deprecated": false
|
|
2536
|
+
}
|
|
2537
|
+
],
|
|
2538
|
+
"methods": []
|
|
2539
|
+
},
|
|
2540
|
+
"TreeSelectionState": {
|
|
2541
|
+
"description": "Defines valid state in TreeSelection component.",
|
|
2542
|
+
"relatedProp": "",
|
|
2543
|
+
"props": [],
|
|
2544
|
+
"methods": []
|
|
2545
|
+
},
|
|
2546
|
+
"TreeSelectionExposes": {
|
|
2547
|
+
"description": "Defines the methods and properties exposed by TreeSelection component.\nRendered once per node and once per header slot; inspect `isHeader` to pick the right fields.",
|
|
2548
|
+
"relatedProp": "",
|
|
2549
|
+
"props": [
|
|
2550
|
+
{
|
|
2551
|
+
"name": "tree",
|
|
2552
|
+
"type": "TreeRootInstance",
|
|
2553
|
+
"default": "",
|
|
2554
|
+
"description": "The Tree component instance."
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"name": "isHeader",
|
|
2558
|
+
"type": "boolean",
|
|
2559
|
+
"default": "",
|
|
2560
|
+
"description": "True when rendered inside `Tree.Header` (aggregate / select-all context)."
|
|
2561
|
+
},
|
|
2562
|
+
{
|
|
2563
|
+
"name": "isAllSelected",
|
|
2564
|
+
"type": "boolean",
|
|
2565
|
+
"default": "",
|
|
2566
|
+
"description": "True when **all** visible nodes are selected. Meaningful only in header context."
|
|
2567
|
+
},
|
|
2568
|
+
{
|
|
2569
|
+
"name": "isSomeSelected",
|
|
2570
|
+
"type": "boolean",
|
|
2571
|
+
"default": "",
|
|
2572
|
+
"description": "True when **some** visible nodes (but not all) are selected. Meaningful only in header context."
|
|
2573
|
+
},
|
|
2574
|
+
{
|
|
2575
|
+
"name": "toggleAll",
|
|
2576
|
+
"type": "(event: SyntheticEvent) => void",
|
|
2577
|
+
"default": "",
|
|
2578
|
+
"description": "Select or deselect every visible node. Meaningful only in header context."
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
"name": "isSelected",
|
|
2582
|
+
"type": "boolean",
|
|
2583
|
+
"default": "",
|
|
2584
|
+
"description": "True when the current node is selected. Meaningful only in node context."
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"name": "isPartiallySelected",
|
|
2588
|
+
"type": "boolean",
|
|
2589
|
+
"default": "",
|
|
2590
|
+
"description": "True when the current node is partially selected (checkbox cascade tri-state).\nMeaningful only in node context."
|
|
2591
|
+
},
|
|
2592
|
+
{
|
|
2593
|
+
"name": "toggle",
|
|
2594
|
+
"type": "(event: SyntheticEvent) => void",
|
|
2595
|
+
"default": "",
|
|
2596
|
+
"description": "Toggle selection for the current node. Meaningful only in node context."
|
|
2597
|
+
}
|
|
2598
|
+
],
|
|
2599
|
+
"methods": []
|
|
2600
|
+
}
|
|
2601
|
+
},
|
|
2602
|
+
"types": {
|
|
2603
|
+
"TreeSelectionPassThroughType": {
|
|
2604
|
+
"description": "Defines passthrough(pt) options type in TreeSelection component.",
|
|
2605
|
+
"values": "PassThroughType<TreeSelectionInstance, E>"
|
|
2606
|
+
},
|
|
2607
|
+
"TreeSelectionInstance": {
|
|
2608
|
+
"description": "Instance of TreeSelection component.",
|
|
2609
|
+
"values": "ComponentInstance<TreeSelectionProps, TreeSelectionState, TreeSelectionExposes>"
|
|
2610
|
+
}
|
|
2611
|
+
},
|
|
2612
|
+
"variables": {}
|
|
2613
|
+
}
|
|
2614
|
+
},
|
|
2615
|
+
{
|
|
2616
|
+
"name": "TreeToggle",
|
|
2617
|
+
"source": "apps/showcase/assets/apidoc/treetoggle.json",
|
|
2618
|
+
"data": {
|
|
2619
|
+
"description": "TreeToggle is the expand/collapse button rendered inside `Tree.Content` .\nIt ships **without** a default icon — users supply icon UI via `Tree.ToggleIndicator` \n(or any other children). For leaf nodes, a `data-part=\"toggle-spacer\"` span is rendered\ninstead of a button to keep row alignment.",
|
|
2620
|
+
"interfaces": {
|
|
2621
|
+
"TreeTogglePassThrough": {
|
|
2622
|
+
"description": "Defines passthrough(pt) options of TreeToggle component.",
|
|
2623
|
+
"relatedProp": "",
|
|
2624
|
+
"props": [
|
|
2625
|
+
{
|
|
2626
|
+
"name": "root",
|
|
2627
|
+
"type": "TreeTogglePassThroughType<ButtonHTMLAttributes<HTMLButtonElement>>",
|
|
2628
|
+
"default": "",
|
|
2629
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2630
|
+
}
|
|
2631
|
+
],
|
|
2632
|
+
"methods": []
|
|
2633
|
+
},
|
|
2634
|
+
"TreeToggleProps": {
|
|
2635
|
+
"description": "Defines valid properties in TreeToggle component.",
|
|
2636
|
+
"relatedProp": "",
|
|
2637
|
+
"extendedTypes": "BaseComponentProps<TreeToggleInstance, unknown, TreeTogglePassThrough>",
|
|
2638
|
+
"props": [
|
|
2639
|
+
{
|
|
2640
|
+
"name": "ref",
|
|
2641
|
+
"type": "Ref<unknown>",
|
|
2642
|
+
"default": "",
|
|
2643
|
+
"description": "The reference to the component instance."
|
|
2644
|
+
},
|
|
2645
|
+
{
|
|
2646
|
+
"name": "pIf",
|
|
2647
|
+
"type": "boolean",
|
|
2648
|
+
"default": "true",
|
|
2649
|
+
"description": "Whether the component should be rendered."
|
|
2650
|
+
},
|
|
2651
|
+
{
|
|
2652
|
+
"name": "style",
|
|
2653
|
+
"type": "CSSProperties | ((instance?: TreeToggleInstance) => CSSProperties)",
|
|
2654
|
+
"default": "",
|
|
2655
|
+
"description": "The style to apply to the component."
|
|
2656
|
+
},
|
|
2657
|
+
{
|
|
2658
|
+
"name": "className",
|
|
2659
|
+
"type": "string | ((instance?: TreeToggleInstance) => string)",
|
|
2660
|
+
"default": "",
|
|
2661
|
+
"description": "The class name to apply to the component."
|
|
2662
|
+
},
|
|
2663
|
+
{
|
|
2664
|
+
"name": "as",
|
|
2665
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2666
|
+
"default": "",
|
|
2667
|
+
"description": "The component type to render."
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
"name": "asChild",
|
|
2671
|
+
"type": "boolean",
|
|
2672
|
+
"default": "false",
|
|
2673
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2674
|
+
},
|
|
2675
|
+
{
|
|
2676
|
+
"name": "instance",
|
|
2677
|
+
"type": "TreeToggleInstance",
|
|
2678
|
+
"default": "",
|
|
2679
|
+
"description": "The instance to pass to the component."
|
|
2680
|
+
},
|
|
2681
|
+
{
|
|
2682
|
+
"name": "pt",
|
|
2683
|
+
"type": "SafeRecord<TreeTogglePassThrough>",
|
|
2684
|
+
"default": "",
|
|
2685
|
+
"description": "The pass-through props to pass to the component."
|
|
2686
|
+
},
|
|
2687
|
+
{
|
|
2688
|
+
"name": "ptOptions",
|
|
2689
|
+
"type": "PassThroughOptions",
|
|
2690
|
+
"default": "",
|
|
2691
|
+
"description": "The pass-through options to pass to the component."
|
|
2692
|
+
},
|
|
2693
|
+
{
|
|
2694
|
+
"name": "unstyled",
|
|
2695
|
+
"type": "boolean",
|
|
2696
|
+
"default": "",
|
|
2697
|
+
"description": "Whether the component should be rendered without classes."
|
|
2698
|
+
},
|
|
2699
|
+
{
|
|
2700
|
+
"name": "dt",
|
|
2701
|
+
"type": "unknown",
|
|
2702
|
+
"default": "",
|
|
2703
|
+
"description": "The design token to use for the component."
|
|
2704
|
+
},
|
|
2705
|
+
{
|
|
2706
|
+
"name": "styles",
|
|
2707
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2708
|
+
"default": "",
|
|
2709
|
+
"description": "The styles to use for the component."
|
|
2710
|
+
},
|
|
2711
|
+
{
|
|
2712
|
+
"name": "render",
|
|
2713
|
+
"type": "(instance: TreeToggleInstance) => ReactNode",
|
|
2714
|
+
"default": "",
|
|
2715
|
+
"description": "The render function to render the component with instance access."
|
|
2716
|
+
},
|
|
2717
|
+
{
|
|
2718
|
+
"name": "children",
|
|
2719
|
+
"type": "any",
|
|
2720
|
+
"default": "",
|
|
2721
|
+
"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."
|
|
2722
|
+
},
|
|
2723
|
+
{
|
|
2724
|
+
"name": "[key: string]",
|
|
2725
|
+
"type": "any",
|
|
2726
|
+
"description": ""
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "pt-{optionName}-*",
|
|
2730
|
+
"type": "-",
|
|
2731
|
+
"default": "",
|
|
2732
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2733
|
+
"deprecated": false
|
|
2734
|
+
}
|
|
2735
|
+
],
|
|
2736
|
+
"methods": []
|
|
2737
|
+
},
|
|
2738
|
+
"TreeToggleState": {
|
|
2739
|
+
"description": "Defines valid state in TreeToggle component.",
|
|
2740
|
+
"relatedProp": "",
|
|
2741
|
+
"props": [],
|
|
2742
|
+
"methods": []
|
|
2743
|
+
},
|
|
2744
|
+
"TreeToggleExposes": {
|
|
2745
|
+
"description": "Defines the methods and properties exposed by TreeToggle component.",
|
|
2746
|
+
"relatedProp": "",
|
|
2747
|
+
"props": [
|
|
2748
|
+
{
|
|
2749
|
+
"name": "tree",
|
|
2750
|
+
"type": "TreeRootInstance",
|
|
2751
|
+
"default": "",
|
|
2752
|
+
"description": "The Tree component instance."
|
|
2753
|
+
},
|
|
2754
|
+
{
|
|
2755
|
+
"name": "treenode",
|
|
2756
|
+
"type": "TreeNodeInstance",
|
|
2757
|
+
"default": "",
|
|
2758
|
+
"description": "The TreeNode component instance."
|
|
2759
|
+
},
|
|
2760
|
+
{
|
|
2761
|
+
"name": "isExpanded",
|
|
2762
|
+
"type": "boolean",
|
|
2763
|
+
"default": "",
|
|
2764
|
+
"description": "Whether the parent node is expanded."
|
|
2765
|
+
},
|
|
2766
|
+
{
|
|
2767
|
+
"name": "isLeaf",
|
|
2768
|
+
"type": "boolean",
|
|
2769
|
+
"default": "",
|
|
2770
|
+
"description": "Whether the parent node is a leaf."
|
|
2771
|
+
},
|
|
2772
|
+
{
|
|
2773
|
+
"name": "isLoading",
|
|
2774
|
+
"type": "boolean",
|
|
2775
|
+
"default": "",
|
|
2776
|
+
"description": "Whether the parent node is currently loading."
|
|
2777
|
+
}
|
|
2778
|
+
],
|
|
2779
|
+
"methods": []
|
|
2780
|
+
}
|
|
2781
|
+
},
|
|
2782
|
+
"types": {
|
|
2783
|
+
"TreeTogglePassThroughType": {
|
|
2784
|
+
"description": "Defines passthrough(pt) options type in TreeToggle component.",
|
|
2785
|
+
"values": "PassThroughType<TreeToggleInstance, E>"
|
|
2786
|
+
},
|
|
2787
|
+
"TreeToggleInstance": {
|
|
2788
|
+
"description": "Instance of TreeToggle component.",
|
|
2789
|
+
"values": "ComponentInstance<TreeToggleProps, TreeToggleState, TreeToggleExposes>"
|
|
2790
|
+
}
|
|
2791
|
+
},
|
|
2792
|
+
"variables": {}
|
|
2793
|
+
}
|
|
2794
|
+
},
|
|
2795
|
+
{
|
|
2796
|
+
"name": "TreeToggleIndicator",
|
|
2797
|
+
"source": "apps/showcase/assets/apidoc/treetoggleindicator.json",
|
|
2798
|
+
"data": {
|
|
2799
|
+
"description": "TreeToggleIndicator displays a visual indicator for the expanded/collapsed state of a node.\nMust be used inside `Tree.Toggle` . Uses the `match` prop for conditional visibility.",
|
|
2800
|
+
"interfaces": {
|
|
2801
|
+
"TreeToggleIndicatorPassThrough": {
|
|
2802
|
+
"description": "Defines passthrough(pt) options of TreeToggleIndicator component.",
|
|
2803
|
+
"relatedProp": "",
|
|
2804
|
+
"props": [
|
|
2805
|
+
{
|
|
2806
|
+
"name": "root",
|
|
2807
|
+
"type": "TreeToggleIndicatorPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2808
|
+
"default": "",
|
|
2809
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2810
|
+
}
|
|
2811
|
+
],
|
|
2812
|
+
"methods": []
|
|
2813
|
+
},
|
|
2814
|
+
"TreeToggleIndicatorProps": {
|
|
2815
|
+
"description": "Defines valid properties in TreeToggleIndicator component.",
|
|
2816
|
+
"relatedProp": "",
|
|
2817
|
+
"extendedTypes": "BaseComponentProps<TreeToggleIndicatorInstance, unknown, TreeToggleIndicatorPassThrough, \"span\">",
|
|
2818
|
+
"props": [
|
|
2819
|
+
{
|
|
2820
|
+
"name": "ref",
|
|
2821
|
+
"type": "Ref<unknown>",
|
|
2822
|
+
"default": "",
|
|
2823
|
+
"description": "The reference to the component instance."
|
|
2824
|
+
},
|
|
2825
|
+
{
|
|
2826
|
+
"name": "pIf",
|
|
2827
|
+
"type": "boolean",
|
|
2828
|
+
"default": "true",
|
|
2829
|
+
"description": "Whether the component should be rendered."
|
|
2830
|
+
},
|
|
2831
|
+
{
|
|
2832
|
+
"name": "style",
|
|
2833
|
+
"type": "CSSProperties | ((instance?: TreeToggleIndicatorInstance) => CSSProperties)",
|
|
2834
|
+
"default": "",
|
|
2835
|
+
"description": "The style to apply to the component."
|
|
2836
|
+
},
|
|
2837
|
+
{
|
|
2838
|
+
"name": "className",
|
|
2839
|
+
"type": "string | ((instance?: TreeToggleIndicatorInstance) => string)",
|
|
2840
|
+
"default": "",
|
|
2841
|
+
"description": "The class name to apply to the component."
|
|
2842
|
+
},
|
|
2843
|
+
{
|
|
2844
|
+
"name": "as",
|
|
2845
|
+
"type": "ReactNode",
|
|
2846
|
+
"default": "",
|
|
2847
|
+
"description": "The component type to render."
|
|
2848
|
+
},
|
|
2849
|
+
{
|
|
2850
|
+
"name": "asChild",
|
|
2851
|
+
"type": "boolean",
|
|
2852
|
+
"default": "false",
|
|
2853
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2854
|
+
},
|
|
2855
|
+
{
|
|
2856
|
+
"name": "instance",
|
|
2857
|
+
"type": "TreeToggleIndicatorInstance",
|
|
2858
|
+
"default": "",
|
|
2859
|
+
"description": "The instance to pass to the component."
|
|
2860
|
+
},
|
|
2861
|
+
{
|
|
2862
|
+
"name": "pt",
|
|
2863
|
+
"type": "SafeRecord<TreeToggleIndicatorPassThrough>",
|
|
2864
|
+
"default": "",
|
|
2865
|
+
"description": "The pass-through props to pass to the component."
|
|
2866
|
+
},
|
|
2867
|
+
{
|
|
2868
|
+
"name": "ptOptions",
|
|
2869
|
+
"type": "PassThroughOptions",
|
|
2870
|
+
"default": "",
|
|
2871
|
+
"description": "The pass-through options to pass to the component."
|
|
2872
|
+
},
|
|
2873
|
+
{
|
|
2874
|
+
"name": "unstyled",
|
|
2875
|
+
"type": "boolean",
|
|
2876
|
+
"default": "",
|
|
2877
|
+
"description": "Whether the component should be rendered without classes."
|
|
2878
|
+
},
|
|
2879
|
+
{
|
|
2880
|
+
"name": "dt",
|
|
2881
|
+
"type": "unknown",
|
|
2882
|
+
"default": "",
|
|
2883
|
+
"description": "The design token to use for the component."
|
|
2884
|
+
},
|
|
2885
|
+
{
|
|
2886
|
+
"name": "styles",
|
|
2887
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2888
|
+
"default": "",
|
|
2889
|
+
"description": "The styles to use for the component."
|
|
2890
|
+
},
|
|
2891
|
+
{
|
|
2892
|
+
"name": "render",
|
|
2893
|
+
"type": "(instance: TreeToggleIndicatorInstance) => ReactNode",
|
|
2894
|
+
"default": "",
|
|
2895
|
+
"description": "The render function to render the component with instance access."
|
|
2896
|
+
},
|
|
2897
|
+
{
|
|
2898
|
+
"name": "children",
|
|
2899
|
+
"type": "any",
|
|
2900
|
+
"default": "",
|
|
2901
|
+
"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."
|
|
2902
|
+
},
|
|
2903
|
+
{
|
|
2904
|
+
"name": "match",
|
|
2905
|
+
"type": "\"always\" | \"expanded\" | \"collapsed\"",
|
|
2906
|
+
"default": "",
|
|
2907
|
+
"description": "Determines the visibility of the indicator based on the toggle state.\n- \"expanded\": Visible when the node is expanded.\n- \"collapsed\": Visible when the node is collapsed.\n- \"always\": Indicator is always visible (useful for loading spinners)."
|
|
2908
|
+
},
|
|
2909
|
+
{
|
|
2910
|
+
"name": "pt-{optionName}-*",
|
|
2911
|
+
"type": "-",
|
|
2912
|
+
"default": "",
|
|
2913
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2914
|
+
"deprecated": false
|
|
2915
|
+
}
|
|
2916
|
+
],
|
|
2917
|
+
"methods": []
|
|
2918
|
+
},
|
|
2919
|
+
"TreeToggleIndicatorState": {
|
|
2920
|
+
"description": "Defines valid state in TreeToggleIndicator component.",
|
|
2921
|
+
"relatedProp": "",
|
|
2922
|
+
"props": [],
|
|
2923
|
+
"methods": []
|
|
2924
|
+
},
|
|
2925
|
+
"TreeToggleIndicatorExposes": {
|
|
2926
|
+
"description": "Defines the methods and properties exposed by TreeToggleIndicator component.",
|
|
2927
|
+
"relatedProp": "",
|
|
2928
|
+
"props": [
|
|
2929
|
+
{
|
|
2930
|
+
"name": "tree",
|
|
2931
|
+
"type": "TreeRootInstance",
|
|
2932
|
+
"default": "",
|
|
2933
|
+
"description": "The Tree component instance."
|
|
2934
|
+
}
|
|
2935
|
+
],
|
|
2936
|
+
"methods": []
|
|
2937
|
+
}
|
|
2938
|
+
},
|
|
2939
|
+
"types": {
|
|
2940
|
+
"TreeToggleIndicatorPassThroughType": {
|
|
2941
|
+
"description": "Defines passthrough(pt) options type in TreeToggleIndicator component.",
|
|
2942
|
+
"values": "PassThroughType<TreeToggleIndicatorInstance, E>"
|
|
2943
|
+
},
|
|
2944
|
+
"TreeToggleIndicatorInstance": {
|
|
2945
|
+
"description": "Instance of TreeToggleIndicator component.",
|
|
2946
|
+
"values": "ComponentInstance<TreeToggleIndicatorProps, TreeToggleIndicatorState, TreeToggleIndicatorExposes>"
|
|
2947
|
+
}
|
|
2948
|
+
},
|
|
2949
|
+
"variables": {}
|
|
2950
|
+
}
|
|
2951
|
+
}
|
|
2952
|
+
]
|