Surface components
Primitives, business widgets, properties and events in the Surface catalog.
The Surface catalog describes primitives and business widget adapters. Composition references Model Fields, record profiles, views, Queries and Actions. Properties below come from the portable owner rather than a separate data language. Compiled-format bounds and identities are distinct from business configuration in Studio.
Catalog compatibility
The current catalog describes all admitted components. Its semantic identity is distinct from software package versions. Studio and Surface tools check that identity and available components before rendering.
Current catalog: 0.0.0.1
HomeHeader
The native Home title, introduction and declared primary navigation.
This component requires no properties.
Events
No events.
HomeLaunchers
Declared native Home Actions, icons and current session availability.
This component requires no properties.
Events
No events.
HomeLayout
The native Home main/aside block placement, using default children.
This component requires no properties.
Events
No events.
HomeSection
One native Home Query preview, limit and exact view-all destination.
| Field | Options / expected values | Description |
|---|---|---|
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
HomeActivity
A declared Home journal activity block, never inferred from update timestamps.
| Field | Options / expected values | Description |
|---|---|---|
blockKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
Page
An application screen containing composed children.
| Field | Options / expected values | Description |
|---|---|---|
title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
Events
No events.
Section
A labelled content section.
| Field | Options / expected values | Description |
|---|---|---|
title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
Events
No events.
Stack
A vertical ordered group.
| Field | Options / expected values | Description |
|---|---|---|
gap |
"none" | "small" | "medium" | "large" |
Required. Defines gap for this object. Observe the type, variants and bounds in the Options column. |
Events
No events.
Grid
A bounded responsive column group.
| Field | Options / expected values | Description |
|---|---|---|
columns |
1 OR 2 OR 3 OR 4 |
Required. Ordered columns and their authorized value sources. |
gap |
"none" | "small" | "medium" | "large" |
Required. Defines gap for this object. Observe the type, variants and bounds in the Options column. |
Events
No events.
RecordLayout
Arranges a record’s main content and relation panel in two declared stacks without an extra frame. On smaller screens, the panel follows the main content.
| Field | Options / expected values | Description |
|---|---|---|
asideWidth |
"standard" | "compact" |
Required. Required right-panel preset: standard for 230 px or compact for 220 px. The gap is 21 px; layout becomes one column below 850 px. |
Events
No events.
Children and order
| Field | Options / expected values | Description |
|---|---|---|
children |
length 2 |
Required. Exact number of declared children; no container is added automatically. |
children[].type |
Stack |
Required. Type of each direct child. |
children order |
main → aside |
Required. Positional roles in this order; element keys remain author-defined and no named slots are created. |
Header
Arranges page identity followed by its Actions in two explicitly declared stacks, without a frame or effects on display. The regions adapt on smaller screens.
This component requires no properties.
Events
No events.
Children and order
| Field | Options / expected values | Description |
|---|---|---|
children |
length 2 |
Required. Exact number of declared children; no container is added automatically. |
children[].type |
Stack |
Required. Type of each direct child. |
children order |
identity → actions |
Required. Positional roles in this order; element keys remain author-defined and no named slots are created. |
Card
A labelled presentation group, not an MCP transport card.
| Field | Options / expected values | Description |
|---|---|---|
title |
string; min length 1; max length 4000 |
Required. Title of the object or section in the interface. |
Events
No events.
Heading
A semantic heading.
| Field | Options / expected values | Description |
|---|---|---|
text |
string; min length 1; max length 4000 |
Required. Defines text for this object. Observe the type, variants and bounds in the Options column. |
level |
1 OR 2 OR 3 OR 4 |
Required. Anchor structural depth in the admitted hierarchy. |
Events
No events.
Text
Plain text, never HTML or an expression.
| Field | Options / expected values | Description |
|---|---|---|
text |
string; min length 1; max length 4000 |
Required. Defines text for this object. Observe the type, variants and bounds in the Options column. |
Events
No events.
Badge
A non-interactive semantic badge.
| Field | Options / expected values | Description |
|---|---|---|
text |
string; min length 1; max length 4000 |
Required. Defines text for this object. Observe the type, variants and bounds in the Options column. |
tone |
"neutral" | "info" | "success" | "warning" | "danger" |
Required. Defines tone for this object. Observe the type, variants and bounds in the Options column. |
Events
No events.
Icon
An exact admitted Model icon with an accessible label.
| Field | Options / expected values | Description |
|---|---|---|
icon |
closed object |
Required. Icon from the catalog admitted for this presentation variant. |
icon.catalog |
Managed by Surface; supplied by the Model tools. |
Required. Defines catalog for this object. Observe the type, variants and bounds in the Options column. |
icon.revision |
string; min length 1; max length 120 |
Required. Defines revision for this object. Observe the type, variants and bounds in the Options column. |
icon.name |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Readable name of the element in its presentation context. |
label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
Events
No events.
RecordIdentity
Identity from the declared record profile and canonical selected head.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
RecordField
One exact Surface placement using its native Form control and session.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
fieldPath |
string; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u; max length 127 |
Required. Semantic Field selector, using the fields/ prefix. |
Events
No events.
RecordSettings
The native Settings owner for the declared record profile.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
RecordTags
Native record tags and existing tag coordinator.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
RecordMetric
A declared complete native metric, never a count of displayed rows.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
metricKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
RecordRelations
One exact declared relation group and its existing Query session.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
NativeContent
The existing native content editor slot, with its persistent format unchanged.
| Field | Options / expected values | Description |
|---|---|---|
recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contentKind |
"document" | "code" | "canvas" | "asset" |
Required. Selects the native content engine and corresponding format. |
Events
No events.
QueryTable
The admitted table projection and native table controls.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
RecordCards
Native record cards from the declared cards Query projection.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
columns |
1 OR 2 OR 3 OR 4 |
Required. Ordered columns and their authorized value sources. |
Events
No events.
QueryGraph
The declared graph view, rendered by Surface’s native graph component.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
QueryKanban
The declared Kanban view and native mutations.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
QueryGantt
The declared Gantt view and native schedule controls.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
QueryTimeline
The declared timeline view.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
QueryCalendar
The declared calendar view.
| Field | Options / expected values | Description |
|---|---|---|
binding |
closed object OR closed object OR closed object OR closed object OR closed object |
Required. Declared value source or destination; does not contain arbitrary scripts. |
binding.[kind=work-section].kind |
"work-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=work-section].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=work-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].kind |
"collection" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=collection].destinationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=collection].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].kind |
"home-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=home-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=home-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].kind |
"record-section" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-section].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-section].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].kind |
"record-relations" |
Required. Selects the variant and the properties admitted in this branch. |
binding.[kind=record-relations].recordProfileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
binding.[kind=record-relations].groupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
ModelAction
An explicit press prepares the declared native Action; mounting never dispatches.
| Field | Options / expected values | Description |
|---|---|---|
actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
Events
| Field | Options / expected values | Description |
|---|---|---|
press |
closed object |
Required. Defines press for this object. Observe the type, variants and bounds in the Options column. |
press.action |
"prepare-action" |
Required. Defines action for this object. Observe the type, variants and bounds in the Options column. |
press.params |
closed object |
Required. Defines params for this object. Observe the type, variants and bounds in the Options column. |
press.params.actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
Tabs
An explicit accessible tab group whose declared panels stay mounted when hidden.
| Field | Options / expected values | Description |
|---|---|---|
label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
defaultTabKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
tabs |
Array<closed object>; min length 1; max length 20 |
Required. Defines tabs for this object. Observe the type, variants and bounds in the Options column. |
tabs[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable semantic identifier used by references; changing it changes identity. |
tabs[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
Events
No events.
TabPanel
One explicitly keyed panel of its direct Tabs parent, containing one Stack.
| Field | Options / expected values | Description |
|---|---|---|
tabKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
ActionGroup
Explicit primary, secondary and menu Actions using the existing native preparation owner.
| Field | Options / expected values | Description |
|---|---|---|
primary |
closed object; null |
Required. Defines primary for this object. Observe the type, variants and bounds in the Options column. |
primary.actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
primary.label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
secondary |
Array<closed object>; max length 20 |
Required. Defines secondary for this object. Observe the type, variants and bounds in the Options column. |
secondary[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
secondary[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
menu |
Array<closed object>; max length 40 |
Required. Defines menu for this object. Observe the type, variants and bounds in the Options column. |
menu[].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
menu[].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
menuLabel |
string; min length 1; max length 4000 |
Required. Defines menu Label for this object. Observe the type, variants and bounds in the Options column. |
Events
No events.
WorkIdentity
Exact selected Work identity from its authorized metadata, not a Record profile.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkNavigation
Controlled declared Work sections; the app-lifetime owner retains selection per exact Work context.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkPanel
One declared controlled Work section with one Stack; hidden panels stay mounted.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkStageRail
Controlled native stage selection, distinct from Workspace navigation and Flow completion.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkTargetContent
The exact durable Work target through the same native ActiveDocument and draft guards.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
contentKind |
"document" | "code" | "canvas" | "asset" |
Required. Selects the native content engine and corresponding format. |
Events
No events.
WorkSources
The declared target Sources view through its existing native source and receipt reader.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkRequests
The existing exact native Flow inspection and occurrence controls, not a synthesized request list.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkCriteria
Declared durable criterion facts, never Task counts or a count of technical evidence checks.
| Field | Options / expected values | Description |
|---|---|---|
experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Events
No events.
WorkAction
An explicit scoped press prepares its declared native Action or nominal consolidation; mounting never executes.
| Field | Options / expected values | Description |
|---|---|---|
[variant 1].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[variant 1].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[variant 1].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[variant 1].scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
[variant 1].actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
[variant 1].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
[kind=consolidation].kind |
"consolidation" |
Required. Selects the variant and the properties admitted in this branch. |
[kind=consolidation].experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[kind=consolidation].sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[kind=consolidation].bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[kind=consolidation].scope |
"selectedStage" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
[kind=consolidation].profileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
[kind=consolidation].label |
string; min length 1; max length 4000 |
Required. Human-readable label displayed in the interface. |
Events
| Field | Options / expected values | Description |
|---|---|---|
press |
closed object OR closed object |
Required. Defines press for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 1].action |
"prepare-action" |
Required. Defines action for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 1].params |
closed object |
Required. Defines params for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 1].params.experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 1].params.sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 1].params.bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 1].params.scope |
"rootWork" | "selectedStage" | "retainedTarget" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 1].params.actionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Reference to a declared Action; rendering does not execute it. |
press.[variant 2].action |
"prepare-consolidation" |
Required. Defines action for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 2].params |
closed object |
Required. Defines params for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 2].params.kind |
"consolidation" |
Required. Selects the variant and the properties admitted in this branch. |
press.[variant 2].params.experienceKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 2].params.sectionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 2].params.bindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
press.[variant 2].params.scope |
"selectedStage" |
Required. Defines scope for this object. Observe the type, variants and bounds in the Options column. |
press.[variant 2].params.profileKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
Admission and native engines
Catalog, bindings and bundle adapters must be compatible before rendering. Surface owners resolve Fields, Queries, results, permissions and operations. Actions are prepared only through explicit interaction. Missing identities, references and capabilities cause refusal; the renderer does not repair the Model or select another engine.
Composition contracts are compiled formats. Studio produces this representation; users do not enter catalog identities or technical digests in their records.
Applied examples : Two components connected to the same client
Notes uses the client profile and the table uses its quotes group.
Configuration
Component properties RecordField.props. Properties and accepted values.
{
"recordProfileKey": "client",
"fieldPath": "fields/notes"
}Variation and connection
Component properties QueryTable.props. Properties and accepted values.
{
"binding": {
"kind": "record-relations",
"recordProfileKey": "client",
"groupKey": "quotes"
}
}UI layout example
The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.
- Client identity
- Notes and follow-up
- Settings
- Linked quotes
Surface componentsTwo components connected to the same client
ClientsNS
North StudioActive client · Professional services
StatusActive
The client wants a proposal for a new project. Clarify requirements and confirm the budget before review.
Editable text on the Surface