Schemas / UI (control surfaces)
rig.ui.group
v0.31.0 · draft 5 fields 2 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
panel |
entity | required | Owning rig.ui.panel |
parent |
entity | optional | Optional. Parent group entity; absent or null = top-level in the panel |
order |
int | required | Sort key among siblings (same parent) |
orientation |
enumvertical · horizontal | optional | Optional. Flow hint: vertical \ |
collapsed |
bool | optional | Optional. Disclosure hint; absent = false. Hosts without disclosure ignore it |
Section or row inside a rig.ui.panel. Groups carry structure that survives swapping UI packs - not dock slots or toolkit trees. Labels compose rig.meta.named.
Controls and actions may set group to this entity. Nest groups via parent - do not invent a second graph.
Required: panel, order.
JSON Schema
Resolves at https://rig.works/schemas/rig.ui.group.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.ui.group.schema.json",
"title": "rig.ui.group",
"type": "object",
"additionalProperties": false,
"properties": {
"panel": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"parent": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"order": {
"$ref": "./_defs.schema.json#/$defs/int"
},
"orientation": {
"type": "string",
"enum": [
"vertical",
"horizontal"
]
},
"collapsed": {
"$ref": "./_defs.schema.json#/$defs/bool"
}
},
"required": [
"panel",
"order"
],
"description": "Section/row inside a panel. Nesting via parent (group entity). Flow hints are advisory."
}