Report | GistUI

Preview

Loading preview…

root = Report(Sheet(Header("Annual report", "Fiscal year 2026", size:xl, align:center), layout:center, bg:inverse), Sheet(Header("Summary"), Stats(kpis), Callout("Revenue grew in every region.", tone:success)), title:"Annual report")
kpis = |Label|Value|Delta
|Revenue|$14.2M|+18%
|Margin|61%|+3pt

Signature

This is the line a model reads in the system prompt.

Report(...Sheet, title:str, subtitle:str, size:a4|letter)

Group: Layout
Children: Yes: Sheet
Positional arguments: none

Props

Prop	Type	How to write it	Notes
`title`	string	named: `title:…`
`subtitle`	string	named: `subtitle:…`
`size`	`a4` · `letter`	named: `size:…`	Default `"a4"`.

Use your own component

Keep the name and schema, swap what is drawn. The prompt and the model’s output do not change.

import { ui } from "@gistui/react/ui";

const lib = ui.extend({ Report: MyReport });
<GistUI library={lib} stream={response.body} />;

<GistUI :source="answer" :components="{ Report: MyReport }" />

<GistUI source={answer} components={{ Report: MyReport }} />

<GistUI source={answer()} components={{ Report: MyReport }} />

import { ui } from "@gistui/vanilla/ui";

const lib = ui.extend({ Report: (ctx) => ({ el: myElement(ctx) }) });

See Custom components for the full contract. Style hook: [data-gistui="Report"].