stat
GraphStat
Two to four big numbers. Write `- 12,400 docs` and bold the one that matters most. For a single number with a trend, use KPI.
- use it
- Good for two to four large numbers, with no sparkline.
- instead
- One number with a trend is KPI. A live clock is Timer.
this week
12,400
docs
4,100
copies
860
shipped
<GraphStat title="THIS WEEK">
- 12,400 docs
- 4,100 copies
- **860 shipped**
</GraphStat>install
command
latency
142ms
read
−18ms
410ms
write
+22ms
<GraphStat title="P95">
- 142ms read — −18ms
- **410ms write — +22ms**
</GraphStat>| Prop | Type | Default | Description |
|---|---|---|---|
| title | string | — | Caption drawn on the top edge of the frame. |
| items | StatItem[] | — | value, label, optional hint, optional accent. Optional when children are Markdown. |
| children | Markdown | — | - **860** shipped |
| corner | string | "+" | Character at each corner of the frame. |
| frame | "box" | "corners" | "rule" | "none" | "box" | box draws the dashed border. corners keeps only the corner marks. rule draws dashed lines above and below. none drops the border and padding, and puts the title above the content. |
| className | string | — | Passed to the outer frame. |