A2uiBasicCatalogV1

Artifact: androidx.a2ui.compose:compose-ui

class 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.

This class is intended to support the Basic Catalog specification 1.0 defined in https://a2ui.org/specification/v1_0/catalogs/basic/catalog.json, support for it is planned.

This class acts as the API contract for any design system (e.g. Material 3, Jetpack Compose Glimmer, TV Compose) wishing to implement the basic catalog specification.

Summary

Nested types
`class A2uiBasicCatalogV1.AccessibilityAttributes` Attributes to enhance accessibility of the A2UI Basic Catalog components when using assistive technologies like screen readers.
`interface A2uiBasicCatalogV1.AudioPlayer : A2uiComponent` The A2UI `"AudioPlayer"` component for playing audio content from a URL.
`interface A2uiBasicCatalogV1.Button : A2uiComponent` The A2UI `"Button"` component for clickable buttons that dispatch actions.
`enum A2uiBasicCatalogV1.Button.Variant : Enum` Visual style variant for a `Button`.
`interface A2uiBasicCatalogV1.Card : A2uiComponent` The A2UI `"Card"` component for displaying content in a styled container.
`interface A2uiBasicCatalogV1.CheckBox : A2uiComponent` The A2UI `"CheckBox"` component for displaying a checkable control with an associated label.
`class A2uiBasicCatalogV1.CheckRule` Holds the evaluated result of a client-side validation rule.
`interface A2uiBasicCatalogV1.ChoicePicker : A2uiComponent` The A2UI `"ChoicePicker"` component for selecting one or more options from a list.
`enum A2uiBasicCatalogV1.ChoicePicker.DisplayStyle : Enum` Display style for a `ChoicePicker`.
`class A2uiBasicCatalogV1.ChoicePicker.Option` A selectable option within a `ChoicePicker` component.
`enum A2uiBasicCatalogV1.ChoicePicker.Variant : Enum` Selection behavior variant for a `ChoicePicker`.
`interface A2uiBasicCatalogV1.Column : A2uiComponent` The A2UI `"Column"` component for arranging children vertically.
`enum A2uiBasicCatalogV1.Column.Align : Enum` Alignment of children along the cross axis of a `Column`.
`enum A2uiBasicCatalogV1.Column.Justify : Enum` Arrangement of children along the main axis of a `Column`.
`interface A2uiBasicCatalogV1.DateTimeInput : A2uiComponent` The A2UI `"DateTimeInput"` component for selecting date and/or time.
`interface A2uiBasicCatalogV1.Divider : A2uiComponent` The A2UI `"Divider"` component for displaying a horizontal or vertical dividing line.
`enum A2uiBasicCatalogV1.Divider.Axis : Enum` Orientation of a `Divider`.
`interface A2uiBasicCatalogV1.Icon : A2uiComponent` The A2UI `"Icon"` component for displaying an icon.
`enum A2uiBasicCatalogV1.Icon.BuiltIn : Enum, A2uiBasicCatalogV1.Icon.Source` Built-in icon token for an `Icon`.
`sealed interface A2uiBasicCatalogV1.Icon.Source` The visual source for the `Icon`.
`class A2uiBasicCatalogV1.Icon.SvgPath : A2uiBasicCatalogV1.Icon.Source` An `Icon` drawn from a client-provided SVG path rather than a `BuiltIn` token.
`class A2uiBasicCatalogV1.Icon.Unrecognized : A2uiBasicCatalogV1.Icon.Source` An `Icon` named by a string that matches no predefined `BuiltIn` token.
`interface A2uiBasicCatalogV1.Image : A2uiComponent` The A2UI `"Image"` component for displaying an image from a URL.
`enum A2uiBasicCatalogV1.Image.Fit : Enum` Resizing behavior for an `Image` within its container.
`enum A2uiBasicCatalogV1.Image.Variant : Enum` Size and style variant for an `Image`.
`interface A2uiBasicCatalogV1.List : A2uiComponent` The A2UI `"List"` component for displaying a scrollable list of components.
`enum A2uiBasicCatalogV1.List.Align : Enum` Alignment of children along the cross axis of a `List`.
`enum A2uiBasicCatalogV1.List.Direction : Enum` Layout direction of the items in a `List`.
`interface A2uiBasicCatalogV1.Modal : A2uiComponent` The A2UI `"Modal"` component for displaying a dialog window.
`interface A2uiBasicCatalogV1.Row : A2uiComponent` The A2UI `"Row"` component for displaying content in a horizontal layout.
`enum A2uiBasicCatalogV1.Row.Align : Enum` Alignment of children along the cross axis of a `Row`.
`enum A2uiBasicCatalogV1.Row.Justify : Enum` Arrangement of children along the main axis of a `Row`.
`interface A2uiBasicCatalogV1.Slider : A2uiComponent` The A2UI `"Slider"` component for selecting a numeric value within a range.
`interface A2uiBasicCatalogV1.Tabs : A2uiComponent` The A2UI `"Tabs"` component for displaying a set of tabs.
`class A2uiBasicCatalogV1.Tabs.Tab` A resolved tab within a `Tabs` component.
`interface A2uiBasicCatalogV1.Text : A2uiComponent` The A2UI `"Text"` component for displaying text.
`enum A2uiBasicCatalogV1.Text.Variant : Enum` Typography style variant for a `Text`.
`interface A2uiBasicCatalogV1.TextField : A2uiComponent` The A2UI `"TextField"` component for user text input.
`enum A2uiBasicCatalogV1.TextField.Variant : Enum` Input style variant for a `TextField`.
`interface A2uiBasicCatalogV1.Video : A2uiComponent` The A2UI `"Video"` component for displaying a video from a URL.

