A2uiBasicCatalogV1.TextField

interface A2uiBasicCatalogV1.TextField : A2uiComponent

The A2UI "TextField" component for user text input.

Schema Properties:

  • accessibility (Dynamic Custom, optional): Accessibility attributes for the text field.

  • weight (Number, optional): The relative weight of the component within a Row or Column. May only be set when the component is a direct descendant of a Row or Column. See WeightProperty.

  • checks (Dynamic Custom, optional): Client-side check validation rules for the text field. See CheckRule.

  • label (Dynamic String, required): The text label for the input field.

  • value (Dynamic String, optional): The value of the text field.

  • variant (String Enum, optional): The type of input field to display. Valid options: "longText", "number", "shortText", "obscured". Defaults to "shortText".

  • validationRegexp (String, optional): A regular expression used for client-side validation of the input.

Summary

Nested types

Input style variant for a TextField.

Public companion properties
DynamicA2uiProperty<A2uiBasicCatalogV1.AccessibilityAttributes>

The A2uiProperty for the "accessibility" property of a TextField.
DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>>

The A2uiProperty for the "checks" property of a TextField.
DynamicA2uiProperty<String>

The A2uiProperty for the "label" property of a TextField.
StaticA2uiProperty<String>

The A2uiProperty for the "validationRegexp" property of a TextField.
DynamicA2uiProperty<String>

The A2uiProperty for the "value" property of a TextField.
StaticA2uiProperty<A2uiBasicCatalogV1.TextField.Variant>

The A2uiProperty for the "variant" property of a TextField.

Public functions
open Unit
@Composable
A2uiComponentScope.Content(
    properties: A2uiComponentProperties,
    modifier: Modifier
)

Emits the UI for this component.
Unit
@Composable
A2uiComponentScope.TypedContent(
    label: String,
    value: String?,
    variant: A2uiBasicCatalogV1.TextField.Variant,
    validationRegexp: String?,
    onValueChange: (String) -> Unit,
    enabled: Boolean,
    accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?,
    checks: List<A2uiBasicCatalogV1.CheckRule>,
    modifier: Modifier
)

Renders the TextField with its resolved property values.
open Boolean

Determines whether this component is ready to be rendered.

Public properties
open String

A semantic description of the component's behavior and purpose.
open String

The unique string identifier for this component type (e.g., "Text", "Button").
open List<A2uiProperty<*>>

The list of typed properties expected by this component.

Public companion properties

AccessibilityProperty

Added in 1.0.0-alpha01
val AccessibilityProperty: DynamicA2uiProperty<A2uiBasicCatalogV1.AccessibilityAttributes>

The A2uiProperty for the "accessibility" property of a TextField.

ChecksProperty

Added in 1.0.0-alpha01
val ChecksProperty: DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>>

The A2uiProperty for the "checks" property of a TextField. See CheckRule.

LabelProperty

Added in 1.0.0-alpha01
val LabelProperty: DynamicA2uiProperty<String>

The A2uiProperty for the "label" property of a TextField.

ValidationRegexpProperty

Added in 1.0.0-alpha01
val ValidationRegexpProperty: StaticA2uiProperty<String>

The A2uiProperty for the "validationRegexp" property of a TextField.

ValueProperty

Added in 1.0.0-alpha01
val ValueProperty: DynamicA2uiProperty<String>

The A2uiProperty for the "value" property of a TextField.

VariantProperty

Added in 1.0.0-alpha01
val VariantProperty: StaticA2uiProperty<A2uiBasicCatalogV1.TextField.Variant>

The A2uiProperty for the "variant" property of a TextField.

Public functions

A2uiComponentScope.Content

@Composable
open fun A2uiComponentScope.Content(
    properties: A2uiComponentProperties,
    modifier: Modifier
): Unit

Emits the UI for this component.

This function is invoked within the A2uiComponentScope, which provides access to extensions for evaluating reactive data bindings, rendering nested children, dispatching user actions, and reporting runtime errors.

Parameters
properties: A2uiComponentProperties

The stable properties wrapper from which to extract static payloads or bind dynamic data paths.
modifier: Modifier

The Modifier applied to the root of this component's layout.

A2uiComponentScope.TypedContent

@Composable
fun A2uiComponentScope.TypedContent(
    label: String,
    value: String?,
    variant: A2uiBasicCatalogV1.TextField.Variant,
    validationRegexp: String?,
    onValueChange: (String) -> Unit,
    enabled: Boolean,
    accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?,
    checks: List<A2uiBasicCatalogV1.CheckRule>,
    modifier: Modifier
): Unit

Renders the TextField with its resolved property values.

Parameters
label: String

the text label for the input field
value: String?

the current text value of the field, or null if not set
variant: A2uiBasicCatalogV1.TextField.Variant

Variant input style of the text field
validationRegexp: String?

an optional regex pattern for client-side input validation, or null if none
onValueChange: (String) -> Unit

callback invoked when the user updates the text in the field
enabled: Boolean

controls the enabled state of the text field. When false, this component will not respond to user input.
accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?

accessibility attributes for the text field
checks: List<A2uiBasicCatalogV1.CheckRule>

validation rules for this text field. When any CheckRule.condition is false, the text field should display an error state and show the failing CheckRule.message. See CheckRule.
modifier: Modifier

Modifier to apply to the layout

A2uiComponentScope.isReady

@Composable
open fun A2uiComponentScope.isReady(properties: A2uiComponentProperties): Boolean

Determines whether this component is ready to be rendered.

This is evaluated during component state resolution to determine if the component should transition from the androidx.a2ui.compose.runtime.A2uiComponentState.Loading state to the androidx.a2ui.compose.runtime.A2uiComponentState.Success state. The readiness is automatically re-evaluated when any reactive state read in this composable function changes (such as dynamic data bindings observed via properties.bind(...)).

By default, components are considered instantly ready. Override this method to support progressive rendering—for example, returning false until a required dynamic data binding (like an image URL or text string) has been successfully resolved from the surface's data model.

Parameters
properties: A2uiComponentProperties

The stable properties wrapper provided by the A2UI protocol.
Returns
Boolean

true if the component is fully ready to be composed, false if it is still loading.

Public properties

description

open val description: String

A semantic description of the component's behavior and purpose.

This is included in the generated schema to help the agent understand when and how it should output this component.

name

open val name: String

The unique string identifier for this component type (e.g., "Text", "Button").

This matches the "component" field in the A2UI protocol's component payloads and is used by the framework to route incoming payloads to this specific implementation.

Note: This name must be unique within an A2uiCatalog.

properties

open val properties: List<A2uiProperty<*>>

The list of typed properties expected by this component.

The properties serve two purposes:

  1. To automatically generate the component's JSON schema for the agent.

  2. To serve as type-safe tokens for extracting payloads or resolving dynamic data bindings from A2uiComponentProperties at runtime.