CheckBox
Gen UI 2.0 standardA checkbox with a label. Bind value with { "@path": "/x" } to read its state, true or false.
One of the 69 components in CopilotKit's standardUI. The playground's catalog extends it, so every agent here can use CheckBox. 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.
| Prop | Type | Required | Description |
|---|---|---|---|
| label | string | No | The label text. Always set it |
| value | boolean | No | True when checked. Bind it with { "@path": "/x" } to read the state of the box |
| checks | { condition?, message? }[] | No | Validation rules. The control shows the first failed one |
| name | string | No | - |
| disabled | boolean | No | - |
| required | boolean | No | - |
| shape | "round" | "square" | No | Default "round" |
| weight | number | No | flex-grow in a Row or Column |
| lineThrough | boolean | No | Default false. Strikes the label when the box is checked |