Skip to content

ChoicePicker

Gen UI 2.0 standard

Options as checkboxes or chips: pick one, or several with variant "multipleSelection". Its value is the list of chosen values. Give it a label.

One of the 69 components in CopilotKit's standardUI. The playground's catalog extends it, so every agent here can use ChoicePicker. 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-
valuestring[]NoThe chosen option values. Bind it with { "@path": "/x" } to a string list
checks{ condition?, message? }[]NoValidation rules. The control shows the first failed one
variant"multipleSelection" | "mutuallyExclusive"NoDefault "mutuallyExclusive": the user picks one option
displayStyle"checkbox" | "chips"NoDefault "checkbox". "chips" shows the options as pills
filterablebooleanNoDefault false. Shows a field that filters the options
disabledbooleanNo-
requiredbooleanNo-
weightnumberNoflex-grow in a Row or Column