ComponentScope

@Stable

What a component renderer sees: its properties resolved in its data scope, its children, two-way binding writes and action dispatch.

Properties

val component: JsonObject

fun child(prop: String = "child"): ChildRef?

The single child whose id is in prop (e.g. a Card's or Button's child).

fun children(prop: String = "children"): List<ChildRef>

The children in prop: a static id list or a template repeated over a data list.

fun dispatch(prop: String = "action")

Run the prop action: an agent event (sent with resolved context) or a local functionCall.

Messages of the failing checks (A2UI Checkable); empty when valid.

fun raw(prop: String): JsonElement?

fun ref(id: String, scope: DataContext = context): ChildRef?

A child referenced by id somewhere else in the properties (e.g. a tab's child).

@Composable

fun Render(child: ChildRef?, modifier: Modifier = Modifier)

fun resolve(prop: String): JsonElement?

fun write(prop: String, value: JsonElement?)

Two-way binding: store value where prop is bound (literal properties are read-only).