androidx.compose.material3.a2ui.catalog

Interfaces

A2uiAudioPlayerRenderer

An abstraction of an asynchronous audio player which should be implemented using the application's media loading library (such as Media3/ExoPlayer), used for rendering audio playback controls for A2uiBasicCatalogV1.AudioPlayer.
A2uiImageRenderer

An abstraction of an asynchronous image loader which should be implemented using the application's image loading library (such as Coil or Glide), used for rendering an image for A2uiBasicCatalogV1.Image.
A2uiVideoRenderer

An abstraction of an asynchronous video player which should be implemented using the application's media loading library (such as Media3/ExoPlayer), used for rendering video playback for A2uiBasicCatalogV1.Video.

Objects

MaterialA2uiBasicCatalogV1Defaults

Default component implementations for materialA2uiBasicCatalogV1.

Top-level functions summary

A2uiCatalog
materialA2uiBasicCatalogV1(
    image: A2uiBasicCatalogV1.Image,
    video: A2uiBasicCatalogV1.Video,
    audioPlayer: A2uiBasicCatalogV1.AudioPlayer,
    urlOpener: A2uiUrlOpener,
    messageFormatter: A2uiMessageFormatter,
    localeProvider: A2uiLocaleProvider,
    text: A2uiBasicCatalogV1.Text,
    icon: A2uiBasicCatalogV1.Icon,
    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
)

Creates an A2uiCatalog for the A2UI Basic Catalog V1 using Material Design 3.

Top-level functions

materialA2uiBasicCatalogV1

fun materialA2uiBasicCatalogV1(
    image: A2uiBasicCatalogV1.Image,
    video: A2uiBasicCatalogV1.Video,
    audioPlayer: A2uiBasicCatalogV1.AudioPlayer,
    urlOpener: A2uiUrlOpener,
    messageFormatter: A2uiMessageFormatter,
    localeProvider: A2uiLocaleProvider,
    text: A2uiBasicCatalogV1.Text = MaterialA2uiBasicCatalogV1Defaults.text,
    icon: A2uiBasicCatalogV1.Icon = MaterialA2uiBasicCatalogV1Defaults.icon,
    row: A2uiBasicCatalogV1.Row = MaterialA2uiBasicCatalogV1Defaults.row,
    column: A2uiBasicCatalogV1.Column = MaterialA2uiBasicCatalogV1Defaults.column,
    list: A2uiBasicCatalogV1.List = MaterialA2uiBasicCatalogV1Defaults.list,
    card: A2uiBasicCatalogV1.Card = MaterialA2uiBasicCatalogV1Defaults.card,
    tabs: A2uiBasicCatalogV1.Tabs = MaterialA2uiBasicCatalogV1Defaults.tabs,
    modal: A2uiBasicCatalogV1.Modal = MaterialA2uiBasicCatalogV1Defaults.modal,
    divider: A2uiBasicCatalogV1.Divider = MaterialA2uiBasicCatalogV1Defaults.divider,
    button: A2uiBasicCatalogV1.Button = MaterialA2uiBasicCatalogV1Defaults.button,
    textField: A2uiBasicCatalogV1.TextField = MaterialA2uiBasicCatalogV1Defaults.textField,
    checkBox: A2uiBasicCatalogV1.CheckBox = MaterialA2uiBasicCatalogV1Defaults.checkBox,
    choicePicker: A2uiBasicCatalogV1.ChoicePicker = MaterialA2uiBasicCatalogV1Defaults.choicePicker,
    slider: A2uiBasicCatalogV1.Slider = MaterialA2uiBasicCatalogV1Defaults.slider,
    dateTimeInput: A2uiBasicCatalogV1.DateTimeInput = MaterialA2uiBasicCatalogV1Defaults.dateTimeInput
): A2uiCatalog

Creates an A2uiCatalog for the A2UI Basic Catalog V1 using Material Design 3.

Provides default Material 3 implementations for all components in the A2UI Basic Catalog V1 specification, while allowing individual component implementations to be overridden.

