Skip to content

TextField

Gen UI 2.0 standard

A text input, single-line unless variant is "longText". Bind value with { "@path": "/x" } to read what the user typed. 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 TextField. 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
valuestring | numberNoBind it with { "@path": "/x" } to read what the user typed
checks{ condition?, message? }[]NoValidation rules. The control shows the first failed one
placeholderstringNo-
variant"shortText" | "longText" | "number" | "obscured" | "email" | "url" | ...NoDefault "shortText". "longText" is a multi-line field, "obscured" a password
namestringNo-
requiredbooleanNo-
disabledbooleanNo-
invalidbooleanNo-
autoSelectbooleanNo-
maskstringNo-
weightnumberNoflex-grow in a Row or Column
size"sm" | "md" | "lg" | "xl"NoDefault "xl"
pillbooleanNoDefault true