Constants
`const String`	`CatalogId` The catalog ID for the A2UI Basic Catalog V1.

Public companion properties
`A2uiSchema`	`ThemeSchema` The standard theme schema for the A2UI Basic Catalog V1.
`StaticA2uiProperty<Number>`	`WeightProperty` The relative weight property for `A2uiBasicCatalogV1` components.

Public constructors
A2uiBasicCatalogV1( text: A2uiBasicCatalogV1.Text, image: A2uiBasicCatalogV1.Image, icon: A2uiBasicCatalogV1.Icon, video: A2uiBasicCatalogV1.Video, audioPlayer: A2uiBasicCatalogV1.AudioPlayer, row: A2uiBasicCatalogV1.Row, column: A2uiBasicCatalogV1.Column, list: A2uiBasicCatalogV1.List, card: A2uiBasicCatalogV1.Card, tabs: A2uiBasicCatalogV1.Tabs, modal: A2uiBasicCatalogV1.Modal, divider: A2uiBasicCatalogV1.Divider, button: A2uiBasicCatalogV1.Button, textField: A2uiBasicCatalogV1.TextField, checkBox: A2uiBasicCatalogV1.CheckBox, choicePicker: A2uiBasicCatalogV1.ChoicePicker, slider: A2uiBasicCatalogV1.Slider, dateTimeInput: A2uiBasicCatalogV1.DateTimeInput, functions: List<A2uiFunction> )

Public constructors

A2uiBasicCatalogV1(
    text: A2uiBasicCatalogV1.Text,
    image: A2uiBasicCatalogV1.Image,
    icon: A2uiBasicCatalogV1.Icon,
    video: A2uiBasicCatalogV1.Video,
    audioPlayer: A2uiBasicCatalogV1.AudioPlayer,
    row: A2uiBasicCatalogV1.Row,
    column: A2uiBasicCatalogV1.Column,
    list: A2uiBasicCatalogV1.List,
    card: A2uiBasicCatalogV1.Card,
    tabs: A2uiBasicCatalogV1.Tabs,
    modal: A2uiBasicCatalogV1.Modal,
    divider: A2uiBasicCatalogV1.Divider,
    button: A2uiBasicCatalogV1.Button,
    textField: A2uiBasicCatalogV1.TextField,
    checkBox: A2uiBasicCatalogV1.CheckBox,
    choicePicker: A2uiBasicCatalogV1.ChoicePicker,
    slider: A2uiBasicCatalogV1.Slider,
    dateTimeInput: A2uiBasicCatalogV1.DateTimeInput,
    functions: List<A2uiFunction>
)

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`A2uiBasicCatalogV1.AudioPlayer`	`audioPlayer` the `AudioPlayer` component implementation
`A2uiBasicCatalogV1.Button`	`button` the `Button` component implementation
`A2uiBasicCatalogV1.Card`	`card` the `Card` component implementation
`String`	`catalogId` The unique identifier for this catalog.
`A2uiBasicCatalogV1.CheckBox`	`checkBox` the `CheckBox` component implementation
`A2uiBasicCatalogV1.ChoicePicker`	`choicePicker` the `ChoicePicker` component implementation
`A2uiBasicCatalogV1.Column`	`column` the `Column` component implementation
`List<A2uiComponent>`	`components` The list of `A2uiComponent`s supported by this catalog.
`A2uiBasicCatalogV1.DateTimeInput`	`dateTimeInput` the `DateTimeInput` component implementation
`A2uiBasicCatalogV1.Divider`	`divider` the `Divider` component implementation
`List<A2uiFunction>`	`functions` the list of `A2uiFunction`s supported by this catalog, recommended default is to create the function list using `androidx.a2ui.model.catalog.basiccatalog.createBasicCatalogFunctions`
`A2uiBasicCatalogV1.Icon`	`icon` the `Icon` component implementation
`A2uiBasicCatalogV1.Image`	`image` the `Image` component implementation
`A2uiBasicCatalogV1.List`	`list` the `List` component implementation
`A2uiBasicCatalogV1.Modal`	`modal` the `Modal` component implementation
`A2uiBasicCatalogV1.Row`	`row` the `Row` component implementation
`A2uiBasicCatalogV1.Slider`	`slider` the `Slider` component implementation
`A2uiBasicCatalogV1.Tabs`	`tabs` the `Tabs` component implementation
`A2uiBasicCatalogV1.Text`	`text` the `Text` component implementation
`A2uiBasicCatalogV1.TextField`	`textField` the `TextField` component implementation
`A2uiSchema`	`themeSchema` The `A2uiSchema` defining the dynamic theme schema for this catalog.
`A2uiBasicCatalogV1.Video`	`video` the `Video` component implementation

Extension functions
`A2uiCatalog`	`A2uiBasicCatalogV1.toA2uiCatalog(isInline: Boolean)` Converts this basic catalog into an `A2uiCatalog` holding the catalog definitions.

Constants

CatalogId

const val CatalogId: String

The catalog ID for the A2UI Basic Catalog V1.

A2uiBasicCatalogV1

Summary

Nested types

Constants

Public companion properties

Public constructors

Public functions

Public properties

Extension functions

Constants

CatalogId

Public companion properties

ThemeSchema

WeightProperty

Public constructors