Skip to content

SegmentedControl

Gen UI 2.0 standard

A row of segments. The user chooses one option. Use it for 2 to 5 short options. Bind value with { "@path": "/x" } to read it.

One of the 69 components in CopilotKit's standardUI. The playground's catalog extends it, so every agent here can use SegmentedControl. 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
labelstringNoThe visible label of the field. Always set it
options(string | { value, label?, description? })[]No-
valuestringNoBind it with { "@path": "/x" } to read what the user entered
checks{ condition?, message? }[]NoValidation rules. The control shows the first failed one
blockbooleanNoFull width
variant"solid" | "soft" | "outline" | "ghost"NoDefault "ghost"
disabledbooleanNo-
size"sm" | "md" | "lg" | "xl"NoDefault "lg"
pillbooleanNoDefault true