Skip to content

List

Gen UI 2.0 standard

A list in a Card or next to another component; a plain list of text is markdown. Give "items": an item with a value and no action is a key-value row (Price: $1,599). Or give "children": ListItem ids or a template. With "action" the user picks an item; the event context gets its index, label and value.

One of the 69 components in CopilotKit's standardUI. The playground's catalog extends it, so every agent here can use List. 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
items(string | { label, description?, icon?, value? })[]No-
childrenstring[] | { componentId, path }NoIds of child components, or a template { componentId, path } over a data list.
actionAction (event or functionCall)NoRuns when the user picks an item. The args are the index, label and value of the item.
direction"vertical" | "horizontal"NoDefault "vertical". "horizontal" scrolls sideways
marker"bullet" | "number" | "rich" | "none"NoDefault "bullet"
connector"none" | "solid"NoDefault "none"
startnumberNoThe first number of marker "number"
maxMarkerSizenumberNoThe width of the marker column in pixels
align"start" | "center" | "end" | "stretch"No-
weightnumberNoflex-grow in a Row or Column
gapnumber | stringNo-