androidx.a2ui.compose.ui.catalog

Interfaces

A2uiBasicCatalogV1.AudioPlayer

The A2UI "AudioPlayer" component for playing audio content from a URL.

A2uiBasicCatalogV1.Button

The A2UI "Button" component for clickable buttons that dispatch actions.

A2uiBasicCatalogV1.Card

The A2UI "Card" component for displaying content in a styled container.

A2uiBasicCatalogV1.CheckBox

The A2UI "CheckBox" component for displaying a checkable control with an associated label.

A2uiBasicCatalogV1.ChoicePicker

The A2UI "ChoicePicker" component for selecting one or more options from a list.

A2uiBasicCatalogV1.Column

The A2UI "Column" component for arranging children vertically.

A2uiBasicCatalogV1.DateTimeInput

The A2UI "DateTimeInput" component for selecting date and/or time.

A2uiBasicCatalogV1.Divider

The A2UI "Divider" component for displaying a horizontal or vertical dividing line.

A2uiBasicCatalogV1.Icon

The A2UI "Icon" component for displaying an icon.

A2uiBasicCatalogV1.Icon.Source

The visual source for the Icon.

A2uiBasicCatalogV1.Image

The A2UI "Image" component for displaying an image from a URL.

A2uiBasicCatalogV1.List

The A2UI "List" component for displaying a scrollable list of components.

A2uiBasicCatalogV1.Modal

The A2UI "Modal" component for displaying a dialog window.

A2uiBasicCatalogV1.Row

The A2UI "Row" component for displaying content in a horizontal layout.

A2uiBasicCatalogV1.Slider

The A2UI "Slider" component for selecting a numeric value within a range.

A2uiBasicCatalogV1.Tabs

The A2UI "Tabs" component for displaying a set of tabs.

A2uiBasicCatalogV1.Text

The A2UI "Text" component for displaying text.

A2uiBasicCatalogV1.TextField

The A2UI "TextField" component for user text input.

A2uiBasicCatalogV1.Video

The A2UI "Video" component for displaying a video from a URL.

Classes

A2uiBasicCatalogV1

Defines the API contract and schemas for the A2UI Basic Catalog V1 following the specification in https://a2ui.org/specification/v0_9/catalogs/basic/catalog.json.

A2uiBasicCatalogV1.AccessibilityAttributes

Attributes to enhance accessibility of the A2UI Basic Catalog components when using assistive technologies like screen readers.

A2uiBasicCatalogV1.CheckRule

Holds the evaluated result of a client-side validation rule.

A2uiBasicCatalogV1.ChoicePicker.Option

A selectable option within a ChoicePicker component.

A2uiBasicCatalogV1.Icon.SvgPath

An Icon drawn from a client-provided SVG path rather than a BuiltIn token.

A2uiBasicCatalogV1.Icon.Unrecognized

An Icon named by a string that matches no predefined BuiltIn token.

A2uiBasicCatalogV1.Tabs.Tab

A resolved tab within a Tabs component.

Enums

A2uiBasicCatalogV1.Button.Variant

Visual style variant for a Button.

A2uiBasicCatalogV1.ChoicePicker.DisplayStyle

Display style for a ChoicePicker.

A2uiBasicCatalogV1.ChoicePicker.Variant

Selection behavior variant for a ChoicePicker.

A2uiBasicCatalogV1.Column.Align

Alignment of children along the cross axis of a Column.

A2uiBasicCatalogV1.Column.Justify

Arrangement of children along the main axis of a Column.

A2uiBasicCatalogV1.Divider.Axis

Orientation of a Divider.

A2uiBasicCatalogV1.Icon.BuiltIn

Built-in icon token for an Icon.

A2uiBasicCatalogV1.Image.Fit

Resizing behavior for an Image within its container.

A2uiBasicCatalogV1.Image.Variant

Size and style variant for an Image.

A2uiBasicCatalogV1.List.Align

Alignment of children along the cross axis of a List.

A2uiBasicCatalogV1.List.Direction

Layout direction of the items in a List.

A2uiBasicCatalogV1.Row.Align

Alignment of children along the cross axis of a Row.

A2uiBasicCatalogV1.Row.Justify

Arrangement of children along the main axis of a Row.

A2uiBasicCatalogV1.Text.Variant

Typography style variant for a Text.

A2uiBasicCatalogV1.TextField.Variant

Input style variant for a TextField.

Extension functions summary

A2uiCatalog

Converts this basic catalog into an A2uiCatalog holding the catalog definitions.

Extension functions

A2uiBasicCatalogV1.toA2uiCatalog

fun A2uiBasicCatalogV1.toA2uiCatalog(isInline: Boolean = false): A2uiCatalog

Converts this basic catalog into an A2uiCatalog holding the catalog definitions.

Parameters
isInline: Boolean = false

whether this catalog's schema should be serialized inline as part of the capabilities advertisement sent to the agent

Returns
A2uiCatalog

a fully initialized A2uiCatalog