A2uiBasicCatalogV1.Slider

Artifact: androidx.a2ui.compose:compose-ui

interface A2uiBasicCatalogV1.Slider : A2uiComponent

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

Schema Properties:

accessibility (Dynamic Custom, optional): Accessibility attributes for the slider.
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 slider. See CheckRule.
label (Dynamic String, optional): The label for the slider.
min (Number, optional): The minimum value of the slider. Defaults to 0.
max (Number, required): The maximum value of the slider.
value (Dynamic Number, required): The current value of the slider.

Summary

Public companion properties
`DynamicA2uiProperty<A2uiBasicCatalogV1.AccessibilityAttributes>`	`AccessibilityProperty` The `A2uiProperty` for the `"accessibility"` property of a `Slider`.
`DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>>`	`ChecksProperty` The `A2uiProperty` for the `"checks"` property of a `Slider`.
`DynamicA2uiProperty<String>`	`LabelProperty` The `A2uiProperty` for the `"label"` property of a `Slider`.
`StaticA2uiProperty<Number>`	`MaxProperty` The `A2uiProperty` for the `"max"` property of a `Slider`.
`StaticA2uiProperty<Number>`	`MinProperty` The `A2uiProperty` for the `"min"` property of a `Slider`.
`DynamicA2uiProperty<Number>`	`ValueProperty` The `A2uiProperty` for the `"value"` property of a `Slider`.

Public functions
`open Unit`	`@Composable A2uiComponentScope.Content( properties: A2uiComponentProperties, modifier: Modifier )` Emits the UI for this component.
`Unit`	`@Composable A2uiComponentScope.TypedContent( label: String?, min: Float, max: Float, value: Float, onValueChange: (Float) -> Unit, enabled: Boolean, accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?, checks: List<A2uiBasicCatalogV1.CheckRule>, modifier: Modifier )` Renders the `Slider` with its resolved property values.
`open Boolean`	`@Composable A2uiComponentScope.isReady(properties: A2uiComponentProperties)` Determines whether this component is ready to be rendered.

Public properties
`open String`	`description` A semantic description of the component's behavior and purpose.
`open String`	`name` The unique string identifier for this component type (e.g., `"Text"`, `"Button"`).
`open List<A2uiProperty<*>>`	`properties` 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 Slider.

ChecksProperty

Added in 1.0.0-alpha01

val ChecksProperty: DynamicA2uiProperty<List<A2uiBasicCatalogV1.CheckRule>>

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

LabelProperty

Added in 1.0.0-alpha01

val LabelProperty: DynamicA2uiProperty<String>

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

MaxProperty

Added in 1.0.0-alpha01

val MaxProperty: StaticA2uiProperty<Number>

The A2uiProperty for the "max" property of a Slider.

MinProperty

Added in 1.0.0-alpha01

val MinProperty: StaticA2uiProperty<Number>

The A2uiProperty for the "min" property of a Slider.

ValueProperty

Added in 1.0.0-alpha01

val ValueProperty: DynamicA2uiProperty<Number>

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

Public functions

A2uiComponentScope.Content

Artifact: androidx.a2ui.compose:compose-ui

View Source

@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

Artifact: androidx.a2ui.compose:compose-ui

View Source

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

Renders the Slider with its resolved property values.

Parameters
`label: String?`	the text label for the slider
`min: Float`	the minimum value of the slider
`max: Float`	the maximum value of the slider
`value: Float`	the current value of the slider
`onValueChange: (Float) -> Unit`	callback invoked when the user interacts with the slider
`enabled: Boolean`	controls the enabled state of the slider. When `false`, this component will not respond to user input.
`accessibility: A2uiBasicCatalogV1.AccessibilityAttributes?`	accessibility attributes for the slider
`checks: List<A2uiBasicCatalogV1.CheckRule>`	validation rules for this slider. When any `CheckRule.condition` is false, the slider should indicate an error state. See `CheckRule`.
`modifier: Modifier`	`Modifier` to apply to the layout

A2uiComponentScope.isReady

Artifact: androidx.a2ui.compose:compose-ui

View Source

@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:

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 A2uiComponentProperties at runtime.