docs/concepts/data-binding.md
Data binding connects UI components to application state using JSON Pointer paths (RFC 6901). It's what allows A2UI to efficiently define layouts for large arrays of data, or to show updated content without being regenerated from scratch.
A2UI separates:
This enables: reactive updates, data-driven UIs, reusable templates, and bidirectional binding.
Each surface has a JSON object holding state:
{
"user": {"name": "Alice", "email": "[email protected]"},
"cart": {
"items": [{"name": "Widget", "price": 9.99, "quantity": 2}],
"total": 19.98
}
}
Syntax:
/user/name - Object property/cart/items/0 - Array index (zero-based)/cart/items/0/price - Nested pathExample:
{"user": {"name": "Alice"}, "items": ["Apple", "Banana"]}
/user/name → "Alice"/items/0 → "Apple"=== "v0.8"
**Literal (fixed):**
```json
{
"id": "title",
"component": {
"Text": {
"text": { "literalString": "Welcome" }
}
}
}
```
**Data-bound (reactive):**
```json
{
"id": "username",
"component": {
"Text": {
"text": { "path": "/user/name" }
}
}
}
```
=== "v0.9"
**Literal (fixed):**
```json
{
"id": "title",
"component": "Text",
"text": "Welcome"
}
```
**Data-bound (reactive):**
```json
{
"id": "username",
"component": "Text",
"text": { "path": "/user/name" }
}
```
When /user/name changes from "Alice" to "Bob", the text automatically updates to "Bob".
Components bound to data paths automatically update when the data changes:
{
"id": "status",
"component": {
"Text": {
"text": { "path": "/order/status" }
}
}
}
/order/status = "Processing..." → displays "Processing..."status: "Shipped" → displays "Shipped"No component updates needed—just data updates.
Use templates to render arrays:
{
"id": "product-list",
"component": {
"Column": {
"children": {
"template": {
"dataBinding": "/products",
"componentId": "product-card"
}
}
}
}
}
Data:
{
"products": [
{ "name": "Widget", "price": 9.99 },
{ "name": "Gadget", "price": 19.99 }
]
}
Result: Two cards rendered, one per product.
Inside a template, paths are scoped to the array item:
{
"id": "product-name",
"component": {
"Text": {
"text": { "path": "/name" }
}
}
}
/products/0, /name resolves to /products/0/name → "Widget"/products/1, /name resolves to /products/1/name → "Gadget"Adding/removing items automatically updates the rendered components.
Interactive components update the data model bidirectionally:
| Component | Example | User Action | Data Update |
|---|---|---|---|
| TextField | {"text": {"path": "/form/name"}} | Types "Alice" | /form/name = "Alice" |
| CheckBox | {"value": {"path": "/form/agreed"}} | Checks box | /form/agreed = true |
| MultipleChoice | {"selections": {"path": "/form/country"}} | Selects "Canada" | /form/country = ["ca"] |
1. Use granular updates - Update only changed paths:
{
"dataModelUpdate": {
"path": "/user",
"contents": [
{ "key": "name", "valueString": "Alice" }
]
}
}
2. Organize by domain - Group related data:
{"user": {...}, "cart": {...}, "ui": {...}}
3. Pre-compute display values - Agent formats data (currency, dates) before sending:
{"price": "$19.99"} // Not: {"price": 19.99}