Treemap

Preview

Install

Add it with the shadcn CLI, or copy the source manually.

$ bunx --bun shadcn add @beui/treemap

API Reference

Treemap

data
readonly TreemapNode[]

Flat leaves or nested groups. Tile area uses leaf values; groups sum their descendants.

Default—
label?
string
Default—
formatValue?
((value: number) => string)
Default—
colors?
readonly string[]

Top-level palette; nodes can override their inherited color and textColor.

Default—
textColor?
string
Default—
activeId?
string | null
Default—
defaultActiveId?
string | null
Default—
onActiveChange?
((id: string | null) => void)
Default—
labels?
Partial<{ label: string; tableCaption: string; item: string; value: string; share: string; details: string; legend: string; tiles: string; ofTotal: string; noPositive: string; empty: string; }>

Override any built-in string.

Default—
className?
string
Default—

TreemapLegend

className?
string
Default—
showValues?
boolean
Defaultfalse

TreemapPlot

className?
string

Sets the plot height; default 20rem. The layout follows its measured dimensions.

Default—
tileClassName?
string
Default—
renderTile?
((tile: TreemapTile) => ReactNode)

Return presentation content only; each tile already owns its button and accessible name.

Default—

TreemapTooltip

className?
string
Default—
side?
"top" | "right" | "bottom" | "left"
Defaulttop

Updated