@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,3622 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "GalleryBackdrop",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/gallerybackdrop.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "GalleryBackdrop is a component that displays a backdrop of content.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"GalleryBackdropPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of GalleryBackdrop component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "GalleryBackdropPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"GalleryBackdropProps": {
|
|
22
|
+
"description": "Defines valid properties in GalleryBackdrop component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<GalleryBackdropInstance, unknown, GalleryBackdropPassThrough>",
|
|
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?: GalleryBackdropInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: GalleryBackdropInstance) => 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": "GalleryBackdropInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<GalleryBackdropPassThrough>",
|
|
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: GalleryBackdropInstance) => 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
|
+
"GalleryBackdropState": {
|
|
126
|
+
"description": "Defines valid state in GalleryBackdrop component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"GalleryBackdropExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by GalleryBackdrop component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "gallery",
|
|
137
|
+
"type": "GalleryRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Gallery component instance."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"GalleryBackdropPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in GalleryBackdrop component.",
|
|
148
|
+
"values": "PassThroughType<GalleryBackdropInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"GalleryBackdropInstance": {
|
|
151
|
+
"description": "Instance of GalleryBackdrop component.",
|
|
152
|
+
"values": "ComponentInstance<GalleryBackdropProps, GalleryBackdropState, GalleryBackdropExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "GalleryContent",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/gallerycontent.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "GalleryContent is a component that displays a content of a gallery.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"GalleryContentPassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of GalleryContent component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "GalleryContentPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"GalleryContentProps": {
|
|
178
|
+
"description": "Defines valid properties in GalleryContent component.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "BaseComponentProps<GalleryContentInstance, unknown, GalleryContentPassThrough>",
|
|
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?: GalleryContentInstance) => CSSProperties)",
|
|
197
|
+
"default": "",
|
|
198
|
+
"description": "The style to apply to the component."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "className",
|
|
202
|
+
"type": "string | ((instance?: GalleryContentInstance) => 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": "GalleryContentInstance",
|
|
221
|
+
"default": "",
|
|
222
|
+
"description": "The instance to pass to the component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "pt",
|
|
226
|
+
"type": "SafeRecord<GalleryContentPassThrough>",
|
|
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: GalleryContentInstance) => 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
|
+
"GalleryContentState": {
|
|
282
|
+
"description": "Defines valid state in GalleryContent component.",
|
|
283
|
+
"relatedProp": "",
|
|
284
|
+
"props": [],
|
|
285
|
+
"methods": []
|
|
286
|
+
},
|
|
287
|
+
"GalleryContentExposes": {
|
|
288
|
+
"description": "Defines the methods and properties exposed by GalleryContent component.",
|
|
289
|
+
"relatedProp": "",
|
|
290
|
+
"props": [
|
|
291
|
+
{
|
|
292
|
+
"name": "gallery",
|
|
293
|
+
"type": "GalleryRootInstance",
|
|
294
|
+
"default": "",
|
|
295
|
+
"description": "The Gallery component instance."
|
|
296
|
+
}
|
|
297
|
+
],
|
|
298
|
+
"methods": []
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"types": {
|
|
302
|
+
"GalleryContentPassThroughType": {
|
|
303
|
+
"description": "Defines passthrough(pt) options type in GalleryContent component.",
|
|
304
|
+
"values": "PassThroughType<GalleryContentInstance, E>"
|
|
305
|
+
},
|
|
306
|
+
"GalleryContentInstance": {
|
|
307
|
+
"description": "Instance of GalleryContent component.",
|
|
308
|
+
"values": "ComponentInstance<GalleryContentProps, GalleryContentState, GalleryContentExposes>"
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"variables": {}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "GalleryDownload",
|
|
316
|
+
"source": "apps/showcase/assets/apidoc/gallerydownload.json",
|
|
317
|
+
"data": {
|
|
318
|
+
"description": "GalleryDownload is a component that displays a download action.",
|
|
319
|
+
"interfaces": {
|
|
320
|
+
"GalleryDownloadPassThrough": {
|
|
321
|
+
"description": "Defines passthrough(pt) options of GalleryDownload component.",
|
|
322
|
+
"relatedProp": "",
|
|
323
|
+
"props": [
|
|
324
|
+
{
|
|
325
|
+
"name": "root",
|
|
326
|
+
"type": "GalleryDownloadPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
327
|
+
"default": "",
|
|
328
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"methods": []
|
|
332
|
+
},
|
|
333
|
+
"GalleryDownloadProps": {
|
|
334
|
+
"description": "Defines valid properties in GalleryDownload component.",
|
|
335
|
+
"relatedProp": "",
|
|
336
|
+
"extendedTypes": "BaseComponentProps<GalleryDownloadInstance, unknown, GalleryDownloadPassThrough>",
|
|
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?: GalleryDownloadInstance) => CSSProperties)",
|
|
353
|
+
"default": "",
|
|
354
|
+
"description": "The style to apply to the component."
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "className",
|
|
358
|
+
"type": "string | ((instance?: GalleryDownloadInstance) => 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": "GalleryDownloadInstance",
|
|
377
|
+
"default": "",
|
|
378
|
+
"description": "The instance to pass to the component."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "pt",
|
|
382
|
+
"type": "SafeRecord<GalleryDownloadPassThrough>",
|
|
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: GalleryDownloadInstance) => 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
|
+
"GalleryDownloadState": {
|
|
438
|
+
"description": "Defines valid state in GalleryDownload component.",
|
|
439
|
+
"relatedProp": "",
|
|
440
|
+
"props": [],
|
|
441
|
+
"methods": []
|
|
442
|
+
},
|
|
443
|
+
"GalleryDownloadExposes": {
|
|
444
|
+
"description": "Defines the methods and properties exposed by GalleryDownload component.",
|
|
445
|
+
"relatedProp": "",
|
|
446
|
+
"props": [
|
|
447
|
+
{
|
|
448
|
+
"name": "gallery",
|
|
449
|
+
"type": "GalleryRootInstance",
|
|
450
|
+
"default": "",
|
|
451
|
+
"description": "The Gallery component instance."
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
"methods": []
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"types": {
|
|
458
|
+
"GalleryDownloadPassThroughType": {
|
|
459
|
+
"description": "Defines passthrough(pt) options type in GalleryDownload component.",
|
|
460
|
+
"values": "PassThroughType<GalleryDownloadInstance, E>"
|
|
461
|
+
},
|
|
462
|
+
"GalleryDownloadInstance": {
|
|
463
|
+
"description": "Instance of GalleryDownload component.",
|
|
464
|
+
"values": "ComponentInstance<GalleryDownloadProps, GalleryDownloadState, GalleryDownloadExposes>"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"variables": {}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "GalleryFlipX",
|
|
472
|
+
"source": "apps/showcase/assets/apidoc/galleryflipx.json",
|
|
473
|
+
"data": {
|
|
474
|
+
"description": "GalleryFlipX is a component that displays a flip x action.",
|
|
475
|
+
"interfaces": {
|
|
476
|
+
"GalleryFlipXPassThrough": {
|
|
477
|
+
"description": "Defines passthrough(pt) options of GalleryFlipX component.",
|
|
478
|
+
"relatedProp": "",
|
|
479
|
+
"props": [
|
|
480
|
+
{
|
|
481
|
+
"name": "root",
|
|
482
|
+
"type": "GalleryFlipXPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
483
|
+
"default": "",
|
|
484
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
485
|
+
}
|
|
486
|
+
],
|
|
487
|
+
"methods": []
|
|
488
|
+
},
|
|
489
|
+
"GalleryFlipXProps": {
|
|
490
|
+
"description": "Defines valid properties in GalleryFlipX component.",
|
|
491
|
+
"relatedProp": "",
|
|
492
|
+
"extendedTypes": "BaseComponentProps<GalleryFlipXInstance, unknown, GalleryFlipXPassThrough>",
|
|
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?: GalleryFlipXInstance) => CSSProperties)",
|
|
509
|
+
"default": "",
|
|
510
|
+
"description": "The style to apply to the component."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "className",
|
|
514
|
+
"type": "string | ((instance?: GalleryFlipXInstance) => 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": "GalleryFlipXInstance",
|
|
533
|
+
"default": "",
|
|
534
|
+
"description": "The instance to pass to the component."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "pt",
|
|
538
|
+
"type": "SafeRecord<GalleryFlipXPassThrough>",
|
|
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: GalleryFlipXInstance) => 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
|
+
"GalleryFlipXState": {
|
|
594
|
+
"description": "Defines valid state in GalleryFlipX component.",
|
|
595
|
+
"relatedProp": "",
|
|
596
|
+
"props": [],
|
|
597
|
+
"methods": []
|
|
598
|
+
},
|
|
599
|
+
"GalleryFlipXExposes": {
|
|
600
|
+
"description": "Defines the methods and properties exposed by GalleryFlipX component.",
|
|
601
|
+
"relatedProp": "",
|
|
602
|
+
"props": [
|
|
603
|
+
{
|
|
604
|
+
"name": "gallery",
|
|
605
|
+
"type": "GalleryRootInstance",
|
|
606
|
+
"default": "",
|
|
607
|
+
"description": "The Gallery component instance."
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"methods": []
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
"types": {
|
|
614
|
+
"GalleryFlipXPassThroughType": {
|
|
615
|
+
"description": "Defines passthrough(pt) options type in GalleryFlipX component.",
|
|
616
|
+
"values": "PassThroughType<GalleryFlipXInstance, E>"
|
|
617
|
+
},
|
|
618
|
+
"GalleryFlipXInstance": {
|
|
619
|
+
"description": "Instance of GalleryFlipX component.",
|
|
620
|
+
"values": "ComponentInstance<GalleryFlipXProps, GalleryFlipXState, GalleryFlipXExposes>"
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
"variables": {}
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "GalleryFlipY",
|
|
628
|
+
"source": "apps/showcase/assets/apidoc/galleryflipy.json",
|
|
629
|
+
"data": {
|
|
630
|
+
"description": "GalleryFlipY is a component that displays a flip y action.",
|
|
631
|
+
"interfaces": {
|
|
632
|
+
"GalleryFlipYPassThrough": {
|
|
633
|
+
"description": "Defines passthrough(pt) options of GalleryFlipY component.",
|
|
634
|
+
"relatedProp": "",
|
|
635
|
+
"props": [
|
|
636
|
+
{
|
|
637
|
+
"name": "root",
|
|
638
|
+
"type": "GalleryFlipYPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
639
|
+
"default": "",
|
|
640
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"methods": []
|
|
644
|
+
},
|
|
645
|
+
"GalleryFlipYProps": {
|
|
646
|
+
"description": "Defines valid properties in GalleryFlipY component.",
|
|
647
|
+
"relatedProp": "",
|
|
648
|
+
"extendedTypes": "BaseComponentProps<GalleryFlipYInstance, unknown, GalleryFlipYPassThrough>",
|
|
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?: GalleryFlipYInstance) => CSSProperties)",
|
|
665
|
+
"default": "",
|
|
666
|
+
"description": "The style to apply to the component."
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "className",
|
|
670
|
+
"type": "string | ((instance?: GalleryFlipYInstance) => 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": "GalleryFlipYInstance",
|
|
689
|
+
"default": "",
|
|
690
|
+
"description": "The instance to pass to the component."
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"name": "pt",
|
|
694
|
+
"type": "SafeRecord<GalleryFlipYPassThrough>",
|
|
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: GalleryFlipYInstance) => 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
|
+
"GalleryFlipYState": {
|
|
750
|
+
"description": "Defines valid state in GalleryFlipY component.",
|
|
751
|
+
"relatedProp": "",
|
|
752
|
+
"props": [],
|
|
753
|
+
"methods": []
|
|
754
|
+
},
|
|
755
|
+
"GalleryFlipYExposes": {
|
|
756
|
+
"description": "Defines the methods and properties exposed by GalleryFlipY component.",
|
|
757
|
+
"relatedProp": "",
|
|
758
|
+
"props": [
|
|
759
|
+
{
|
|
760
|
+
"name": "gallery",
|
|
761
|
+
"type": "GalleryRootInstance",
|
|
762
|
+
"default": "",
|
|
763
|
+
"description": "The Gallery component instance."
|
|
764
|
+
}
|
|
765
|
+
],
|
|
766
|
+
"methods": []
|
|
767
|
+
}
|
|
768
|
+
},
|
|
769
|
+
"types": {
|
|
770
|
+
"GalleryFlipYPassThroughType": {
|
|
771
|
+
"description": "Defines passthrough(pt) options type in GalleryFlipY component.",
|
|
772
|
+
"values": "PassThroughType<GalleryFlipYInstance, E>"
|
|
773
|
+
},
|
|
774
|
+
"GalleryFlipYInstance": {
|
|
775
|
+
"description": "Instance of GalleryFlipY component.",
|
|
776
|
+
"values": "ComponentInstance<GalleryFlipYProps, GalleryFlipYState, GalleryFlipYExposes>"
|
|
777
|
+
}
|
|
778
|
+
},
|
|
779
|
+
"variables": {}
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"name": "GalleryFooter",
|
|
784
|
+
"source": "apps/showcase/assets/apidoc/galleryfooter.json",
|
|
785
|
+
"data": {
|
|
786
|
+
"description": "GalleryFooter is a component that displays a footer of content.",
|
|
787
|
+
"interfaces": {
|
|
788
|
+
"GalleryFooterPassThrough": {
|
|
789
|
+
"description": "Defines passthrough(pt) options of GalleryFooter component.",
|
|
790
|
+
"relatedProp": "",
|
|
791
|
+
"props": [
|
|
792
|
+
{
|
|
793
|
+
"name": "root",
|
|
794
|
+
"type": "GalleryFooterPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
795
|
+
"default": "",
|
|
796
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
797
|
+
}
|
|
798
|
+
],
|
|
799
|
+
"methods": []
|
|
800
|
+
},
|
|
801
|
+
"GalleryFooterProps": {
|
|
802
|
+
"description": "Defines valid properties in GalleryFooter component.",
|
|
803
|
+
"relatedProp": "",
|
|
804
|
+
"extendedTypes": "BaseComponentProps<GalleryFooterInstance, unknown, GalleryFooterPassThrough>",
|
|
805
|
+
"props": [
|
|
806
|
+
{
|
|
807
|
+
"name": "ref",
|
|
808
|
+
"type": "Ref<unknown>",
|
|
809
|
+
"default": "",
|
|
810
|
+
"description": "The reference to the component instance."
|
|
811
|
+
},
|
|
812
|
+
{
|
|
813
|
+
"name": "pIf",
|
|
814
|
+
"type": "boolean",
|
|
815
|
+
"default": "true",
|
|
816
|
+
"description": "Whether the component should be rendered."
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "style",
|
|
820
|
+
"type": "CSSProperties | ((instance?: GalleryFooterInstance) => CSSProperties)",
|
|
821
|
+
"default": "",
|
|
822
|
+
"description": "The style to apply to the component."
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"name": "className",
|
|
826
|
+
"type": "string | ((instance?: GalleryFooterInstance) => string)",
|
|
827
|
+
"default": "",
|
|
828
|
+
"description": "The class name to apply to the component."
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "as",
|
|
832
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
833
|
+
"default": "",
|
|
834
|
+
"description": "The component type to render."
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "asChild",
|
|
838
|
+
"type": "boolean",
|
|
839
|
+
"default": "false",
|
|
840
|
+
"description": "Whether the component should be rendered as a child component."
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "instance",
|
|
844
|
+
"type": "GalleryFooterInstance",
|
|
845
|
+
"default": "",
|
|
846
|
+
"description": "The instance to pass to the component."
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "pt",
|
|
850
|
+
"type": "SafeRecord<GalleryFooterPassThrough>",
|
|
851
|
+
"default": "",
|
|
852
|
+
"description": "The pass-through props to pass to the component."
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"name": "ptOptions",
|
|
856
|
+
"type": "PassThroughOptions",
|
|
857
|
+
"default": "",
|
|
858
|
+
"description": "The pass-through options to pass to the component."
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "unstyled",
|
|
862
|
+
"type": "boolean",
|
|
863
|
+
"default": "",
|
|
864
|
+
"description": "Whether the component should be rendered without classes."
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "dt",
|
|
868
|
+
"type": "unknown",
|
|
869
|
+
"default": "",
|
|
870
|
+
"description": "The design token to use for the component."
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "styles",
|
|
874
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
875
|
+
"default": "",
|
|
876
|
+
"description": "The styles to use for the component."
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "render",
|
|
880
|
+
"type": "(instance: GalleryFooterInstance) => ReactNode",
|
|
881
|
+
"default": "",
|
|
882
|
+
"description": "The render function to render the component with instance access."
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "children",
|
|
886
|
+
"type": "any",
|
|
887
|
+
"default": "",
|
|
888
|
+
"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."
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"name": "[key: string]",
|
|
892
|
+
"type": "any",
|
|
893
|
+
"description": ""
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"name": "pt-{optionName}-*",
|
|
897
|
+
"type": "-",
|
|
898
|
+
"default": "",
|
|
899
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
900
|
+
"deprecated": false
|
|
901
|
+
}
|
|
902
|
+
],
|
|
903
|
+
"methods": []
|
|
904
|
+
},
|
|
905
|
+
"GalleryFooterState": {
|
|
906
|
+
"description": "Defines valid state in GalleryFooter component.",
|
|
907
|
+
"relatedProp": "",
|
|
908
|
+
"props": [],
|
|
909
|
+
"methods": []
|
|
910
|
+
},
|
|
911
|
+
"GalleryFooterExposes": {
|
|
912
|
+
"description": "Defines the methods and properties exposed by GalleryFooter component.",
|
|
913
|
+
"relatedProp": "",
|
|
914
|
+
"props": [
|
|
915
|
+
{
|
|
916
|
+
"name": "gallery",
|
|
917
|
+
"type": "GalleryRootInstance",
|
|
918
|
+
"default": "",
|
|
919
|
+
"description": "The Gallery component instance."
|
|
920
|
+
}
|
|
921
|
+
],
|
|
922
|
+
"methods": []
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"types": {
|
|
926
|
+
"GalleryFooterPassThroughType": {
|
|
927
|
+
"description": "Defines passthrough(pt) options type in GalleryFooter component.",
|
|
928
|
+
"values": "PassThroughType<GalleryFooterInstance, E>"
|
|
929
|
+
},
|
|
930
|
+
"GalleryFooterInstance": {
|
|
931
|
+
"description": "Instance of GalleryFooter component.",
|
|
932
|
+
"values": "ComponentInstance<GalleryFooterProps, GalleryFooterState, GalleryFooterExposes>"
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
"variables": {}
|
|
936
|
+
}
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "GalleryFullScreen",
|
|
940
|
+
"source": "apps/showcase/assets/apidoc/galleryfullscreen.json",
|
|
941
|
+
"data": {
|
|
942
|
+
"description": "GalleryFullScreen is a component that displays a full screen action.",
|
|
943
|
+
"interfaces": {
|
|
944
|
+
"GalleryFullScreenPassThrough": {
|
|
945
|
+
"description": "Defines passthrough(pt) options of GalleryFullScreen component.",
|
|
946
|
+
"relatedProp": "",
|
|
947
|
+
"props": [
|
|
948
|
+
{
|
|
949
|
+
"name": "root",
|
|
950
|
+
"type": "GalleryFullScreenPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
951
|
+
"default": "",
|
|
952
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
953
|
+
}
|
|
954
|
+
],
|
|
955
|
+
"methods": []
|
|
956
|
+
},
|
|
957
|
+
"GalleryFullScreenProps": {
|
|
958
|
+
"description": "Defines valid properties in GalleryFullScreen component.",
|
|
959
|
+
"relatedProp": "",
|
|
960
|
+
"extendedTypes": "BaseComponentProps<GalleryFullScreenInstance, unknown, GalleryFullScreenPassThrough>",
|
|
961
|
+
"props": [
|
|
962
|
+
{
|
|
963
|
+
"name": "ref",
|
|
964
|
+
"type": "Ref<unknown>",
|
|
965
|
+
"default": "",
|
|
966
|
+
"description": "The reference to the component instance."
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "pIf",
|
|
970
|
+
"type": "boolean",
|
|
971
|
+
"default": "true",
|
|
972
|
+
"description": "Whether the component should be rendered."
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
"name": "style",
|
|
976
|
+
"type": "CSSProperties | ((instance?: GalleryFullScreenInstance) => CSSProperties)",
|
|
977
|
+
"default": "",
|
|
978
|
+
"description": "The style to apply to the component."
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "className",
|
|
982
|
+
"type": "string | ((instance?: GalleryFullScreenInstance) => string)",
|
|
983
|
+
"default": "",
|
|
984
|
+
"description": "The class name to apply to the component."
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "as",
|
|
988
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
989
|
+
"default": "",
|
|
990
|
+
"description": "The component type to render."
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "asChild",
|
|
994
|
+
"type": "boolean",
|
|
995
|
+
"default": "false",
|
|
996
|
+
"description": "Whether the component should be rendered as a child component."
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
"name": "instance",
|
|
1000
|
+
"type": "GalleryFullScreenInstance",
|
|
1001
|
+
"default": "",
|
|
1002
|
+
"description": "The instance to pass to the component."
|
|
1003
|
+
},
|
|
1004
|
+
{
|
|
1005
|
+
"name": "pt",
|
|
1006
|
+
"type": "SafeRecord<GalleryFullScreenPassThrough>",
|
|
1007
|
+
"default": "",
|
|
1008
|
+
"description": "The pass-through props to pass to the component."
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "ptOptions",
|
|
1012
|
+
"type": "PassThroughOptions",
|
|
1013
|
+
"default": "",
|
|
1014
|
+
"description": "The pass-through options to pass to the component."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "unstyled",
|
|
1018
|
+
"type": "boolean",
|
|
1019
|
+
"default": "",
|
|
1020
|
+
"description": "Whether the component should be rendered without classes."
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "dt",
|
|
1024
|
+
"type": "unknown",
|
|
1025
|
+
"default": "",
|
|
1026
|
+
"description": "The design token to use for the component."
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "styles",
|
|
1030
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1031
|
+
"default": "",
|
|
1032
|
+
"description": "The styles to use for the component."
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "render",
|
|
1036
|
+
"type": "(instance: GalleryFullScreenInstance) => ReactNode",
|
|
1037
|
+
"default": "",
|
|
1038
|
+
"description": "The render function to render the component with instance access."
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "children",
|
|
1042
|
+
"type": "any",
|
|
1043
|
+
"default": "",
|
|
1044
|
+
"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."
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "[key: string]",
|
|
1048
|
+
"type": "any",
|
|
1049
|
+
"description": ""
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"name": "pt-{optionName}-*",
|
|
1053
|
+
"type": "-",
|
|
1054
|
+
"default": "",
|
|
1055
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1056
|
+
"deprecated": false
|
|
1057
|
+
}
|
|
1058
|
+
],
|
|
1059
|
+
"methods": []
|
|
1060
|
+
},
|
|
1061
|
+
"GalleryFullScreenState": {
|
|
1062
|
+
"description": "Defines valid state in GalleryFullScreen component.",
|
|
1063
|
+
"relatedProp": "",
|
|
1064
|
+
"props": [],
|
|
1065
|
+
"methods": []
|
|
1066
|
+
},
|
|
1067
|
+
"GalleryFullScreenExposes": {
|
|
1068
|
+
"description": "Defines the methods and properties exposed by GalleryFullScreen component.",
|
|
1069
|
+
"relatedProp": "",
|
|
1070
|
+
"props": [
|
|
1071
|
+
{
|
|
1072
|
+
"name": "gallery",
|
|
1073
|
+
"type": "GalleryRootInstance",
|
|
1074
|
+
"default": "",
|
|
1075
|
+
"description": "The Gallery component instance."
|
|
1076
|
+
}
|
|
1077
|
+
],
|
|
1078
|
+
"methods": []
|
|
1079
|
+
}
|
|
1080
|
+
},
|
|
1081
|
+
"types": {
|
|
1082
|
+
"GalleryFullScreenPassThroughType": {
|
|
1083
|
+
"description": "Defines passthrough(pt) options type in GalleryFullScreen component.",
|
|
1084
|
+
"values": "PassThroughType<GalleryFullScreenInstance, E>"
|
|
1085
|
+
},
|
|
1086
|
+
"GalleryFullScreenInstance": {
|
|
1087
|
+
"description": "Instance of GalleryFullScreen component.",
|
|
1088
|
+
"values": "ComponentInstance<GalleryFullScreenProps, GalleryFullScreenState, GalleryFullScreenExposes>"
|
|
1089
|
+
}
|
|
1090
|
+
},
|
|
1091
|
+
"variables": {}
|
|
1092
|
+
}
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "GalleryHeader",
|
|
1096
|
+
"source": "apps/showcase/assets/apidoc/galleryheader.json",
|
|
1097
|
+
"data": {
|
|
1098
|
+
"description": "GalleryHeader is a component that displays a header of content.",
|
|
1099
|
+
"interfaces": {
|
|
1100
|
+
"GalleryHeaderPassThrough": {
|
|
1101
|
+
"description": "Defines passthrough(pt) options of GalleryHeader component.",
|
|
1102
|
+
"relatedProp": "",
|
|
1103
|
+
"props": [
|
|
1104
|
+
{
|
|
1105
|
+
"name": "root",
|
|
1106
|
+
"type": "GalleryHeaderPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1107
|
+
"default": "",
|
|
1108
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1109
|
+
}
|
|
1110
|
+
],
|
|
1111
|
+
"methods": []
|
|
1112
|
+
},
|
|
1113
|
+
"GalleryHeaderProps": {
|
|
1114
|
+
"description": "Defines valid properties in GalleryHeader component.",
|
|
1115
|
+
"relatedProp": "",
|
|
1116
|
+
"extendedTypes": "BaseComponentProps<GalleryHeaderInstance, unknown, GalleryHeaderPassThrough>",
|
|
1117
|
+
"props": [
|
|
1118
|
+
{
|
|
1119
|
+
"name": "ref",
|
|
1120
|
+
"type": "Ref<unknown>",
|
|
1121
|
+
"default": "",
|
|
1122
|
+
"description": "The reference to the component instance."
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "pIf",
|
|
1126
|
+
"type": "boolean",
|
|
1127
|
+
"default": "true",
|
|
1128
|
+
"description": "Whether the component should be rendered."
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "style",
|
|
1132
|
+
"type": "CSSProperties | ((instance?: GalleryHeaderInstance) => CSSProperties)",
|
|
1133
|
+
"default": "",
|
|
1134
|
+
"description": "The style to apply to the component."
|
|
1135
|
+
},
|
|
1136
|
+
{
|
|
1137
|
+
"name": "className",
|
|
1138
|
+
"type": "string | ((instance?: GalleryHeaderInstance) => string)",
|
|
1139
|
+
"default": "",
|
|
1140
|
+
"description": "The class name to apply to the component."
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"name": "as",
|
|
1144
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1145
|
+
"default": "",
|
|
1146
|
+
"description": "The component type to render."
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"name": "asChild",
|
|
1150
|
+
"type": "boolean",
|
|
1151
|
+
"default": "false",
|
|
1152
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "instance",
|
|
1156
|
+
"type": "GalleryHeaderInstance",
|
|
1157
|
+
"default": "",
|
|
1158
|
+
"description": "The instance to pass to the component."
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "pt",
|
|
1162
|
+
"type": "SafeRecord<GalleryHeaderPassThrough>",
|
|
1163
|
+
"default": "",
|
|
1164
|
+
"description": "The pass-through props to pass to the component."
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "ptOptions",
|
|
1168
|
+
"type": "PassThroughOptions",
|
|
1169
|
+
"default": "",
|
|
1170
|
+
"description": "The pass-through options to pass to the component."
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"name": "unstyled",
|
|
1174
|
+
"type": "boolean",
|
|
1175
|
+
"default": "",
|
|
1176
|
+
"description": "Whether the component should be rendered without classes."
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"name": "dt",
|
|
1180
|
+
"type": "unknown",
|
|
1181
|
+
"default": "",
|
|
1182
|
+
"description": "The design token to use for the component."
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
"name": "styles",
|
|
1186
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1187
|
+
"default": "",
|
|
1188
|
+
"description": "The styles to use for the component."
|
|
1189
|
+
},
|
|
1190
|
+
{
|
|
1191
|
+
"name": "render",
|
|
1192
|
+
"type": "(instance: GalleryHeaderInstance) => ReactNode",
|
|
1193
|
+
"default": "",
|
|
1194
|
+
"description": "The render function to render the component with instance access."
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"name": "children",
|
|
1198
|
+
"type": "any",
|
|
1199
|
+
"default": "",
|
|
1200
|
+
"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."
|
|
1201
|
+
},
|
|
1202
|
+
{
|
|
1203
|
+
"name": "[key: string]",
|
|
1204
|
+
"type": "any",
|
|
1205
|
+
"description": ""
|
|
1206
|
+
},
|
|
1207
|
+
{
|
|
1208
|
+
"name": "pt-{optionName}-*",
|
|
1209
|
+
"type": "-",
|
|
1210
|
+
"default": "",
|
|
1211
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1212
|
+
"deprecated": false
|
|
1213
|
+
}
|
|
1214
|
+
],
|
|
1215
|
+
"methods": []
|
|
1216
|
+
},
|
|
1217
|
+
"GalleryHeaderState": {
|
|
1218
|
+
"description": "Defines valid state in GalleryHeader component.",
|
|
1219
|
+
"relatedProp": "",
|
|
1220
|
+
"props": [],
|
|
1221
|
+
"methods": []
|
|
1222
|
+
},
|
|
1223
|
+
"GalleryHeaderExposes": {
|
|
1224
|
+
"description": "Defines the methods and properties exposed by GalleryHeader component.",
|
|
1225
|
+
"relatedProp": "",
|
|
1226
|
+
"props": [
|
|
1227
|
+
{
|
|
1228
|
+
"name": "gallery",
|
|
1229
|
+
"type": "GalleryRootInstance",
|
|
1230
|
+
"default": "",
|
|
1231
|
+
"description": "The Gallery component instance."
|
|
1232
|
+
}
|
|
1233
|
+
],
|
|
1234
|
+
"methods": []
|
|
1235
|
+
}
|
|
1236
|
+
},
|
|
1237
|
+
"types": {
|
|
1238
|
+
"GalleryHeaderPassThroughType": {
|
|
1239
|
+
"description": "Defines passthrough(pt) options type in GalleryHeader component.",
|
|
1240
|
+
"values": "PassThroughType<GalleryHeaderInstance, E>"
|
|
1241
|
+
},
|
|
1242
|
+
"GalleryHeaderInstance": {
|
|
1243
|
+
"description": "Instance of GalleryHeader component.",
|
|
1244
|
+
"values": "ComponentInstance<GalleryHeaderProps, GalleryHeaderState, GalleryHeaderExposes>"
|
|
1245
|
+
}
|
|
1246
|
+
},
|
|
1247
|
+
"variables": {}
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "GalleryItem",
|
|
1252
|
+
"source": "apps/showcase/assets/apidoc/galleryitem.json",
|
|
1253
|
+
"data": {
|
|
1254
|
+
"description": "Gallery groups a collection of contents in items.",
|
|
1255
|
+
"interfaces": {
|
|
1256
|
+
"GalleryItemPassThrough": {
|
|
1257
|
+
"description": "Defines passthrough(pt) options of GalleryItem component.",
|
|
1258
|
+
"relatedProp": "",
|
|
1259
|
+
"props": [
|
|
1260
|
+
{
|
|
1261
|
+
"name": "root",
|
|
1262
|
+
"type": "GalleryItemPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1263
|
+
"default": "",
|
|
1264
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1265
|
+
}
|
|
1266
|
+
],
|
|
1267
|
+
"methods": []
|
|
1268
|
+
},
|
|
1269
|
+
"GalleryItemProps": {
|
|
1270
|
+
"description": "Defines valid properties in GalleryItem component.",
|
|
1271
|
+
"relatedProp": "",
|
|
1272
|
+
"extendedTypes": "BaseComponentProps<GalleryItemInstance, UseGalleryItemProps, GalleryItemPassThrough>",
|
|
1273
|
+
"props": [
|
|
1274
|
+
{
|
|
1275
|
+
"name": "ref",
|
|
1276
|
+
"type": "Ref<unknown>",
|
|
1277
|
+
"default": "",
|
|
1278
|
+
"description": "The reference to the component instance."
|
|
1279
|
+
},
|
|
1280
|
+
{
|
|
1281
|
+
"name": "pIf",
|
|
1282
|
+
"type": "boolean",
|
|
1283
|
+
"default": "true",
|
|
1284
|
+
"description": "Whether the component should be rendered."
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"name": "style",
|
|
1288
|
+
"type": "CSSProperties | ((instance?: GalleryItemInstance) => CSSProperties)",
|
|
1289
|
+
"default": "",
|
|
1290
|
+
"description": "The style to apply to the component."
|
|
1291
|
+
},
|
|
1292
|
+
{
|
|
1293
|
+
"name": "className",
|
|
1294
|
+
"type": "string | ((instance?: GalleryItemInstance) => string)",
|
|
1295
|
+
"default": "",
|
|
1296
|
+
"description": "The class name to apply to the component."
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "as",
|
|
1300
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1301
|
+
"default": "",
|
|
1302
|
+
"description": "The component type to render."
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
"name": "asChild",
|
|
1306
|
+
"type": "boolean",
|
|
1307
|
+
"default": "false",
|
|
1308
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"name": "instance",
|
|
1312
|
+
"type": "GalleryItemInstance",
|
|
1313
|
+
"default": "",
|
|
1314
|
+
"description": "The instance to pass to the component."
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "pt",
|
|
1318
|
+
"type": "SafeRecord<GalleryItemPassThrough>",
|
|
1319
|
+
"default": "",
|
|
1320
|
+
"description": "The pass-through props to pass to the component."
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
"name": "ptOptions",
|
|
1324
|
+
"type": "PassThroughOptions",
|
|
1325
|
+
"default": "",
|
|
1326
|
+
"description": "The pass-through options to pass to the component."
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "unstyled",
|
|
1330
|
+
"type": "boolean",
|
|
1331
|
+
"default": "",
|
|
1332
|
+
"description": "Whether the component should be rendered without classes."
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "dt",
|
|
1336
|
+
"type": "unknown",
|
|
1337
|
+
"default": "",
|
|
1338
|
+
"description": "The design token to use for the component."
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"name": "styles",
|
|
1342
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1343
|
+
"default": "",
|
|
1344
|
+
"description": "The styles to use for the component."
|
|
1345
|
+
},
|
|
1346
|
+
{
|
|
1347
|
+
"name": "render",
|
|
1348
|
+
"type": "(instance: GalleryItemInstance) => ReactNode",
|
|
1349
|
+
"default": "",
|
|
1350
|
+
"description": "The render function to render the component with instance access."
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "children",
|
|
1354
|
+
"type": "any",
|
|
1355
|
+
"default": "",
|
|
1356
|
+
"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."
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "context",
|
|
1360
|
+
"type": "UseGalleryItemGalleryRef",
|
|
1361
|
+
"default": "",
|
|
1362
|
+
"description": "The parent gallery instance. The primitive `Gallery.Item` reads it from the\nnearest `GalleryProvider` and passes it here; supply it directly for standalone\nheadless usage. The headless hook itself never reads React context, keeping the\nheadless layer independent of the primitive layer."
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
"name": "normalScale",
|
|
1366
|
+
"type": "number",
|
|
1367
|
+
"default": "1",
|
|
1368
|
+
"description": "The normal scale of the gallery item."
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"name": "zoomedScale",
|
|
1372
|
+
"type": "number",
|
|
1373
|
+
"default": "3",
|
|
1374
|
+
"description": "The zoomed scale of the gallery item."
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "[key: string]",
|
|
1378
|
+
"type": "any",
|
|
1379
|
+
"description": ""
|
|
1380
|
+
},
|
|
1381
|
+
{
|
|
1382
|
+
"name": "pt-{optionName}-*",
|
|
1383
|
+
"type": "-",
|
|
1384
|
+
"default": "",
|
|
1385
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1386
|
+
"deprecated": false
|
|
1387
|
+
}
|
|
1388
|
+
],
|
|
1389
|
+
"methods": []
|
|
1390
|
+
},
|
|
1391
|
+
"GalleryItemState": {
|
|
1392
|
+
"description": "Defines valid state in GalleryItem component.",
|
|
1393
|
+
"relatedProp": "",
|
|
1394
|
+
"extendedTypes": "UseGalleryItemState",
|
|
1395
|
+
"props": [
|
|
1396
|
+
{
|
|
1397
|
+
"name": "index",
|
|
1398
|
+
"type": "number",
|
|
1399
|
+
"default": "",
|
|
1400
|
+
"description": "The index of the item in the gallery."
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"name": "isActive",
|
|
1404
|
+
"type": "boolean",
|
|
1405
|
+
"default": "",
|
|
1406
|
+
"description": "Whether the item is the active (visible) item."
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "position",
|
|
1410
|
+
"type": "{ x: number; y: number }",
|
|
1411
|
+
"default": "",
|
|
1412
|
+
"description": "The current pan position."
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"name": "scale",
|
|
1416
|
+
"type": "number",
|
|
1417
|
+
"default": "",
|
|
1418
|
+
"description": "The current zoom scale."
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"name": "rotation",
|
|
1422
|
+
"type": "number",
|
|
1423
|
+
"default": "",
|
|
1424
|
+
"description": "The current rotation in degrees."
|
|
1425
|
+
},
|
|
1426
|
+
{
|
|
1427
|
+
"name": "flip",
|
|
1428
|
+
"type": "{ x: number; y: number }",
|
|
1429
|
+
"default": "",
|
|
1430
|
+
"description": "The current flip state."
|
|
1431
|
+
}
|
|
1432
|
+
],
|
|
1433
|
+
"methods": []
|
|
1434
|
+
},
|
|
1435
|
+
"GalleryItemExposes": {
|
|
1436
|
+
"description": "Defines the methods and properties exposed by GalleryItem component.",
|
|
1437
|
+
"relatedProp": "",
|
|
1438
|
+
"extendedTypes": "UseGalleryItemExposes",
|
|
1439
|
+
"props": [
|
|
1440
|
+
{
|
|
1441
|
+
"name": "state",
|
|
1442
|
+
"type": "UseGalleryItemState",
|
|
1443
|
+
"default": "",
|
|
1444
|
+
"description": "The state of the useGalleryItem."
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"name": "itemProps",
|
|
1448
|
+
"type": "UseGalleryItemElementProps",
|
|
1449
|
+
"default": "",
|
|
1450
|
+
"description": "Pre-built props for the item root element."
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"name": "handleDragStart",
|
|
1454
|
+
"type": "(e: DragEvent<HTMLDivElement>) => void",
|
|
1455
|
+
"default": "",
|
|
1456
|
+
"description": "Handles the drag start event to prevent default browser drag behavior."
|
|
1457
|
+
},
|
|
1458
|
+
{
|
|
1459
|
+
"name": "handlePointerUp",
|
|
1460
|
+
"type": "(e: PointerEvent<HTMLDivElement>) => void",
|
|
1461
|
+
"default": "",
|
|
1462
|
+
"description": "Handles the pointer up event to end panning."
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"name": "handlePointerMove",
|
|
1466
|
+
"type": "(e: PointerEvent<HTMLDivElement>) => void",
|
|
1467
|
+
"default": "",
|
|
1468
|
+
"description": "Handles the pointer move event for panning while zoomed."
|
|
1469
|
+
},
|
|
1470
|
+
{
|
|
1471
|
+
"name": "handlePointerDown",
|
|
1472
|
+
"type": "(e: PointerEvent<HTMLDivElement>) => void",
|
|
1473
|
+
"default": "",
|
|
1474
|
+
"description": "Handles the pointer down event to start panning."
|
|
1475
|
+
},
|
|
1476
|
+
{
|
|
1477
|
+
"name": "handleClick",
|
|
1478
|
+
"type": "(e: MouseEvent<HTMLDivElement>) => void",
|
|
1479
|
+
"default": "",
|
|
1480
|
+
"description": "Handles the click event to toggle zoom."
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
"name": "zoomIn",
|
|
1484
|
+
"type": "() => void",
|
|
1485
|
+
"default": "",
|
|
1486
|
+
"description": "Zooms in the gallery item."
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "zoomOut",
|
|
1490
|
+
"type": "() => void",
|
|
1491
|
+
"default": "",
|
|
1492
|
+
"description": "Zooms out the gallery item."
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
"name": "rotateLeft",
|
|
1496
|
+
"type": "() => void",
|
|
1497
|
+
"default": "",
|
|
1498
|
+
"description": "Rotates the gallery item left by 90 degrees."
|
|
1499
|
+
},
|
|
1500
|
+
{
|
|
1501
|
+
"name": "rotateRight",
|
|
1502
|
+
"type": "() => void",
|
|
1503
|
+
"default": "",
|
|
1504
|
+
"description": "Rotates the gallery item right by 90 degrees."
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "flipX",
|
|
1508
|
+
"type": "() => void",
|
|
1509
|
+
"default": "",
|
|
1510
|
+
"description": "Flips the gallery item horizontally."
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
"name": "flipY",
|
|
1514
|
+
"type": "() => void",
|
|
1515
|
+
"default": "",
|
|
1516
|
+
"description": "Flips the gallery item vertically."
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
"name": "download",
|
|
1520
|
+
"type": "() => void",
|
|
1521
|
+
"default": "",
|
|
1522
|
+
"description": "Downloads the gallery item."
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"name": "calculateConstraints",
|
|
1526
|
+
"type": "() => { minX: number; maxX: number; minY: number; maxY: number }",
|
|
1527
|
+
"default": "",
|
|
1528
|
+
"description": "Calculates the pan constraints for the gallery item based on its current scale."
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
"name": "calculateItemSize",
|
|
1532
|
+
"type": "() => void",
|
|
1533
|
+
"default": "",
|
|
1534
|
+
"description": "Recalculates the size of the gallery item element."
|
|
1535
|
+
}
|
|
1536
|
+
],
|
|
1537
|
+
"methods": []
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
"types": {
|
|
1541
|
+
"GalleryItemPassThroughType": {
|
|
1542
|
+
"description": "Defines passthrough(pt) options type in GalleryItem component.",
|
|
1543
|
+
"values": "PassThroughType<GalleryItemInstance, E>"
|
|
1544
|
+
},
|
|
1545
|
+
"GalleryItemInstance": {
|
|
1546
|
+
"description": "Instance of GalleryItem component.",
|
|
1547
|
+
"values": "ComponentInstance<GalleryItemProps, GalleryItemState, GalleryItemExposes>"
|
|
1548
|
+
}
|
|
1549
|
+
},
|
|
1550
|
+
"variables": {}
|
|
1551
|
+
}
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"name": "GalleryNext",
|
|
1555
|
+
"source": "apps/showcase/assets/apidoc/gallerynext.json",
|
|
1556
|
+
"data": {
|
|
1557
|
+
"description": "GalleryNext is a component that displays a next of a gallery.",
|
|
1558
|
+
"interfaces": {
|
|
1559
|
+
"GalleryNextPassThrough": {
|
|
1560
|
+
"description": "Defines passthrough(pt) options of GalleryNext component.",
|
|
1561
|
+
"relatedProp": "",
|
|
1562
|
+
"props": [
|
|
1563
|
+
{
|
|
1564
|
+
"name": "root",
|
|
1565
|
+
"type": "GalleryNextPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1566
|
+
"default": "",
|
|
1567
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1568
|
+
}
|
|
1569
|
+
],
|
|
1570
|
+
"methods": []
|
|
1571
|
+
},
|
|
1572
|
+
"GalleryNextProps": {
|
|
1573
|
+
"description": "Defines valid properties in GalleryNext component.",
|
|
1574
|
+
"relatedProp": "",
|
|
1575
|
+
"extendedTypes": "BaseComponentProps<GalleryNextInstance, unknown, GalleryNextPassThrough>",
|
|
1576
|
+
"props": [
|
|
1577
|
+
{
|
|
1578
|
+
"name": "ref",
|
|
1579
|
+
"type": "Ref<unknown>",
|
|
1580
|
+
"default": "",
|
|
1581
|
+
"description": "The reference to the component instance."
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "pIf",
|
|
1585
|
+
"type": "boolean",
|
|
1586
|
+
"default": "true",
|
|
1587
|
+
"description": "Whether the component should be rendered."
|
|
1588
|
+
},
|
|
1589
|
+
{
|
|
1590
|
+
"name": "style",
|
|
1591
|
+
"type": "CSSProperties | ((instance?: GalleryNextInstance) => CSSProperties)",
|
|
1592
|
+
"default": "",
|
|
1593
|
+
"description": "The style to apply to the component."
|
|
1594
|
+
},
|
|
1595
|
+
{
|
|
1596
|
+
"name": "className",
|
|
1597
|
+
"type": "string | ((instance?: GalleryNextInstance) => string)",
|
|
1598
|
+
"default": "",
|
|
1599
|
+
"description": "The class name to apply to the component."
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"name": "as",
|
|
1603
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1604
|
+
"default": "",
|
|
1605
|
+
"description": "The component type to render."
|
|
1606
|
+
},
|
|
1607
|
+
{
|
|
1608
|
+
"name": "asChild",
|
|
1609
|
+
"type": "boolean",
|
|
1610
|
+
"default": "false",
|
|
1611
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "instance",
|
|
1615
|
+
"type": "GalleryNextInstance",
|
|
1616
|
+
"default": "",
|
|
1617
|
+
"description": "The instance to pass to the component."
|
|
1618
|
+
},
|
|
1619
|
+
{
|
|
1620
|
+
"name": "pt",
|
|
1621
|
+
"type": "SafeRecord<GalleryNextPassThrough>",
|
|
1622
|
+
"default": "",
|
|
1623
|
+
"description": "The pass-through props to pass to the component."
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"name": "ptOptions",
|
|
1627
|
+
"type": "PassThroughOptions",
|
|
1628
|
+
"default": "",
|
|
1629
|
+
"description": "The pass-through options to pass to the component."
|
|
1630
|
+
},
|
|
1631
|
+
{
|
|
1632
|
+
"name": "unstyled",
|
|
1633
|
+
"type": "boolean",
|
|
1634
|
+
"default": "",
|
|
1635
|
+
"description": "Whether the component should be rendered without classes."
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
"name": "dt",
|
|
1639
|
+
"type": "unknown",
|
|
1640
|
+
"default": "",
|
|
1641
|
+
"description": "The design token to use for the component."
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "styles",
|
|
1645
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1646
|
+
"default": "",
|
|
1647
|
+
"description": "The styles to use for the component."
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
"name": "render",
|
|
1651
|
+
"type": "(instance: GalleryNextInstance) => ReactNode",
|
|
1652
|
+
"default": "",
|
|
1653
|
+
"description": "The render function to render the component with instance access."
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"name": "children",
|
|
1657
|
+
"type": "any",
|
|
1658
|
+
"default": "",
|
|
1659
|
+
"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."
|
|
1660
|
+
},
|
|
1661
|
+
{
|
|
1662
|
+
"name": "[key: string]",
|
|
1663
|
+
"type": "any",
|
|
1664
|
+
"description": ""
|
|
1665
|
+
},
|
|
1666
|
+
{
|
|
1667
|
+
"name": "pt-{optionName}-*",
|
|
1668
|
+
"type": "-",
|
|
1669
|
+
"default": "",
|
|
1670
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1671
|
+
"deprecated": false
|
|
1672
|
+
}
|
|
1673
|
+
],
|
|
1674
|
+
"methods": []
|
|
1675
|
+
},
|
|
1676
|
+
"GalleryNextState": {
|
|
1677
|
+
"description": "Defines valid state in GalleryNext component.",
|
|
1678
|
+
"relatedProp": "",
|
|
1679
|
+
"props": [],
|
|
1680
|
+
"methods": []
|
|
1681
|
+
},
|
|
1682
|
+
"GalleryNextExposes": {
|
|
1683
|
+
"description": "Defines the methods and properties exposed by GalleryNext component.",
|
|
1684
|
+
"relatedProp": "",
|
|
1685
|
+
"props": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "gallery",
|
|
1688
|
+
"type": "GalleryRootInstance",
|
|
1689
|
+
"default": "",
|
|
1690
|
+
"description": "The Gallery component instance."
|
|
1691
|
+
}
|
|
1692
|
+
],
|
|
1693
|
+
"methods": []
|
|
1694
|
+
}
|
|
1695
|
+
},
|
|
1696
|
+
"types": {
|
|
1697
|
+
"GalleryNextPassThroughType": {
|
|
1698
|
+
"description": "Defines passthrough(pt) options type in GalleryNext component.",
|
|
1699
|
+
"values": "PassThroughType<GalleryNextInstance, E>"
|
|
1700
|
+
},
|
|
1701
|
+
"GalleryNextInstance": {
|
|
1702
|
+
"description": "Instance of GalleryNext component.",
|
|
1703
|
+
"values": "ComponentInstance<GalleryNextProps, GalleryNextState, GalleryNextExposes>"
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
"variables": {}
|
|
1707
|
+
}
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "GalleryPrev",
|
|
1711
|
+
"source": "apps/showcase/assets/apidoc/galleryprev.json",
|
|
1712
|
+
"data": {
|
|
1713
|
+
"description": "GalleryPrev is a component that displays a previous of a gallery.",
|
|
1714
|
+
"interfaces": {
|
|
1715
|
+
"GalleryPrevPassThrough": {
|
|
1716
|
+
"description": "Defines passthrough(pt) options of GalleryPrev component.",
|
|
1717
|
+
"relatedProp": "",
|
|
1718
|
+
"props": [
|
|
1719
|
+
{
|
|
1720
|
+
"name": "root",
|
|
1721
|
+
"type": "GalleryPrevPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
1722
|
+
"default": "",
|
|
1723
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1724
|
+
}
|
|
1725
|
+
],
|
|
1726
|
+
"methods": []
|
|
1727
|
+
},
|
|
1728
|
+
"GalleryPrevProps": {
|
|
1729
|
+
"description": "Defines valid properties in GalleryPrev component.",
|
|
1730
|
+
"relatedProp": "",
|
|
1731
|
+
"extendedTypes": "BaseComponentProps<GalleryPrevInstance, unknown, GalleryPrevPassThrough>",
|
|
1732
|
+
"props": [
|
|
1733
|
+
{
|
|
1734
|
+
"name": "ref",
|
|
1735
|
+
"type": "Ref<unknown>",
|
|
1736
|
+
"default": "",
|
|
1737
|
+
"description": "The reference to the component instance."
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "pIf",
|
|
1741
|
+
"type": "boolean",
|
|
1742
|
+
"default": "true",
|
|
1743
|
+
"description": "Whether the component should be rendered."
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "style",
|
|
1747
|
+
"type": "CSSProperties | ((instance?: GalleryPrevInstance) => CSSProperties)",
|
|
1748
|
+
"default": "",
|
|
1749
|
+
"description": "The style to apply to the component."
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "className",
|
|
1753
|
+
"type": "string | ((instance?: GalleryPrevInstance) => string)",
|
|
1754
|
+
"default": "",
|
|
1755
|
+
"description": "The class name to apply to the component."
|
|
1756
|
+
},
|
|
1757
|
+
{
|
|
1758
|
+
"name": "as",
|
|
1759
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1760
|
+
"default": "",
|
|
1761
|
+
"description": "The component type to render."
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"name": "asChild",
|
|
1765
|
+
"type": "boolean",
|
|
1766
|
+
"default": "false",
|
|
1767
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "instance",
|
|
1771
|
+
"type": "GalleryPrevInstance",
|
|
1772
|
+
"default": "",
|
|
1773
|
+
"description": "The instance to pass to the component."
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
"name": "pt",
|
|
1777
|
+
"type": "SafeRecord<GalleryPrevPassThrough>",
|
|
1778
|
+
"default": "",
|
|
1779
|
+
"description": "The pass-through props to pass to the component."
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"name": "ptOptions",
|
|
1783
|
+
"type": "PassThroughOptions",
|
|
1784
|
+
"default": "",
|
|
1785
|
+
"description": "The pass-through options to pass to the component."
|
|
1786
|
+
},
|
|
1787
|
+
{
|
|
1788
|
+
"name": "unstyled",
|
|
1789
|
+
"type": "boolean",
|
|
1790
|
+
"default": "",
|
|
1791
|
+
"description": "Whether the component should be rendered without classes."
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"name": "dt",
|
|
1795
|
+
"type": "unknown",
|
|
1796
|
+
"default": "",
|
|
1797
|
+
"description": "The design token to use for the component."
|
|
1798
|
+
},
|
|
1799
|
+
{
|
|
1800
|
+
"name": "styles",
|
|
1801
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1802
|
+
"default": "",
|
|
1803
|
+
"description": "The styles to use for the component."
|
|
1804
|
+
},
|
|
1805
|
+
{
|
|
1806
|
+
"name": "render",
|
|
1807
|
+
"type": "(instance: GalleryPrevInstance) => ReactNode",
|
|
1808
|
+
"default": "",
|
|
1809
|
+
"description": "The render function to render the component with instance access."
|
|
1810
|
+
},
|
|
1811
|
+
{
|
|
1812
|
+
"name": "children",
|
|
1813
|
+
"type": "any",
|
|
1814
|
+
"default": "",
|
|
1815
|
+
"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."
|
|
1816
|
+
},
|
|
1817
|
+
{
|
|
1818
|
+
"name": "[key: string]",
|
|
1819
|
+
"type": "any",
|
|
1820
|
+
"description": ""
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"name": "pt-{optionName}-*",
|
|
1824
|
+
"type": "-",
|
|
1825
|
+
"default": "",
|
|
1826
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1827
|
+
"deprecated": false
|
|
1828
|
+
}
|
|
1829
|
+
],
|
|
1830
|
+
"methods": []
|
|
1831
|
+
},
|
|
1832
|
+
"GalleryPrevState": {
|
|
1833
|
+
"description": "Defines valid state in GalleryPrev component.",
|
|
1834
|
+
"relatedProp": "",
|
|
1835
|
+
"props": [],
|
|
1836
|
+
"methods": []
|
|
1837
|
+
},
|
|
1838
|
+
"GalleryPrevExposes": {
|
|
1839
|
+
"description": "Defines the methods and properties exposed by GalleryPrev component.",
|
|
1840
|
+
"relatedProp": "",
|
|
1841
|
+
"props": [
|
|
1842
|
+
{
|
|
1843
|
+
"name": "gallery",
|
|
1844
|
+
"type": "GalleryRootInstance",
|
|
1845
|
+
"default": "",
|
|
1846
|
+
"description": "The Gallery component instance."
|
|
1847
|
+
}
|
|
1848
|
+
],
|
|
1849
|
+
"methods": []
|
|
1850
|
+
}
|
|
1851
|
+
},
|
|
1852
|
+
"types": {
|
|
1853
|
+
"GalleryPrevPassThroughType": {
|
|
1854
|
+
"description": "Defines passthrough(pt) options type in GalleryPrev component.",
|
|
1855
|
+
"values": "PassThroughType<GalleryPrevInstance, E>"
|
|
1856
|
+
},
|
|
1857
|
+
"GalleryPrevInstance": {
|
|
1858
|
+
"description": "Instance of GalleryPrev component.",
|
|
1859
|
+
"values": "ComponentInstance<GalleryPrevProps, GalleryPrevState, GalleryPrevExposes>"
|
|
1860
|
+
}
|
|
1861
|
+
},
|
|
1862
|
+
"variables": {}
|
|
1863
|
+
}
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "GalleryRoot",
|
|
1867
|
+
"source": "apps/showcase/assets/apidoc/galleryroot.json",
|
|
1868
|
+
"data": {
|
|
1869
|
+
"description": "Gallery groups a collection of contents in items.",
|
|
1870
|
+
"interfaces": {
|
|
1871
|
+
"GalleryRootPassThrough": {
|
|
1872
|
+
"description": "Defines passthrough(pt) options of Gallery component.",
|
|
1873
|
+
"relatedProp": "",
|
|
1874
|
+
"props": [
|
|
1875
|
+
{
|
|
1876
|
+
"name": "root",
|
|
1877
|
+
"type": "GalleryRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1878
|
+
"default": "",
|
|
1879
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"name": "item",
|
|
1883
|
+
"type": "GalleryRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1884
|
+
"default": "",
|
|
1885
|
+
"description": "Used to pass attributes to the item's DOM element."
|
|
1886
|
+
},
|
|
1887
|
+
{
|
|
1888
|
+
"name": "thumbnailContent",
|
|
1889
|
+
"type": "GalleryRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1890
|
+
"default": "",
|
|
1891
|
+
"description": "Used to pass attributes to the thumbnail content's DOM element."
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"name": "thumbnail",
|
|
1895
|
+
"type": "GalleryRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1896
|
+
"default": "",
|
|
1897
|
+
"description": "Used to pass attributes to the thumbnail's DOM element."
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
"name": "thumbnailItem",
|
|
1901
|
+
"type": "GalleryRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1902
|
+
"default": "",
|
|
1903
|
+
"description": "Used to pass attributes to the thumbnail item's DOM element."
|
|
1904
|
+
}
|
|
1905
|
+
],
|
|
1906
|
+
"methods": []
|
|
1907
|
+
},
|
|
1908
|
+
"GalleryRootProps": {
|
|
1909
|
+
"description": "Defines valid properties in Gallery component.",
|
|
1910
|
+
"relatedProp": "",
|
|
1911
|
+
"extendedTypes": "BaseComponentProps<GalleryRootInstance, UseGalleryProps, GalleryRootPassThrough>",
|
|
1912
|
+
"props": [
|
|
1913
|
+
{
|
|
1914
|
+
"name": "ref",
|
|
1915
|
+
"type": "Ref<unknown>",
|
|
1916
|
+
"default": "",
|
|
1917
|
+
"description": "The reference to the component instance."
|
|
1918
|
+
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "pIf",
|
|
1921
|
+
"type": "boolean",
|
|
1922
|
+
"default": "true",
|
|
1923
|
+
"description": "Whether the component should be rendered."
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
"name": "style",
|
|
1927
|
+
"type": "CSSProperties | ((instance?: GalleryRootInstance) => CSSProperties)",
|
|
1928
|
+
"default": "",
|
|
1929
|
+
"description": "The style to apply to the component."
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"name": "className",
|
|
1933
|
+
"type": "string | ((instance?: GalleryRootInstance) => string)",
|
|
1934
|
+
"default": "",
|
|
1935
|
+
"description": "The class name to apply to the component."
|
|
1936
|
+
},
|
|
1937
|
+
{
|
|
1938
|
+
"name": "as",
|
|
1939
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1940
|
+
"default": "",
|
|
1941
|
+
"description": "The component type to render."
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "asChild",
|
|
1945
|
+
"type": "boolean",
|
|
1946
|
+
"default": "false",
|
|
1947
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "instance",
|
|
1951
|
+
"type": "GalleryRootInstance",
|
|
1952
|
+
"default": "",
|
|
1953
|
+
"description": "The instance to pass to the component."
|
|
1954
|
+
},
|
|
1955
|
+
{
|
|
1956
|
+
"name": "pt",
|
|
1957
|
+
"type": "SafeRecord<GalleryRootPassThrough>",
|
|
1958
|
+
"default": "",
|
|
1959
|
+
"description": "The pass-through props to pass to the component."
|
|
1960
|
+
},
|
|
1961
|
+
{
|
|
1962
|
+
"name": "ptOptions",
|
|
1963
|
+
"type": "PassThroughOptions",
|
|
1964
|
+
"default": "",
|
|
1965
|
+
"description": "The pass-through options to pass to the component."
|
|
1966
|
+
},
|
|
1967
|
+
{
|
|
1968
|
+
"name": "unstyled",
|
|
1969
|
+
"type": "boolean",
|
|
1970
|
+
"default": "",
|
|
1971
|
+
"description": "Whether the component should be rendered without classes."
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"name": "dt",
|
|
1975
|
+
"type": "unknown",
|
|
1976
|
+
"default": "",
|
|
1977
|
+
"description": "The design token to use for the component."
|
|
1978
|
+
},
|
|
1979
|
+
{
|
|
1980
|
+
"name": "styles",
|
|
1981
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1982
|
+
"default": "",
|
|
1983
|
+
"description": "The styles to use for the component."
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
"name": "render",
|
|
1987
|
+
"type": "(instance: GalleryRootInstance) => ReactNode",
|
|
1988
|
+
"default": "",
|
|
1989
|
+
"description": "The render function to render the component with instance access."
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"name": "children",
|
|
1993
|
+
"type": "any",
|
|
1994
|
+
"default": "",
|
|
1995
|
+
"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."
|
|
1996
|
+
},
|
|
1997
|
+
{
|
|
1998
|
+
"name": "activeIndex",
|
|
1999
|
+
"type": "number",
|
|
2000
|
+
"default": "",
|
|
2001
|
+
"description": "The index of the active item (controlled). Use together with `onActiveIndexChange` .\nWhen provided, the gallery is controlled and its active item is driven by this value."
|
|
2002
|
+
},
|
|
2003
|
+
{
|
|
2004
|
+
"name": "defaultActiveIndex",
|
|
2005
|
+
"type": "number",
|
|
2006
|
+
"default": "0",
|
|
2007
|
+
"description": "The initial index of the active item for uncontrolled usage."
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
"name": "fullscreen",
|
|
2011
|
+
"type": "boolean",
|
|
2012
|
+
"default": "false",
|
|
2013
|
+
"description": "Whether the gallery is rendered fullscreen via a portal. When `true` , the gallery escapes its parent layout\nand covers the viewport — useful for opening a single image in a modal-style viewer."
|
|
2014
|
+
},
|
|
2015
|
+
{
|
|
2016
|
+
"name": "closeOnEscape",
|
|
2017
|
+
"type": "boolean",
|
|
2018
|
+
"default": "true",
|
|
2019
|
+
"description": "Whether pressing Escape closes the gallery when in fullscreen mode."
|
|
2020
|
+
},
|
|
2021
|
+
{
|
|
2022
|
+
"name": "onFullscreenChange",
|
|
2023
|
+
"type": "(value: boolean) => void",
|
|
2024
|
+
"default": "",
|
|
2025
|
+
"description": "Callback fired when the gallery's fullscreen state changes (via close button, escape key, etc.)."
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
"name": "onZoomChange",
|
|
2029
|
+
"type": "(scale: number) => void",
|
|
2030
|
+
"default": "",
|
|
2031
|
+
"description": "Callback fired when the active item's zoom scale changes."
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"name": "onRotateChange",
|
|
2035
|
+
"type": "(rotation: number) => void",
|
|
2036
|
+
"default": "",
|
|
2037
|
+
"description": "Callback fired when the active item's rotation changes."
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
"name": "onFlipChange",
|
|
2041
|
+
"type": "(flip: { x: number; y: number }) => void",
|
|
2042
|
+
"default": "",
|
|
2043
|
+
"description": "Callback fired when the active item's flip state changes."
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"name": "onActiveIndexChange",
|
|
2047
|
+
"type": "(event: UseGalleryChangeEvent) => void",
|
|
2048
|
+
"default": "",
|
|
2049
|
+
"description": "Callback fired when the gallery's active index changes."
|
|
2050
|
+
},
|
|
2051
|
+
{
|
|
2052
|
+
"name": "[key: string]",
|
|
2053
|
+
"type": "any",
|
|
2054
|
+
"description": ""
|
|
2055
|
+
},
|
|
2056
|
+
{
|
|
2057
|
+
"name": "pt-{optionName}-*",
|
|
2058
|
+
"type": "-",
|
|
2059
|
+
"default": "",
|
|
2060
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2061
|
+
"deprecated": false
|
|
2062
|
+
}
|
|
2063
|
+
],
|
|
2064
|
+
"methods": []
|
|
2065
|
+
},
|
|
2066
|
+
"GalleryRootState": {
|
|
2067
|
+
"description": "Defines valid state in Gallery component.",
|
|
2068
|
+
"relatedProp": "",
|
|
2069
|
+
"extendedTypes": "UseGalleryState",
|
|
2070
|
+
"props": [
|
|
2071
|
+
{
|
|
2072
|
+
"name": "isFullscreen",
|
|
2073
|
+
"type": "boolean",
|
|
2074
|
+
"default": "",
|
|
2075
|
+
"description": "Whether the gallery is in fullscreen mode."
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "activeIndex",
|
|
2079
|
+
"type": "number",
|
|
2080
|
+
"default": "",
|
|
2081
|
+
"description": "The index of the active item."
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"name": "zoomed",
|
|
2085
|
+
"type": "boolean",
|
|
2086
|
+
"default": "",
|
|
2087
|
+
"description": "Whether the active item is zoomed in."
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"name": "rotated",
|
|
2091
|
+
"type": "boolean",
|
|
2092
|
+
"default": "",
|
|
2093
|
+
"description": "Whether the active item is rotated."
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "flipped",
|
|
2097
|
+
"type": "boolean",
|
|
2098
|
+
"default": "",
|
|
2099
|
+
"description": "Whether the active item is flipped."
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
"name": "pendingAction",
|
|
2103
|
+
"type": "GalleryPendingAction",
|
|
2104
|
+
"default": "",
|
|
2105
|
+
"description": "The pending action for the active item to consume."
|
|
2106
|
+
}
|
|
2107
|
+
],
|
|
2108
|
+
"methods": []
|
|
2109
|
+
},
|
|
2110
|
+
"GalleryRootExposes": {
|
|
2111
|
+
"description": "Defines the methods and properties exposed by Gallery component.",
|
|
2112
|
+
"relatedProp": "",
|
|
2113
|
+
"extendedTypes": "UseGalleryExposes",
|
|
2114
|
+
"props": [
|
|
2115
|
+
{
|
|
2116
|
+
"name": "state",
|
|
2117
|
+
"type": "UseGalleryState",
|
|
2118
|
+
"default": "",
|
|
2119
|
+
"description": "The state of the useGallery."
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
"name": "actions",
|
|
2123
|
+
"type": "useGalleryActions",
|
|
2124
|
+
"default": "",
|
|
2125
|
+
"description": "The available actions for the gallery."
|
|
2126
|
+
},
|
|
2127
|
+
{
|
|
2128
|
+
"name": "contentRef",
|
|
2129
|
+
"type": "RefObject<HTMLElement>",
|
|
2130
|
+
"default": "",
|
|
2131
|
+
"description": "Ref to the content element."
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"name": "thumbnailRef",
|
|
2135
|
+
"type": "RefObject<CarouselRootInstance>",
|
|
2136
|
+
"default": "",
|
|
2137
|
+
"description": "Ref to the thumbnail carousel element."
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"name": "prevRef",
|
|
2141
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
2142
|
+
"default": "",
|
|
2143
|
+
"description": "Ref to the previous button element."
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
"name": "nextRef",
|
|
2147
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
2148
|
+
"default": "",
|
|
2149
|
+
"description": "Ref to the next button element."
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
"name": "registerItem",
|
|
2153
|
+
"type": "(index: number) => { index: number; unregister: () => void }",
|
|
2154
|
+
"default": "",
|
|
2155
|
+
"description": "Registers an item and returns its assigned index plus an `unregister` callback to call on item unmount.\nPass null for first registration, or the existing index to re-register."
|
|
2156
|
+
},
|
|
2157
|
+
{
|
|
2158
|
+
"name": "handleNext",
|
|
2159
|
+
"type": "(originalEvent?: SyntheticEvent) => void",
|
|
2160
|
+
"default": "",
|
|
2161
|
+
"description": "Navigates to the next item."
|
|
2162
|
+
},
|
|
2163
|
+
{
|
|
2164
|
+
"name": "handlePrev",
|
|
2165
|
+
"type": "(originalEvent?: SyntheticEvent) => void",
|
|
2166
|
+
"default": "",
|
|
2167
|
+
"description": "Navigates to the previous item."
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"name": "selectItem",
|
|
2171
|
+
"type": "(index: number, originalEvent?: SyntheticEvent) => void",
|
|
2172
|
+
"default": "",
|
|
2173
|
+
"description": "Selects a specific item by index."
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
"name": "clearPendingAction",
|
|
2177
|
+
"type": "() => void",
|
|
2178
|
+
"default": "",
|
|
2179
|
+
"description": "Clears the pending action after it has been consumed by the active item."
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"name": "toggleFullScreen",
|
|
2183
|
+
"type": "() => void",
|
|
2184
|
+
"default": "",
|
|
2185
|
+
"description": "Toggles the fullscreen state."
|
|
2186
|
+
},
|
|
2187
|
+
{
|
|
2188
|
+
"name": "handleClickAction",
|
|
2189
|
+
"type": "(action?: string) => void",
|
|
2190
|
+
"default": "",
|
|
2191
|
+
"description": "Handles a click action dispatched from toolbar or action buttons."
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"name": "reportItemState",
|
|
2195
|
+
"type": "(itemState: { zoomed: boolean; rotated: boolean; flipped: boolean; scale: number; rotation: number; flip: { x: number; y: number } }) => void",
|
|
2196
|
+
"default": "",
|
|
2197
|
+
"description": "Reports the active item's transform state to the gallery."
|
|
2198
|
+
},
|
|
2199
|
+
{
|
|
2200
|
+
"name": "rootProps",
|
|
2201
|
+
"type": "UseGalleryRootProps",
|
|
2202
|
+
"default": "",
|
|
2203
|
+
"description": "Pre-built props for the root element."
|
|
2204
|
+
},
|
|
2205
|
+
{
|
|
2206
|
+
"name": "nextProps",
|
|
2207
|
+
"type": "UseGalleryNextProps",
|
|
2208
|
+
"default": "",
|
|
2209
|
+
"description": "Pre-built props for the next button element."
|
|
2210
|
+
},
|
|
2211
|
+
{
|
|
2212
|
+
"name": "prevProps",
|
|
2213
|
+
"type": "UseGalleryPrevProps",
|
|
2214
|
+
"default": "",
|
|
2215
|
+
"description": "Pre-built props for the previous button element."
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
"name": "thumbnailProps",
|
|
2219
|
+
"type": "UseGalleryThumbnailProps",
|
|
2220
|
+
"default": "",
|
|
2221
|
+
"description": "Pre-built props for the thumbnail carousel element."
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
"name": "thumbnailContentProps",
|
|
2225
|
+
"type": "UseGalleryThumbnailContentProps",
|
|
2226
|
+
"default": "",
|
|
2227
|
+
"description": "Pre-built props for the thumbnail content element."
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
"name": "thumbnailItemProps",
|
|
2231
|
+
"type": "(index: number) => UseGalleryThumbnailItemProps",
|
|
2232
|
+
"default": "",
|
|
2233
|
+
"description": "Returns pre-built props for a thumbnail item element."
|
|
2234
|
+
},
|
|
2235
|
+
{
|
|
2236
|
+
"name": "toolbarProps",
|
|
2237
|
+
"type": "UseGalleryToolbarProps",
|
|
2238
|
+
"default": "",
|
|
2239
|
+
"description": "Pre-built props for the toolbar element."
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "toolbarItemProps",
|
|
2243
|
+
"type": "(action: string) => UseGalleryToolbarItemProps",
|
|
2244
|
+
"default": "",
|
|
2245
|
+
"description": "Returns pre-built props for a toolbar item element."
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"name": "headerProps",
|
|
2249
|
+
"type": "UseGalleryHeaderProps",
|
|
2250
|
+
"default": "",
|
|
2251
|
+
"description": "Pre-built props for the header element."
|
|
2252
|
+
},
|
|
2253
|
+
{
|
|
2254
|
+
"name": "footerProps",
|
|
2255
|
+
"type": "UseGalleryFooterProps",
|
|
2256
|
+
"default": "",
|
|
2257
|
+
"description": "Pre-built props for the footer element."
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"name": "backdropProps",
|
|
2261
|
+
"type": "UseGalleryBackdropProps",
|
|
2262
|
+
"default": "",
|
|
2263
|
+
"description": "Pre-built props for the backdrop element."
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"name": "contentProps",
|
|
2267
|
+
"type": "UseGalleryContentProps",
|
|
2268
|
+
"default": "",
|
|
2269
|
+
"description": "Pre-built props for the content element."
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
"name": "downloadProps",
|
|
2273
|
+
"type": "UseGalleryActionProps",
|
|
2274
|
+
"default": "",
|
|
2275
|
+
"description": "Pre-built props for the download action button."
|
|
2276
|
+
},
|
|
2277
|
+
{
|
|
2278
|
+
"name": "flipXProps",
|
|
2279
|
+
"type": "UseGalleryActionProps",
|
|
2280
|
+
"default": "",
|
|
2281
|
+
"description": "Pre-built props for the flip-x action button."
|
|
2282
|
+
},
|
|
2283
|
+
{
|
|
2284
|
+
"name": "flipYProps",
|
|
2285
|
+
"type": "UseGalleryActionProps",
|
|
2286
|
+
"default": "",
|
|
2287
|
+
"description": "Pre-built props for the flip-y action button."
|
|
2288
|
+
},
|
|
2289
|
+
{
|
|
2290
|
+
"name": "rotateLeftProps",
|
|
2291
|
+
"type": "UseGalleryActionProps",
|
|
2292
|
+
"default": "",
|
|
2293
|
+
"description": "Pre-built props for the rotate-left action button."
|
|
2294
|
+
},
|
|
2295
|
+
{
|
|
2296
|
+
"name": "rotateRightProps",
|
|
2297
|
+
"type": "UseGalleryActionProps",
|
|
2298
|
+
"default": "",
|
|
2299
|
+
"description": "Pre-built props for the rotate-right action button."
|
|
2300
|
+
},
|
|
2301
|
+
{
|
|
2302
|
+
"name": "fullScreenProps",
|
|
2303
|
+
"type": "UseGalleryFullScreenProps",
|
|
2304
|
+
"default": "",
|
|
2305
|
+
"description": "Pre-built props for the fullscreen toggle button."
|
|
2306
|
+
},
|
|
2307
|
+
{
|
|
2308
|
+
"name": "zoomInProps",
|
|
2309
|
+
"type": "UseGalleryZoomInProps",
|
|
2310
|
+
"default": "",
|
|
2311
|
+
"description": "Pre-built props for the zoom-in action button."
|
|
2312
|
+
},
|
|
2313
|
+
{
|
|
2314
|
+
"name": "zoomOutProps",
|
|
2315
|
+
"type": "UseGalleryZoomOutProps",
|
|
2316
|
+
"default": "",
|
|
2317
|
+
"description": "Pre-built props for the zoom-out action button."
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
"name": "zoomToggleProps",
|
|
2321
|
+
"type": "UseGalleryActionProps",
|
|
2322
|
+
"default": "",
|
|
2323
|
+
"description": "Pre-built props for the zoom-toggle action button."
|
|
2324
|
+
},
|
|
2325
|
+
{
|
|
2326
|
+
"name": "getItemProps",
|
|
2327
|
+
"type": "(index: number) => UseGalleryGetItemProps",
|
|
2328
|
+
"default": "",
|
|
2329
|
+
"description": "Returns pre-built props for an item element at the given index."
|
|
2330
|
+
}
|
|
2331
|
+
],
|
|
2332
|
+
"methods": []
|
|
2333
|
+
},
|
|
2334
|
+
"GalleryRootChangeEvent": {
|
|
2335
|
+
"description": "Event fired when the gallery's active index changes.",
|
|
2336
|
+
"relatedProp": "",
|
|
2337
|
+
"extendedTypes": "UseGalleryChangeEvent",
|
|
2338
|
+
"props": [
|
|
2339
|
+
{
|
|
2340
|
+
"name": "originalEvent",
|
|
2341
|
+
"type": "SyntheticEvent",
|
|
2342
|
+
"default": "",
|
|
2343
|
+
"description": "The original event that triggered the change. Absent when the change is\ntriggered programmatically (e.g. via the `next()` / `prev()` API)."
|
|
2344
|
+
},
|
|
2345
|
+
{
|
|
2346
|
+
"name": "value",
|
|
2347
|
+
"type": "number",
|
|
2348
|
+
"default": "",
|
|
2349
|
+
"description": "The value of the gallery."
|
|
2350
|
+
}
|
|
2351
|
+
],
|
|
2352
|
+
"methods": []
|
|
2353
|
+
}
|
|
2354
|
+
},
|
|
2355
|
+
"types": {
|
|
2356
|
+
"GalleryRootPassThroughType": {
|
|
2357
|
+
"description": "Defines passthrough(pt) options type in Gallery component.",
|
|
2358
|
+
"values": "PassThroughType<GalleryRootInstance, E>"
|
|
2359
|
+
},
|
|
2360
|
+
"GalleryRootInstance": {
|
|
2361
|
+
"description": "Instance of Gallery component.",
|
|
2362
|
+
"values": "ComponentInstance<GalleryRootProps, GalleryRootState, GalleryRootExposes>"
|
|
2363
|
+
}
|
|
2364
|
+
},
|
|
2365
|
+
"variables": {}
|
|
2366
|
+
}
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"name": "GalleryRotateLeft",
|
|
2370
|
+
"source": "apps/showcase/assets/apidoc/galleryrotateleft.json",
|
|
2371
|
+
"data": {
|
|
2372
|
+
"description": "GalleryRotateLeft is a component that displays a rotate left action.",
|
|
2373
|
+
"interfaces": {
|
|
2374
|
+
"GalleryRotateLeftPassThrough": {
|
|
2375
|
+
"description": "Defines passthrough(pt) options of GalleryRotateLeft component.",
|
|
2376
|
+
"relatedProp": "",
|
|
2377
|
+
"props": [
|
|
2378
|
+
{
|
|
2379
|
+
"name": "root",
|
|
2380
|
+
"type": "GalleryRotateLeftPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
2381
|
+
"default": "",
|
|
2382
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2383
|
+
}
|
|
2384
|
+
],
|
|
2385
|
+
"methods": []
|
|
2386
|
+
},
|
|
2387
|
+
"GalleryRotateLeftProps": {
|
|
2388
|
+
"description": "Defines valid properties in GalleryRotateLeft component.",
|
|
2389
|
+
"relatedProp": "",
|
|
2390
|
+
"extendedTypes": "BaseComponentProps<GalleryRotateLeftInstance, unknown, GalleryRotateLeftPassThrough>",
|
|
2391
|
+
"props": [
|
|
2392
|
+
{
|
|
2393
|
+
"name": "ref",
|
|
2394
|
+
"type": "Ref<unknown>",
|
|
2395
|
+
"default": "",
|
|
2396
|
+
"description": "The reference to the component instance."
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "pIf",
|
|
2400
|
+
"type": "boolean",
|
|
2401
|
+
"default": "true",
|
|
2402
|
+
"description": "Whether the component should be rendered."
|
|
2403
|
+
},
|
|
2404
|
+
{
|
|
2405
|
+
"name": "style",
|
|
2406
|
+
"type": "CSSProperties | ((instance?: GalleryRotateLeftInstance) => CSSProperties)",
|
|
2407
|
+
"default": "",
|
|
2408
|
+
"description": "The style to apply to the component."
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"name": "className",
|
|
2412
|
+
"type": "string | ((instance?: GalleryRotateLeftInstance) => string)",
|
|
2413
|
+
"default": "",
|
|
2414
|
+
"description": "The class name to apply to the component."
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"name": "as",
|
|
2418
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2419
|
+
"default": "",
|
|
2420
|
+
"description": "The component type to render."
|
|
2421
|
+
},
|
|
2422
|
+
{
|
|
2423
|
+
"name": "asChild",
|
|
2424
|
+
"type": "boolean",
|
|
2425
|
+
"default": "false",
|
|
2426
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"name": "instance",
|
|
2430
|
+
"type": "GalleryRotateLeftInstance",
|
|
2431
|
+
"default": "",
|
|
2432
|
+
"description": "The instance to pass to the component."
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
"name": "pt",
|
|
2436
|
+
"type": "SafeRecord<GalleryRotateLeftPassThrough>",
|
|
2437
|
+
"default": "",
|
|
2438
|
+
"description": "The pass-through props to pass to the component."
|
|
2439
|
+
},
|
|
2440
|
+
{
|
|
2441
|
+
"name": "ptOptions",
|
|
2442
|
+
"type": "PassThroughOptions",
|
|
2443
|
+
"default": "",
|
|
2444
|
+
"description": "The pass-through options to pass to the component."
|
|
2445
|
+
},
|
|
2446
|
+
{
|
|
2447
|
+
"name": "unstyled",
|
|
2448
|
+
"type": "boolean",
|
|
2449
|
+
"default": "",
|
|
2450
|
+
"description": "Whether the component should be rendered without classes."
|
|
2451
|
+
},
|
|
2452
|
+
{
|
|
2453
|
+
"name": "dt",
|
|
2454
|
+
"type": "unknown",
|
|
2455
|
+
"default": "",
|
|
2456
|
+
"description": "The design token to use for the component."
|
|
2457
|
+
},
|
|
2458
|
+
{
|
|
2459
|
+
"name": "styles",
|
|
2460
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2461
|
+
"default": "",
|
|
2462
|
+
"description": "The styles to use for the component."
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"name": "render",
|
|
2466
|
+
"type": "(instance: GalleryRotateLeftInstance) => ReactNode",
|
|
2467
|
+
"default": "",
|
|
2468
|
+
"description": "The render function to render the component with instance access."
|
|
2469
|
+
},
|
|
2470
|
+
{
|
|
2471
|
+
"name": "children",
|
|
2472
|
+
"type": "any",
|
|
2473
|
+
"default": "",
|
|
2474
|
+
"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."
|
|
2475
|
+
},
|
|
2476
|
+
{
|
|
2477
|
+
"name": "[key: string]",
|
|
2478
|
+
"type": "any",
|
|
2479
|
+
"description": ""
|
|
2480
|
+
},
|
|
2481
|
+
{
|
|
2482
|
+
"name": "pt-{optionName}-*",
|
|
2483
|
+
"type": "-",
|
|
2484
|
+
"default": "",
|
|
2485
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2486
|
+
"deprecated": false
|
|
2487
|
+
}
|
|
2488
|
+
],
|
|
2489
|
+
"methods": []
|
|
2490
|
+
},
|
|
2491
|
+
"GalleryRotateLeftState": {
|
|
2492
|
+
"description": "Defines valid state in GalleryRotateLeft component.",
|
|
2493
|
+
"relatedProp": "",
|
|
2494
|
+
"props": [],
|
|
2495
|
+
"methods": []
|
|
2496
|
+
},
|
|
2497
|
+
"GalleryRotateLeftExposes": {
|
|
2498
|
+
"description": "Defines the methods and properties exposed by GalleryRotateLeft component.",
|
|
2499
|
+
"relatedProp": "",
|
|
2500
|
+
"props": [
|
|
2501
|
+
{
|
|
2502
|
+
"name": "gallery",
|
|
2503
|
+
"type": "GalleryRootInstance",
|
|
2504
|
+
"default": "",
|
|
2505
|
+
"description": "The Gallery component instance."
|
|
2506
|
+
}
|
|
2507
|
+
],
|
|
2508
|
+
"methods": []
|
|
2509
|
+
}
|
|
2510
|
+
},
|
|
2511
|
+
"types": {
|
|
2512
|
+
"GalleryRotateLeftPassThroughType": {
|
|
2513
|
+
"description": "Defines passthrough(pt) options type in GalleryRotateLeft component.",
|
|
2514
|
+
"values": "PassThroughType<GalleryRotateLeftInstance, E>"
|
|
2515
|
+
},
|
|
2516
|
+
"GalleryRotateLeftInstance": {
|
|
2517
|
+
"description": "Instance of GalleryRotateLeft component.",
|
|
2518
|
+
"values": "ComponentInstance<GalleryRotateLeftProps, GalleryRotateLeftState, GalleryRotateLeftExposes>"
|
|
2519
|
+
}
|
|
2520
|
+
},
|
|
2521
|
+
"variables": {}
|
|
2522
|
+
}
|
|
2523
|
+
},
|
|
2524
|
+
{
|
|
2525
|
+
"name": "GalleryRotateRight",
|
|
2526
|
+
"source": "apps/showcase/assets/apidoc/galleryrotateright.json",
|
|
2527
|
+
"data": {
|
|
2528
|
+
"description": "GalleryRotateRight is a component that displays a rotate right action.",
|
|
2529
|
+
"interfaces": {
|
|
2530
|
+
"GalleryRotateRightPassThrough": {
|
|
2531
|
+
"description": "Defines passthrough(pt) options of GalleryRotateRight component.",
|
|
2532
|
+
"relatedProp": "",
|
|
2533
|
+
"props": [
|
|
2534
|
+
{
|
|
2535
|
+
"name": "root",
|
|
2536
|
+
"type": "GalleryRotateRightPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
2537
|
+
"default": "",
|
|
2538
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2539
|
+
}
|
|
2540
|
+
],
|
|
2541
|
+
"methods": []
|
|
2542
|
+
},
|
|
2543
|
+
"GalleryRotateRightProps": {
|
|
2544
|
+
"description": "Defines valid properties in GalleryRotateRight component.",
|
|
2545
|
+
"relatedProp": "",
|
|
2546
|
+
"extendedTypes": "BaseComponentProps<GalleryRotateRightInstance, unknown, GalleryRotateRightPassThrough>",
|
|
2547
|
+
"props": [
|
|
2548
|
+
{
|
|
2549
|
+
"name": "ref",
|
|
2550
|
+
"type": "Ref<unknown>",
|
|
2551
|
+
"default": "",
|
|
2552
|
+
"description": "The reference to the component instance."
|
|
2553
|
+
},
|
|
2554
|
+
{
|
|
2555
|
+
"name": "pIf",
|
|
2556
|
+
"type": "boolean",
|
|
2557
|
+
"default": "true",
|
|
2558
|
+
"description": "Whether the component should be rendered."
|
|
2559
|
+
},
|
|
2560
|
+
{
|
|
2561
|
+
"name": "style",
|
|
2562
|
+
"type": "CSSProperties | ((instance?: GalleryRotateRightInstance) => CSSProperties)",
|
|
2563
|
+
"default": "",
|
|
2564
|
+
"description": "The style to apply to the component."
|
|
2565
|
+
},
|
|
2566
|
+
{
|
|
2567
|
+
"name": "className",
|
|
2568
|
+
"type": "string | ((instance?: GalleryRotateRightInstance) => string)",
|
|
2569
|
+
"default": "",
|
|
2570
|
+
"description": "The class name to apply to the component."
|
|
2571
|
+
},
|
|
2572
|
+
{
|
|
2573
|
+
"name": "as",
|
|
2574
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2575
|
+
"default": "",
|
|
2576
|
+
"description": "The component type to render."
|
|
2577
|
+
},
|
|
2578
|
+
{
|
|
2579
|
+
"name": "asChild",
|
|
2580
|
+
"type": "boolean",
|
|
2581
|
+
"default": "false",
|
|
2582
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2583
|
+
},
|
|
2584
|
+
{
|
|
2585
|
+
"name": "instance",
|
|
2586
|
+
"type": "GalleryRotateRightInstance",
|
|
2587
|
+
"default": "",
|
|
2588
|
+
"description": "The instance to pass to the component."
|
|
2589
|
+
},
|
|
2590
|
+
{
|
|
2591
|
+
"name": "pt",
|
|
2592
|
+
"type": "SafeRecord<GalleryRotateRightPassThrough>",
|
|
2593
|
+
"default": "",
|
|
2594
|
+
"description": "The pass-through props to pass to the component."
|
|
2595
|
+
},
|
|
2596
|
+
{
|
|
2597
|
+
"name": "ptOptions",
|
|
2598
|
+
"type": "PassThroughOptions",
|
|
2599
|
+
"default": "",
|
|
2600
|
+
"description": "The pass-through options to pass to the component."
|
|
2601
|
+
},
|
|
2602
|
+
{
|
|
2603
|
+
"name": "unstyled",
|
|
2604
|
+
"type": "boolean",
|
|
2605
|
+
"default": "",
|
|
2606
|
+
"description": "Whether the component should be rendered without classes."
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"name": "dt",
|
|
2610
|
+
"type": "unknown",
|
|
2611
|
+
"default": "",
|
|
2612
|
+
"description": "The design token to use for the component."
|
|
2613
|
+
},
|
|
2614
|
+
{
|
|
2615
|
+
"name": "styles",
|
|
2616
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2617
|
+
"default": "",
|
|
2618
|
+
"description": "The styles to use for the component."
|
|
2619
|
+
},
|
|
2620
|
+
{
|
|
2621
|
+
"name": "render",
|
|
2622
|
+
"type": "(instance: GalleryRotateRightInstance) => ReactNode",
|
|
2623
|
+
"default": "",
|
|
2624
|
+
"description": "The render function to render the component with instance access."
|
|
2625
|
+
},
|
|
2626
|
+
{
|
|
2627
|
+
"name": "children",
|
|
2628
|
+
"type": "any",
|
|
2629
|
+
"default": "",
|
|
2630
|
+
"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."
|
|
2631
|
+
},
|
|
2632
|
+
{
|
|
2633
|
+
"name": "[key: string]",
|
|
2634
|
+
"type": "any",
|
|
2635
|
+
"description": ""
|
|
2636
|
+
},
|
|
2637
|
+
{
|
|
2638
|
+
"name": "pt-{optionName}-*",
|
|
2639
|
+
"type": "-",
|
|
2640
|
+
"default": "",
|
|
2641
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2642
|
+
"deprecated": false
|
|
2643
|
+
}
|
|
2644
|
+
],
|
|
2645
|
+
"methods": []
|
|
2646
|
+
},
|
|
2647
|
+
"GalleryRotateRightState": {
|
|
2648
|
+
"description": "Defines valid state in GalleryRotateRight component.",
|
|
2649
|
+
"relatedProp": "",
|
|
2650
|
+
"props": [],
|
|
2651
|
+
"methods": []
|
|
2652
|
+
},
|
|
2653
|
+
"GalleryRotateRightExposes": {
|
|
2654
|
+
"description": "Defines the methods and properties exposed by GalleryRotateRight component.",
|
|
2655
|
+
"relatedProp": "",
|
|
2656
|
+
"props": [
|
|
2657
|
+
{
|
|
2658
|
+
"name": "gallery",
|
|
2659
|
+
"type": "GalleryRootInstance",
|
|
2660
|
+
"default": "",
|
|
2661
|
+
"description": "The Gallery component instance."
|
|
2662
|
+
}
|
|
2663
|
+
],
|
|
2664
|
+
"methods": []
|
|
2665
|
+
}
|
|
2666
|
+
},
|
|
2667
|
+
"types": {
|
|
2668
|
+
"GalleryRotateRightPassThroughType": {
|
|
2669
|
+
"description": "Defines passthrough(pt) options type in GalleryRotateRight component.",
|
|
2670
|
+
"values": "PassThroughType<GalleryRotateRightInstance, E>"
|
|
2671
|
+
},
|
|
2672
|
+
"GalleryRotateRightInstance": {
|
|
2673
|
+
"description": "Instance of GalleryRotateRight component.",
|
|
2674
|
+
"values": "ComponentInstance<GalleryRotateRightProps, GalleryRotateRightState, GalleryRotateRightExposes>"
|
|
2675
|
+
}
|
|
2676
|
+
},
|
|
2677
|
+
"variables": {}
|
|
2678
|
+
}
|
|
2679
|
+
},
|
|
2680
|
+
{
|
|
2681
|
+
"name": "GalleryThumbnail",
|
|
2682
|
+
"source": "apps/showcase/assets/apidoc/gallerythumbnail.json",
|
|
2683
|
+
"data": {
|
|
2684
|
+
"description": "GalleryThumbnail is a component that displays a thumbnail of a gallery.",
|
|
2685
|
+
"interfaces": {
|
|
2686
|
+
"GalleryThumbnailPassThrough": {
|
|
2687
|
+
"description": "Defines passthrough(pt) options of GalleryThumbnail component.",
|
|
2688
|
+
"relatedProp": "",
|
|
2689
|
+
"props": [
|
|
2690
|
+
{
|
|
2691
|
+
"name": "root",
|
|
2692
|
+
"type": "GalleryThumbnailPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2693
|
+
"default": "",
|
|
2694
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2695
|
+
}
|
|
2696
|
+
],
|
|
2697
|
+
"methods": []
|
|
2698
|
+
},
|
|
2699
|
+
"GalleryThumbnailProps": {
|
|
2700
|
+
"description": "Defines valid properties in GalleryThumbnail component.",
|
|
2701
|
+
"relatedProp": "",
|
|
2702
|
+
"extendedTypes": "BaseComponentProps<GalleryThumbnailInstance, unknown, GalleryThumbnailPassThrough>",
|
|
2703
|
+
"props": [
|
|
2704
|
+
{
|
|
2705
|
+
"name": "ref",
|
|
2706
|
+
"type": "Ref<unknown>",
|
|
2707
|
+
"default": "",
|
|
2708
|
+
"description": "The reference to the component instance."
|
|
2709
|
+
},
|
|
2710
|
+
{
|
|
2711
|
+
"name": "pIf",
|
|
2712
|
+
"type": "boolean",
|
|
2713
|
+
"default": "true",
|
|
2714
|
+
"description": "Whether the component should be rendered."
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "style",
|
|
2718
|
+
"type": "CSSProperties | ((instance?: GalleryThumbnailInstance) => CSSProperties)",
|
|
2719
|
+
"default": "",
|
|
2720
|
+
"description": "The style to apply to the component."
|
|
2721
|
+
},
|
|
2722
|
+
{
|
|
2723
|
+
"name": "className",
|
|
2724
|
+
"type": "string | ((instance?: GalleryThumbnailInstance) => string)",
|
|
2725
|
+
"default": "",
|
|
2726
|
+
"description": "The class name to apply to the component."
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "as",
|
|
2730
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2731
|
+
"default": "",
|
|
2732
|
+
"description": "The component type to render."
|
|
2733
|
+
},
|
|
2734
|
+
{
|
|
2735
|
+
"name": "asChild",
|
|
2736
|
+
"type": "boolean",
|
|
2737
|
+
"default": "false",
|
|
2738
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2739
|
+
},
|
|
2740
|
+
{
|
|
2741
|
+
"name": "instance",
|
|
2742
|
+
"type": "GalleryThumbnailInstance",
|
|
2743
|
+
"default": "",
|
|
2744
|
+
"description": "The instance to pass to the component."
|
|
2745
|
+
},
|
|
2746
|
+
{
|
|
2747
|
+
"name": "pt",
|
|
2748
|
+
"type": "SafeRecord<GalleryThumbnailPassThrough>",
|
|
2749
|
+
"default": "",
|
|
2750
|
+
"description": "The pass-through props to pass to the component."
|
|
2751
|
+
},
|
|
2752
|
+
{
|
|
2753
|
+
"name": "ptOptions",
|
|
2754
|
+
"type": "PassThroughOptions",
|
|
2755
|
+
"default": "",
|
|
2756
|
+
"description": "The pass-through options to pass to the component."
|
|
2757
|
+
},
|
|
2758
|
+
{
|
|
2759
|
+
"name": "unstyled",
|
|
2760
|
+
"type": "boolean",
|
|
2761
|
+
"default": "",
|
|
2762
|
+
"description": "Whether the component should be rendered without classes."
|
|
2763
|
+
},
|
|
2764
|
+
{
|
|
2765
|
+
"name": "dt",
|
|
2766
|
+
"type": "unknown",
|
|
2767
|
+
"default": "",
|
|
2768
|
+
"description": "The design token to use for the component."
|
|
2769
|
+
},
|
|
2770
|
+
{
|
|
2771
|
+
"name": "styles",
|
|
2772
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2773
|
+
"default": "",
|
|
2774
|
+
"description": "The styles to use for the component."
|
|
2775
|
+
},
|
|
2776
|
+
{
|
|
2777
|
+
"name": "render",
|
|
2778
|
+
"type": "(instance: GalleryThumbnailInstance) => ReactNode",
|
|
2779
|
+
"default": "",
|
|
2780
|
+
"description": "The render function to render the component with instance access."
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"name": "children",
|
|
2784
|
+
"type": "any",
|
|
2785
|
+
"default": "",
|
|
2786
|
+
"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."
|
|
2787
|
+
},
|
|
2788
|
+
{
|
|
2789
|
+
"name": "[key: string]",
|
|
2790
|
+
"type": "any",
|
|
2791
|
+
"description": ""
|
|
2792
|
+
},
|
|
2793
|
+
{
|
|
2794
|
+
"name": "pt-{optionName}-*",
|
|
2795
|
+
"type": "-",
|
|
2796
|
+
"default": "",
|
|
2797
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2798
|
+
"deprecated": false
|
|
2799
|
+
}
|
|
2800
|
+
],
|
|
2801
|
+
"methods": []
|
|
2802
|
+
},
|
|
2803
|
+
"GalleryThumbnailState": {
|
|
2804
|
+
"description": "Defines valid state in GalleryThumbnail component.",
|
|
2805
|
+
"relatedProp": "",
|
|
2806
|
+
"props": [],
|
|
2807
|
+
"methods": []
|
|
2808
|
+
},
|
|
2809
|
+
"GalleryThumbnailExposes": {
|
|
2810
|
+
"description": "Defines the methods and properties exposed by GalleryThumbnail component.",
|
|
2811
|
+
"relatedProp": "",
|
|
2812
|
+
"props": [
|
|
2813
|
+
{
|
|
2814
|
+
"name": "gallery",
|
|
2815
|
+
"type": "GalleryRootInstance",
|
|
2816
|
+
"default": "",
|
|
2817
|
+
"description": "The Gallery component instance."
|
|
2818
|
+
}
|
|
2819
|
+
],
|
|
2820
|
+
"methods": []
|
|
2821
|
+
}
|
|
2822
|
+
},
|
|
2823
|
+
"types": {
|
|
2824
|
+
"GalleryThumbnailPassThroughType": {
|
|
2825
|
+
"description": "Defines passthrough(pt) options type in GalleryThumbnail component.",
|
|
2826
|
+
"values": "PassThroughType<GalleryThumbnailInstance, E>"
|
|
2827
|
+
},
|
|
2828
|
+
"GalleryThumbnailInstance": {
|
|
2829
|
+
"description": "Instance of GalleryThumbnail component.",
|
|
2830
|
+
"values": "ComponentInstance<GalleryThumbnailProps, GalleryThumbnailState, GalleryThumbnailExposes>"
|
|
2831
|
+
}
|
|
2832
|
+
},
|
|
2833
|
+
"variables": {}
|
|
2834
|
+
}
|
|
2835
|
+
},
|
|
2836
|
+
{
|
|
2837
|
+
"name": "GalleryThumbnailContent",
|
|
2838
|
+
"source": "apps/showcase/assets/apidoc/gallerythumbnailcontent.json",
|
|
2839
|
+
"data": {
|
|
2840
|
+
"description": "GalleryThumbnailContent is a component that displays a content of a thumbnail.",
|
|
2841
|
+
"interfaces": {
|
|
2842
|
+
"GalleryThumbnailContentPassThrough": {
|
|
2843
|
+
"description": "Defines passthrough(pt) options of GalleryThumbnailContent component.",
|
|
2844
|
+
"relatedProp": "",
|
|
2845
|
+
"props": [
|
|
2846
|
+
{
|
|
2847
|
+
"name": "root",
|
|
2848
|
+
"type": "GalleryThumbnailContentPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
2849
|
+
"default": "",
|
|
2850
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
2851
|
+
}
|
|
2852
|
+
],
|
|
2853
|
+
"methods": []
|
|
2854
|
+
},
|
|
2855
|
+
"GalleryThumbnailContentProps": {
|
|
2856
|
+
"description": "Defines valid properties in GalleryThumbnailContent component.",
|
|
2857
|
+
"relatedProp": "",
|
|
2858
|
+
"extendedTypes": "BaseComponentProps<GalleryThumbnailContentInstance, unknown, GalleryThumbnailContentPassThrough>",
|
|
2859
|
+
"props": [
|
|
2860
|
+
{
|
|
2861
|
+
"name": "ref",
|
|
2862
|
+
"type": "Ref<unknown>",
|
|
2863
|
+
"default": "",
|
|
2864
|
+
"description": "The reference to the component instance."
|
|
2865
|
+
},
|
|
2866
|
+
{
|
|
2867
|
+
"name": "pIf",
|
|
2868
|
+
"type": "boolean",
|
|
2869
|
+
"default": "true",
|
|
2870
|
+
"description": "Whether the component should be rendered."
|
|
2871
|
+
},
|
|
2872
|
+
{
|
|
2873
|
+
"name": "style",
|
|
2874
|
+
"type": "CSSProperties | ((instance?: GalleryThumbnailContentInstance) => CSSProperties)",
|
|
2875
|
+
"default": "",
|
|
2876
|
+
"description": "The style to apply to the component."
|
|
2877
|
+
},
|
|
2878
|
+
{
|
|
2879
|
+
"name": "className",
|
|
2880
|
+
"type": "string | ((instance?: GalleryThumbnailContentInstance) => string)",
|
|
2881
|
+
"default": "",
|
|
2882
|
+
"description": "The class name to apply to the component."
|
|
2883
|
+
},
|
|
2884
|
+
{
|
|
2885
|
+
"name": "as",
|
|
2886
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
2887
|
+
"default": "",
|
|
2888
|
+
"description": "The component type to render."
|
|
2889
|
+
},
|
|
2890
|
+
{
|
|
2891
|
+
"name": "asChild",
|
|
2892
|
+
"type": "boolean",
|
|
2893
|
+
"default": "false",
|
|
2894
|
+
"description": "Whether the component should be rendered as a child component."
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"name": "instance",
|
|
2898
|
+
"type": "GalleryThumbnailContentInstance",
|
|
2899
|
+
"default": "",
|
|
2900
|
+
"description": "The instance to pass to the component."
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"name": "pt",
|
|
2904
|
+
"type": "SafeRecord<GalleryThumbnailContentPassThrough>",
|
|
2905
|
+
"default": "",
|
|
2906
|
+
"description": "The pass-through props to pass to the component."
|
|
2907
|
+
},
|
|
2908
|
+
{
|
|
2909
|
+
"name": "ptOptions",
|
|
2910
|
+
"type": "PassThroughOptions",
|
|
2911
|
+
"default": "",
|
|
2912
|
+
"description": "The pass-through options to pass to the component."
|
|
2913
|
+
},
|
|
2914
|
+
{
|
|
2915
|
+
"name": "unstyled",
|
|
2916
|
+
"type": "boolean",
|
|
2917
|
+
"default": "",
|
|
2918
|
+
"description": "Whether the component should be rendered without classes."
|
|
2919
|
+
},
|
|
2920
|
+
{
|
|
2921
|
+
"name": "dt",
|
|
2922
|
+
"type": "unknown",
|
|
2923
|
+
"default": "",
|
|
2924
|
+
"description": "The design token to use for the component."
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
"name": "styles",
|
|
2928
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
2929
|
+
"default": "",
|
|
2930
|
+
"description": "The styles to use for the component."
|
|
2931
|
+
},
|
|
2932
|
+
{
|
|
2933
|
+
"name": "render",
|
|
2934
|
+
"type": "(instance: GalleryThumbnailContentInstance) => ReactNode",
|
|
2935
|
+
"default": "",
|
|
2936
|
+
"description": "The render function to render the component with instance access."
|
|
2937
|
+
},
|
|
2938
|
+
{
|
|
2939
|
+
"name": "children",
|
|
2940
|
+
"type": "any",
|
|
2941
|
+
"default": "",
|
|
2942
|
+
"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."
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
"name": "[key: string]",
|
|
2946
|
+
"type": "any",
|
|
2947
|
+
"description": ""
|
|
2948
|
+
},
|
|
2949
|
+
{
|
|
2950
|
+
"name": "pt-{optionName}-*",
|
|
2951
|
+
"type": "-",
|
|
2952
|
+
"default": "",
|
|
2953
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
2954
|
+
"deprecated": false
|
|
2955
|
+
}
|
|
2956
|
+
],
|
|
2957
|
+
"methods": []
|
|
2958
|
+
},
|
|
2959
|
+
"GalleryThumbnailContentState": {
|
|
2960
|
+
"description": "Defines valid state in GalleryThumbnailContent component.",
|
|
2961
|
+
"relatedProp": "",
|
|
2962
|
+
"props": [],
|
|
2963
|
+
"methods": []
|
|
2964
|
+
},
|
|
2965
|
+
"GalleryThumbnailContentExposes": {
|
|
2966
|
+
"description": "Defines the methods and properties exposed by GalleryThumbnailContent component.",
|
|
2967
|
+
"relatedProp": "",
|
|
2968
|
+
"props": [
|
|
2969
|
+
{
|
|
2970
|
+
"name": "gallery",
|
|
2971
|
+
"type": "GalleryRootInstance",
|
|
2972
|
+
"default": "",
|
|
2973
|
+
"description": "The Gallery component instance."
|
|
2974
|
+
}
|
|
2975
|
+
],
|
|
2976
|
+
"methods": []
|
|
2977
|
+
}
|
|
2978
|
+
},
|
|
2979
|
+
"types": {
|
|
2980
|
+
"GalleryThumbnailContentPassThroughType": {
|
|
2981
|
+
"description": "Defines passthrough(pt) options type in GalleryThumbnailContent component.",
|
|
2982
|
+
"values": "PassThroughType<GalleryThumbnailContentInstance, E>"
|
|
2983
|
+
},
|
|
2984
|
+
"GalleryThumbnailContentInstance": {
|
|
2985
|
+
"description": "Instance of GalleryThumbnailContent component.",
|
|
2986
|
+
"values": "ComponentInstance<GalleryThumbnailContentProps, GalleryThumbnailContentState, GalleryThumbnailContentExposes>"
|
|
2987
|
+
}
|
|
2988
|
+
},
|
|
2989
|
+
"variables": {}
|
|
2990
|
+
}
|
|
2991
|
+
},
|
|
2992
|
+
{
|
|
2993
|
+
"name": "GalleryThumbnailItem",
|
|
2994
|
+
"source": "apps/showcase/assets/apidoc/gallerythumbnailitem.json",
|
|
2995
|
+
"data": {
|
|
2996
|
+
"description": "GalleryThumbnailItem is a component that displays a thumbnail item of a gallery.",
|
|
2997
|
+
"interfaces": {
|
|
2998
|
+
"GalleryThumbnailItemPassThrough": {
|
|
2999
|
+
"description": "Defines passthrough(pt) options of GalleryThumbnailItem component.",
|
|
3000
|
+
"relatedProp": "",
|
|
3001
|
+
"props": [
|
|
3002
|
+
{
|
|
3003
|
+
"name": "root",
|
|
3004
|
+
"type": "GalleryThumbnailItemPassThroughType<HTMLAttributes<HTMLSpanElement>>",
|
|
3005
|
+
"default": "",
|
|
3006
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3007
|
+
}
|
|
3008
|
+
],
|
|
3009
|
+
"methods": []
|
|
3010
|
+
},
|
|
3011
|
+
"GalleryThumbnailItemProps": {
|
|
3012
|
+
"description": "Defines valid properties in GalleryThumbnailItem component.",
|
|
3013
|
+
"relatedProp": "",
|
|
3014
|
+
"extendedTypes": "BaseComponentProps<GalleryThumbnailItemInstance, unknown, GalleryThumbnailItemPassThrough>",
|
|
3015
|
+
"props": [
|
|
3016
|
+
{
|
|
3017
|
+
"name": "ref",
|
|
3018
|
+
"type": "Ref<unknown>",
|
|
3019
|
+
"default": "",
|
|
3020
|
+
"description": "The reference to the component instance."
|
|
3021
|
+
},
|
|
3022
|
+
{
|
|
3023
|
+
"name": "pIf",
|
|
3024
|
+
"type": "boolean",
|
|
3025
|
+
"default": "true",
|
|
3026
|
+
"description": "Whether the component should be rendered."
|
|
3027
|
+
},
|
|
3028
|
+
{
|
|
3029
|
+
"name": "style",
|
|
3030
|
+
"type": "CSSProperties | ((instance?: GalleryThumbnailItemInstance) => CSSProperties)",
|
|
3031
|
+
"default": "",
|
|
3032
|
+
"description": "The style to apply to the component."
|
|
3033
|
+
},
|
|
3034
|
+
{
|
|
3035
|
+
"name": "className",
|
|
3036
|
+
"type": "string | ((instance?: GalleryThumbnailItemInstance) => string)",
|
|
3037
|
+
"default": "",
|
|
3038
|
+
"description": "The class name to apply to the component."
|
|
3039
|
+
},
|
|
3040
|
+
{
|
|
3041
|
+
"name": "as",
|
|
3042
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3043
|
+
"default": "",
|
|
3044
|
+
"description": "The component type to render."
|
|
3045
|
+
},
|
|
3046
|
+
{
|
|
3047
|
+
"name": "asChild",
|
|
3048
|
+
"type": "boolean",
|
|
3049
|
+
"default": "false",
|
|
3050
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3051
|
+
},
|
|
3052
|
+
{
|
|
3053
|
+
"name": "instance",
|
|
3054
|
+
"type": "GalleryThumbnailItemInstance",
|
|
3055
|
+
"default": "",
|
|
3056
|
+
"description": "The instance to pass to the component."
|
|
3057
|
+
},
|
|
3058
|
+
{
|
|
3059
|
+
"name": "pt",
|
|
3060
|
+
"type": "SafeRecord<GalleryThumbnailItemPassThrough>",
|
|
3061
|
+
"default": "",
|
|
3062
|
+
"description": "The pass-through props to pass to the component."
|
|
3063
|
+
},
|
|
3064
|
+
{
|
|
3065
|
+
"name": "ptOptions",
|
|
3066
|
+
"type": "PassThroughOptions",
|
|
3067
|
+
"default": "",
|
|
3068
|
+
"description": "The pass-through options to pass to the component."
|
|
3069
|
+
},
|
|
3070
|
+
{
|
|
3071
|
+
"name": "unstyled",
|
|
3072
|
+
"type": "boolean",
|
|
3073
|
+
"default": "",
|
|
3074
|
+
"description": "Whether the component should be rendered without classes."
|
|
3075
|
+
},
|
|
3076
|
+
{
|
|
3077
|
+
"name": "dt",
|
|
3078
|
+
"type": "unknown",
|
|
3079
|
+
"default": "",
|
|
3080
|
+
"description": "The design token to use for the component."
|
|
3081
|
+
},
|
|
3082
|
+
{
|
|
3083
|
+
"name": "styles",
|
|
3084
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3085
|
+
"default": "",
|
|
3086
|
+
"description": "The styles to use for the component."
|
|
3087
|
+
},
|
|
3088
|
+
{
|
|
3089
|
+
"name": "render",
|
|
3090
|
+
"type": "(instance: GalleryThumbnailItemInstance) => ReactNode",
|
|
3091
|
+
"default": "",
|
|
3092
|
+
"description": "The render function to render the component with instance access."
|
|
3093
|
+
},
|
|
3094
|
+
{
|
|
3095
|
+
"name": "children",
|
|
3096
|
+
"type": "any",
|
|
3097
|
+
"default": "",
|
|
3098
|
+
"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."
|
|
3099
|
+
},
|
|
3100
|
+
{
|
|
3101
|
+
"name": "index",
|
|
3102
|
+
"type": "number",
|
|
3103
|
+
"default": "",
|
|
3104
|
+
"description": "The index of the thumbnail item. Used to select the active item on click."
|
|
3105
|
+
},
|
|
3106
|
+
{
|
|
3107
|
+
"name": "[key: string]",
|
|
3108
|
+
"type": "any",
|
|
3109
|
+
"description": ""
|
|
3110
|
+
},
|
|
3111
|
+
{
|
|
3112
|
+
"name": "pt-{optionName}-*",
|
|
3113
|
+
"type": "-",
|
|
3114
|
+
"default": "",
|
|
3115
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3116
|
+
"deprecated": false
|
|
3117
|
+
}
|
|
3118
|
+
],
|
|
3119
|
+
"methods": []
|
|
3120
|
+
},
|
|
3121
|
+
"GalleryThumbnailItemState": {
|
|
3122
|
+
"description": "Defines valid state in GalleryThumbnailItem component.",
|
|
3123
|
+
"relatedProp": "",
|
|
3124
|
+
"props": [],
|
|
3125
|
+
"methods": []
|
|
3126
|
+
},
|
|
3127
|
+
"GalleryThumbnailItemExposes": {
|
|
3128
|
+
"description": "Defines the methods and properties exposed by GalleryThumbnailItem component.",
|
|
3129
|
+
"relatedProp": "",
|
|
3130
|
+
"props": [
|
|
3131
|
+
{
|
|
3132
|
+
"name": "gallery",
|
|
3133
|
+
"type": "GalleryRootInstance",
|
|
3134
|
+
"default": "",
|
|
3135
|
+
"description": "The Gallery component instance."
|
|
3136
|
+
}
|
|
3137
|
+
],
|
|
3138
|
+
"methods": []
|
|
3139
|
+
}
|
|
3140
|
+
},
|
|
3141
|
+
"types": {
|
|
3142
|
+
"GalleryThumbnailItemPassThroughType": {
|
|
3143
|
+
"description": "Defines passthrough(pt) options type in GalleryThumbnailItem component.",
|
|
3144
|
+
"values": "PassThroughType<GalleryThumbnailItemInstance, E>"
|
|
3145
|
+
},
|
|
3146
|
+
"GalleryThumbnailItemInstance": {
|
|
3147
|
+
"description": "Instance of GalleryThumbnailItem component.",
|
|
3148
|
+
"values": "ComponentInstance<GalleryThumbnailItemProps, GalleryThumbnailItemState, GalleryThumbnailItemExposes>"
|
|
3149
|
+
}
|
|
3150
|
+
},
|
|
3151
|
+
"variables": {}
|
|
3152
|
+
}
|
|
3153
|
+
},
|
|
3154
|
+
{
|
|
3155
|
+
"name": "GalleryZoomIn",
|
|
3156
|
+
"source": "apps/showcase/assets/apidoc/galleryzoomin.json",
|
|
3157
|
+
"data": {
|
|
3158
|
+
"description": "GalleryZoomIn is a component that displays a zoom in action.",
|
|
3159
|
+
"interfaces": {
|
|
3160
|
+
"GalleryZoomInPassThrough": {
|
|
3161
|
+
"description": "Defines passthrough(pt) options of GalleryZoomIn component.",
|
|
3162
|
+
"relatedProp": "",
|
|
3163
|
+
"props": [
|
|
3164
|
+
{
|
|
3165
|
+
"name": "root",
|
|
3166
|
+
"type": "GalleryZoomInPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
3167
|
+
"default": "",
|
|
3168
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3169
|
+
}
|
|
3170
|
+
],
|
|
3171
|
+
"methods": []
|
|
3172
|
+
},
|
|
3173
|
+
"GalleryZoomInProps": {
|
|
3174
|
+
"description": "Defines valid properties in GalleryZoomIn component.",
|
|
3175
|
+
"relatedProp": "",
|
|
3176
|
+
"extendedTypes": "BaseComponentProps<GalleryZoomInInstance, unknown, GalleryZoomInPassThrough>",
|
|
3177
|
+
"props": [
|
|
3178
|
+
{
|
|
3179
|
+
"name": "ref",
|
|
3180
|
+
"type": "Ref<unknown>",
|
|
3181
|
+
"default": "",
|
|
3182
|
+
"description": "The reference to the component instance."
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
"name": "pIf",
|
|
3186
|
+
"type": "boolean",
|
|
3187
|
+
"default": "true",
|
|
3188
|
+
"description": "Whether the component should be rendered."
|
|
3189
|
+
},
|
|
3190
|
+
{
|
|
3191
|
+
"name": "style",
|
|
3192
|
+
"type": "CSSProperties | ((instance?: GalleryZoomInInstance) => CSSProperties)",
|
|
3193
|
+
"default": "",
|
|
3194
|
+
"description": "The style to apply to the component."
|
|
3195
|
+
},
|
|
3196
|
+
{
|
|
3197
|
+
"name": "className",
|
|
3198
|
+
"type": "string | ((instance?: GalleryZoomInInstance) => string)",
|
|
3199
|
+
"default": "",
|
|
3200
|
+
"description": "The class name to apply to the component."
|
|
3201
|
+
},
|
|
3202
|
+
{
|
|
3203
|
+
"name": "as",
|
|
3204
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3205
|
+
"default": "",
|
|
3206
|
+
"description": "The component type to render."
|
|
3207
|
+
},
|
|
3208
|
+
{
|
|
3209
|
+
"name": "asChild",
|
|
3210
|
+
"type": "boolean",
|
|
3211
|
+
"default": "false",
|
|
3212
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3213
|
+
},
|
|
3214
|
+
{
|
|
3215
|
+
"name": "instance",
|
|
3216
|
+
"type": "GalleryZoomInInstance",
|
|
3217
|
+
"default": "",
|
|
3218
|
+
"description": "The instance to pass to the component."
|
|
3219
|
+
},
|
|
3220
|
+
{
|
|
3221
|
+
"name": "pt",
|
|
3222
|
+
"type": "SafeRecord<GalleryZoomInPassThrough>",
|
|
3223
|
+
"default": "",
|
|
3224
|
+
"description": "The pass-through props to pass to the component."
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
"name": "ptOptions",
|
|
3228
|
+
"type": "PassThroughOptions",
|
|
3229
|
+
"default": "",
|
|
3230
|
+
"description": "The pass-through options to pass to the component."
|
|
3231
|
+
},
|
|
3232
|
+
{
|
|
3233
|
+
"name": "unstyled",
|
|
3234
|
+
"type": "boolean",
|
|
3235
|
+
"default": "",
|
|
3236
|
+
"description": "Whether the component should be rendered without classes."
|
|
3237
|
+
},
|
|
3238
|
+
{
|
|
3239
|
+
"name": "dt",
|
|
3240
|
+
"type": "unknown",
|
|
3241
|
+
"default": "",
|
|
3242
|
+
"description": "The design token to use for the component."
|
|
3243
|
+
},
|
|
3244
|
+
{
|
|
3245
|
+
"name": "styles",
|
|
3246
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3247
|
+
"default": "",
|
|
3248
|
+
"description": "The styles to use for the component."
|
|
3249
|
+
},
|
|
3250
|
+
{
|
|
3251
|
+
"name": "render",
|
|
3252
|
+
"type": "(instance: GalleryZoomInInstance) => ReactNode",
|
|
3253
|
+
"default": "",
|
|
3254
|
+
"description": "The render function to render the component with instance access."
|
|
3255
|
+
},
|
|
3256
|
+
{
|
|
3257
|
+
"name": "children",
|
|
3258
|
+
"type": "any",
|
|
3259
|
+
"default": "",
|
|
3260
|
+
"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."
|
|
3261
|
+
},
|
|
3262
|
+
{
|
|
3263
|
+
"name": "[key: string]",
|
|
3264
|
+
"type": "any",
|
|
3265
|
+
"description": ""
|
|
3266
|
+
},
|
|
3267
|
+
{
|
|
3268
|
+
"name": "pt-{optionName}-*",
|
|
3269
|
+
"type": "-",
|
|
3270
|
+
"default": "",
|
|
3271
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3272
|
+
"deprecated": false
|
|
3273
|
+
}
|
|
3274
|
+
],
|
|
3275
|
+
"methods": []
|
|
3276
|
+
},
|
|
3277
|
+
"GalleryZoomInState": {
|
|
3278
|
+
"description": "Defines valid state in GalleryZoomIn component.",
|
|
3279
|
+
"relatedProp": "",
|
|
3280
|
+
"props": [],
|
|
3281
|
+
"methods": []
|
|
3282
|
+
},
|
|
3283
|
+
"GalleryZoomInExposes": {
|
|
3284
|
+
"description": "Defines the methods and properties exposed by GalleryZoomIn component.",
|
|
3285
|
+
"relatedProp": "",
|
|
3286
|
+
"props": [
|
|
3287
|
+
{
|
|
3288
|
+
"name": "gallery",
|
|
3289
|
+
"type": "GalleryRootInstance",
|
|
3290
|
+
"default": "",
|
|
3291
|
+
"description": "The Gallery component instance."
|
|
3292
|
+
}
|
|
3293
|
+
],
|
|
3294
|
+
"methods": []
|
|
3295
|
+
}
|
|
3296
|
+
},
|
|
3297
|
+
"types": {
|
|
3298
|
+
"GalleryZoomInPassThroughType": {
|
|
3299
|
+
"description": "Defines passthrough(pt) options type in GalleryZoomIn component.",
|
|
3300
|
+
"values": "PassThroughType<GalleryZoomInInstance, E>"
|
|
3301
|
+
},
|
|
3302
|
+
"GalleryZoomInInstance": {
|
|
3303
|
+
"description": "Instance of GalleryZoomIn component.",
|
|
3304
|
+
"values": "ComponentInstance<GalleryZoomInProps, GalleryZoomInState, GalleryZoomInExposes>"
|
|
3305
|
+
}
|
|
3306
|
+
},
|
|
3307
|
+
"variables": {}
|
|
3308
|
+
}
|
|
3309
|
+
},
|
|
3310
|
+
{
|
|
3311
|
+
"name": "GalleryZoomOut",
|
|
3312
|
+
"source": "apps/showcase/assets/apidoc/galleryzoomout.json",
|
|
3313
|
+
"data": {
|
|
3314
|
+
"description": "GalleryZoomOut is a component that displays a zoom out action.",
|
|
3315
|
+
"interfaces": {
|
|
3316
|
+
"GalleryZoomOutPassThrough": {
|
|
3317
|
+
"description": "Defines passthrough(pt) options of GalleryZoomOut component.",
|
|
3318
|
+
"relatedProp": "",
|
|
3319
|
+
"props": [
|
|
3320
|
+
{
|
|
3321
|
+
"name": "root",
|
|
3322
|
+
"type": "GalleryZoomOutPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
3323
|
+
"default": "",
|
|
3324
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3325
|
+
}
|
|
3326
|
+
],
|
|
3327
|
+
"methods": []
|
|
3328
|
+
},
|
|
3329
|
+
"GalleryZoomOutProps": {
|
|
3330
|
+
"description": "Defines valid properties in GalleryZoomOut component.",
|
|
3331
|
+
"relatedProp": "",
|
|
3332
|
+
"extendedTypes": "BaseComponentProps<GalleryZoomOutInstance, unknown, GalleryZoomOutPassThrough>",
|
|
3333
|
+
"props": [
|
|
3334
|
+
{
|
|
3335
|
+
"name": "ref",
|
|
3336
|
+
"type": "Ref<unknown>",
|
|
3337
|
+
"default": "",
|
|
3338
|
+
"description": "The reference to the component instance."
|
|
3339
|
+
},
|
|
3340
|
+
{
|
|
3341
|
+
"name": "pIf",
|
|
3342
|
+
"type": "boolean",
|
|
3343
|
+
"default": "true",
|
|
3344
|
+
"description": "Whether the component should be rendered."
|
|
3345
|
+
},
|
|
3346
|
+
{
|
|
3347
|
+
"name": "style",
|
|
3348
|
+
"type": "CSSProperties | ((instance?: GalleryZoomOutInstance) => CSSProperties)",
|
|
3349
|
+
"default": "",
|
|
3350
|
+
"description": "The style to apply to the component."
|
|
3351
|
+
},
|
|
3352
|
+
{
|
|
3353
|
+
"name": "className",
|
|
3354
|
+
"type": "string | ((instance?: GalleryZoomOutInstance) => string)",
|
|
3355
|
+
"default": "",
|
|
3356
|
+
"description": "The class name to apply to the component."
|
|
3357
|
+
},
|
|
3358
|
+
{
|
|
3359
|
+
"name": "as",
|
|
3360
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3361
|
+
"default": "",
|
|
3362
|
+
"description": "The component type to render."
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
"name": "asChild",
|
|
3366
|
+
"type": "boolean",
|
|
3367
|
+
"default": "false",
|
|
3368
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3369
|
+
},
|
|
3370
|
+
{
|
|
3371
|
+
"name": "instance",
|
|
3372
|
+
"type": "GalleryZoomOutInstance",
|
|
3373
|
+
"default": "",
|
|
3374
|
+
"description": "The instance to pass to the component."
|
|
3375
|
+
},
|
|
3376
|
+
{
|
|
3377
|
+
"name": "pt",
|
|
3378
|
+
"type": "SafeRecord<GalleryZoomOutPassThrough>",
|
|
3379
|
+
"default": "",
|
|
3380
|
+
"description": "The pass-through props to pass to the component."
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "ptOptions",
|
|
3384
|
+
"type": "PassThroughOptions",
|
|
3385
|
+
"default": "",
|
|
3386
|
+
"description": "The pass-through options to pass to the component."
|
|
3387
|
+
},
|
|
3388
|
+
{
|
|
3389
|
+
"name": "unstyled",
|
|
3390
|
+
"type": "boolean",
|
|
3391
|
+
"default": "",
|
|
3392
|
+
"description": "Whether the component should be rendered without classes."
|
|
3393
|
+
},
|
|
3394
|
+
{
|
|
3395
|
+
"name": "dt",
|
|
3396
|
+
"type": "unknown",
|
|
3397
|
+
"default": "",
|
|
3398
|
+
"description": "The design token to use for the component."
|
|
3399
|
+
},
|
|
3400
|
+
{
|
|
3401
|
+
"name": "styles",
|
|
3402
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3403
|
+
"default": "",
|
|
3404
|
+
"description": "The styles to use for the component."
|
|
3405
|
+
},
|
|
3406
|
+
{
|
|
3407
|
+
"name": "render",
|
|
3408
|
+
"type": "(instance: GalleryZoomOutInstance) => ReactNode",
|
|
3409
|
+
"default": "",
|
|
3410
|
+
"description": "The render function to render the component with instance access."
|
|
3411
|
+
},
|
|
3412
|
+
{
|
|
3413
|
+
"name": "children",
|
|
3414
|
+
"type": "any",
|
|
3415
|
+
"default": "",
|
|
3416
|
+
"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."
|
|
3417
|
+
},
|
|
3418
|
+
{
|
|
3419
|
+
"name": "[key: string]",
|
|
3420
|
+
"type": "any",
|
|
3421
|
+
"description": ""
|
|
3422
|
+
},
|
|
3423
|
+
{
|
|
3424
|
+
"name": "pt-{optionName}-*",
|
|
3425
|
+
"type": "-",
|
|
3426
|
+
"default": "",
|
|
3427
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3428
|
+
"deprecated": false
|
|
3429
|
+
}
|
|
3430
|
+
],
|
|
3431
|
+
"methods": []
|
|
3432
|
+
},
|
|
3433
|
+
"GalleryZoomOutState": {
|
|
3434
|
+
"description": "Defines valid state in GalleryZoomOut component.",
|
|
3435
|
+
"relatedProp": "",
|
|
3436
|
+
"props": [],
|
|
3437
|
+
"methods": []
|
|
3438
|
+
},
|
|
3439
|
+
"GalleryZoomOutExposes": {
|
|
3440
|
+
"description": "Defines the methods and properties exposed by GalleryZoomOut component.",
|
|
3441
|
+
"relatedProp": "",
|
|
3442
|
+
"props": [
|
|
3443
|
+
{
|
|
3444
|
+
"name": "gallery",
|
|
3445
|
+
"type": "GalleryRootInstance",
|
|
3446
|
+
"default": "",
|
|
3447
|
+
"description": "The Gallery component instance."
|
|
3448
|
+
}
|
|
3449
|
+
],
|
|
3450
|
+
"methods": []
|
|
3451
|
+
}
|
|
3452
|
+
},
|
|
3453
|
+
"types": {
|
|
3454
|
+
"GalleryZoomOutPassThroughType": {
|
|
3455
|
+
"description": "Defines passthrough(pt) options type in GalleryZoomOut component.",
|
|
3456
|
+
"values": "PassThroughType<GalleryZoomOutInstance, E>"
|
|
3457
|
+
},
|
|
3458
|
+
"GalleryZoomOutInstance": {
|
|
3459
|
+
"description": "Instance of GalleryZoomOut component.",
|
|
3460
|
+
"values": "ComponentInstance<GalleryZoomOutProps, GalleryZoomOutState, GalleryZoomOutExposes>"
|
|
3461
|
+
}
|
|
3462
|
+
},
|
|
3463
|
+
"variables": {}
|
|
3464
|
+
}
|
|
3465
|
+
},
|
|
3466
|
+
{
|
|
3467
|
+
"name": "GalleryZoomToggle",
|
|
3468
|
+
"source": "apps/showcase/assets/apidoc/galleryzoomtoggle.json",
|
|
3469
|
+
"data": {
|
|
3470
|
+
"description": "GalleryZoomToggle is a component that displays a zoom toggle action.",
|
|
3471
|
+
"interfaces": {
|
|
3472
|
+
"GalleryZoomTogglePassThrough": {
|
|
3473
|
+
"description": "Defines passthrough(pt) options of GalleryZoomToggle component.",
|
|
3474
|
+
"relatedProp": "",
|
|
3475
|
+
"props": [
|
|
3476
|
+
{
|
|
3477
|
+
"name": "root",
|
|
3478
|
+
"type": "GalleryZoomTogglePassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
3479
|
+
"default": "",
|
|
3480
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
3481
|
+
}
|
|
3482
|
+
],
|
|
3483
|
+
"methods": []
|
|
3484
|
+
},
|
|
3485
|
+
"GalleryZoomToggleProps": {
|
|
3486
|
+
"description": "Defines valid properties in GalleryZoomToggle component.",
|
|
3487
|
+
"relatedProp": "",
|
|
3488
|
+
"extendedTypes": "BaseComponentProps<GalleryZoomToggleInstance, unknown, GalleryZoomTogglePassThrough>",
|
|
3489
|
+
"props": [
|
|
3490
|
+
{
|
|
3491
|
+
"name": "ref",
|
|
3492
|
+
"type": "Ref<unknown>",
|
|
3493
|
+
"default": "",
|
|
3494
|
+
"description": "The reference to the component instance."
|
|
3495
|
+
},
|
|
3496
|
+
{
|
|
3497
|
+
"name": "pIf",
|
|
3498
|
+
"type": "boolean",
|
|
3499
|
+
"default": "true",
|
|
3500
|
+
"description": "Whether the component should be rendered."
|
|
3501
|
+
},
|
|
3502
|
+
{
|
|
3503
|
+
"name": "style",
|
|
3504
|
+
"type": "CSSProperties | ((instance?: GalleryZoomToggleInstance) => CSSProperties)",
|
|
3505
|
+
"default": "",
|
|
3506
|
+
"description": "The style to apply to the component."
|
|
3507
|
+
},
|
|
3508
|
+
{
|
|
3509
|
+
"name": "className",
|
|
3510
|
+
"type": "string | ((instance?: GalleryZoomToggleInstance) => string)",
|
|
3511
|
+
"default": "",
|
|
3512
|
+
"description": "The class name to apply to the component."
|
|
3513
|
+
},
|
|
3514
|
+
{
|
|
3515
|
+
"name": "as",
|
|
3516
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
3517
|
+
"default": "",
|
|
3518
|
+
"description": "The component type to render."
|
|
3519
|
+
},
|
|
3520
|
+
{
|
|
3521
|
+
"name": "asChild",
|
|
3522
|
+
"type": "boolean",
|
|
3523
|
+
"default": "false",
|
|
3524
|
+
"description": "Whether the component should be rendered as a child component."
|
|
3525
|
+
},
|
|
3526
|
+
{
|
|
3527
|
+
"name": "instance",
|
|
3528
|
+
"type": "GalleryZoomToggleInstance",
|
|
3529
|
+
"default": "",
|
|
3530
|
+
"description": "The instance to pass to the component."
|
|
3531
|
+
},
|
|
3532
|
+
{
|
|
3533
|
+
"name": "pt",
|
|
3534
|
+
"type": "SafeRecord<GalleryZoomTogglePassThrough>",
|
|
3535
|
+
"default": "",
|
|
3536
|
+
"description": "The pass-through props to pass to the component."
|
|
3537
|
+
},
|
|
3538
|
+
{
|
|
3539
|
+
"name": "ptOptions",
|
|
3540
|
+
"type": "PassThroughOptions",
|
|
3541
|
+
"default": "",
|
|
3542
|
+
"description": "The pass-through options to pass to the component."
|
|
3543
|
+
},
|
|
3544
|
+
{
|
|
3545
|
+
"name": "unstyled",
|
|
3546
|
+
"type": "boolean",
|
|
3547
|
+
"default": "",
|
|
3548
|
+
"description": "Whether the component should be rendered without classes."
|
|
3549
|
+
},
|
|
3550
|
+
{
|
|
3551
|
+
"name": "dt",
|
|
3552
|
+
"type": "unknown",
|
|
3553
|
+
"default": "",
|
|
3554
|
+
"description": "The design token to use for the component."
|
|
3555
|
+
},
|
|
3556
|
+
{
|
|
3557
|
+
"name": "styles",
|
|
3558
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
3559
|
+
"default": "",
|
|
3560
|
+
"description": "The styles to use for the component."
|
|
3561
|
+
},
|
|
3562
|
+
{
|
|
3563
|
+
"name": "render",
|
|
3564
|
+
"type": "(instance: GalleryZoomToggleInstance) => ReactNode",
|
|
3565
|
+
"default": "",
|
|
3566
|
+
"description": "The render function to render the component with instance access."
|
|
3567
|
+
},
|
|
3568
|
+
{
|
|
3569
|
+
"name": "children",
|
|
3570
|
+
"type": "any",
|
|
3571
|
+
"default": "",
|
|
3572
|
+
"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."
|
|
3573
|
+
},
|
|
3574
|
+
{
|
|
3575
|
+
"name": "[key: string]",
|
|
3576
|
+
"type": "any",
|
|
3577
|
+
"description": ""
|
|
3578
|
+
},
|
|
3579
|
+
{
|
|
3580
|
+
"name": "pt-{optionName}-*",
|
|
3581
|
+
"type": "-",
|
|
3582
|
+
"default": "",
|
|
3583
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
3584
|
+
"deprecated": false
|
|
3585
|
+
}
|
|
3586
|
+
],
|
|
3587
|
+
"methods": []
|
|
3588
|
+
},
|
|
3589
|
+
"GalleryZoomToggleState": {
|
|
3590
|
+
"description": "Defines valid state in GalleryZoomToggle component.",
|
|
3591
|
+
"relatedProp": "",
|
|
3592
|
+
"props": [],
|
|
3593
|
+
"methods": []
|
|
3594
|
+
},
|
|
3595
|
+
"GalleryZoomToggleExposes": {
|
|
3596
|
+
"description": "Defines the methods and properties exposed by GalleryZoomToggle component.",
|
|
3597
|
+
"relatedProp": "",
|
|
3598
|
+
"props": [
|
|
3599
|
+
{
|
|
3600
|
+
"name": "gallery",
|
|
3601
|
+
"type": "GalleryRootInstance",
|
|
3602
|
+
"default": "",
|
|
3603
|
+
"description": "The Gallery component instance."
|
|
3604
|
+
}
|
|
3605
|
+
],
|
|
3606
|
+
"methods": []
|
|
3607
|
+
}
|
|
3608
|
+
},
|
|
3609
|
+
"types": {
|
|
3610
|
+
"GalleryZoomTogglePassThroughType": {
|
|
3611
|
+
"description": "Defines passthrough(pt) options type in GalleryZoomToggle component.",
|
|
3612
|
+
"values": "PassThroughType<GalleryZoomToggleInstance, E>"
|
|
3613
|
+
},
|
|
3614
|
+
"GalleryZoomToggleInstance": {
|
|
3615
|
+
"description": "Instance of GalleryZoomToggle component.",
|
|
3616
|
+
"values": "ComponentInstance<GalleryZoomToggleProps, GalleryZoomToggleState, GalleryZoomToggleExposes>"
|
|
3617
|
+
}
|
|
3618
|
+
},
|
|
3619
|
+
"variables": {}
|
|
3620
|
+
}
|
|
3621
|
+
}
|
|
3622
|
+
]
|