Parameters
image: A2uiBasicCatalogV1.Image

A2uiBasicCatalogV1.Image component implementation. Use MaterialA2uiBasicCatalogV1Defaults.image to create a default Material 3 implementation with an A2uiImageRenderer
video: A2uiBasicCatalogV1.Video

A2uiBasicCatalogV1.Video component implementation. Use MaterialA2uiBasicCatalogV1Defaults.video to create a default Material 3 implementation with an A2uiVideoRenderer
audioPlayer: A2uiBasicCatalogV1.AudioPlayer

A2uiBasicCatalogV1.AudioPlayer component implementation. Use MaterialA2uiBasicCatalogV1Defaults.audioPlayer to create a default Material 3 implementation with an A2uiAudioPlayerRenderer
urlOpener: A2uiUrlOpener

A2uiUrlOpener used by catalog functions to open URLs
messageFormatter: A2uiMessageFormatter

A2uiMessageFormatter used by catalog functions to format localized messages with arguments
localeProvider: A2uiLocaleProvider

A2uiLocaleProvider used by catalog functions to determine the active locale
text: A2uiBasicCatalogV1.Text = MaterialA2uiBasicCatalogV1Defaults.text

A2uiBasicCatalogV1.Text component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.text
icon: A2uiBasicCatalogV1.Icon = MaterialA2uiBasicCatalogV1Defaults.icon

A2uiBasicCatalogV1.Icon component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.icon
row: A2uiBasicCatalogV1.Row = MaterialA2uiBasicCatalogV1Defaults.row

A2uiBasicCatalogV1.Row component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.row
column: A2uiBasicCatalogV1.Column = MaterialA2uiBasicCatalogV1Defaults.column

A2uiBasicCatalogV1.Column component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.column
list: A2uiBasicCatalogV1.List = MaterialA2uiBasicCatalogV1Defaults.list

A2uiBasicCatalogV1.List component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.list
card: A2uiBasicCatalogV1.Card = MaterialA2uiBasicCatalogV1Defaults.card

A2uiBasicCatalogV1.Card component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.card
tabs: A2uiBasicCatalogV1.Tabs = MaterialA2uiBasicCatalogV1Defaults.tabs

A2uiBasicCatalogV1.Tabs component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.tabs
modal: A2uiBasicCatalogV1.Modal = MaterialA2uiBasicCatalogV1Defaults.modal

A2uiBasicCatalogV1.Modal component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.modal
divider: A2uiBasicCatalogV1.Divider = MaterialA2uiBasicCatalogV1Defaults.divider

A2uiBasicCatalogV1.Divider component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.divider
button: A2uiBasicCatalogV1.Button = MaterialA2uiBasicCatalogV1Defaults.button

A2uiBasicCatalogV1.Button component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.button
textField: A2uiBasicCatalogV1.TextField = MaterialA2uiBasicCatalogV1Defaults.textField

A2uiBasicCatalogV1.TextField component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.textField
checkBox: A2uiBasicCatalogV1.CheckBox = MaterialA2uiBasicCatalogV1Defaults.checkBox

A2uiBasicCatalogV1.CheckBox component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.checkBox
choicePicker: A2uiBasicCatalogV1.ChoicePicker = MaterialA2uiBasicCatalogV1Defaults.choicePicker

A2uiBasicCatalogV1.ChoicePicker component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.choicePicker
slider: A2uiBasicCatalogV1.Slider = MaterialA2uiBasicCatalogV1Defaults.slider

A2uiBasicCatalogV1.Slider component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.slider
dateTimeInput: A2uiBasicCatalogV1.DateTimeInput = MaterialA2uiBasicCatalogV1Defaults.dateTimeInput

A2uiBasicCatalogV1.DateTimeInput component implementation, defaults to MaterialA2uiBasicCatalogV1Defaults.dateTimeInput
Returns
A2uiCatalog

an A2uiCatalog configured with Material 3 basic components and functions