A2uiBasicCatalogV1.Button
interface A2uiBasicCatalogV1.Button : A2uiComponent
The A2UI "Button" component for clickable buttons that dispatch actions.
Schema Properties:
-
accessibility(Dynamic Custom, optional): Accessibility attributes for the button. -
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. SeeWeightProperty. -
checks(Dynamic Custom, optional): Client-side check validation rules for the button. SeeCheckRule. -
child(Component ID String, required): The ID of the child component inside the button (e.g., a"Text"or"Icon"component). -
variant(String Enum, optional): A hint for the button style. This is a static configuration and does not support dynamic data bindings. Valid options:"default","primary","borderless". Defaults to"default". -
action(Action Object, required): The action payload dispatched when the button is clicked.
Summary
Nested types |
|---|
|
Visual style variant for a |
Public companion properties |
|
|---|---|
DynamicA2uiProperty<A2uiBasicCatalogV1.AccessibilityAttributes> |
The |
StaticA2uiProperty<Map<String, Any?>> |
The |
DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>> |
The |
StaticA2uiProperty<String> |
The |
StaticA2uiProperty<A2uiBasicCatalogV1.Button.Variant> |
The |
Public functions |
|
|---|---|
open Unit |
@ComposableEmits the UI for this component. |
Unit |
@ComposableRenders the |
open Boolean |
@ComposableDetermines 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., |
open List<A2uiProperty<*>> |
The list of typed properties expected by this component. |
Public companion properties
AccessibilityProperty
val AccessibilityProperty: DynamicA2uiProperty<A2uiBasicCatalogV1.AccessibilityAttributes>
The A2uiProperty for the "accessibility" property of a Button.
ActionProperty
val ActionProperty: StaticA2uiProperty<Map<String, Any?>>
The A2uiProperty for the "action" property of a Button.
ChecksProperty
val ChecksProperty: DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>>
The A2uiProperty for the "checks" property of a Button. See CheckRule.
ChildProperty
val ChildProperty: StaticA2uiProperty<String>
The A2uiProperty for the "child" property of a Button.
VariantProperty
val VariantProperty: StaticA2uiProperty<A2uiBasicCatalogV1.Button.Variant>
The A2uiProperty for the "variant" property of a Button.
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 |
A2uiComponentScope.TypedContent
@Composable
fun A2uiComponentScope.TypedContent(
childId: String,
variant: A2uiBasicCatalogV1.Button.Variant,
action: Map<String, Any?>,
accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?,
checks: List<A2uiBasicCatalogV1.CheckRule>,
modifier: Modifier
): Unit
Renders the Button with its resolved property values.
| Parameters | |
|---|---|
childId: String |
ID of the child component to render inside this button |
variant: A2uiBasicCatalogV1.Button.Variant |
|
action: Map<String, Any?> |
action payload |
accessibility: A2uiBasicCatalogV1.AccessibilityAttributes? |
accessibility attributes for the button |
checks: List<A2uiBasicCatalogV1.CheckRule> |
validation rules for this button. When any |
modifier: Modifier |
|
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 |
|
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:
-
To automatically generate the component's JSON schema for the agent.
-
To serve as type-safe tokens for extracting payloads or resolving dynamic data bindings from
A2uiComponentPropertiesat runtime.