@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,2102 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "ToastAction",
|
|
4
|
+
"source": "apps/showcase/assets/apidoc/toastaction.json",
|
|
5
|
+
"data": {
|
|
6
|
+
"description": "ToastAction component is used to display a toast action.",
|
|
7
|
+
"interfaces": {
|
|
8
|
+
"ToastActionPassThrough": {
|
|
9
|
+
"description": "Defines passthrough(pt) options of ToastAction component.",
|
|
10
|
+
"relatedProp": "",
|
|
11
|
+
"props": [
|
|
12
|
+
{
|
|
13
|
+
"name": "root",
|
|
14
|
+
"type": "ToastActionPassThroughType<ButtonHTMLAttributes<HTMLButtonElement>>",
|
|
15
|
+
"default": "",
|
|
16
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"methods": []
|
|
20
|
+
},
|
|
21
|
+
"ToastActionProps": {
|
|
22
|
+
"description": "Defines valid properties in ToastAction component.",
|
|
23
|
+
"relatedProp": "",
|
|
24
|
+
"extendedTypes": "BaseComponentProps<ToastActionInstance, unknown, ToastActionPassThrough>",
|
|
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?: ToastActionInstance) => CSSProperties)",
|
|
41
|
+
"default": "",
|
|
42
|
+
"description": "The style to apply to the component."
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "className",
|
|
46
|
+
"type": "string | ((instance?: ToastActionInstance) => 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": "ToastActionInstance",
|
|
65
|
+
"default": "",
|
|
66
|
+
"description": "The instance to pass to the component."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "pt",
|
|
70
|
+
"type": "SafeRecord<ToastActionPassThrough>",
|
|
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: ToastActionInstance) => 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
|
+
"ToastActionState": {
|
|
126
|
+
"description": "Defines valid state in ToastAction component.",
|
|
127
|
+
"relatedProp": "",
|
|
128
|
+
"props": [],
|
|
129
|
+
"methods": []
|
|
130
|
+
},
|
|
131
|
+
"ToastActionExposes": {
|
|
132
|
+
"description": "Defines the methods and properties exposed by ToastAction component.",
|
|
133
|
+
"relatedProp": "",
|
|
134
|
+
"props": [
|
|
135
|
+
{
|
|
136
|
+
"name": "toast",
|
|
137
|
+
"type": "ToastRootInstance",
|
|
138
|
+
"default": "",
|
|
139
|
+
"description": "The Toast component instance."
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"methods": []
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"types": {
|
|
146
|
+
"ToastActionPassThroughType": {
|
|
147
|
+
"description": "Defines passthrough(pt) options type in ToastAction component.",
|
|
148
|
+
"values": "PassThroughType<ToastActionInstance, E>"
|
|
149
|
+
},
|
|
150
|
+
"ToastActionInstance": {
|
|
151
|
+
"description": "Instance of ToastAction component.",
|
|
152
|
+
"values": "ComponentInstance<ToastActionProps, ToastActionState, ToastActionExposes>"
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"variables": {}
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "ToastClose",
|
|
160
|
+
"source": "apps/showcase/assets/apidoc/toastclose.json",
|
|
161
|
+
"data": {
|
|
162
|
+
"description": "ToastClose component is used to display a toast close.",
|
|
163
|
+
"interfaces": {
|
|
164
|
+
"ToastClosePassThrough": {
|
|
165
|
+
"description": "Defines passthrough(pt) options of ToastClose component.",
|
|
166
|
+
"relatedProp": "",
|
|
167
|
+
"props": [
|
|
168
|
+
{
|
|
169
|
+
"name": "root",
|
|
170
|
+
"type": "ToastClosePassThroughType<ButtonHTMLAttributes<HTMLButtonElement>>",
|
|
171
|
+
"default": "",
|
|
172
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
173
|
+
}
|
|
174
|
+
],
|
|
175
|
+
"methods": []
|
|
176
|
+
},
|
|
177
|
+
"ToastCloseProps": {
|
|
178
|
+
"description": "Defines valid properties in ToastClose component.",
|
|
179
|
+
"relatedProp": "",
|
|
180
|
+
"extendedTypes": "BaseComponentProps<ToastCloseInstance, unknown, ToastClosePassThrough>",
|
|
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?: ToastCloseInstance) => CSSProperties)",
|
|
197
|
+
"default": "",
|
|
198
|
+
"description": "The style to apply to the component."
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "className",
|
|
202
|
+
"type": "string | ((instance?: ToastCloseInstance) => 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": "ToastCloseInstance",
|
|
221
|
+
"default": "",
|
|
222
|
+
"description": "The instance to pass to the component."
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "pt",
|
|
226
|
+
"type": "SafeRecord<ToastClosePassThrough>",
|
|
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: ToastCloseInstance) => 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
|
+
"ToastCloseState": {
|
|
282
|
+
"description": "Defines valid state in ToastClose component.",
|
|
283
|
+
"relatedProp": "",
|
|
284
|
+
"props": [],
|
|
285
|
+
"methods": []
|
|
286
|
+
},
|
|
287
|
+
"ToastCloseExposes": {
|
|
288
|
+
"description": "Defines the methods and properties exposed by ToastClose component.",
|
|
289
|
+
"relatedProp": "",
|
|
290
|
+
"props": [
|
|
291
|
+
{
|
|
292
|
+
"name": "toast",
|
|
293
|
+
"type": "ToastRootInstance",
|
|
294
|
+
"default": "",
|
|
295
|
+
"description": "The Toast component instance."
|
|
296
|
+
}
|
|
297
|
+
],
|
|
298
|
+
"methods": []
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"types": {
|
|
302
|
+
"ToastClosePassThroughType": {
|
|
303
|
+
"description": "Defines passthrough(pt) options type in ToastClose component.",
|
|
304
|
+
"values": "PassThroughType<ToastCloseInstance, E>"
|
|
305
|
+
},
|
|
306
|
+
"ToastCloseInstance": {
|
|
307
|
+
"description": "Instance of ToastClose component.",
|
|
308
|
+
"values": "ComponentInstance<ToastCloseProps, ToastCloseState, ToastCloseExposes>"
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"variables": {}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "ToastContent",
|
|
316
|
+
"source": "apps/showcase/assets/apidoc/toastcontent.json",
|
|
317
|
+
"data": {
|
|
318
|
+
"description": "ToastContent is a layout wrapper that holds the icon and content within a Toast.",
|
|
319
|
+
"interfaces": {
|
|
320
|
+
"ToastContentPassThrough": {
|
|
321
|
+
"description": "Defines passthrough(pt) options of ToastContent component.",
|
|
322
|
+
"relatedProp": "",
|
|
323
|
+
"props": [
|
|
324
|
+
{
|
|
325
|
+
"name": "root",
|
|
326
|
+
"type": "ToastContentPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
327
|
+
"default": "",
|
|
328
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"methods": []
|
|
332
|
+
},
|
|
333
|
+
"ToastContentProps": {
|
|
334
|
+
"description": "Defines valid properties in ToastContent component.",
|
|
335
|
+
"relatedProp": "",
|
|
336
|
+
"extendedTypes": "BaseComponentProps<ToastContentInstance, unknown, ToastContentPassThrough>",
|
|
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?: ToastContentInstance) => CSSProperties)",
|
|
353
|
+
"default": "",
|
|
354
|
+
"description": "The style to apply to the component."
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "className",
|
|
358
|
+
"type": "string | ((instance?: ToastContentInstance) => 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": "ToastContentInstance",
|
|
377
|
+
"default": "",
|
|
378
|
+
"description": "The instance to pass to the component."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "pt",
|
|
382
|
+
"type": "SafeRecord<ToastContentPassThrough>",
|
|
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: ToastContentInstance) => 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
|
+
"ToastContentState": {
|
|
438
|
+
"description": "Defines valid state in ToastContent component.",
|
|
439
|
+
"relatedProp": "",
|
|
440
|
+
"props": [],
|
|
441
|
+
"methods": []
|
|
442
|
+
},
|
|
443
|
+
"ToastContentExposes": {
|
|
444
|
+
"description": "Defines the methods and properties exposed by ToastContent component.",
|
|
445
|
+
"relatedProp": "",
|
|
446
|
+
"props": [
|
|
447
|
+
{
|
|
448
|
+
"name": "toast",
|
|
449
|
+
"type": "ToastRootInstance",
|
|
450
|
+
"default": "",
|
|
451
|
+
"description": "The Toast component instance."
|
|
452
|
+
}
|
|
453
|
+
],
|
|
454
|
+
"methods": []
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"types": {
|
|
458
|
+
"ToastContentPassThroughType": {
|
|
459
|
+
"description": "Defines passthrough(pt) options type in ToastContent component.",
|
|
460
|
+
"values": "PassThroughType<ToastContentInstance, E>"
|
|
461
|
+
},
|
|
462
|
+
"ToastContentInstance": {
|
|
463
|
+
"description": "Instance of ToastContent component.",
|
|
464
|
+
"values": "ComponentInstance<ToastContentProps, ToastContentState, ToastContentExposes>"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"variables": {}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "ToastDescription",
|
|
472
|
+
"source": "apps/showcase/assets/apidoc/toastdescription.json",
|
|
473
|
+
"data": {
|
|
474
|
+
"description": "ToastDescription component is used to display a toast description.",
|
|
475
|
+
"interfaces": {
|
|
476
|
+
"ToastDescriptionPassThrough": {
|
|
477
|
+
"description": "Defines passthrough(pt) options of ToastDescription component.",
|
|
478
|
+
"relatedProp": "",
|
|
479
|
+
"props": [
|
|
480
|
+
{
|
|
481
|
+
"name": "root",
|
|
482
|
+
"type": "ToastDescriptionPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
483
|
+
"default": "",
|
|
484
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
485
|
+
}
|
|
486
|
+
],
|
|
487
|
+
"methods": []
|
|
488
|
+
},
|
|
489
|
+
"ToastDescriptionProps": {
|
|
490
|
+
"description": "Defines valid properties in ToastDescription component.",
|
|
491
|
+
"relatedProp": "",
|
|
492
|
+
"extendedTypes": "BaseComponentProps<ToastDescriptionInstance, unknown, ToastDescriptionPassThrough>",
|
|
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?: ToastDescriptionInstance) => CSSProperties)",
|
|
509
|
+
"default": "",
|
|
510
|
+
"description": "The style to apply to the component."
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"name": "className",
|
|
514
|
+
"type": "string | ((instance?: ToastDescriptionInstance) => 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": "ToastDescriptionInstance",
|
|
533
|
+
"default": "",
|
|
534
|
+
"description": "The instance to pass to the component."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "pt",
|
|
538
|
+
"type": "SafeRecord<ToastDescriptionPassThrough>",
|
|
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: ToastDescriptionInstance) => 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
|
+
"ToastDescriptionState": {
|
|
594
|
+
"description": "Defines valid state in ToastDescription component.",
|
|
595
|
+
"relatedProp": "",
|
|
596
|
+
"props": [],
|
|
597
|
+
"methods": []
|
|
598
|
+
},
|
|
599
|
+
"ToastDescriptionExposes": {
|
|
600
|
+
"description": "Defines the methods and properties exposed by ToastItem component.",
|
|
601
|
+
"relatedProp": "",
|
|
602
|
+
"props": [
|
|
603
|
+
{
|
|
604
|
+
"name": "toast",
|
|
605
|
+
"type": "ToastRootInstance",
|
|
606
|
+
"default": "",
|
|
607
|
+
"description": "The Toast component instance."
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"methods": []
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
"types": {
|
|
614
|
+
"ToastDescriptionPassThroughType": {
|
|
615
|
+
"description": "Defines passthrough(pt) options type in ToastDescription component.",
|
|
616
|
+
"values": "PassThroughType<ToastDescriptionInstance, E>"
|
|
617
|
+
},
|
|
618
|
+
"ToastDescriptionInstance": {
|
|
619
|
+
"description": "Instance of ToastItem component.",
|
|
620
|
+
"values": "ComponentInstance<ToastDescriptionProps, ToastDescriptionState, ToastDescriptionExposes>"
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
"variables": {}
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "ToastIcon",
|
|
628
|
+
"source": "apps/showcase/assets/apidoc/toasticon.json",
|
|
629
|
+
"data": {
|
|
630
|
+
"description": "ToastIcon component is used to display a toast icon.",
|
|
631
|
+
"interfaces": {
|
|
632
|
+
"ToastIconPassThrough": {
|
|
633
|
+
"description": "Defines passthrough(pt) options of ToastIcon component.",
|
|
634
|
+
"relatedProp": "",
|
|
635
|
+
"props": [
|
|
636
|
+
{
|
|
637
|
+
"name": "root",
|
|
638
|
+
"type": "ToastIconPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
639
|
+
"default": "",
|
|
640
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"methods": []
|
|
644
|
+
},
|
|
645
|
+
"ToastIconProps": {
|
|
646
|
+
"description": "Defines valid properties in ToastIcon component.",
|
|
647
|
+
"relatedProp": "",
|
|
648
|
+
"extendedTypes": "BaseComponentProps<ToastIconInstance, unknown, ToastIconPassThrough>",
|
|
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?: ToastIconInstance) => CSSProperties)",
|
|
665
|
+
"default": "",
|
|
666
|
+
"description": "The style to apply to the component."
|
|
667
|
+
},
|
|
668
|
+
{
|
|
669
|
+
"name": "className",
|
|
670
|
+
"type": "string | ((instance?: ToastIconInstance) => 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": "ToastIconInstance",
|
|
689
|
+
"default": "",
|
|
690
|
+
"description": "The instance to pass to the component."
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"name": "pt",
|
|
694
|
+
"type": "SafeRecord<ToastIconPassThrough>",
|
|
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: ToastIconInstance) => 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": "match",
|
|
736
|
+
"type": "\"always\" | ToastSeverity",
|
|
737
|
+
"default": "'always'",
|
|
738
|
+
"description": "Restricts rendering to toasts of the given severity. Use `'always'` to render for any severity."
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"name": "[key: string]",
|
|
742
|
+
"type": "any",
|
|
743
|
+
"description": ""
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"name": "pt-{optionName}-*",
|
|
747
|
+
"type": "-",
|
|
748
|
+
"default": "",
|
|
749
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
750
|
+
"deprecated": false
|
|
751
|
+
}
|
|
752
|
+
],
|
|
753
|
+
"methods": []
|
|
754
|
+
},
|
|
755
|
+
"ToastIconState": {
|
|
756
|
+
"description": "Defines valid state in ToastDescription component.",
|
|
757
|
+
"relatedProp": "",
|
|
758
|
+
"props": [],
|
|
759
|
+
"methods": []
|
|
760
|
+
},
|
|
761
|
+
"ToastIconExposes": {
|
|
762
|
+
"description": "Defines the methods and properties exposed by ToastIcon component.",
|
|
763
|
+
"relatedProp": "",
|
|
764
|
+
"props": [
|
|
765
|
+
{
|
|
766
|
+
"name": "toast",
|
|
767
|
+
"type": "ToastRootInstance",
|
|
768
|
+
"default": "",
|
|
769
|
+
"description": "The Toast component instance."
|
|
770
|
+
}
|
|
771
|
+
],
|
|
772
|
+
"methods": []
|
|
773
|
+
}
|
|
774
|
+
},
|
|
775
|
+
"types": {
|
|
776
|
+
"ToastIconPassThroughType": {
|
|
777
|
+
"description": "Defines passthrough(pt) options type in ToastIcon component.",
|
|
778
|
+
"values": "PassThroughType<ToastIconInstance, E>"
|
|
779
|
+
},
|
|
780
|
+
"ToastIconInstance": {
|
|
781
|
+
"description": "Instance of ToastItem component.",
|
|
782
|
+
"values": "ComponentInstance<ToastIconProps, ToastIconState, ToastIconExposes>"
|
|
783
|
+
}
|
|
784
|
+
},
|
|
785
|
+
"variables": {}
|
|
786
|
+
}
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"name": "ToastMessage",
|
|
790
|
+
"source": "apps/showcase/assets/apidoc/toastmessage.json",
|
|
791
|
+
"data": {
|
|
792
|
+
"description": "ToastMessage groups the title, description and action text content within a Toast.",
|
|
793
|
+
"interfaces": {
|
|
794
|
+
"ToastMessagePassThrough": {
|
|
795
|
+
"description": "Defines passthrough(pt) options of ToastMessage component.",
|
|
796
|
+
"relatedProp": "",
|
|
797
|
+
"props": [
|
|
798
|
+
{
|
|
799
|
+
"name": "root",
|
|
800
|
+
"type": "ToastMessagePassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
801
|
+
"default": "",
|
|
802
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
803
|
+
}
|
|
804
|
+
],
|
|
805
|
+
"methods": []
|
|
806
|
+
},
|
|
807
|
+
"ToastMessageProps": {
|
|
808
|
+
"description": "Defines valid properties in ToastMessage component.",
|
|
809
|
+
"relatedProp": "",
|
|
810
|
+
"extendedTypes": "BaseComponentProps<ToastMessageInstance, unknown, ToastMessagePassThrough>",
|
|
811
|
+
"props": [
|
|
812
|
+
{
|
|
813
|
+
"name": "ref",
|
|
814
|
+
"type": "Ref<unknown>",
|
|
815
|
+
"default": "",
|
|
816
|
+
"description": "The reference to the component instance."
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "pIf",
|
|
820
|
+
"type": "boolean",
|
|
821
|
+
"default": "true",
|
|
822
|
+
"description": "Whether the component should be rendered."
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"name": "style",
|
|
826
|
+
"type": "CSSProperties | ((instance?: ToastMessageInstance) => CSSProperties)",
|
|
827
|
+
"default": "",
|
|
828
|
+
"description": "The style to apply to the component."
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "className",
|
|
832
|
+
"type": "string | ((instance?: ToastMessageInstance) => string)",
|
|
833
|
+
"default": "",
|
|
834
|
+
"description": "The class name to apply to the component."
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "as",
|
|
838
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
839
|
+
"default": "",
|
|
840
|
+
"description": "The component type to render."
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "asChild",
|
|
844
|
+
"type": "boolean",
|
|
845
|
+
"default": "false",
|
|
846
|
+
"description": "Whether the component should be rendered as a child component."
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "instance",
|
|
850
|
+
"type": "ToastMessageInstance",
|
|
851
|
+
"default": "",
|
|
852
|
+
"description": "The instance to pass to the component."
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"name": "pt",
|
|
856
|
+
"type": "SafeRecord<ToastMessagePassThrough>",
|
|
857
|
+
"default": "",
|
|
858
|
+
"description": "The pass-through props to pass to the component."
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "ptOptions",
|
|
862
|
+
"type": "PassThroughOptions",
|
|
863
|
+
"default": "",
|
|
864
|
+
"description": "The pass-through options to pass to the component."
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "unstyled",
|
|
868
|
+
"type": "boolean",
|
|
869
|
+
"default": "",
|
|
870
|
+
"description": "Whether the component should be rendered without classes."
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "dt",
|
|
874
|
+
"type": "unknown",
|
|
875
|
+
"default": "",
|
|
876
|
+
"description": "The design token to use for the component."
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "styles",
|
|
880
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
881
|
+
"default": "",
|
|
882
|
+
"description": "The styles to use for the component."
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "render",
|
|
886
|
+
"type": "(instance: ToastMessageInstance) => ReactNode",
|
|
887
|
+
"default": "",
|
|
888
|
+
"description": "The render function to render the component with instance access."
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"name": "children",
|
|
892
|
+
"type": "any",
|
|
893
|
+
"default": "",
|
|
894
|
+
"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."
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
"name": "[key: string]",
|
|
898
|
+
"type": "any",
|
|
899
|
+
"description": ""
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"name": "pt-{optionName}-*",
|
|
903
|
+
"type": "-",
|
|
904
|
+
"default": "",
|
|
905
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
906
|
+
"deprecated": false
|
|
907
|
+
}
|
|
908
|
+
],
|
|
909
|
+
"methods": []
|
|
910
|
+
},
|
|
911
|
+
"ToastMessageState": {
|
|
912
|
+
"description": "Defines valid state in ToastMessage component.",
|
|
913
|
+
"relatedProp": "",
|
|
914
|
+
"props": [],
|
|
915
|
+
"methods": []
|
|
916
|
+
},
|
|
917
|
+
"ToastMessageExposes": {
|
|
918
|
+
"description": "Defines the methods and properties exposed by ToastMessage component.",
|
|
919
|
+
"relatedProp": "",
|
|
920
|
+
"props": [
|
|
921
|
+
{
|
|
922
|
+
"name": "toast",
|
|
923
|
+
"type": "ToastRootInstance",
|
|
924
|
+
"default": "",
|
|
925
|
+
"description": "The Toast component instance."
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
"methods": []
|
|
929
|
+
}
|
|
930
|
+
},
|
|
931
|
+
"types": {
|
|
932
|
+
"ToastMessagePassThroughType": {
|
|
933
|
+
"description": "Defines passthrough(pt) options type in ToastMessage component.",
|
|
934
|
+
"values": "PassThroughType<ToastMessageInstance, E>"
|
|
935
|
+
},
|
|
936
|
+
"ToastMessageInstance": {
|
|
937
|
+
"description": "Instance of ToastMessage component.",
|
|
938
|
+
"values": "ComponentInstance<ToastMessageProps, ToastMessageState, ToastMessageExposes>"
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
"variables": {}
|
|
942
|
+
}
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "ToastRoot",
|
|
946
|
+
"source": "apps/showcase/assets/apidoc/toastroot.json",
|
|
947
|
+
"data": {
|
|
948
|
+
"description": "ToastItem component is used to display a toast item.",
|
|
949
|
+
"interfaces": {
|
|
950
|
+
"ToastRootPassThrough": {
|
|
951
|
+
"description": "Defines passthrough(pt) options of ToastRoot component.",
|
|
952
|
+
"relatedProp": "",
|
|
953
|
+
"props": [
|
|
954
|
+
{
|
|
955
|
+
"name": "root",
|
|
956
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
957
|
+
"default": "",
|
|
958
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"name": "body",
|
|
962
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
963
|
+
"default": "",
|
|
964
|
+
"description": "Used to pass attributes to the body's DOM element."
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "content",
|
|
968
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
969
|
+
"default": "",
|
|
970
|
+
"description": "Used to pass attributes to the content's DOM element."
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "icon",
|
|
974
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
975
|
+
"default": "",
|
|
976
|
+
"description": "Used to pass attributes to the icon's DOM element."
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"name": "title",
|
|
980
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
981
|
+
"default": "",
|
|
982
|
+
"description": "Used to pass attributes to the title's DOM element."
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"name": "description",
|
|
986
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
987
|
+
"default": "",
|
|
988
|
+
"description": "Used to pass attributes to the description's DOM element."
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"name": "action",
|
|
992
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
993
|
+
"default": "",
|
|
994
|
+
"description": "Used to pass attributes to the action button's DOM element."
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"name": "close",
|
|
998
|
+
"type": "ToastRootPassThroughType<HTMLAttributes<HTMLButtonElement>>",
|
|
999
|
+
"default": "",
|
|
1000
|
+
"description": "Used to pass attributes to the close button's DOM element."
|
|
1001
|
+
}
|
|
1002
|
+
],
|
|
1003
|
+
"methods": []
|
|
1004
|
+
},
|
|
1005
|
+
"ToastRootProps": {
|
|
1006
|
+
"description": "Defines valid properties in ToastRoot component.",
|
|
1007
|
+
"relatedProp": "",
|
|
1008
|
+
"extendedTypes": "BaseComponentProps<ToastRootInstance, UseToastProps, ToastRootPassThrough>",
|
|
1009
|
+
"props": [
|
|
1010
|
+
{
|
|
1011
|
+
"name": "ref",
|
|
1012
|
+
"type": "Ref<unknown>",
|
|
1013
|
+
"default": "",
|
|
1014
|
+
"description": "The reference to the component instance."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "pIf",
|
|
1018
|
+
"type": "boolean",
|
|
1019
|
+
"default": "true",
|
|
1020
|
+
"description": "Whether the component should be rendered."
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "style",
|
|
1024
|
+
"type": "CSSProperties | ((instance?: ToastRootInstance) => CSSProperties)",
|
|
1025
|
+
"default": "",
|
|
1026
|
+
"description": "The style to apply to the component."
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "className",
|
|
1030
|
+
"type": "string | ((instance?: ToastRootInstance) => string)",
|
|
1031
|
+
"default": "",
|
|
1032
|
+
"description": "The class name to apply to the component."
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "as",
|
|
1036
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1037
|
+
"default": "",
|
|
1038
|
+
"description": "The component type to render."
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "asChild",
|
|
1042
|
+
"type": "boolean",
|
|
1043
|
+
"default": "false",
|
|
1044
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "instance",
|
|
1048
|
+
"type": "ToastRootInstance",
|
|
1049
|
+
"default": "",
|
|
1050
|
+
"description": "The instance to pass to the component."
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "pt",
|
|
1054
|
+
"type": "SafeRecord<ToastRootPassThrough>",
|
|
1055
|
+
"default": "",
|
|
1056
|
+
"description": "The pass-through props to pass to the component."
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "ptOptions",
|
|
1060
|
+
"type": "PassThroughOptions",
|
|
1061
|
+
"default": "",
|
|
1062
|
+
"description": "The pass-through options to pass to the component."
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "unstyled",
|
|
1066
|
+
"type": "boolean",
|
|
1067
|
+
"default": "",
|
|
1068
|
+
"description": "Whether the component should be rendered without classes."
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "dt",
|
|
1072
|
+
"type": "unknown",
|
|
1073
|
+
"default": "",
|
|
1074
|
+
"description": "The design token to use for the component."
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"name": "styles",
|
|
1078
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1079
|
+
"default": "",
|
|
1080
|
+
"description": "The styles to use for the component."
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "render",
|
|
1084
|
+
"type": "(instance: ToastRootInstance) => ReactNode",
|
|
1085
|
+
"default": "",
|
|
1086
|
+
"description": "The render function to render the component with instance access."
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "children",
|
|
1090
|
+
"type": "any",
|
|
1091
|
+
"default": "",
|
|
1092
|
+
"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."
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "toast",
|
|
1096
|
+
"type": "ToastType",
|
|
1097
|
+
"default": "",
|
|
1098
|
+
"description": "Toast data containing all toast information"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "toaster",
|
|
1102
|
+
"type": "ToasterRootInstance",
|
|
1103
|
+
"default": "",
|
|
1104
|
+
"description": "Reference to the parent Toaster instance"
|
|
1105
|
+
},
|
|
1106
|
+
{
|
|
1107
|
+
"name": "[key: string]",
|
|
1108
|
+
"type": "any",
|
|
1109
|
+
"description": ""
|
|
1110
|
+
},
|
|
1111
|
+
{
|
|
1112
|
+
"name": "pt-{optionName}-*",
|
|
1113
|
+
"type": "-",
|
|
1114
|
+
"default": "",
|
|
1115
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1116
|
+
"deprecated": false
|
|
1117
|
+
}
|
|
1118
|
+
],
|
|
1119
|
+
"methods": []
|
|
1120
|
+
},
|
|
1121
|
+
"ToastRootState": {
|
|
1122
|
+
"description": "Defines valid state in ToastRoot component.",
|
|
1123
|
+
"relatedProp": "",
|
|
1124
|
+
"extendedTypes": "UseToastState",
|
|
1125
|
+
"props": [
|
|
1126
|
+
{
|
|
1127
|
+
"name": "mounted",
|
|
1128
|
+
"type": "boolean",
|
|
1129
|
+
"default": "",
|
|
1130
|
+
"description": "Indicates whether the toast is mounted"
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"name": "swiping",
|
|
1134
|
+
"type": "boolean",
|
|
1135
|
+
"default": "",
|
|
1136
|
+
"description": "Indicates whether the user is swiping the toast"
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "swipeOut",
|
|
1140
|
+
"type": "boolean",
|
|
1141
|
+
"default": "",
|
|
1142
|
+
"description": "Indicates whether the toast has been swiped out (dismissed)"
|
|
1143
|
+
},
|
|
1144
|
+
{
|
|
1145
|
+
"name": "swipeOutDirection",
|
|
1146
|
+
"type": "ToastSwipeDirection",
|
|
1147
|
+
"default": "",
|
|
1148
|
+
"description": "Direction of swipe out animation"
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "swipeDirection",
|
|
1152
|
+
"type": "ToastSwipeAxis",
|
|
1153
|
+
"default": "",
|
|
1154
|
+
"description": "Direction of swipe interaction"
|
|
1155
|
+
},
|
|
1156
|
+
{
|
|
1157
|
+
"name": "initialHeight",
|
|
1158
|
+
"type": "number",
|
|
1159
|
+
"default": "",
|
|
1160
|
+
"description": "Measured height of the toast content"
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
"name": "removed",
|
|
1164
|
+
"type": "boolean",
|
|
1165
|
+
"default": "",
|
|
1166
|
+
"description": "Whether the toast has been removed from the stack"
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"name": "isSwiped",
|
|
1170
|
+
"type": "boolean",
|
|
1171
|
+
"default": "",
|
|
1172
|
+
"description": "Whether the toast has been swiped (even if not dismissed)"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"name": "offsetBeforeRemove",
|
|
1176
|
+
"type": "number",
|
|
1177
|
+
"default": "",
|
|
1178
|
+
"description": "Offset that should be preserved while the toast exits"
|
|
1179
|
+
}
|
|
1180
|
+
],
|
|
1181
|
+
"methods": []
|
|
1182
|
+
},
|
|
1183
|
+
"ToastRootExposes": {
|
|
1184
|
+
"description": "Defines the methods and properties exposed by ToastRoot component.",
|
|
1185
|
+
"relatedProp": "",
|
|
1186
|
+
"extendedTypes": "UseToastExposes",
|
|
1187
|
+
"props": [
|
|
1188
|
+
{
|
|
1189
|
+
"name": "offset",
|
|
1190
|
+
"type": "number",
|
|
1191
|
+
"default": "",
|
|
1192
|
+
"description": "Vertical offset for stacking toasts"
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
"name": "offsetBeforeRemove",
|
|
1196
|
+
"type": "number",
|
|
1197
|
+
"default": "",
|
|
1198
|
+
"description": "Offset snapshot used during removal transitions"
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"name": "index",
|
|
1202
|
+
"type": "number",
|
|
1203
|
+
"default": "",
|
|
1204
|
+
"description": "Index of the toast in the stack"
|
|
1205
|
+
},
|
|
1206
|
+
{
|
|
1207
|
+
"name": "visibleIndex",
|
|
1208
|
+
"type": "number",
|
|
1209
|
+
"default": "",
|
|
1210
|
+
"description": "Index among currently visible toasts"
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"name": "isVisible",
|
|
1214
|
+
"type": "boolean",
|
|
1215
|
+
"default": "",
|
|
1216
|
+
"description": "Whether the toast is currently visible considering the limit"
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"name": "isFront",
|
|
1220
|
+
"type": "boolean",
|
|
1221
|
+
"default": "",
|
|
1222
|
+
"description": "Whether the toast is in the front-most position"
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "toaster",
|
|
1226
|
+
"type": "ToasterRootInstance",
|
|
1227
|
+
"default": "",
|
|
1228
|
+
"description": "Reference to the parent Toaster instance"
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"name": "rootProps",
|
|
1232
|
+
"type": "Record<string, unknown>",
|
|
1233
|
+
"default": "",
|
|
1234
|
+
"description": "Pre-built props for the root element"
|
|
1235
|
+
},
|
|
1236
|
+
{
|
|
1237
|
+
"name": "actionProps",
|
|
1238
|
+
"type": "UseToastActionProps",
|
|
1239
|
+
"default": "",
|
|
1240
|
+
"description": "Pre-built props for the action element"
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
"name": "contentProps",
|
|
1244
|
+
"type": "UseToastContentProps",
|
|
1245
|
+
"default": "",
|
|
1246
|
+
"description": "Pre-built props for the body element"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "closeProps",
|
|
1250
|
+
"type": "UseToastCloseProps",
|
|
1251
|
+
"default": "",
|
|
1252
|
+
"description": "Pre-built props for the close element"
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "messageProps",
|
|
1256
|
+
"type": "UseToastMessageProps",
|
|
1257
|
+
"default": "",
|
|
1258
|
+
"description": "Pre-built props for the content element"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "descriptionProps",
|
|
1262
|
+
"type": "UseToastDescriptionProps",
|
|
1263
|
+
"default": "",
|
|
1264
|
+
"description": "Pre-built props for the description element"
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "iconProps",
|
|
1268
|
+
"type": "UseToastIconProps",
|
|
1269
|
+
"default": "",
|
|
1270
|
+
"description": "Pre-built props for the icon element"
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "titleProps",
|
|
1274
|
+
"type": "UseToastTitleProps",
|
|
1275
|
+
"default": "",
|
|
1276
|
+
"description": "Pre-built props for the title element"
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"name": "onPointerDown",
|
|
1280
|
+
"type": "(event: PointerEvent<HTMLDivElement>) => void",
|
|
1281
|
+
"default": "",
|
|
1282
|
+
"description": "Handler for pointer down events (swipe start)"
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "onPointerMove",
|
|
1286
|
+
"type": "(event: PointerEvent<HTMLDivElement>) => void",
|
|
1287
|
+
"default": "",
|
|
1288
|
+
"description": "Handler for pointer move events (swipe progress)"
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"name": "onPointerUp",
|
|
1292
|
+
"type": "() => void",
|
|
1293
|
+
"default": "",
|
|
1294
|
+
"description": "Handler for pointer up events (swipe end)"
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
"name": "onDragEnd",
|
|
1298
|
+
"type": "() => void",
|
|
1299
|
+
"default": "",
|
|
1300
|
+
"description": "Handler for drag end events"
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"name": "handleCloseOnClick",
|
|
1304
|
+
"type": "() => void",
|
|
1305
|
+
"default": "",
|
|
1306
|
+
"description": "Handler for close button click"
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
"name": "toast",
|
|
1310
|
+
"type": "UseToastInstance",
|
|
1311
|
+
"default": "",
|
|
1312
|
+
"description": "Reference to the parent Toast instance."
|
|
1313
|
+
}
|
|
1314
|
+
],
|
|
1315
|
+
"methods": []
|
|
1316
|
+
}
|
|
1317
|
+
},
|
|
1318
|
+
"types": {
|
|
1319
|
+
"ToastRootPassThroughType": {
|
|
1320
|
+
"description": "Defines passthrough(pt) options type in ToastRoot component.",
|
|
1321
|
+
"values": "PassThroughType<ToastRootInstance, E>"
|
|
1322
|
+
},
|
|
1323
|
+
"ToastRootInstance": {
|
|
1324
|
+
"description": "Instance of ToastRoot component.",
|
|
1325
|
+
"values": "ComponentInstance<ToastRootProps, ToastRootState, ToastRootExposes>"
|
|
1326
|
+
}
|
|
1327
|
+
},
|
|
1328
|
+
"variables": {}
|
|
1329
|
+
}
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "ToastTitle",
|
|
1333
|
+
"source": "apps/showcase/assets/apidoc/toasttitle.json",
|
|
1334
|
+
"data": {
|
|
1335
|
+
"description": "ToastTitle is a component that displays a toast title.",
|
|
1336
|
+
"interfaces": {
|
|
1337
|
+
"ToastTitlePassThrough": {
|
|
1338
|
+
"description": "Defines passthrough(pt) options of ToastTitle component.",
|
|
1339
|
+
"relatedProp": "",
|
|
1340
|
+
"props": [
|
|
1341
|
+
{
|
|
1342
|
+
"name": "root",
|
|
1343
|
+
"type": "ToastTitlePassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1344
|
+
"default": "",
|
|
1345
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1346
|
+
}
|
|
1347
|
+
],
|
|
1348
|
+
"methods": []
|
|
1349
|
+
},
|
|
1350
|
+
"ToastTitleProps": {
|
|
1351
|
+
"description": "Defines valid properties in ToastTitle component.",
|
|
1352
|
+
"relatedProp": "",
|
|
1353
|
+
"extendedTypes": "BaseComponentProps<ToastTitleInstance, unknown, ToastTitlePassThrough>",
|
|
1354
|
+
"props": [
|
|
1355
|
+
{
|
|
1356
|
+
"name": "ref",
|
|
1357
|
+
"type": "Ref<unknown>",
|
|
1358
|
+
"default": "",
|
|
1359
|
+
"description": "The reference to the component instance."
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"name": "pIf",
|
|
1363
|
+
"type": "boolean",
|
|
1364
|
+
"default": "true",
|
|
1365
|
+
"description": "Whether the component should be rendered."
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
"name": "style",
|
|
1369
|
+
"type": "CSSProperties | ((instance?: ToastTitleInstance) => CSSProperties)",
|
|
1370
|
+
"default": "",
|
|
1371
|
+
"description": "The style to apply to the component."
|
|
1372
|
+
},
|
|
1373
|
+
{
|
|
1374
|
+
"name": "className",
|
|
1375
|
+
"type": "string | ((instance?: ToastTitleInstance) => string)",
|
|
1376
|
+
"default": "",
|
|
1377
|
+
"description": "The class name to apply to the component."
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"name": "as",
|
|
1381
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1382
|
+
"default": "",
|
|
1383
|
+
"description": "The component type to render."
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
"name": "asChild",
|
|
1387
|
+
"type": "boolean",
|
|
1388
|
+
"default": "false",
|
|
1389
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
"name": "instance",
|
|
1393
|
+
"type": "ToastTitleInstance",
|
|
1394
|
+
"default": "",
|
|
1395
|
+
"description": "The instance to pass to the component."
|
|
1396
|
+
},
|
|
1397
|
+
{
|
|
1398
|
+
"name": "pt",
|
|
1399
|
+
"type": "SafeRecord<ToastTitlePassThrough>",
|
|
1400
|
+
"default": "",
|
|
1401
|
+
"description": "The pass-through props to pass to the component."
|
|
1402
|
+
},
|
|
1403
|
+
{
|
|
1404
|
+
"name": "ptOptions",
|
|
1405
|
+
"type": "PassThroughOptions",
|
|
1406
|
+
"default": "",
|
|
1407
|
+
"description": "The pass-through options to pass to the component."
|
|
1408
|
+
},
|
|
1409
|
+
{
|
|
1410
|
+
"name": "unstyled",
|
|
1411
|
+
"type": "boolean",
|
|
1412
|
+
"default": "",
|
|
1413
|
+
"description": "Whether the component should be rendered without classes."
|
|
1414
|
+
},
|
|
1415
|
+
{
|
|
1416
|
+
"name": "dt",
|
|
1417
|
+
"type": "unknown",
|
|
1418
|
+
"default": "",
|
|
1419
|
+
"description": "The design token to use for the component."
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
"name": "styles",
|
|
1423
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1424
|
+
"default": "",
|
|
1425
|
+
"description": "The styles to use for the component."
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "render",
|
|
1429
|
+
"type": "(instance: ToastTitleInstance) => ReactNode",
|
|
1430
|
+
"default": "",
|
|
1431
|
+
"description": "The render function to render the component with instance access."
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"name": "children",
|
|
1435
|
+
"type": "any",
|
|
1436
|
+
"default": "",
|
|
1437
|
+
"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."
|
|
1438
|
+
},
|
|
1439
|
+
{
|
|
1440
|
+
"name": "[key: string]",
|
|
1441
|
+
"type": "any",
|
|
1442
|
+
"description": ""
|
|
1443
|
+
},
|
|
1444
|
+
{
|
|
1445
|
+
"name": "pt-{optionName}-*",
|
|
1446
|
+
"type": "-",
|
|
1447
|
+
"default": "",
|
|
1448
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1449
|
+
"deprecated": false
|
|
1450
|
+
}
|
|
1451
|
+
],
|
|
1452
|
+
"methods": []
|
|
1453
|
+
},
|
|
1454
|
+
"ToastTitleState": {
|
|
1455
|
+
"description": "Defines valid state in ToastTitle component.",
|
|
1456
|
+
"relatedProp": "",
|
|
1457
|
+
"props": [],
|
|
1458
|
+
"methods": []
|
|
1459
|
+
},
|
|
1460
|
+
"ToastTitleExposes": {
|
|
1461
|
+
"description": "Defines the methods and properties exposed by ToastTitle component.",
|
|
1462
|
+
"relatedProp": "",
|
|
1463
|
+
"props": [
|
|
1464
|
+
{
|
|
1465
|
+
"name": "toast",
|
|
1466
|
+
"type": "ToastRootInstance",
|
|
1467
|
+
"default": "",
|
|
1468
|
+
"description": "The Toast component instance."
|
|
1469
|
+
}
|
|
1470
|
+
],
|
|
1471
|
+
"methods": []
|
|
1472
|
+
}
|
|
1473
|
+
},
|
|
1474
|
+
"types": {
|
|
1475
|
+
"ToastTitlePassThroughType": {
|
|
1476
|
+
"description": "Defines passthrough(pt) options type in ToastTitle component.",
|
|
1477
|
+
"values": "PassThroughType<ToastTitleInstance, E>"
|
|
1478
|
+
},
|
|
1479
|
+
"ToastTitleInstance": {
|
|
1480
|
+
"description": "Instance of ToastTitle component.",
|
|
1481
|
+
"values": "ComponentInstance<ToastTitleProps, ToastTitleState, ToastTitleExposes>"
|
|
1482
|
+
}
|
|
1483
|
+
},
|
|
1484
|
+
"variables": {}
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
"name": "ToasterPortal",
|
|
1489
|
+
"source": "apps/showcase/assets/apidoc/toasterportal.json",
|
|
1490
|
+
"data": {
|
|
1491
|
+
"description": "ToasterPortal is a component that displays a toaster portal.",
|
|
1492
|
+
"interfaces": {
|
|
1493
|
+
"ToasterPortalPassThrough": {
|
|
1494
|
+
"description": "Defines passthrough(pt) options of ToasterPortal component.",
|
|
1495
|
+
"relatedProp": "",
|
|
1496
|
+
"props": [
|
|
1497
|
+
{
|
|
1498
|
+
"name": "root",
|
|
1499
|
+
"type": "ToasterPortalPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1500
|
+
"default": "",
|
|
1501
|
+
"description": "Used to pass attributes to the portal's DOM element."
|
|
1502
|
+
}
|
|
1503
|
+
],
|
|
1504
|
+
"methods": []
|
|
1505
|
+
},
|
|
1506
|
+
"ToasterPortalProps": {
|
|
1507
|
+
"description": "Defines valid properties in ToasterPortal component.",
|
|
1508
|
+
"relatedProp": "",
|
|
1509
|
+
"extendedTypes": "BaseComponentProps<ToasterPortalInstance, unknown, ToasterPortalPassThrough>",
|
|
1510
|
+
"props": [
|
|
1511
|
+
{
|
|
1512
|
+
"name": "ref",
|
|
1513
|
+
"type": "Ref<unknown>",
|
|
1514
|
+
"default": "",
|
|
1515
|
+
"description": "The reference to the component instance."
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"name": "pIf",
|
|
1519
|
+
"type": "boolean",
|
|
1520
|
+
"default": "true",
|
|
1521
|
+
"description": "Whether the component should be rendered."
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
"name": "style",
|
|
1525
|
+
"type": "CSSProperties | ((instance?: ToasterPortalInstance) => CSSProperties)",
|
|
1526
|
+
"default": "",
|
|
1527
|
+
"description": "The style to apply to the component."
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "className",
|
|
1531
|
+
"type": "string | ((instance?: ToasterPortalInstance) => string)",
|
|
1532
|
+
"default": "",
|
|
1533
|
+
"description": "The class name to apply to the component."
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
"name": "as",
|
|
1537
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1538
|
+
"default": "",
|
|
1539
|
+
"description": "The component type to render."
|
|
1540
|
+
},
|
|
1541
|
+
{
|
|
1542
|
+
"name": "asChild",
|
|
1543
|
+
"type": "boolean",
|
|
1544
|
+
"default": "false",
|
|
1545
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"name": "instance",
|
|
1549
|
+
"type": "ToasterPortalInstance",
|
|
1550
|
+
"default": "",
|
|
1551
|
+
"description": "The instance to pass to the component."
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"name": "pt",
|
|
1555
|
+
"type": "SafeRecord<ToasterPortalPassThrough>",
|
|
1556
|
+
"default": "",
|
|
1557
|
+
"description": "The pass-through props to pass to the component."
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"name": "ptOptions",
|
|
1561
|
+
"type": "PassThroughOptions",
|
|
1562
|
+
"default": "",
|
|
1563
|
+
"description": "The pass-through options to pass to the component."
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
"name": "unstyled",
|
|
1567
|
+
"type": "boolean",
|
|
1568
|
+
"default": "",
|
|
1569
|
+
"description": "Whether the component should be rendered without classes."
|
|
1570
|
+
},
|
|
1571
|
+
{
|
|
1572
|
+
"name": "dt",
|
|
1573
|
+
"type": "unknown",
|
|
1574
|
+
"default": "",
|
|
1575
|
+
"description": "The design token to use for the component."
|
|
1576
|
+
},
|
|
1577
|
+
{
|
|
1578
|
+
"name": "styles",
|
|
1579
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1580
|
+
"default": "",
|
|
1581
|
+
"description": "The styles to use for the component."
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "render",
|
|
1585
|
+
"type": "(instance: ToasterPortalInstance) => ReactNode",
|
|
1586
|
+
"default": "",
|
|
1587
|
+
"description": "The render function to render the component with instance access."
|
|
1588
|
+
},
|
|
1589
|
+
{
|
|
1590
|
+
"name": "children",
|
|
1591
|
+
"type": "any",
|
|
1592
|
+
"default": "",
|
|
1593
|
+
"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."
|
|
1594
|
+
},
|
|
1595
|
+
{
|
|
1596
|
+
"name": "[key: string]",
|
|
1597
|
+
"type": "any",
|
|
1598
|
+
"description": ""
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"name": "pt-{optionName}-*",
|
|
1602
|
+
"type": "-",
|
|
1603
|
+
"default": "",
|
|
1604
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1605
|
+
"deprecated": false
|
|
1606
|
+
}
|
|
1607
|
+
],
|
|
1608
|
+
"methods": []
|
|
1609
|
+
},
|
|
1610
|
+
"ToasterPortalState": {
|
|
1611
|
+
"description": "Defines valid state in ToasterPortal component.",
|
|
1612
|
+
"relatedProp": "",
|
|
1613
|
+
"props": [],
|
|
1614
|
+
"methods": []
|
|
1615
|
+
},
|
|
1616
|
+
"ToasterPortalExposes": {
|
|
1617
|
+
"description": "Defines the methods and properties exposed by ToasterPortal component.",
|
|
1618
|
+
"relatedProp": "",
|
|
1619
|
+
"props": [
|
|
1620
|
+
{
|
|
1621
|
+
"name": "toaster",
|
|
1622
|
+
"type": "ToasterRootInstance",
|
|
1623
|
+
"default": "",
|
|
1624
|
+
"description": "The Toaster component instance."
|
|
1625
|
+
}
|
|
1626
|
+
],
|
|
1627
|
+
"methods": []
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1630
|
+
"types": {
|
|
1631
|
+
"ToasterPortalPassThroughType": {
|
|
1632
|
+
"description": "Defines passthrough(pt) options type in ToasterPortal component.",
|
|
1633
|
+
"values": "PassThroughType<ToasterPortalInstance, E>"
|
|
1634
|
+
},
|
|
1635
|
+
"ToasterPortalInstance": {
|
|
1636
|
+
"description": "Instance of ToasterPortal component.",
|
|
1637
|
+
"values": "ComponentInstance<ToasterPortalProps, ToasterPortalState, ToasterPortalExposes>"
|
|
1638
|
+
}
|
|
1639
|
+
},
|
|
1640
|
+
"variables": {}
|
|
1641
|
+
}
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "ToasterRegion",
|
|
1645
|
+
"source": "apps/showcase/assets/apidoc/toasterregion.json",
|
|
1646
|
+
"data": {
|
|
1647
|
+
"description": "ToasterRegion is a component that displays a toaster region.",
|
|
1648
|
+
"interfaces": {
|
|
1649
|
+
"ToasterRegionPassThrough": {
|
|
1650
|
+
"description": "Defines passthrough(pt) options of ToasterRegion component.",
|
|
1651
|
+
"relatedProp": "",
|
|
1652
|
+
"props": [
|
|
1653
|
+
{
|
|
1654
|
+
"name": "root",
|
|
1655
|
+
"type": "ToasterRegionPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1656
|
+
"default": "",
|
|
1657
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1658
|
+
}
|
|
1659
|
+
],
|
|
1660
|
+
"methods": []
|
|
1661
|
+
},
|
|
1662
|
+
"ToasterRegionProps": {
|
|
1663
|
+
"description": "Defines valid properties in ToasterRegion component.",
|
|
1664
|
+
"relatedProp": "",
|
|
1665
|
+
"extendedTypes": "BaseComponentProps<ToasterRegionInstance, unknown, ToasterRegionPassThrough>",
|
|
1666
|
+
"props": [
|
|
1667
|
+
{
|
|
1668
|
+
"name": "ref",
|
|
1669
|
+
"type": "Ref<unknown>",
|
|
1670
|
+
"default": "",
|
|
1671
|
+
"description": "The reference to the component instance."
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"name": "pIf",
|
|
1675
|
+
"type": "boolean",
|
|
1676
|
+
"default": "true",
|
|
1677
|
+
"description": "Whether the component should be rendered."
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "style",
|
|
1681
|
+
"type": "CSSProperties | ((instance?: ToasterRegionInstance) => CSSProperties)",
|
|
1682
|
+
"default": "",
|
|
1683
|
+
"description": "The style to apply to the component."
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "className",
|
|
1687
|
+
"type": "string | ((instance?: ToasterRegionInstance) => string)",
|
|
1688
|
+
"default": "",
|
|
1689
|
+
"description": "The class name to apply to the component."
|
|
1690
|
+
},
|
|
1691
|
+
{
|
|
1692
|
+
"name": "as",
|
|
1693
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1694
|
+
"default": "",
|
|
1695
|
+
"description": "The component type to render."
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"name": "asChild",
|
|
1699
|
+
"type": "boolean",
|
|
1700
|
+
"default": "false",
|
|
1701
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "instance",
|
|
1705
|
+
"type": "ToasterRegionInstance",
|
|
1706
|
+
"default": "",
|
|
1707
|
+
"description": "The instance to pass to the component."
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "pt",
|
|
1711
|
+
"type": "SafeRecord<ToasterRegionPassThrough>",
|
|
1712
|
+
"default": "",
|
|
1713
|
+
"description": "The pass-through props to pass to the component."
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"name": "ptOptions",
|
|
1717
|
+
"type": "PassThroughOptions",
|
|
1718
|
+
"default": "",
|
|
1719
|
+
"description": "The pass-through options to pass to the component."
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"name": "unstyled",
|
|
1723
|
+
"type": "boolean",
|
|
1724
|
+
"default": "",
|
|
1725
|
+
"description": "Whether the component should be rendered without classes."
|
|
1726
|
+
},
|
|
1727
|
+
{
|
|
1728
|
+
"name": "dt",
|
|
1729
|
+
"type": "unknown",
|
|
1730
|
+
"default": "",
|
|
1731
|
+
"description": "The design token to use for the component."
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "styles",
|
|
1735
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1736
|
+
"default": "",
|
|
1737
|
+
"description": "The styles to use for the component."
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "render",
|
|
1741
|
+
"type": "(instance: ToasterRegionInstance) => ReactNode",
|
|
1742
|
+
"default": "",
|
|
1743
|
+
"description": "The render function to render the component with instance access."
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "children",
|
|
1747
|
+
"type": "any",
|
|
1748
|
+
"default": "",
|
|
1749
|
+
"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."
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "[key: string]",
|
|
1753
|
+
"type": "any",
|
|
1754
|
+
"description": ""
|
|
1755
|
+
},
|
|
1756
|
+
{
|
|
1757
|
+
"name": "pt-{optionName}-*",
|
|
1758
|
+
"type": "-",
|
|
1759
|
+
"default": "",
|
|
1760
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1761
|
+
"deprecated": false
|
|
1762
|
+
}
|
|
1763
|
+
],
|
|
1764
|
+
"methods": []
|
|
1765
|
+
},
|
|
1766
|
+
"ToasterRegionState": {
|
|
1767
|
+
"description": "Defines valid state in ToasterRegion component.",
|
|
1768
|
+
"relatedProp": "",
|
|
1769
|
+
"props": [],
|
|
1770
|
+
"methods": []
|
|
1771
|
+
},
|
|
1772
|
+
"ToasterRegionExposes": {
|
|
1773
|
+
"description": "Defines the methods and properties exposed by ToasterRegion component.",
|
|
1774
|
+
"relatedProp": "",
|
|
1775
|
+
"props": [
|
|
1776
|
+
{
|
|
1777
|
+
"name": "toaster",
|
|
1778
|
+
"type": "ToasterRootInstance",
|
|
1779
|
+
"default": "",
|
|
1780
|
+
"description": "The Toaster component instance."
|
|
1781
|
+
}
|
|
1782
|
+
],
|
|
1783
|
+
"methods": []
|
|
1784
|
+
}
|
|
1785
|
+
},
|
|
1786
|
+
"types": {
|
|
1787
|
+
"ToasterRegionPassThroughType": {
|
|
1788
|
+
"description": "Defines passthrough(pt) options type in ToasterRegion component.",
|
|
1789
|
+
"values": "PassThroughType<ToasterRegionInstance, E>"
|
|
1790
|
+
},
|
|
1791
|
+
"ToasterRegionInstance": {
|
|
1792
|
+
"description": "Instance of ToasterRegion component.",
|
|
1793
|
+
"values": "ComponentInstance<ToasterRegionProps, ToasterRegionState, ToasterRegionExposes>"
|
|
1794
|
+
}
|
|
1795
|
+
},
|
|
1796
|
+
"variables": {}
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
{
|
|
1800
|
+
"name": "ToasterRoot",
|
|
1801
|
+
"source": "apps/showcase/assets/apidoc/toasterroot.json",
|
|
1802
|
+
"data": {
|
|
1803
|
+
"description": "Toaster Root component is used to display messages.",
|
|
1804
|
+
"interfaces": {
|
|
1805
|
+
"ToasterRootPassThrough": {
|
|
1806
|
+
"description": "Defines passthrough(pt) options of Toaster component.",
|
|
1807
|
+
"relatedProp": "",
|
|
1808
|
+
"props": [
|
|
1809
|
+
{
|
|
1810
|
+
"name": "root",
|
|
1811
|
+
"type": "ToasterRootPassThroughType<HTMLAttributes<HTMLDivElement>>",
|
|
1812
|
+
"default": "",
|
|
1813
|
+
"description": "Used to pass attributes to the root's DOM element."
|
|
1814
|
+
}
|
|
1815
|
+
],
|
|
1816
|
+
"methods": []
|
|
1817
|
+
},
|
|
1818
|
+
"ToasterRootProps": {
|
|
1819
|
+
"description": "Defines valid properties in Toaster component.",
|
|
1820
|
+
"relatedProp": "",
|
|
1821
|
+
"extendedTypes": "BaseComponentProps<ToasterRootInstance, UseToasterProps, ToasterRootPassThrough>",
|
|
1822
|
+
"props": [
|
|
1823
|
+
{
|
|
1824
|
+
"name": "ref",
|
|
1825
|
+
"type": "Ref<unknown>",
|
|
1826
|
+
"default": "",
|
|
1827
|
+
"description": "The reference to the component instance."
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"name": "pIf",
|
|
1831
|
+
"type": "boolean",
|
|
1832
|
+
"default": "true",
|
|
1833
|
+
"description": "Whether the component should be rendered."
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"name": "style",
|
|
1837
|
+
"type": "CSSProperties | ((instance?: ToasterRootInstance) => CSSProperties)",
|
|
1838
|
+
"default": "",
|
|
1839
|
+
"description": "The style to apply to the component."
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "className",
|
|
1843
|
+
"type": "string | ((instance?: ToasterRootInstance) => string)",
|
|
1844
|
+
"default": "",
|
|
1845
|
+
"description": "The class name to apply to the component."
|
|
1846
|
+
},
|
|
1847
|
+
{
|
|
1848
|
+
"name": "as",
|
|
1849
|
+
"type": "string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode>",
|
|
1850
|
+
"default": "",
|
|
1851
|
+
"description": "The component type to render."
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "asChild",
|
|
1855
|
+
"type": "boolean",
|
|
1856
|
+
"default": "false",
|
|
1857
|
+
"description": "Whether the component should be rendered as a child component."
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"name": "instance",
|
|
1861
|
+
"type": "ToasterRootInstance",
|
|
1862
|
+
"default": "",
|
|
1863
|
+
"description": "The instance to pass to the component."
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "pt",
|
|
1867
|
+
"type": "SafeRecord<ToasterRootPassThrough>",
|
|
1868
|
+
"default": "",
|
|
1869
|
+
"description": "The pass-through props to pass to the component."
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"name": "ptOptions",
|
|
1873
|
+
"type": "PassThroughOptions",
|
|
1874
|
+
"default": "",
|
|
1875
|
+
"description": "The pass-through options to pass to the component."
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
"name": "unstyled",
|
|
1879
|
+
"type": "boolean",
|
|
1880
|
+
"default": "",
|
|
1881
|
+
"description": "Whether the component should be rendered without classes."
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"name": "dt",
|
|
1885
|
+
"type": "unknown",
|
|
1886
|
+
"default": "",
|
|
1887
|
+
"description": "The design token to use for the component."
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
"name": "styles",
|
|
1891
|
+
"type": "StylesOptions<ComponentInstance>",
|
|
1892
|
+
"default": "",
|
|
1893
|
+
"description": "The styles to use for the component."
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
"name": "render",
|
|
1897
|
+
"type": "(instance: ToasterRootInstance) => ReactNode",
|
|
1898
|
+
"default": "",
|
|
1899
|
+
"description": "The render function to render the component with instance access."
|
|
1900
|
+
},
|
|
1901
|
+
{
|
|
1902
|
+
"name": "children",
|
|
1903
|
+
"type": "any",
|
|
1904
|
+
"default": "",
|
|
1905
|
+
"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."
|
|
1906
|
+
},
|
|
1907
|
+
{
|
|
1908
|
+
"name": "position",
|
|
1909
|
+
"type": "ToasterPosition",
|
|
1910
|
+
"default": "'top-right'",
|
|
1911
|
+
"description": "Position of the toaster container"
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"name": "mode",
|
|
1915
|
+
"type": "ToasterMode",
|
|
1916
|
+
"default": "'stacked'",
|
|
1917
|
+
"description": "Layout mode of the toaster."
|
|
1918
|
+
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "limit",
|
|
1921
|
+
"type": "number",
|
|
1922
|
+
"default": "3",
|
|
1923
|
+
"description": "Maximum number of toasts to be visible"
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
"name": "gap",
|
|
1927
|
+
"type": "number",
|
|
1928
|
+
"default": "14",
|
|
1929
|
+
"description": "Gap between toasts in pixels"
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"name": "timeout",
|
|
1933
|
+
"type": "number",
|
|
1934
|
+
"default": "6000",
|
|
1935
|
+
"description": "Timeout for toast auto-dismiss (alias for duration)"
|
|
1936
|
+
},
|
|
1937
|
+
{
|
|
1938
|
+
"name": "group",
|
|
1939
|
+
"type": "string",
|
|
1940
|
+
"default": "",
|
|
1941
|
+
"description": "Group identifier for toast grouping"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"name": "[key: string]",
|
|
1945
|
+
"type": "any",
|
|
1946
|
+
"description": ""
|
|
1947
|
+
},
|
|
1948
|
+
{
|
|
1949
|
+
"name": "pt-{optionName}-*",
|
|
1950
|
+
"type": "-",
|
|
1951
|
+
"default": "",
|
|
1952
|
+
"description": "Pass through attributes for customizing component parts.",
|
|
1953
|
+
"deprecated": false
|
|
1954
|
+
}
|
|
1955
|
+
],
|
|
1956
|
+
"methods": []
|
|
1957
|
+
},
|
|
1958
|
+
"ToasterRootState": {
|
|
1959
|
+
"description": "Defines valid state in Toaster component.",
|
|
1960
|
+
"relatedProp": "",
|
|
1961
|
+
"extendedTypes": "UseToasterState",
|
|
1962
|
+
"props": [
|
|
1963
|
+
{
|
|
1964
|
+
"name": "isExpanded",
|
|
1965
|
+
"type": "boolean",
|
|
1966
|
+
"default": "",
|
|
1967
|
+
"description": "Whether the toaster container is expanded (showing all toasts).\nIn `single` mode this is always true; in `stacked` mode it follows hover/focus."
|
|
1968
|
+
},
|
|
1969
|
+
{
|
|
1970
|
+
"name": "isHovered",
|
|
1971
|
+
"type": "boolean",
|
|
1972
|
+
"default": "",
|
|
1973
|
+
"description": "Whether the user is currently hovering or has focus within the toast region.\nUsed to pause auto-dismiss timers independently of the visual expanded state."
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"name": "isInteracting",
|
|
1977
|
+
"type": "boolean",
|
|
1978
|
+
"default": "",
|
|
1979
|
+
"description": "Whether user is currently interacting with toasts"
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"name": "heights",
|
|
1983
|
+
"type": "{ toastId: ToastId; height: number }[]",
|
|
1984
|
+
"default": "",
|
|
1985
|
+
"description": "Cached heights of rendered toasts for stacking calculations"
|
|
1986
|
+
}
|
|
1987
|
+
],
|
|
1988
|
+
"methods": []
|
|
1989
|
+
},
|
|
1990
|
+
"ToasterRootExposes": {
|
|
1991
|
+
"description": "Defines the methods and properties exposed by Toaster Root component.",
|
|
1992
|
+
"relatedProp": "",
|
|
1993
|
+
"extendedTypes": "UseToasterExposes",
|
|
1994
|
+
"props": [
|
|
1995
|
+
{
|
|
1996
|
+
"name": "toasts",
|
|
1997
|
+
"type": "ToastType[]",
|
|
1998
|
+
"default": "",
|
|
1999
|
+
"description": "Array of filtered toasts for the current group"
|
|
2000
|
+
},
|
|
2001
|
+
{
|
|
2002
|
+
"name": "rootProps",
|
|
2003
|
+
"type": "Record<string, unknown>",
|
|
2004
|
+
"default": "",
|
|
2005
|
+
"description": "Pre-built props for the toaster root element"
|
|
2006
|
+
},
|
|
2007
|
+
{
|
|
2008
|
+
"name": "regionProps",
|
|
2009
|
+
"type": "Record<string, unknown>",
|
|
2010
|
+
"default": "",
|
|
2011
|
+
"description": "Pre-built props for the toaster region element"
|
|
2012
|
+
},
|
|
2013
|
+
{
|
|
2014
|
+
"name": "onRegionMouseEnter",
|
|
2015
|
+
"type": "() => void",
|
|
2016
|
+
"default": "",
|
|
2017
|
+
"description": "Handler for mouse enter on the toast region"
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
"name": "onRegionMouseMove",
|
|
2021
|
+
"type": "() => void",
|
|
2022
|
+
"default": "",
|
|
2023
|
+
"description": "Handler for mouse move on the toast region"
|
|
2024
|
+
},
|
|
2025
|
+
{
|
|
2026
|
+
"name": "onRegionMouseLeave",
|
|
2027
|
+
"type": "() => void",
|
|
2028
|
+
"default": "",
|
|
2029
|
+
"description": "Handler for mouse leave on the toast region"
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"name": "onRegionDragEnd",
|
|
2033
|
+
"type": "() => void",
|
|
2034
|
+
"default": "",
|
|
2035
|
+
"description": "Handler for drag end on the toast region"
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
"name": "onRegionPointerDown",
|
|
2039
|
+
"type": "(event: PointerEvent) => void",
|
|
2040
|
+
"default": "",
|
|
2041
|
+
"description": "Handler for pointer down on the toast region"
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"name": "onRegionPointerUp",
|
|
2045
|
+
"type": "() => void",
|
|
2046
|
+
"default": "",
|
|
2047
|
+
"description": "Handler for pointer up on the toast region"
|
|
2048
|
+
},
|
|
2049
|
+
{
|
|
2050
|
+
"name": "onRegionFocus",
|
|
2051
|
+
"type": "(event: FocusEvent<HTMLElement>) => void",
|
|
2052
|
+
"default": "",
|
|
2053
|
+
"description": "Handler for focus events within the toast region"
|
|
2054
|
+
},
|
|
2055
|
+
{
|
|
2056
|
+
"name": "onRegionBlur",
|
|
2057
|
+
"type": "(event: FocusEvent<HTMLElement>) => void",
|
|
2058
|
+
"default": "",
|
|
2059
|
+
"description": "Handler for blur events leaving the toast region"
|
|
2060
|
+
},
|
|
2061
|
+
{
|
|
2062
|
+
"name": "setHeights",
|
|
2063
|
+
"type": "Dispatch<SetStateAction<{ height: number; toastId: ToastId }[]>>",
|
|
2064
|
+
"default": "",
|
|
2065
|
+
"description": "Function to update the heights state"
|
|
2066
|
+
},
|
|
2067
|
+
{
|
|
2068
|
+
"name": "removeFromQueue",
|
|
2069
|
+
"type": "(id: ToastId) => void",
|
|
2070
|
+
"default": "",
|
|
2071
|
+
"description": "Marks a toast as removed in the toaster's local queue. Called by the\nper-toast hook after its exit animation completes; the toast is then\nfiltered out of the rendered list."
|
|
2072
|
+
},
|
|
2073
|
+
{
|
|
2074
|
+
"name": "handleFocusManagement",
|
|
2075
|
+
"type": "(toastElement: HTMLElement) => void",
|
|
2076
|
+
"default": "",
|
|
2077
|
+
"description": "Handler for managing focus when a toast is dismissed"
|
|
2078
|
+
},
|
|
2079
|
+
{
|
|
2080
|
+
"name": "toaster",
|
|
2081
|
+
"type": "ToasterRootInstance",
|
|
2082
|
+
"default": "",
|
|
2083
|
+
"description": "Reference to the parent Toaster instance."
|
|
2084
|
+
}
|
|
2085
|
+
],
|
|
2086
|
+
"methods": []
|
|
2087
|
+
}
|
|
2088
|
+
},
|
|
2089
|
+
"types": {
|
|
2090
|
+
"ToasterRootPassThroughType": {
|
|
2091
|
+
"description": "Defines passthrough(pt) options type in Toaster component.",
|
|
2092
|
+
"values": "PassThroughType<ToasterRootInstance, E>"
|
|
2093
|
+
},
|
|
2094
|
+
"ToasterRootInstance": {
|
|
2095
|
+
"description": "Instance of Toaster Root component.",
|
|
2096
|
+
"values": "ComponentInstance<ToasterRootProps, ToasterRootState, ToasterRootExposes>"
|
|
2097
|
+
}
|
|
2098
|
+
},
|
|
2099
|
+
"variables": {}
|
|
2100
|
+
}
|
|
2101
|
+
}
|
|
2102
|
+
]
|