Skip to content

CarouselMediaItem

Gen UI 2.0 standard

A Carousel slide: an image with its children (a Caption, a Text) under it. size "sm" 160px, "md" 240px (default), "lg" 320px wide. A click opens all slides full-screen, unless href or onClick is set.

One of the 69 components in CopilotKit's standardUI. The playground's catalog extends it, so every agent here can use CarouselMediaItem. Standard catalog docs

Props

Read from standardUI.manifestComponents in the installed @copilotkit/react-core. In A2UI 1.0 any value may also be a { "@path" } binding into the surface data model or a { "@call" } function call.

PropTypeRequiredDescription
urlstringYesImage URL
childrenstring[] | { componentId, path }NoIds of child components, or a template { componentId, path } over a data list.
onClickAction (event or functionCall)NoSent when the user clicks the image. It replaces the full-screen view.
descriptionstringNoWhat the image shows, for screen readers
hrefstringNoOpens this URL in a new tab
lightboxbooleanNoDefault true: a click opens all slides full-screen
onVisibleAction (event or functionCall)NoSent once, the first time the container scrolls into view. Use it to load more content lazily.
align"start" | "center" | "end" | "baseline" | "stretch"No-
justify"start" | "center" | "end" | "spaceBetween" | "spaceAround" | "spaceEvenly" | ...No-
wrap"nowrap" | "wrap" | "wrap-reverse"No-
gapnumber | stringNo4px steps when a number
rowGapnumber | stringNo-
columnGapnumber | stringNo-
paddingnumber | stringNo4px steps when a number
backgroundstringNoLeave it unset. A surface token such as surface, surface-secondary, info, success, warning, danger, discovery, or one with -solid, or a CSS color. Only one summary panel in a Card uses "surface-secondary"
borderbooleanNo-
borderColor"default" | "subtle" | "strong" | "info" | "warning" | "caution" | ...No-
radius"2xs" | "xs" | "sm" | "md" | "lg" | "xl" | ... | number | string | { topLeft?, topRight?, bottomLeft?, bottomRight? }No-
widthnumber | stringNo-
heightnumber | stringNo-
minWidthnumber | stringNo-
maxWidthnumber | stringNo-
minHeightnumber | stringNo-
maxHeightnumber | stringNo-
flexnumberNo-
weightnumberNoflex-grow in a Row or Column
aspectRatiostringNoDefault "4 / 3"
scrollablebooleanNo-
clipbooleanNo-
shadowbooleanNo-
inlinebooleanNo-
rolestringNoARIA role
flushbooleanNoNo padding
minSizenumber | stringNoMinimum width and height
maxSizenumber | stringNoMaximum width and height
disableAutoSpacingbooleanNoNo default gap between children
size"sm" | "md" | "lg"NoThe width: "sm" 160px, "md" 240px, "lg" 320px. Default "md"