Skip to content

Interface: UiBlockMeta

Defined in: packages/core/src/presenter/ui.ts:43

Optional metadata for a UI block — layout hints and presentation context.

Metadata is rendered as XML attributes on the <ui_passthrough> wrapper, providing downstream clients and AI agents with structured display hints without altering the content payload.

Example

typescript
ui.echarts(chartConfig, { title: 'Revenue', width: 'half' });
ui.table(headers, rows, { title: 'Invoices', priority: 1 });

Properties

priority?

ts
readonly optional priority: number;

Defined in: packages/core/src/presenter/ui.ts:49

Rendering priority (lower = rendered first). Default: insertion order


title?

ts
readonly optional title: string;

Defined in: packages/core/src/presenter/ui.ts:45

Human-readable label for the block (e.g. chart title, section name)


width?

ts
readonly optional width: "full" | "half" | "third";

Defined in: packages/core/src/presenter/ui.ts:47

Layout width hint for rendering clients