@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,1374 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "CarouselContent",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/carouselcontent.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "CarouselContent is a component that displays content inside a Carousel.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"CarouselContentPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of CarouselContent component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "CarouselContentPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"CarouselContentProps": {
|
|
22
|
+
"description": "Defines valid properties in CarouselContent component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<CarouselContentInstance, unknown, CarouselContentPassThrough>",
|
|
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?: CarouselContentInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: CarouselContentInstance) => 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": "CarouselContentInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<CarouselContentPassThrough>",
|
|
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: CarouselContentInstance) => 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
|
+
"CarouselContentState": {
|
|
126
|
+
"description": "Defines valid state in CarouselContent component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"CarouselContentExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by CarouselContent component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "carousel",
|
|
137
|
+
"type": "CarouselRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Carousel component instance."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"CarouselContentPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in CarouselContent component.",
|
|
148
|
+
"values": "PassThroughType<CarouselContentInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"CarouselContentInstance": {
|
|
151
|
+
"description": "Instance of CarouselContent component.",
|
|
152
|
+
"values": "ComponentInstance<CarouselContentProps, CarouselContentState, CarouselContentExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "CarouselIndicator",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/carouselindicator.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "CarouselIndicator is a component that displays indicator for the Carousel.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"CarouselIndicatorPassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of CarouselIndicator component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "CarouselIndicatorPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"CarouselIndicatorProps": {
|
|
178
|
+
"description": "Defines valid properties in CarouselIndicator component.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "BaseComponentProps<CarouselIndicatorInstance, unknown, CarouselIndicatorPassThrough>",
|
|
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?: CarouselIndicatorInstance) => CSSProperties)",
|
|
197
|
+
"default": "",
|
|
198
|
+
"description": "The style to apply to the component."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "className",
|
|
202
|
+
"type": "string | ((instance?: CarouselIndicatorInstance) => 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": "CarouselIndicatorInstance",
|
|
221
|
+
"default": "",
|
|
222
|
+
"description": "The instance to pass to the component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "pt",
|
|
226
|
+
"type": "SafeRecord<CarouselIndicatorPassThrough>",
|
|
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: CarouselIndicatorInstance) => 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": "page",
|
|
268
|
+
"type": "number",
|
|
269
|
+
"default": ""
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "[key: string]",
|
|
273
|
+
"type": "any",
|
|
274
|
+
"description": ""
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
"name": "pt-{optionName}-*",
|
|
278
|
+
"type": "-",
|
|
279
|
+
"default": "",
|
|
280
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
281
|
+
"deprecated": false
|
|
282
|
+
}
|
|
283
|
+
],
|
|
284
|
+
"methods": []
|
|
285
|
+
},
|
|
286
|
+
"CarouselIndicatorState": {
|
|
287
|
+
"description": "Defines valid state in CarouselIndicator component.",
|
|
288
|
+
"relatedProp": "",
|
|
289
|
+
"props": [],
|
|
290
|
+
"methods": []
|
|
291
|
+
},
|
|
292
|
+
"CarouselIndicatorExposes": {
|
|
293
|
+
"description": "Defines the methods and properties exposed by CarouselIndicator component.",
|
|
294
|
+
"relatedProp": "",
|
|
295
|
+
"props": [
|
|
296
|
+
{
|
|
297
|
+
"name": "carousel",
|
|
298
|
+
"type": "CarouselRootInstance",
|
|
299
|
+
"default": "",
|
|
300
|
+
"description": "The Carousel component instance."
|
|
301
|
+
}
|
|
302
|
+
],
|
|
303
|
+
"methods": []
|
|
304
|
+
}
|
|
305
|
+
},
|
|
306
|
+
"types": {
|
|
307
|
+
"CarouselIndicatorPassThroughType": {
|
|
308
|
+
"description": "Defines passthrough(pt) options type in CarouselIndicator component.",
|
|
309
|
+
"values": "PassThroughType<CarouselIndicatorInstance, E>"
|
|
310
|
+
},
|
|
311
|
+
"CarouselIndicatorInstance": {
|
|
312
|
+
"description": "Instance of CarouselIndicator component.",
|
|
313
|
+
"values": "ComponentInstance<CarouselIndicatorProps, CarouselIndicatorState, CarouselIndicatorExposes>"
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
"variables": {}
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"name": "CarouselIndicators",
|
|
321
|
+
"source": "apps/showcase/assets/apidoc/carouselindicators.json",
|
|
322
|
+
"data": {
|
|
323
|
+
"description": "CarouselIndicators is a component that displays indicators for the Carousel.",
|
|
324
|
+
"interfaces": {
|
|
325
|
+
"CarouselIndicatorsPassThrough": {
|
|
326
|
+
"description": "Defines passthrough(pt) options of CarouselIndicators component.",
|
|
327
|
+
"relatedProp": "",
|
|
328
|
+
"props": [
|
|
329
|
+
{
|
|
330
|
+
"name": "root",
|
|
331
|
+
"type": "CarouselIndicatorsPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
332
|
+
"default": "",
|
|
333
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
334
|
+
}
|
|
335
|
+
],
|
|
336
|
+
"methods": []
|
|
337
|
+
},
|
|
338
|
+
"CarouselIndicatorsProps": {
|
|
339
|
+
"description": "Defines valid properties in CarouselIndicators component.",
|
|
340
|
+
"relatedProp": "",
|
|
341
|
+
"extendedTypes": "BaseComponentProps<CarouselIndicatorsInstance, unknown, CarouselIndicatorsPassThrough>",
|
|
342
|
+
"props": [
|
|
343
|
+
{
|
|
344
|
+
"name": "ref",
|
|
345
|
+
"type": "Ref<unknown>",
|
|
346
|
+
"default": "",
|
|
347
|
+
"description": "The reference to the component instance."
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"name": "pIf",
|
|
351
|
+
"type": "boolean",
|
|
352
|
+
"default": "true",
|
|
353
|
+
"description": "Whether the component should be rendered."
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "style",
|
|
357
|
+
"type": "CSSProperties | ((instance?: CarouselIndicatorsInstance) => CSSProperties)",
|
|
358
|
+
"default": "",
|
|
359
|
+
"description": "The style to apply to the component."
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"name": "className",
|
|
363
|
+
"type": "string | ((instance?: CarouselIndicatorsInstance) => string)",
|
|
364
|
+
"default": "",
|
|
365
|
+
"description": "The class name to apply to the component."
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "as",
|
|
369
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
370
|
+
"default": "",
|
|
371
|
+
"description": "The component type to render."
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"name": "asChild",
|
|
375
|
+
"type": "boolean",
|
|
376
|
+
"default": "false",
|
|
377
|
+
"description": "Whether the component should be rendered as a child component."
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"name": "instance",
|
|
381
|
+
"type": "CarouselIndicatorsInstance",
|
|
382
|
+
"default": "",
|
|
383
|
+
"description": "The instance to pass to the component."
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"name": "pt",
|
|
387
|
+
"type": "SafeRecord<CarouselIndicatorsPassThrough>",
|
|
388
|
+
"default": "",
|
|
389
|
+
"description": "The pass-through props to pass to the component."
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"name": "ptOptions",
|
|
393
|
+
"type": "PassThroughOptions",
|
|
394
|
+
"default": "",
|
|
395
|
+
"description": "The pass-through options to pass to the component."
|
|
396
|
+
},
|
|
397
|
+
{
|
|
398
|
+
"name": "unstyled",
|
|
399
|
+
"type": "boolean",
|
|
400
|
+
"default": "",
|
|
401
|
+
"description": "Whether the component should be rendered without classes."
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "dt",
|
|
405
|
+
"type": "unknown",
|
|
406
|
+
"default": "",
|
|
407
|
+
"description": "The design token to use for the component."
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "styles",
|
|
411
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
412
|
+
"default": "",
|
|
413
|
+
"description": "The styles to use for the component."
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "render",
|
|
417
|
+
"type": "(instance: CarouselIndicatorsInstance) => ReactNode",
|
|
418
|
+
"default": "",
|
|
419
|
+
"description": "The render function to render the component with instance access."
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "children",
|
|
423
|
+
"type": "any",
|
|
424
|
+
"default": "",
|
|
425
|
+
"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."
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
"name": "[key: string]",
|
|
429
|
+
"type": "any",
|
|
430
|
+
"description": ""
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
"name": "pt-{optionName}-*",
|
|
434
|
+
"type": "-",
|
|
435
|
+
"default": "",
|
|
436
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
437
|
+
"deprecated": false
|
|
438
|
+
}
|
|
439
|
+
],
|
|
440
|
+
"methods": []
|
|
441
|
+
},
|
|
442
|
+
"CarouselIndicatorsState": {
|
|
443
|
+
"description": "Defines valid state in CarouselIndicators component.",
|
|
444
|
+
"relatedProp": "",
|
|
445
|
+
"props": [],
|
|
446
|
+
"methods": []
|
|
447
|
+
},
|
|
448
|
+
"CarouselIndicatorsExposes": {
|
|
449
|
+
"description": "Defines the methods and properties exposed by CarouselIndicators component.",
|
|
450
|
+
"relatedProp": "",
|
|
451
|
+
"props": [
|
|
452
|
+
{
|
|
453
|
+
"name": "carousel",
|
|
454
|
+
"type": "CarouselRootInstance",
|
|
455
|
+
"default": "",
|
|
456
|
+
"description": "The Carousel component instance."
|
|
457
|
+
}
|
|
458
|
+
],
|
|
459
|
+
"methods": []
|
|
460
|
+
}
|
|
461
|
+
},
|
|
462
|
+
"types": {
|
|
463
|
+
"CarouselIndicatorsPassThroughType": {
|
|
464
|
+
"description": "Defines passthrough(pt) options type in CarouselIndicators component.",
|
|
465
|
+
"values": "PassThroughType<CarouselIndicatorsInstance, E>"
|
|
466
|
+
},
|
|
467
|
+
"CarouselIndicatorsInstance": {
|
|
468
|
+
"description": "Instance of CarouselIndicators component.",
|
|
469
|
+
"values": "ComponentInstance<CarouselIndicatorsProps, CarouselIndicatorsState, CarouselIndicatorsExposes>"
|
|
470
|
+
}
|
|
471
|
+
},
|
|
472
|
+
"variables": {}
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "CarouselItem",
|
|
477
|
+
"source": "apps/showcase/assets/apidoc/carouselitem.json",
|
|
478
|
+
"data": {
|
|
479
|
+
"description": "CarouselItem is a component that displays an item inside a Carousel.",
|
|
480
|
+
"interfaces": {
|
|
481
|
+
"CarouselItemPassThrough": {
|
|
482
|
+
"description": "Defines passthrough(pt) options of CarouselItem component.",
|
|
483
|
+
"relatedProp": "",
|
|
484
|
+
"props": [
|
|
485
|
+
{
|
|
486
|
+
"name": "root",
|
|
487
|
+
"type": "CarouselItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
488
|
+
"default": "",
|
|
489
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
490
|
+
}
|
|
491
|
+
],
|
|
492
|
+
"methods": []
|
|
493
|
+
},
|
|
494
|
+
"CarouselItemProps": {
|
|
495
|
+
"description": "Defines valid properties in CarouselItem component.",
|
|
496
|
+
"relatedProp": "",
|
|
497
|
+
"extendedTypes": "BaseComponentProps<CarouselItemInstance, unknown, CarouselItemPassThrough>",
|
|
498
|
+
"props": [
|
|
499
|
+
{
|
|
500
|
+
"name": "ref",
|
|
501
|
+
"type": "Ref<unknown>",
|
|
502
|
+
"default": "",
|
|
503
|
+
"description": "The reference to the component instance."
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"name": "pIf",
|
|
507
|
+
"type": "boolean",
|
|
508
|
+
"default": "true",
|
|
509
|
+
"description": "Whether the component should be rendered."
|
|
510
|
+
},
|
|
511
|
+
{
|
|
512
|
+
"name": "style",
|
|
513
|
+
"type": "CSSProperties | ((instance?: CarouselItemInstance) => CSSProperties)",
|
|
514
|
+
"default": "",
|
|
515
|
+
"description": "The style to apply to the component."
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
"name": "className",
|
|
519
|
+
"type": "string | ((instance?: CarouselItemInstance) => string)",
|
|
520
|
+
"default": "",
|
|
521
|
+
"description": "The class name to apply to the component."
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"name": "as",
|
|
525
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
526
|
+
"default": "",
|
|
527
|
+
"description": "The component type to render."
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "asChild",
|
|
531
|
+
"type": "boolean",
|
|
532
|
+
"default": "false",
|
|
533
|
+
"description": "Whether the component should be rendered as a child component."
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"name": "instance",
|
|
537
|
+
"type": "CarouselItemInstance",
|
|
538
|
+
"default": "",
|
|
539
|
+
"description": "The instance to pass to the component."
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "pt",
|
|
543
|
+
"type": "SafeRecord<CarouselItemPassThrough>",
|
|
544
|
+
"default": "",
|
|
545
|
+
"description": "The pass-through props to pass to the component."
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "ptOptions",
|
|
549
|
+
"type": "PassThroughOptions",
|
|
550
|
+
"default": "",
|
|
551
|
+
"description": "The pass-through options to pass to the component."
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "unstyled",
|
|
555
|
+
"type": "boolean",
|
|
556
|
+
"default": "",
|
|
557
|
+
"description": "Whether the component should be rendered without classes."
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "dt",
|
|
561
|
+
"type": "unknown",
|
|
562
|
+
"default": "",
|
|
563
|
+
"description": "The design token to use for the component."
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "styles",
|
|
567
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
568
|
+
"default": "",
|
|
569
|
+
"description": "The styles to use for the component."
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"name": "render",
|
|
573
|
+
"type": "(instance: CarouselItemInstance) => ReactNode",
|
|
574
|
+
"default": "",
|
|
575
|
+
"description": "The render function to render the component with instance access."
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"name": "children",
|
|
579
|
+
"type": "any",
|
|
580
|
+
"default": "",
|
|
581
|
+
"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."
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"name": "[key: string]",
|
|
585
|
+
"type": "any",
|
|
586
|
+
"description": ""
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "pt-{optionName}-*",
|
|
590
|
+
"type": "-",
|
|
591
|
+
"default": "",
|
|
592
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
593
|
+
"deprecated": false
|
|
594
|
+
}
|
|
595
|
+
],
|
|
596
|
+
"methods": []
|
|
597
|
+
},
|
|
598
|
+
"CarouselItemState": {
|
|
599
|
+
"description": "Defines valid state in CarouselItem component.",
|
|
600
|
+
"relatedProp": "",
|
|
601
|
+
"props": [],
|
|
602
|
+
"methods": []
|
|
603
|
+
},
|
|
604
|
+
"CarouselItemExposes": {
|
|
605
|
+
"description": "Defines the methods and properties exposed by CarouselItem component.",
|
|
606
|
+
"relatedProp": "",
|
|
607
|
+
"props": [
|
|
608
|
+
{
|
|
609
|
+
"name": "carousel",
|
|
610
|
+
"type": "CarouselRootInstance",
|
|
611
|
+
"default": "",
|
|
612
|
+
"description": "The Carousel component instance."
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"methods": []
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"types": {
|
|
619
|
+
"CarouselItemPassThroughType": {
|
|
620
|
+
"description": "Defines passthrough(pt) options type in CarouselItem component.",
|
|
621
|
+
"values": "PassThroughType<CarouselItemInstance, E>"
|
|
622
|
+
},
|
|
623
|
+
"CarouselItemInstance": {
|
|
624
|
+
"description": "Instance of CarouselItem component.",
|
|
625
|
+
"values": "ComponentInstance<CarouselItemProps, CarouselItemState, CarouselItemExposes>"
|
|
626
|
+
}
|
|
627
|
+
},
|
|
628
|
+
"variables": {}
|
|
629
|
+
}
|
|
630
|
+
},
|
|
631
|
+
{
|
|
632
|
+
"name": "CarouselNext",
|
|
633
|
+
"source": "apps/showcase/assets/apidoc/carouselnext.json",
|
|
634
|
+
"data": {
|
|
635
|
+
"description": "CarouselNext is a component that moves to the next item in a Carousel.",
|
|
636
|
+
"interfaces": {
|
|
637
|
+
"CarouselNextPassThrough": {
|
|
638
|
+
"description": "Defines passthrough(pt) options of CarouselNext component.",
|
|
639
|
+
"relatedProp": "",
|
|
640
|
+
"props": [
|
|
641
|
+
{
|
|
642
|
+
"name": "root",
|
|
643
|
+
"type": "CarouselNextPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
644
|
+
"default": "",
|
|
645
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
646
|
+
}
|
|
647
|
+
],
|
|
648
|
+
"methods": []
|
|
649
|
+
},
|
|
650
|
+
"CarouselNextProps": {
|
|
651
|
+
"description": "Defines valid properties in CarouselNext component.",
|
|
652
|
+
"relatedProp": "",
|
|
653
|
+
"extendedTypes": "BaseComponentProps<CarouselNextInstance, unknown, CarouselNextPassThrough>",
|
|
654
|
+
"props": [
|
|
655
|
+
{
|
|
656
|
+
"name": "ref",
|
|
657
|
+
"type": "Ref<unknown>",
|
|
658
|
+
"default": "",
|
|
659
|
+
"description": "The reference to the component instance."
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"name": "pIf",
|
|
663
|
+
"type": "boolean",
|
|
664
|
+
"default": "true",
|
|
665
|
+
"description": "Whether the component should be rendered."
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"name": "style",
|
|
669
|
+
"type": "CSSProperties | ((instance?: CarouselNextInstance) => CSSProperties)",
|
|
670
|
+
"default": "",
|
|
671
|
+
"description": "The style to apply to the component."
|
|
672
|
+
},
|
|
673
|
+
{
|
|
674
|
+
"name": "className",
|
|
675
|
+
"type": "string | ((instance?: CarouselNextInstance) => string)",
|
|
676
|
+
"default": "",
|
|
677
|
+
"description": "The class name to apply to the component."
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"name": "as",
|
|
681
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
682
|
+
"default": "",
|
|
683
|
+
"description": "The component type to render."
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
"name": "asChild",
|
|
687
|
+
"type": "boolean",
|
|
688
|
+
"default": "false",
|
|
689
|
+
"description": "Whether the component should be rendered as a child component."
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
"name": "instance",
|
|
693
|
+
"type": "CarouselNextInstance",
|
|
694
|
+
"default": "",
|
|
695
|
+
"description": "The instance to pass to the component."
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"name": "pt",
|
|
699
|
+
"type": "SafeRecord<CarouselNextPassThrough>",
|
|
700
|
+
"default": "",
|
|
701
|
+
"description": "The pass-through props to pass to the component."
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "ptOptions",
|
|
705
|
+
"type": "PassThroughOptions",
|
|
706
|
+
"default": "",
|
|
707
|
+
"description": "The pass-through options to pass to the component."
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"name": "unstyled",
|
|
711
|
+
"type": "boolean",
|
|
712
|
+
"default": "",
|
|
713
|
+
"description": "Whether the component should be rendered without classes."
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "dt",
|
|
717
|
+
"type": "unknown",
|
|
718
|
+
"default": "",
|
|
719
|
+
"description": "The design token to use for the component."
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"name": "styles",
|
|
723
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
724
|
+
"default": "",
|
|
725
|
+
"description": "The styles to use for the component."
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "render",
|
|
729
|
+
"type": "(instance: CarouselNextInstance) => ReactNode",
|
|
730
|
+
"default": "",
|
|
731
|
+
"description": "The render function to render the component with instance access."
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"name": "children",
|
|
735
|
+
"type": "any",
|
|
736
|
+
"default": "",
|
|
737
|
+
"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."
|
|
738
|
+
},
|
|
739
|
+
{
|
|
740
|
+
"name": "[key: string]",
|
|
741
|
+
"type": "any",
|
|
742
|
+
"description": ""
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "pt-{optionName}-*",
|
|
746
|
+
"type": "-",
|
|
747
|
+
"default": "",
|
|
748
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
749
|
+
"deprecated": false
|
|
750
|
+
}
|
|
751
|
+
],
|
|
752
|
+
"methods": []
|
|
753
|
+
},
|
|
754
|
+
"CarouselNextState": {
|
|
755
|
+
"description": "Defines valid state in CarouselNext component.",
|
|
756
|
+
"relatedProp": "",
|
|
757
|
+
"props": [],
|
|
758
|
+
"methods": []
|
|
759
|
+
},
|
|
760
|
+
"CarouselNextExposes": {
|
|
761
|
+
"description": "Defines the methods and properties exposed by CarouselNext component.",
|
|
762
|
+
"relatedProp": "",
|
|
763
|
+
"props": [
|
|
764
|
+
{
|
|
765
|
+
"name": "carousel",
|
|
766
|
+
"type": "CarouselRootInstance",
|
|
767
|
+
"default": "",
|
|
768
|
+
"description": "The Carousel component instance."
|
|
769
|
+
}
|
|
770
|
+
],
|
|
771
|
+
"methods": []
|
|
772
|
+
}
|
|
773
|
+
},
|
|
774
|
+
"types": {
|
|
775
|
+
"CarouselNextPassThroughType": {
|
|
776
|
+
"description": "Defines passthrough(pt) options type in CarouselNext component.",
|
|
777
|
+
"values": "PassThroughType<CarouselNextInstance, E>"
|
|
778
|
+
},
|
|
779
|
+
"CarouselNextInstance": {
|
|
780
|
+
"description": "Instance of CarouselNext component.",
|
|
781
|
+
"values": "ComponentInstance<CarouselNextProps, CarouselNextState, CarouselNextExposes>"
|
|
782
|
+
}
|
|
783
|
+
},
|
|
784
|
+
"variables": {}
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
{
|
|
788
|
+
"name": "CarouselPrev",
|
|
789
|
+
"source": "apps/showcase/assets/apidoc/carouselprev.json",
|
|
790
|
+
"data": {
|
|
791
|
+
"description": "CarouselPrev is a component that moves to the previous item in a Carousel.",
|
|
792
|
+
"interfaces": {
|
|
793
|
+
"CarouselPrevPassThrough": {
|
|
794
|
+
"description": "Defines passthrough(pt) options of CarouselPrev component.",
|
|
795
|
+
"relatedProp": "",
|
|
796
|
+
"props": [
|
|
797
|
+
{
|
|
798
|
+
"name": "root",
|
|
799
|
+
"type": "CarouselPrevPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
800
|
+
"default": "",
|
|
801
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
802
|
+
}
|
|
803
|
+
],
|
|
804
|
+
"methods": []
|
|
805
|
+
},
|
|
806
|
+
"CarouselPrevProps": {
|
|
807
|
+
"description": "Defines valid properties in CarouselPrev component.",
|
|
808
|
+
"relatedProp": "",
|
|
809
|
+
"extendedTypes": "BaseComponentProps<CarouselPrevInstance, unknown, CarouselPrevPassThrough>",
|
|
810
|
+
"props": [
|
|
811
|
+
{
|
|
812
|
+
"name": "ref",
|
|
813
|
+
"type": "Ref<unknown>",
|
|
814
|
+
"default": "",
|
|
815
|
+
"description": "The reference to the component instance."
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"name": "pIf",
|
|
819
|
+
"type": "boolean",
|
|
820
|
+
"default": "true",
|
|
821
|
+
"description": "Whether the component should be rendered."
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
"name": "style",
|
|
825
|
+
"type": "CSSProperties | ((instance?: CarouselPrevInstance) => CSSProperties)",
|
|
826
|
+
"default": "",
|
|
827
|
+
"description": "The style to apply to the component."
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "className",
|
|
831
|
+
"type": "string | ((instance?: CarouselPrevInstance) => string)",
|
|
832
|
+
"default": "",
|
|
833
|
+
"description": "The class name to apply to the component."
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"name": "as",
|
|
837
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
838
|
+
"default": "",
|
|
839
|
+
"description": "The component type to render."
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "asChild",
|
|
843
|
+
"type": "boolean",
|
|
844
|
+
"default": "false",
|
|
845
|
+
"description": "Whether the component should be rendered as a child component."
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
"name": "instance",
|
|
849
|
+
"type": "CarouselPrevInstance",
|
|
850
|
+
"default": "",
|
|
851
|
+
"description": "The instance to pass to the component."
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"name": "pt",
|
|
855
|
+
"type": "SafeRecord<CarouselPrevPassThrough>",
|
|
856
|
+
"default": "",
|
|
857
|
+
"description": "The pass-through props to pass to the component."
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"name": "ptOptions",
|
|
861
|
+
"type": "PassThroughOptions",
|
|
862
|
+
"default": "",
|
|
863
|
+
"description": "The pass-through options to pass to the component."
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"name": "unstyled",
|
|
867
|
+
"type": "boolean",
|
|
868
|
+
"default": "",
|
|
869
|
+
"description": "Whether the component should be rendered without classes."
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"name": "dt",
|
|
873
|
+
"type": "unknown",
|
|
874
|
+
"default": "",
|
|
875
|
+
"description": "The design token to use for the component."
|
|
876
|
+
},
|
|
877
|
+
{
|
|
878
|
+
"name": "styles",
|
|
879
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
880
|
+
"default": "",
|
|
881
|
+
"description": "The styles to use for the component."
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"name": "render",
|
|
885
|
+
"type": "(instance: CarouselPrevInstance) => ReactNode",
|
|
886
|
+
"default": "",
|
|
887
|
+
"description": "The render function to render the component with instance access."
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
"name": "children",
|
|
891
|
+
"type": "any",
|
|
892
|
+
"default": "",
|
|
893
|
+
"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."
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "[key: string]",
|
|
897
|
+
"type": "any",
|
|
898
|
+
"description": ""
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "pt-{optionName}-*",
|
|
902
|
+
"type": "-",
|
|
903
|
+
"default": "",
|
|
904
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
905
|
+
"deprecated": false
|
|
906
|
+
}
|
|
907
|
+
],
|
|
908
|
+
"methods": []
|
|
909
|
+
},
|
|
910
|
+
"CarouselPrevState": {
|
|
911
|
+
"description": "Defines valid state in CarouselPrev component.",
|
|
912
|
+
"relatedProp": "",
|
|
913
|
+
"props": [],
|
|
914
|
+
"methods": []
|
|
915
|
+
},
|
|
916
|
+
"CarouselPrevExposes": {
|
|
917
|
+
"description": "Defines the methods and properties exposed by CarouselPrev component.",
|
|
918
|
+
"relatedProp": "",
|
|
919
|
+
"props": [
|
|
920
|
+
{
|
|
921
|
+
"name": "carousel",
|
|
922
|
+
"type": "CarouselRootInstance",
|
|
923
|
+
"default": "",
|
|
924
|
+
"description": "The Carousel component instance."
|
|
925
|
+
}
|
|
926
|
+
],
|
|
927
|
+
"methods": []
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"types": {
|
|
931
|
+
"CarouselPrevPassThroughType": {
|
|
932
|
+
"description": "Defines passthrough(pt) options type in CarouselPrev component.",
|
|
933
|
+
"values": "PassThroughType<CarouselPrevInstance, E>"
|
|
934
|
+
},
|
|
935
|
+
"CarouselPrevInstance": {
|
|
936
|
+
"description": "Instance of CarouselPrev component.",
|
|
937
|
+
"values": "ComponentInstance<CarouselPrevProps, CarouselPrevState, CarouselPrevExposes>"
|
|
938
|
+
}
|
|
939
|
+
},
|
|
940
|
+
"variables": {}
|
|
941
|
+
}
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"name": "CarouselRoot",
|
|
945
|
+
"source": "apps/showcase/assets/apidoc/carouselroot.json",
|
|
946
|
+
"data": {
|
|
947
|
+
"description": "Carousel is a flexible container component.",
|
|
948
|
+
"interfaces": {
|
|
949
|
+
"CarouselRootPassThrough": {
|
|
950
|
+
"description": "Defines passthrough(pt) options of Carousel component.",
|
|
951
|
+
"relatedProp": "",
|
|
952
|
+
"props": [
|
|
953
|
+
{
|
|
954
|
+
"name": "root",
|
|
955
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
956
|
+
"default": "",
|
|
957
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"name": "content",
|
|
961
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
962
|
+
"default": "",
|
|
963
|
+
"description": "Used to pass attributes to the content's DOM element."
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "item",
|
|
967
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
968
|
+
"default": "",
|
|
969
|
+
"description": "Used to pass attributes to the item's DOM element."
|
|
970
|
+
},
|
|
971
|
+
{
|
|
972
|
+
"name": "prev",
|
|
973
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
974
|
+
"default": "",
|
|
975
|
+
"description": "Used to pass attributes to the prev button's DOM element."
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "next",
|
|
979
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
980
|
+
"default": "",
|
|
981
|
+
"description": "Used to pass attributes to the next button's DOM element."
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "indicators",
|
|
985
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
986
|
+
"default": "",
|
|
987
|
+
"description": "Used to pass attributes to the indicators' DOM element."
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"name": "indicator",
|
|
991
|
+
"type": "CarouselRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
992
|
+
"default": "",
|
|
993
|
+
"description": "Used to pass attributes to the indicator's DOM element."
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"methods": []
|
|
997
|
+
},
|
|
998
|
+
"CarouselRootProps": {
|
|
999
|
+
"description": "Defines valid properties in Carousel component.",
|
|
1000
|
+
"relatedProp": "",
|
|
1001
|
+
"extendedTypes": "BaseComponentProps<CarouselRootInstance, UseCarouselProps, CarouselRootPassThrough>",
|
|
1002
|
+
"props": [
|
|
1003
|
+
{
|
|
1004
|
+
"name": "ref",
|
|
1005
|
+
"type": "Ref<unknown>",
|
|
1006
|
+
"default": "",
|
|
1007
|
+
"description": "The reference to the component instance."
|
|
1008
|
+
},
|
|
1009
|
+
{
|
|
1010
|
+
"name": "pIf",
|
|
1011
|
+
"type": "boolean",
|
|
1012
|
+
"default": "true",
|
|
1013
|
+
"description": "Whether the component should be rendered."
|
|
1014
|
+
},
|
|
1015
|
+
{
|
|
1016
|
+
"name": "style",
|
|
1017
|
+
"type": "CSSProperties | ((instance?: CarouselRootInstance) => CSSProperties)",
|
|
1018
|
+
"default": "",
|
|
1019
|
+
"description": "The style to apply to the component."
|
|
1020
|
+
},
|
|
1021
|
+
{
|
|
1022
|
+
"name": "className",
|
|
1023
|
+
"type": "string | ((instance?: CarouselRootInstance) => string)",
|
|
1024
|
+
"default": "",
|
|
1025
|
+
"description": "The class name to apply to the component."
|
|
1026
|
+
},
|
|
1027
|
+
{
|
|
1028
|
+
"name": "as",
|
|
1029
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1030
|
+
"default": "",
|
|
1031
|
+
"description": "The component type to render."
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"name": "asChild",
|
|
1035
|
+
"type": "boolean",
|
|
1036
|
+
"default": "false",
|
|
1037
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1038
|
+
},
|
|
1039
|
+
{
|
|
1040
|
+
"name": "instance",
|
|
1041
|
+
"type": "CarouselRootInstance",
|
|
1042
|
+
"default": "",
|
|
1043
|
+
"description": "The instance to pass to the component."
|
|
1044
|
+
},
|
|
1045
|
+
{
|
|
1046
|
+
"name": "pt",
|
|
1047
|
+
"type": "SafeRecord<CarouselRootPassThrough>",
|
|
1048
|
+
"default": "",
|
|
1049
|
+
"description": "The pass-through props to pass to the component."
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"name": "ptOptions",
|
|
1053
|
+
"type": "PassThroughOptions",
|
|
1054
|
+
"default": "",
|
|
1055
|
+
"description": "The pass-through options to pass to the component."
|
|
1056
|
+
},
|
|
1057
|
+
{
|
|
1058
|
+
"name": "unstyled",
|
|
1059
|
+
"type": "boolean",
|
|
1060
|
+
"default": "",
|
|
1061
|
+
"description": "Whether the component should be rendered without classes."
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "dt",
|
|
1065
|
+
"type": "unknown",
|
|
1066
|
+
"default": "",
|
|
1067
|
+
"description": "The design token to use for the component."
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"name": "styles",
|
|
1071
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1072
|
+
"default": "",
|
|
1073
|
+
"description": "The styles to use for the component."
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "render",
|
|
1077
|
+
"type": "(instance: CarouselRootInstance) => ReactNode",
|
|
1078
|
+
"default": "",
|
|
1079
|
+
"description": "The render function to render the component with instance access."
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
"name": "children",
|
|
1083
|
+
"type": "any",
|
|
1084
|
+
"default": "",
|
|
1085
|
+
"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."
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"name": "autoSize",
|
|
1089
|
+
"type": "boolean",
|
|
1090
|
+
"default": "false",
|
|
1091
|
+
"description": "Whether the carousel should auto size."
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "orientation",
|
|
1095
|
+
"type": "\"horizontal\" | \"vertical\"",
|
|
1096
|
+
"default": "'horizontal'",
|
|
1097
|
+
"description": "Orientation of the carousel."
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "align",
|
|
1101
|
+
"type": "\"center\" | \"start\" | \"end\"",
|
|
1102
|
+
"default": "'center'",
|
|
1103
|
+
"description": "Alignment of the carousel items."
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "loop",
|
|
1107
|
+
"type": "boolean",
|
|
1108
|
+
"default": "false",
|
|
1109
|
+
"description": "Whether the carousel should loop."
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"name": "snapType",
|
|
1113
|
+
"type": "\"mandatory\" | \"proximity\"",
|
|
1114
|
+
"default": "'mandatory'",
|
|
1115
|
+
"description": "Scroll snap type applied to the track."
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
"name": "spacing",
|
|
1119
|
+
"type": "number",
|
|
1120
|
+
"default": "16",
|
|
1121
|
+
"description": "Spacing between carousel items."
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"name": "slidesPerPage",
|
|
1125
|
+
"type": "number",
|
|
1126
|
+
"default": "1",
|
|
1127
|
+
"description": "How many slides are visible per page. Supports fractions (e.g. 1.5)."
|
|
1128
|
+
},
|
|
1129
|
+
{
|
|
1130
|
+
"name": "page",
|
|
1131
|
+
"type": "number",
|
|
1132
|
+
"default": "undefined",
|
|
1133
|
+
"description": "Index of the active slide."
|
|
1134
|
+
},
|
|
1135
|
+
{
|
|
1136
|
+
"name": "defaultPage",
|
|
1137
|
+
"type": "number",
|
|
1138
|
+
"default": "0",
|
|
1139
|
+
"description": "Default index of the active slide."
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "slide",
|
|
1143
|
+
"type": "number",
|
|
1144
|
+
"default": "undefined",
|
|
1145
|
+
"description": "Index of the active slide."
|
|
1146
|
+
},
|
|
1147
|
+
{
|
|
1148
|
+
"name": "onPageChange",
|
|
1149
|
+
"type": "(event: UseCarouselChangeEvent) => void",
|
|
1150
|
+
"default": "",
|
|
1151
|
+
"description": "Callback fired when the carousel's page changes."
|
|
1152
|
+
},
|
|
1153
|
+
{
|
|
1154
|
+
"name": "onSlideChange",
|
|
1155
|
+
"type": "(event: UseCarouselChangeEvent) => void",
|
|
1156
|
+
"default": "",
|
|
1157
|
+
"description": "Callback fired when the active slide (by value) changes."
|
|
1158
|
+
},
|
|
1159
|
+
{
|
|
1160
|
+
"name": "[key: string]",
|
|
1161
|
+
"type": "any",
|
|
1162
|
+
"description": ""
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"name": "pt-{optionName}-*",
|
|
1166
|
+
"type": "-",
|
|
1167
|
+
"default": "",
|
|
1168
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1169
|
+
"deprecated": false
|
|
1170
|
+
}
|
|
1171
|
+
],
|
|
1172
|
+
"methods": []
|
|
1173
|
+
},
|
|
1174
|
+
"CarouselRootState": {
|
|
1175
|
+
"description": "Defines valid state in Carousel component.",
|
|
1176
|
+
"relatedProp": "",
|
|
1177
|
+
"extendedTypes": "UseCarouselState",
|
|
1178
|
+
"props": [
|
|
1179
|
+
{
|
|
1180
|
+
"name": "isPrevDisabled",
|
|
1181
|
+
"type": "boolean",
|
|
1182
|
+
"default": "",
|
|
1183
|
+
"description": "Whether the \"previous\" navigation button should be disabled."
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"name": "isNextDisabled",
|
|
1187
|
+
"type": "boolean",
|
|
1188
|
+
"default": "",
|
|
1189
|
+
"description": "Whether the \"next\" navigation button should be disabled."
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
"name": "snapPoints",
|
|
1193
|
+
"type": "Set<number>",
|
|
1194
|
+
"default": "",
|
|
1195
|
+
"description": "The snap points of the carousel."
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "page",
|
|
1199
|
+
"type": "number",
|
|
1200
|
+
"default": "",
|
|
1201
|
+
"description": "The current page of the carousel."
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
"name": "swiping",
|
|
1205
|
+
"type": "boolean",
|
|
1206
|
+
"default": "",
|
|
1207
|
+
"description": "Whether the user is currently swiping the carousel by touch."
|
|
1208
|
+
}
|
|
1209
|
+
],
|
|
1210
|
+
"methods": []
|
|
1211
|
+
},
|
|
1212
|
+
"CarouselRootExposes": {
|
|
1213
|
+
"description": "Defines the methods and properties exposed by Carousel component.",
|
|
1214
|
+
"relatedProp": "",
|
|
1215
|
+
"extendedTypes": "UseCarouselExposes",
|
|
1216
|
+
"props": [
|
|
1217
|
+
{
|
|
1218
|
+
"name": "state",
|
|
1219
|
+
"type": "UseCarouselState",
|
|
1220
|
+
"default": "",
|
|
1221
|
+
"description": "The state of the useCarousel."
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "slidesPerPage",
|
|
1225
|
+
"type": "number",
|
|
1226
|
+
"default": "",
|
|
1227
|
+
"description": "Number of slides displayed per page."
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "prev",
|
|
1231
|
+
"type": "(originalEvent?: Event | SyntheticEvent<Element, Event>) => void",
|
|
1232
|
+
"default": "",
|
|
1233
|
+
"description": "Navigates to the previous slide."
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "next",
|
|
1237
|
+
"type": "(originalEvent?: Event | SyntheticEvent<Element, Event>) => void",
|
|
1238
|
+
"default": "",
|
|
1239
|
+
"description": "Navigates to the next slide."
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"name": "scrollTo",
|
|
1243
|
+
"type": "(value: number) => void",
|
|
1244
|
+
"default": "",
|
|
1245
|
+
"description": "Scrolls to the specified value."
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"name": "scrollToPage",
|
|
1249
|
+
"type": "(page: number) => void",
|
|
1250
|
+
"default": "",
|
|
1251
|
+
"description": "Scrolls to the specified page."
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
"name": "scrollToSlide",
|
|
1255
|
+
"type": "(slide: number) => void",
|
|
1256
|
+
"default": "",
|
|
1257
|
+
"description": "Scrolls to the specified slide value."
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"name": "setToClosest",
|
|
1261
|
+
"type": "() => void",
|
|
1262
|
+
"default": "",
|
|
1263
|
+
"description": "Scrolls to the closest snap point."
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"name": "onContentPointerDown",
|
|
1267
|
+
"type": "(event: PointerEvent<HTMLDivElement>) => void",
|
|
1268
|
+
"default": "",
|
|
1269
|
+
"description": "Event handler for content pointer down."
|
|
1270
|
+
},
|
|
1271
|
+
{
|
|
1272
|
+
"name": "onContentPointerMove",
|
|
1273
|
+
"type": "(event: PointerEvent<HTMLDivElement>) => void",
|
|
1274
|
+
"default": "",
|
|
1275
|
+
"description": "Event handler for content pointer move."
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"name": "onContentPointerUp",
|
|
1279
|
+
"type": "(event: PointerEvent<HTMLDivElement>) => void",
|
|
1280
|
+
"default": "",
|
|
1281
|
+
"description": "Event handler for content pointer up."
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"name": "onContentWheel",
|
|
1285
|
+
"type": "(event: WheelEvent<HTMLDivElement>) => void",
|
|
1286
|
+
"default": "",
|
|
1287
|
+
"description": "Event handler for content wheel."
|
|
1288
|
+
},
|
|
1289
|
+
{
|
|
1290
|
+
"name": "resolveSnapType",
|
|
1291
|
+
"type": "() => string",
|
|
1292
|
+
"default": "",
|
|
1293
|
+
"description": "Computes the appropriate CSS `scroll-snap-type` value\nbased on orientation and snapping behavior."
|
|
1294
|
+
},
|
|
1295
|
+
{
|
|
1296
|
+
"name": "rootProps",
|
|
1297
|
+
"type": "UseCarouselRootProps",
|
|
1298
|
+
"default": "",
|
|
1299
|
+
"description": "Props for the root element."
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"name": "contentProps",
|
|
1303
|
+
"type": "UseCarouselContentProps",
|
|
1304
|
+
"default": "",
|
|
1305
|
+
"description": "Props for the content (track) element."
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
"name": "indicatorsProps",
|
|
1309
|
+
"type": "UseCarouselIndicatorsProps",
|
|
1310
|
+
"default": "",
|
|
1311
|
+
"description": "Props for the indicators container element."
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"name": "getItemProps",
|
|
1315
|
+
"type": "(value: unknown, index?: number, total?: number) => UseCarouselItemProps",
|
|
1316
|
+
"default": "",
|
|
1317
|
+
"description": "Returns props for an individual carousel item."
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
"name": "getNextProps",
|
|
1321
|
+
"type": "(disabled: boolean) => UseCarouselNextProps",
|
|
1322
|
+
"default": "",
|
|
1323
|
+
"description": "Returns props for the next navigation button."
|
|
1324
|
+
},
|
|
1325
|
+
{
|
|
1326
|
+
"name": "getPrevProps",
|
|
1327
|
+
"type": "(disabled: boolean) => UseCarouselPrevProps",
|
|
1328
|
+
"default": "",
|
|
1329
|
+
"description": "Returns props for the prev navigation button."
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "getIndicatorProps",
|
|
1333
|
+
"type": "(page: number) => UseCarouselIndicatorProps",
|
|
1334
|
+
"default": "",
|
|
1335
|
+
"description": "Returns props for an individual indicator button."
|
|
1336
|
+
}
|
|
1337
|
+
],
|
|
1338
|
+
"methods": []
|
|
1339
|
+
},
|
|
1340
|
+
"CarouselRootChangeEvent": {
|
|
1341
|
+
"description": "Event fired when the carousel's value changes.",
|
|
1342
|
+
"relatedProp": "",
|
|
1343
|
+
"extendedTypes": "UseCarouselChangeEvent",
|
|
1344
|
+
"props": [
|
|
1345
|
+
{
|
|
1346
|
+
"name": "originalEvent",
|
|
1347
|
+
"type": "Event | SyntheticEvent<Element, Event>",
|
|
1348
|
+
"default": "",
|
|
1349
|
+
"description": "The original event that triggered the change."
|
|
1350
|
+
},
|
|
1351
|
+
{
|
|
1352
|
+
"name": "value",
|
|
1353
|
+
"type": "string | number",
|
|
1354
|
+
"default": "",
|
|
1355
|
+
"description": "The value of the carousel."
|
|
1356
|
+
}
|
|
1357
|
+
],
|
|
1358
|
+
"methods": []
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
"types": {
|
|
1362
|
+
"CarouselRootPassThroughType": {
|
|
1363
|
+
"description": "Defines passthrough(pt) options type in Carousel component.",
|
|
1364
|
+
"values": "PassThroughType<CarouselRootInstance, E>"
|
|
1365
|
+
},
|
|
1366
|
+
"CarouselRootInstance": {
|
|
1367
|
+
"description": "Instance of Carousel component.",
|
|
1368
|
+
"values": "ComponentInstance<CarouselRootProps, CarouselRootState, CarouselRootExposes>"
|
|
1369
|
+
}
|
|
1370
|
+
},
|
|
1371
|
+
"variables": {}
|
|
1372
|
+
}
|
|
1373
|
+
}
|
|
1374
|
+
]
|