@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,1162 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "BreadcrumbCurrent",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/breadcrumbcurrent.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "BreadcrumbCurrent is a component that displays the current page in the breadcrumb.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"BreadcrumbCurrentPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of BreadcrumbCurrent component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "BreadcrumbCurrentPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"BreadcrumbCurrentProps": {
|
|
22
|
+
"description": "Defines valid properties in BreadcrumbCurrent component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbCurrentInstance, unknown, BreadcrumbCurrentPassThrough>",
|
|
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?: BreadcrumbCurrentInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: BreadcrumbCurrentInstance) => 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": "BreadcrumbCurrentInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<BreadcrumbCurrentPassThrough>",
|
|
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: BreadcrumbCurrentInstance) => 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
|
+
"BreadcrumbCurrentState": {
|
|
126
|
+
"description": "Defines valid state in BreadcrumbCurrent component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"BreadcrumbCurrentExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by BreadcrumbCurrent component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "breadcrumb",
|
|
137
|
+
"type": "BreadcrumbRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "Instance of the Breadcrumb component."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"BreadcrumbCurrentPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbCurrent component.",
|
|
148
|
+
"values": "PassThroughType<BreadcrumbCurrentInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"BreadcrumbCurrentInstance": {
|
|
151
|
+
"description": "Instance of BreadcrumbCurrent component.",
|
|
152
|
+
"values": "ComponentInstance<BreadcrumbCurrentProps, BreadcrumbCurrentState, BreadcrumbCurrentExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "BreadcrumbEllipsis",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/breadcrumbellipsis.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "BreadcrumbEllipsis is a component that displays an ellipsis indicator for collapsed breadcrumb items.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"BreadcrumbEllipsisPassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of BreadcrumbEllipsis component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "BreadcrumbEllipsisPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"BreadcrumbEllipsisProps": {
|
|
178
|
+
"description": "Defines valid properties in BreadcrumbEllipsis component.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbEllipsisInstance, unknown, BreadcrumbEllipsisPassThrough>",
|
|
181
|
+
"props": [
|
|
182
|
+
{
|
|
183
|
+
"name": "ref",
|
|
184
|
+
"type": "Ref<unknown>",
|
|
185
|
+
"default": "",
|
|
186
|
+
"description": "The reference to the component instance."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "pIf",
|
|
190
|
+
"type": "boolean",
|
|
191
|
+
"default": "true",
|
|
192
|
+
"description": "Whether the component should be rendered."
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "style",
|
|
196
|
+
"type": "CSSProperties | ((instance?: BreadcrumbEllipsisInstance) => CSSProperties)",
|
|
197
|
+
"default": "",
|
|
198
|
+
"description": "The style to apply to the component."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "className",
|
|
202
|
+
"type": "string | ((instance?: BreadcrumbEllipsisInstance) => string)",
|
|
203
|
+
"default": "",
|
|
204
|
+
"description": "The class name to apply to the component."
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "as",
|
|
208
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
209
|
+
"default": "",
|
|
210
|
+
"description": "The component type to render."
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "asChild",
|
|
214
|
+
"type": "boolean",
|
|
215
|
+
"default": "false",
|
|
216
|
+
"description": "Whether the component should be rendered as a child component."
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"name": "instance",
|
|
220
|
+
"type": "BreadcrumbEllipsisInstance",
|
|
221
|
+
"default": "",
|
|
222
|
+
"description": "The instance to pass to the component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "pt",
|
|
226
|
+
"type": "SafeRecord<BreadcrumbEllipsisPassThrough>",
|
|
227
|
+
"default": "",
|
|
228
|
+
"description": "The pass-through props to pass to the component."
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "ptOptions",
|
|
232
|
+
"type": "PassThroughOptions",
|
|
233
|
+
"default": "",
|
|
234
|
+
"description": "The pass-through options to pass to the component."
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "unstyled",
|
|
238
|
+
"type": "boolean",
|
|
239
|
+
"default": "",
|
|
240
|
+
"description": "Whether the component should be rendered without classes."
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"name": "dt",
|
|
244
|
+
"type": "unknown",
|
|
245
|
+
"default": "",
|
|
246
|
+
"description": "The design token to use for the component."
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "styles",
|
|
250
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
251
|
+
"default": "",
|
|
252
|
+
"description": "The styles to use for the component."
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "render",
|
|
256
|
+
"type": "(instance: BreadcrumbEllipsisInstance) => ReactNode",
|
|
257
|
+
"default": "",
|
|
258
|
+
"description": "The render function to render the component with instance access."
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "children",
|
|
262
|
+
"type": "any",
|
|
263
|
+
"default": "",
|
|
264
|
+
"description": "The children to render.\n\nAccepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access.\nTyped as `any` to avoid JSX type errors when used directly in templates."
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "[key: string]",
|
|
268
|
+
"type": "any",
|
|
269
|
+
"description": ""
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "pt-{optionName}-*",
|
|
273
|
+
"type": "-",
|
|
274
|
+
"default": "",
|
|
275
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
276
|
+
"deprecated": false
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"methods": []
|
|
280
|
+
},
|
|
281
|
+
"BreadcrumbEllipsisState": {
|
|
282
|
+
"description": "Defines valid state in BreadcrumbEllipsis component.",
|
|
283
|
+
"relatedProp": "",
|
|
284
|
+
"props": [],
|
|
285
|
+
"methods": []
|
|
286
|
+
},
|
|
287
|
+
"BreadcrumbEllipsisExposes": {
|
|
288
|
+
"description": "Defines the methods and properties exposed by BreadcrumbEllipsis component.",
|
|
289
|
+
"relatedProp": "",
|
|
290
|
+
"props": [
|
|
291
|
+
{
|
|
292
|
+
"name": "breadcrumb",
|
|
293
|
+
"type": "BreadcrumbRootInstance",
|
|
294
|
+
"default": "",
|
|
295
|
+
"description": "Instance of the Breadcrumb component."
|
|
296
|
+
}
|
|
297
|
+
],
|
|
298
|
+
"methods": []
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"types": {
|
|
302
|
+
"BreadcrumbEllipsisPassThroughType": {
|
|
303
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbEllipsis component.",
|
|
304
|
+
"values": "PassThroughType<BreadcrumbEllipsisInstance, E>"
|
|
305
|
+
},
|
|
306
|
+
"BreadcrumbEllipsisInstance": {
|
|
307
|
+
"description": "Instance of BreadcrumbEllipsis component.",
|
|
308
|
+
"values": "ComponentInstance<BreadcrumbEllipsisProps, BreadcrumbEllipsisState, BreadcrumbEllipsisExposes>"
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"variables": {}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "BreadcrumbItem",
|
|
316
|
+
"source": "apps/showcase/assets/apidoc/breadcrumbitem.json",
|
|
317
|
+
"data": {
|
|
318
|
+
"description": "BreadcrumbItem is a component that displays the item.",
|
|
319
|
+
"interfaces": {
|
|
320
|
+
"BreadcrumbItemPassThrough": {
|
|
321
|
+
"description": "Defines passthrough(pt) options of BreadcrumbItem component.",
|
|
322
|
+
"relatedProp": "",
|
|
323
|
+
"props": [
|
|
324
|
+
{
|
|
325
|
+
"name": "root",
|
|
326
|
+
"type": "BreadcrumbItemPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
327
|
+
"default": "",
|
|
328
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"methods": []
|
|
332
|
+
},
|
|
333
|
+
"BreadcrumbItemProps": {
|
|
334
|
+
"description": "Defines valid properties in BreadcrumbItem component.",
|
|
335
|
+
"relatedProp": "",
|
|
336
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbItemInstance, unknown, BreadcrumbItemPassThrough>",
|
|
337
|
+
"props": [
|
|
338
|
+
{
|
|
339
|
+
"name": "ref",
|
|
340
|
+
"type": "Ref<unknown>",
|
|
341
|
+
"default": "",
|
|
342
|
+
"description": "The reference to the component instance."
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
"name": "pIf",
|
|
346
|
+
"type": "boolean",
|
|
347
|
+
"default": "true",
|
|
348
|
+
"description": "Whether the component should be rendered."
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "style",
|
|
352
|
+
"type": "CSSProperties | ((instance?: BreadcrumbItemInstance) => CSSProperties)",
|
|
353
|
+
"default": "",
|
|
354
|
+
"description": "The style to apply to the component."
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "className",
|
|
358
|
+
"type": "string | ((instance?: BreadcrumbItemInstance) => string)",
|
|
359
|
+
"default": "",
|
|
360
|
+
"description": "The class name to apply to the component."
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "as",
|
|
364
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
365
|
+
"default": "",
|
|
366
|
+
"description": "The component type to render."
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "asChild",
|
|
370
|
+
"type": "boolean",
|
|
371
|
+
"default": "false",
|
|
372
|
+
"description": "Whether the component should be rendered as a child component."
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "instance",
|
|
376
|
+
"type": "BreadcrumbItemInstance",
|
|
377
|
+
"default": "",
|
|
378
|
+
"description": "The instance to pass to the component."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "pt",
|
|
382
|
+
"type": "SafeRecord<BreadcrumbItemPassThrough>",
|
|
383
|
+
"default": "",
|
|
384
|
+
"description": "The pass-through props to pass to the component."
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"name": "ptOptions",
|
|
388
|
+
"type": "PassThroughOptions",
|
|
389
|
+
"default": "",
|
|
390
|
+
"description": "The pass-through options to pass to the component."
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "unstyled",
|
|
394
|
+
"type": "boolean",
|
|
395
|
+
"default": "",
|
|
396
|
+
"description": "Whether the component should be rendered without classes."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "dt",
|
|
400
|
+
"type": "unknown",
|
|
401
|
+
"default": "",
|
|
402
|
+
"description": "The design token to use for the component."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "styles",
|
|
406
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
407
|
+
"default": "",
|
|
408
|
+
"description": "The styles to use for the component."
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"name": "render",
|
|
412
|
+
"type": "(instance: BreadcrumbItemInstance) => ReactNode",
|
|
413
|
+
"default": "",
|
|
414
|
+
"description": "The render function to render the component with instance access."
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "children",
|
|
418
|
+
"type": "any",
|
|
419
|
+
"default": "",
|
|
420
|
+
"description": "The children to render.\n\nAccepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access.\nTyped as `any` to avoid JSX type errors when used directly in templates."
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
"name": "[key: string]",
|
|
424
|
+
"type": "any",
|
|
425
|
+
"description": ""
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "pt-{optionName}-*",
|
|
429
|
+
"type": "-",
|
|
430
|
+
"default": "",
|
|
431
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
432
|
+
"deprecated": false
|
|
433
|
+
}
|
|
434
|
+
],
|
|
435
|
+
"methods": []
|
|
436
|
+
},
|
|
437
|
+
"BreadcrumbItemState": {
|
|
438
|
+
"description": "Defines valid state in BreadcrumbItem component.",
|
|
439
|
+
"relatedProp": "",
|
|
440
|
+
"props": [],
|
|
441
|
+
"methods": []
|
|
442
|
+
},
|
|
443
|
+
"BreadcrumbItemExposes": {
|
|
444
|
+
"description": "Defines the methods and properties exposed by BreadcrumbItem component.",
|
|
445
|
+
"relatedProp": "",
|
|
446
|
+
"props": [
|
|
447
|
+
{
|
|
448
|
+
"name": "breadcrumb",
|
|
449
|
+
"type": "BreadcrumbRootInstance",
|
|
450
|
+
"default": "",
|
|
451
|
+
"description": "Instance of the Breadcrumb component."
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
"methods": []
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"types": {
|
|
458
|
+
"BreadcrumbItemPassThroughType": {
|
|
459
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbItem component.",
|
|
460
|
+
"values": "PassThroughType<BreadcrumbItemInstance, E>"
|
|
461
|
+
},
|
|
462
|
+
"BreadcrumbItemInstance": {
|
|
463
|
+
"description": "Instance of BreadcrumbItem component.",
|
|
464
|
+
"values": "ComponentInstance<BreadcrumbItemProps, BreadcrumbItemState, BreadcrumbItemExposes>"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"variables": {}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "BreadcrumbLink",
|
|
472
|
+
"source": "apps/showcase/assets/apidoc/breadcrumblink.json",
|
|
473
|
+
"data": {
|
|
474
|
+
"description": "BreadcrumbLink is a component that displays a navigable link in the breadcrumb.",
|
|
475
|
+
"interfaces": {
|
|
476
|
+
"BreadcrumbLinkPassThrough": {
|
|
477
|
+
"description": "Defines passthrough(pt) options of BreadcrumbLink component.",
|
|
478
|
+
"relatedProp": "",
|
|
479
|
+
"props": [
|
|
480
|
+
{
|
|
481
|
+
"name": "root",
|
|
482
|
+
"type": "BreadcrumbLinkPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
|
|
483
|
+
"default": "",
|
|
484
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
485
|
+
}
|
|
486
|
+
],
|
|
487
|
+
"methods": []
|
|
488
|
+
},
|
|
489
|
+
"BreadcrumbLinkProps": {
|
|
490
|
+
"description": "Defines valid properties in BreadcrumbLink component.",
|
|
491
|
+
"relatedProp": "",
|
|
492
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbLinkInstance, unknown, BreadcrumbLinkPassThrough>",
|
|
493
|
+
"props": [
|
|
494
|
+
{
|
|
495
|
+
"name": "ref",
|
|
496
|
+
"type": "Ref<unknown>",
|
|
497
|
+
"default": "",
|
|
498
|
+
"description": "The reference to the component instance."
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "pIf",
|
|
502
|
+
"type": "boolean",
|
|
503
|
+
"default": "true",
|
|
504
|
+
"description": "Whether the component should be rendered."
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "style",
|
|
508
|
+
"type": "CSSProperties | ((instance?: BreadcrumbLinkInstance) => CSSProperties)",
|
|
509
|
+
"default": "",
|
|
510
|
+
"description": "The style to apply to the component."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "className",
|
|
514
|
+
"type": "string | ((instance?: BreadcrumbLinkInstance) => string)",
|
|
515
|
+
"default": "",
|
|
516
|
+
"description": "The class name to apply to the component."
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "as",
|
|
520
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
521
|
+
"default": "",
|
|
522
|
+
"description": "The component type to render."
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"name": "asChild",
|
|
526
|
+
"type": "boolean",
|
|
527
|
+
"default": "false",
|
|
528
|
+
"description": "Whether the component should be rendered as a child component."
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "instance",
|
|
532
|
+
"type": "BreadcrumbLinkInstance",
|
|
533
|
+
"default": "",
|
|
534
|
+
"description": "The instance to pass to the component."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "pt",
|
|
538
|
+
"type": "SafeRecord<BreadcrumbLinkPassThrough>",
|
|
539
|
+
"default": "",
|
|
540
|
+
"description": "The pass-through props to pass to the component."
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"name": "ptOptions",
|
|
544
|
+
"type": "PassThroughOptions",
|
|
545
|
+
"default": "",
|
|
546
|
+
"description": "The pass-through options to pass to the component."
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "unstyled",
|
|
550
|
+
"type": "boolean",
|
|
551
|
+
"default": "",
|
|
552
|
+
"description": "Whether the component should be rendered without classes."
|
|
553
|
+
},
|
|
554
|
+
{
|
|
555
|
+
"name": "dt",
|
|
556
|
+
"type": "unknown",
|
|
557
|
+
"default": "",
|
|
558
|
+
"description": "The design token to use for the component."
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"name": "styles",
|
|
562
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
563
|
+
"default": "",
|
|
564
|
+
"description": "The styles to use for the component."
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"name": "render",
|
|
568
|
+
"type": "(instance: BreadcrumbLinkInstance) => ReactNode",
|
|
569
|
+
"default": "",
|
|
570
|
+
"description": "The render function to render the component with instance access."
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"name": "children",
|
|
574
|
+
"type": "any",
|
|
575
|
+
"default": "",
|
|
576
|
+
"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."
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"name": "[key: string]",
|
|
580
|
+
"type": "any",
|
|
581
|
+
"description": ""
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"name": "pt-{optionName}-*",
|
|
585
|
+
"type": "-",
|
|
586
|
+
"default": "",
|
|
587
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
588
|
+
"deprecated": false
|
|
589
|
+
}
|
|
590
|
+
],
|
|
591
|
+
"methods": []
|
|
592
|
+
},
|
|
593
|
+
"BreadcrumbLinkState": {
|
|
594
|
+
"description": "Defines valid state in BreadcrumbLink component.",
|
|
595
|
+
"relatedProp": "",
|
|
596
|
+
"props": [],
|
|
597
|
+
"methods": []
|
|
598
|
+
},
|
|
599
|
+
"BreadcrumbLinkExposes": {
|
|
600
|
+
"description": "Defines the methods and properties exposed by BreadcrumbLink component.",
|
|
601
|
+
"relatedProp": "",
|
|
602
|
+
"props": [
|
|
603
|
+
{
|
|
604
|
+
"name": "breadcrumb",
|
|
605
|
+
"type": "BreadcrumbRootInstance",
|
|
606
|
+
"default": "",
|
|
607
|
+
"description": "Instance of the Breadcrumb component."
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"methods": []
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
"types": {
|
|
614
|
+
"BreadcrumbLinkPassThroughType": {
|
|
615
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbLink component.",
|
|
616
|
+
"values": "PassThroughType<BreadcrumbLinkInstance, E>"
|
|
617
|
+
},
|
|
618
|
+
"BreadcrumbLinkInstance": {
|
|
619
|
+
"description": "Instance of BreadcrumbLink component.",
|
|
620
|
+
"values": "ComponentInstance<BreadcrumbLinkProps, BreadcrumbLinkState, BreadcrumbLinkExposes>"
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
"variables": {}
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "BreadcrumbList",
|
|
628
|
+
"source": "apps/showcase/assets/apidoc/breadcrumblist.json",
|
|
629
|
+
"data": {
|
|
630
|
+
"description": "BreadcrumbList is a component that displays the list.",
|
|
631
|
+
"interfaces": {
|
|
632
|
+
"BreadcrumbListPassThrough": {
|
|
633
|
+
"description": "Defines passthrough(pt) options of BreadcrumbList component.",
|
|
634
|
+
"relatedProp": "",
|
|
635
|
+
"props": [
|
|
636
|
+
{
|
|
637
|
+
"name": "root",
|
|
638
|
+
"type": "BreadcrumbListPassThroughType<HTMLAttributes<HTMLOListElement>>",
|
|
639
|
+
"default": "",
|
|
640
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"methods": []
|
|
644
|
+
},
|
|
645
|
+
"BreadcrumbListProps": {
|
|
646
|
+
"description": "Defines valid properties in BreadcrumbList component.",
|
|
647
|
+
"relatedProp": "",
|
|
648
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbListInstance, unknown, BreadcrumbListPassThrough>",
|
|
649
|
+
"props": [
|
|
650
|
+
{
|
|
651
|
+
"name": "ref",
|
|
652
|
+
"type": "Ref<unknown>",
|
|
653
|
+
"default": "",
|
|
654
|
+
"description": "The reference to the component instance."
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
"name": "pIf",
|
|
658
|
+
"type": "boolean",
|
|
659
|
+
"default": "true",
|
|
660
|
+
"description": "Whether the component should be rendered."
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"name": "style",
|
|
664
|
+
"type": "CSSProperties | ((instance?: BreadcrumbListInstance) => CSSProperties)",
|
|
665
|
+
"default": "",
|
|
666
|
+
"description": "The style to apply to the component."
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "className",
|
|
670
|
+
"type": "string | ((instance?: BreadcrumbListInstance) => string)",
|
|
671
|
+
"default": "",
|
|
672
|
+
"description": "The class name to apply to the component."
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"name": "as",
|
|
676
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
677
|
+
"default": "",
|
|
678
|
+
"description": "The component type to render."
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "asChild",
|
|
682
|
+
"type": "boolean",
|
|
683
|
+
"default": "false",
|
|
684
|
+
"description": "Whether the component should be rendered as a child component."
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "instance",
|
|
688
|
+
"type": "BreadcrumbListInstance",
|
|
689
|
+
"default": "",
|
|
690
|
+
"description": "The instance to pass to the component."
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"name": "pt",
|
|
694
|
+
"type": "SafeRecord<BreadcrumbListPassThrough>",
|
|
695
|
+
"default": "",
|
|
696
|
+
"description": "The pass-through props to pass to the component."
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "ptOptions",
|
|
700
|
+
"type": "PassThroughOptions",
|
|
701
|
+
"default": "",
|
|
702
|
+
"description": "The pass-through options to pass to the component."
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"name": "unstyled",
|
|
706
|
+
"type": "boolean",
|
|
707
|
+
"default": "",
|
|
708
|
+
"description": "Whether the component should be rendered without classes."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "dt",
|
|
712
|
+
"type": "unknown",
|
|
713
|
+
"default": "",
|
|
714
|
+
"description": "The design token to use for the component."
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
"name": "styles",
|
|
718
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
719
|
+
"default": "",
|
|
720
|
+
"description": "The styles to use for the component."
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "render",
|
|
724
|
+
"type": "(instance: BreadcrumbListInstance) => ReactNode",
|
|
725
|
+
"default": "",
|
|
726
|
+
"description": "The render function to render the component with instance access."
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"name": "children",
|
|
730
|
+
"type": "any",
|
|
731
|
+
"default": "",
|
|
732
|
+
"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."
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "[key: string]",
|
|
736
|
+
"type": "any",
|
|
737
|
+
"description": ""
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"name": "pt-{optionName}-*",
|
|
741
|
+
"type": "-",
|
|
742
|
+
"default": "",
|
|
743
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
744
|
+
"deprecated": false
|
|
745
|
+
}
|
|
746
|
+
],
|
|
747
|
+
"methods": []
|
|
748
|
+
},
|
|
749
|
+
"BreadcrumbListState": {
|
|
750
|
+
"description": "Defines valid state in BreadcrumbList component.",
|
|
751
|
+
"relatedProp": "",
|
|
752
|
+
"props": [],
|
|
753
|
+
"methods": []
|
|
754
|
+
},
|
|
755
|
+
"BreadcrumbListExposes": {
|
|
756
|
+
"description": "Defines the methods and properties exposed by BreadcrumbList component.",
|
|
757
|
+
"relatedProp": "",
|
|
758
|
+
"props": [
|
|
759
|
+
{
|
|
760
|
+
"name": "breadcrumb",
|
|
761
|
+
"type": "BreadcrumbRootInstance",
|
|
762
|
+
"default": "",
|
|
763
|
+
"description": "Instance of the Breadcrumb component."
|
|
764
|
+
}
|
|
765
|
+
],
|
|
766
|
+
"methods": []
|
|
767
|
+
}
|
|
768
|
+
},
|
|
769
|
+
"types": {
|
|
770
|
+
"BreadcrumbListPassThroughType": {
|
|
771
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbList component.",
|
|
772
|
+
"values": "PassThroughType<BreadcrumbListInstance, E>"
|
|
773
|
+
},
|
|
774
|
+
"BreadcrumbListInstance": {
|
|
775
|
+
"description": "Instance of BreadcrumbList component.",
|
|
776
|
+
"values": "ComponentInstance<BreadcrumbListProps, BreadcrumbListState, BreadcrumbListExposes>"
|
|
777
|
+
}
|
|
778
|
+
},
|
|
779
|
+
"variables": {}
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"name": "BreadcrumbRoot",
|
|
784
|
+
"source": "apps/showcase/assets/apidoc/breadcrumbroot.json",
|
|
785
|
+
"data": {
|
|
786
|
+
"description": "Breadcrumb provides contextual information about page hierarchy.",
|
|
787
|
+
"interfaces": {
|
|
788
|
+
"BreadcrumbRootPassThrough": {
|
|
789
|
+
"description": "Defines passthrough(pt) options of Breadcrumb component.",
|
|
790
|
+
"relatedProp": "",
|
|
791
|
+
"props": [
|
|
792
|
+
{
|
|
793
|
+
"name": "root",
|
|
794
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLElement>>",
|
|
795
|
+
"default": "",
|
|
796
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"name": "list",
|
|
800
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLOListElement>>",
|
|
801
|
+
"default": "",
|
|
802
|
+
"description": "Used to pass attributes to the list's DOM element."
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
"name": "item",
|
|
806
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
807
|
+
"default": "",
|
|
808
|
+
"description": "Used to pass attributes to the item's DOM element."
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
"name": "separator",
|
|
812
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
813
|
+
"default": "",
|
|
814
|
+
"description": "Used to pass attributes to the separator's DOM element."
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "link",
|
|
818
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLAnchorElement>>",
|
|
819
|
+
"default": "",
|
|
820
|
+
"description": "Used to pass attributes to the link's DOM element."
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "current",
|
|
824
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
825
|
+
"default": "",
|
|
826
|
+
"description": "Used to pass attributes to the current's DOM element."
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
"name": "ellipsis",
|
|
830
|
+
"type": "BreadcrumbRootPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
831
|
+
"default": "",
|
|
832
|
+
"description": "Used to pass attributes to the ellipsis's DOM element."
|
|
833
|
+
}
|
|
834
|
+
],
|
|
835
|
+
"methods": []
|
|
836
|
+
},
|
|
837
|
+
"BreadcrumbRootProps": {
|
|
838
|
+
"description": "Defines valid properties in Breadcrumb component.",
|
|
839
|
+
"relatedProp": "",
|
|
840
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbRootInstance, UseBreadcrumbProps, BreadcrumbRootPassThrough>",
|
|
841
|
+
"props": [
|
|
842
|
+
{
|
|
843
|
+
"name": "ref",
|
|
844
|
+
"type": "Ref<unknown>",
|
|
845
|
+
"default": "",
|
|
846
|
+
"description": "The reference to the component instance."
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "pIf",
|
|
850
|
+
"type": "boolean",
|
|
851
|
+
"default": "true",
|
|
852
|
+
"description": "Whether the component should be rendered."
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"name": "style",
|
|
856
|
+
"type": "CSSProperties | ((instance?: BreadcrumbRootInstance) => CSSProperties)",
|
|
857
|
+
"default": "",
|
|
858
|
+
"description": "The style to apply to the component."
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "className",
|
|
862
|
+
"type": "string | ((instance?: BreadcrumbRootInstance) => string)",
|
|
863
|
+
"default": "",
|
|
864
|
+
"description": "The class name to apply to the component."
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "as",
|
|
868
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
869
|
+
"default": "",
|
|
870
|
+
"description": "The component type to render."
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "asChild",
|
|
874
|
+
"type": "boolean",
|
|
875
|
+
"default": "false",
|
|
876
|
+
"description": "Whether the component should be rendered as a child component."
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "instance",
|
|
880
|
+
"type": "BreadcrumbRootInstance",
|
|
881
|
+
"default": "",
|
|
882
|
+
"description": "The instance to pass to the component."
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "pt",
|
|
886
|
+
"type": "SafeRecord<BreadcrumbRootPassThrough>",
|
|
887
|
+
"default": "",
|
|
888
|
+
"description": "The pass-through props to pass to the component."
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"name": "ptOptions",
|
|
892
|
+
"type": "PassThroughOptions",
|
|
893
|
+
"default": "",
|
|
894
|
+
"description": "The pass-through options to pass to the component."
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
"name": "unstyled",
|
|
898
|
+
"type": "boolean",
|
|
899
|
+
"default": "",
|
|
900
|
+
"description": "Whether the component should be rendered without classes."
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"name": "dt",
|
|
904
|
+
"type": "unknown",
|
|
905
|
+
"default": "",
|
|
906
|
+
"description": "The design token to use for the component."
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"name": "styles",
|
|
910
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
911
|
+
"default": "",
|
|
912
|
+
"description": "The styles to use for the component."
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"name": "render",
|
|
916
|
+
"type": "(instance: BreadcrumbRootInstance) => ReactNode",
|
|
917
|
+
"default": "",
|
|
918
|
+
"description": "The render function to render the component with instance access."
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
"name": "children",
|
|
922
|
+
"type": "any",
|
|
923
|
+
"default": "",
|
|
924
|
+
"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."
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "align",
|
|
928
|
+
"type": "\"center\" | \"top\" | \"bottom\" | \"left\" | \"right\"",
|
|
929
|
+
"default": "",
|
|
930
|
+
"description": "Alignment of the content."
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"name": "orientation",
|
|
934
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
935
|
+
"default": "horizontal",
|
|
936
|
+
"description": "Specifies the orientation, valid values are 'horizontal' and 'vertical'."
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "type",
|
|
940
|
+
"type": "\"solid\" | \"dashed\" | \"dotted\"",
|
|
941
|
+
"default": "solid",
|
|
942
|
+
"description": "Border style type."
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "[key: string]",
|
|
946
|
+
"type": "any",
|
|
947
|
+
"description": ""
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"name": "pt-{optionName}-*",
|
|
951
|
+
"type": "-",
|
|
952
|
+
"default": "",
|
|
953
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
954
|
+
"deprecated": false
|
|
955
|
+
}
|
|
956
|
+
],
|
|
957
|
+
"methods": []
|
|
958
|
+
},
|
|
959
|
+
"BreadcrumbRootState": {
|
|
960
|
+
"description": "Defines valid state in Breadcrumb component.",
|
|
961
|
+
"relatedProp": "",
|
|
962
|
+
"extendedTypes": "UseBreadcrumbState",
|
|
963
|
+
"props": [],
|
|
964
|
+
"methods": []
|
|
965
|
+
},
|
|
966
|
+
"BreadcrumbRootExposes": {
|
|
967
|
+
"description": "Defines the methods and properties exposed by Breadcrumb component.",
|
|
968
|
+
"relatedProp": "",
|
|
969
|
+
"extendedTypes": "UseBreadcrumbExposes",
|
|
970
|
+
"props": [
|
|
971
|
+
{
|
|
972
|
+
"name": "rootProps",
|
|
973
|
+
"type": "UseBreadcrumbRootProps",
|
|
974
|
+
"default": "",
|
|
975
|
+
"description": "Pre-built props for the root element.\nIncludes data attributes and accessible label."
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "ellipsisProps",
|
|
979
|
+
"type": "UseBreadcrumbEllipsisProps",
|
|
980
|
+
"default": "",
|
|
981
|
+
"description": "Pre-built props for the ellipsis element.\nIncludes data attributes, presentational role, and aria-hidden."
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "separatorProps",
|
|
985
|
+
"type": "UseBreadcrumbSeparatorProps",
|
|
986
|
+
"default": "",
|
|
987
|
+
"description": "Pre-built props for the separator element.\nIncludes data attributes, presentational role, and aria-hidden."
|
|
988
|
+
}
|
|
989
|
+
],
|
|
990
|
+
"methods": []
|
|
991
|
+
}
|
|
992
|
+
},
|
|
993
|
+
"types": {
|
|
994
|
+
"BreadcrumbRootPassThroughType": {
|
|
995
|
+
"description": "Defines passthrough(pt) options type in Breadcrumb component.",
|
|
996
|
+
"values": "PassThroughType<BreadcrumbRootInstance, E>"
|
|
997
|
+
},
|
|
998
|
+
"BreadcrumbRootInstance": {
|
|
999
|
+
"description": "Instance of Breadcrumb component.",
|
|
1000
|
+
"values": "ComponentInstance<BreadcrumbRootProps, BreadcrumbRootState, BreadcrumbRootExposes>"
|
|
1001
|
+
}
|
|
1002
|
+
},
|
|
1003
|
+
"variables": {}
|
|
1004
|
+
}
|
|
1005
|
+
},
|
|
1006
|
+
{
|
|
1007
|
+
"name": "BreadcrumbSeparator",
|
|
1008
|
+
"source": "apps/showcase/assets/apidoc/breadcrumbseparator.json",
|
|
1009
|
+
"data": {
|
|
1010
|
+
"description": "BreadcrumbSeparator is a component that displays the separator.",
|
|
1011
|
+
"interfaces": {
|
|
1012
|
+
"BreadcrumbSeparatorPassThrough": {
|
|
1013
|
+
"description": "Defines passthrough(pt) options of BreadcrumbSeparator component.",
|
|
1014
|
+
"relatedProp": "",
|
|
1015
|
+
"props": [
|
|
1016
|
+
{
|
|
1017
|
+
"name": "root",
|
|
1018
|
+
"type": "BreadcrumbSeparatorPassThroughType<HTMLAttributes<HTMLLIElement>>",
|
|
1019
|
+
"default": "",
|
|
1020
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1021
|
+
}
|
|
1022
|
+
],
|
|
1023
|
+
"methods": []
|
|
1024
|
+
},
|
|
1025
|
+
"BreadcrumbSeparatorProps": {
|
|
1026
|
+
"description": "Defines valid properties in BreadcrumbSeparator component.",
|
|
1027
|
+
"relatedProp": "",
|
|
1028
|
+
"extendedTypes": "BaseComponentProps<BreadcrumbSeparatorInstance, unknown, BreadcrumbSeparatorPassThrough>",
|
|
1029
|
+
"props": [
|
|
1030
|
+
{
|
|
1031
|
+
"name": "ref",
|
|
1032
|
+
"type": "Ref<unknown>",
|
|
1033
|
+
"default": "",
|
|
1034
|
+
"description": "The reference to the component instance."
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "pIf",
|
|
1038
|
+
"type": "boolean",
|
|
1039
|
+
"default": "true",
|
|
1040
|
+
"description": "Whether the component should be rendered."
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "style",
|
|
1044
|
+
"type": "CSSProperties | ((instance?: BreadcrumbSeparatorInstance) => CSSProperties)",
|
|
1045
|
+
"default": "",
|
|
1046
|
+
"description": "The style to apply to the component."
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"name": "className",
|
|
1050
|
+
"type": "string | ((instance?: BreadcrumbSeparatorInstance) => string)",
|
|
1051
|
+
"default": "",
|
|
1052
|
+
"description": "The class name to apply to the component."
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"name": "as",
|
|
1056
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1057
|
+
"default": "",
|
|
1058
|
+
"description": "The component type to render."
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "asChild",
|
|
1062
|
+
"type": "boolean",
|
|
1063
|
+
"default": "false",
|
|
1064
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "instance",
|
|
1068
|
+
"type": "BreadcrumbSeparatorInstance",
|
|
1069
|
+
"default": "",
|
|
1070
|
+
"description": "The instance to pass to the component."
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"name": "pt",
|
|
1074
|
+
"type": "SafeRecord<BreadcrumbSeparatorPassThrough>",
|
|
1075
|
+
"default": "",
|
|
1076
|
+
"description": "The pass-through props to pass to the component."
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "ptOptions",
|
|
1080
|
+
"type": "PassThroughOptions",
|
|
1081
|
+
"default": "",
|
|
1082
|
+
"description": "The pass-through options to pass to the component."
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"name": "unstyled",
|
|
1086
|
+
"type": "boolean",
|
|
1087
|
+
"default": "",
|
|
1088
|
+
"description": "Whether the component should be rendered without classes."
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"name": "dt",
|
|
1092
|
+
"type": "unknown",
|
|
1093
|
+
"default": "",
|
|
1094
|
+
"description": "The design token to use for the component."
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"name": "styles",
|
|
1098
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1099
|
+
"default": "",
|
|
1100
|
+
"description": "The styles to use for the component."
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
"name": "render",
|
|
1104
|
+
"type": "(instance: BreadcrumbSeparatorInstance) => ReactNode",
|
|
1105
|
+
"default": "",
|
|
1106
|
+
"description": "The render function to render the component with instance access."
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "children",
|
|
1110
|
+
"type": "any",
|
|
1111
|
+
"default": "",
|
|
1112
|
+
"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."
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
"name": "[key: string]",
|
|
1116
|
+
"type": "any",
|
|
1117
|
+
"description": ""
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"name": "pt-{optionName}-*",
|
|
1121
|
+
"type": "-",
|
|
1122
|
+
"default": "",
|
|
1123
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1124
|
+
"deprecated": false
|
|
1125
|
+
}
|
|
1126
|
+
],
|
|
1127
|
+
"methods": []
|
|
1128
|
+
},
|
|
1129
|
+
"BreadcrumbSeparatorState": {
|
|
1130
|
+
"description": "Defines valid state in BreadcrumbSeparator component.",
|
|
1131
|
+
"relatedProp": "",
|
|
1132
|
+
"props": [],
|
|
1133
|
+
"methods": []
|
|
1134
|
+
},
|
|
1135
|
+
"BreadcrumbSeparatorExposes": {
|
|
1136
|
+
"description": "Defines the methods and properties exposed by BreadcrumbSeparator component.",
|
|
1137
|
+
"relatedProp": "",
|
|
1138
|
+
"props": [
|
|
1139
|
+
{
|
|
1140
|
+
"name": "breadcrumb",
|
|
1141
|
+
"type": "BreadcrumbRootInstance",
|
|
1142
|
+
"default": "",
|
|
1143
|
+
"description": "Instance of the Breadcrumb component."
|
|
1144
|
+
}
|
|
1145
|
+
],
|
|
1146
|
+
"methods": []
|
|
1147
|
+
}
|
|
1148
|
+
},
|
|
1149
|
+
"types": {
|
|
1150
|
+
"BreadcrumbSeparatorPassThroughType": {
|
|
1151
|
+
"description": "Defines passthrough(pt) options type in BreadcrumbSeparator component.",
|
|
1152
|
+
"values": "PassThroughType<BreadcrumbSeparatorInstance, E>"
|
|
1153
|
+
},
|
|
1154
|
+
"BreadcrumbSeparatorInstance": {
|
|
1155
|
+
"description": "Instance of BreadcrumbSeparator component.",
|
|
1156
|
+
"values": "ComponentInstance<BreadcrumbSeparatorProps, BreadcrumbSeparatorState, BreadcrumbSeparatorExposes>"
|
|
1157
|
+
}
|
|
1158
|
+
},
|
|
1159
|
+
"variables": {}
|
|
1160
|
+
}
|
|
1161
|
+
}
|
|
1162
|
+
]
|