Text Field

IntroductionLinked dataHuman and agentComponents

Controls / TextField

Collect a short piece of editable text.

Live exampleHow it worksSkill

When to use it

Collect a short piece of editable text.

What the agent supplies

A single- or multi-line text input.

The agent chooses the content and binds it to the component. CLIO then renders the view and its available controls.

What the agent receives

The exact output of load_skill, including resolved local definitions.

load_skill("a2ui-catalog-basic", file="catalog.json#/components/TextField")

{
  "type": "object",
  "allOf": [
    {
      "$ref": "https://a2ui.org/specification/v0_9/common_types.json#/$defs/ComponentCommon"
    },
    {
      "type": "object",
      "properties": {
        "weight": {
          "type": "number",
          "description": "The relative weight of this component within a Row or Column. This is similar to the CSS 'flex-grow' property. Note: this may ONLY be set when the component is a direct descendant of a Row or Column."
        }
      }
    },
    {
      "$ref": "https://a2ui.org/specification/v0_9/common_types.json#/$defs/Checkable"
    },
    {
      "type": "object",
      "properties": {
        "component": {
          "const": "TextField"
        },
        "label": {
          "$ref": "https://a2ui.org/specification/v0_9/common_types.json#/$defs/DynamicString",
          "description": "The text label for the input field."
        },
        "value": {
          "$ref": "https://a2ui.org/specification/v0_9/common_types.json#/$defs/DynamicString",
          "description": "The value of the text field."
        },
        "variant": {
          "type": "string",
          "description": "The type of input field to display.",
          "enum": [
            "longText",
            "number",
            "shortText",
            "obscured"
          ],
          "default": "shortText"
        },
        "validationRegexp": {
          "type": "string",
          "description": "A regular expression used for client-side validation of the input."
        }
      },
      "required": [
        "component",
        "label"
      ]
    }
  ],
  "unevaluatedProperties": false
}

Standard refs (not loadable here): https://a2ui.org/specification/v0_9/common_types.json#/$defs/Checkable, https://a2ui.org/specification/v0_9/common_types.json#/$defs/ComponentCommon, https://a2ui.org/specification/v0_9/common_types.json#/$defs/DynamicString