TreemapChart
Follow the relationship rather than the value — hover a mark to read its row.
@luc/ui/chartsWhat it shows
Show hierarchical composition by area, making large shares findable before reading exact values.
Live preview
The same hierarchy as the sunburst, sized by value: area carries the share, and the drill-down is client-side.
<TreemapChart
data={[
{
name: "Equity",
children: [
{ name: "US", value: 32 },
{ name: "Europe", value: 18 },
{ name: "Asia", value: 12 },
],
},
{
name: "Fixed income",
children: [{ name: "Sovereign", value: 14 }, { name: "Credit", value: 11 }],
},
{ name: "Alternatives", value: 9 },
{ name: "Cash", value: 4 },
]}
format={{ kind: "percent", decimals: 0 }}
height={340}
ariaLabel="Allocation by block"
/>Controls
Height
A chart measures its container, so it always needs a definite height.
State
The surface the chart is in — loading, empty and error are drawn by the component.
Accessible name
A drawing is not readable by a screen reader, so it needs a name that states what it shows.
The same fixture as the live preview above; the controls change how it is drawn, not what it measures.
Code
import { TreemapChart } from "@luc/ui/charts";
<TreemapChart
data={[
{
name: "Equity",
children: [
{ name: "US", value: 32 },
{ name: "Europe", value: 18 },
{ name: "Asia", value: 12 },
],
},
{
name: "Fixed income",
children: [{ name: "Sovereign", value: 14 }, { name: "Credit", value: 11 }],
},
{ name: "Alternatives", value: 9 },
{ name: "Cash", value: 4 },
]}
format={{ kind: "percent", decimals: 0 }}
height={340}
ariaLabel="Allocation by block"
state="ready"
/>Not controllable here
series / rows— The numbers are the caller's; the fixture above is the example.
Copy for an AI agentA specification an agent can act on: the import, the setup, the chosen props, the data contract and the accessibility expectation.
Implement `TreemapChart` from Luc UI. It is: Follow the relationship rather than the value — hover a mark to read its row.
Import it with: import { TreemapChart } from "@luc/ui/charts";
Requires: react ^19.0.0; react-dom ^19.0.0; react-hook-form ^7.0.0 (optional, for @luc/ui/forms/react-hook-form); tailwindcss ^4.0.0; node >= 22 (repository tools). Import the stylesheet once at the app root and wrap the tree in `LucProvider`. Both come from the package that publishes @luc.
Chosen configuration: `height={340}`, `state="ready"`, `ariaLabel="Allocation by block"`.
Accessibility: keep the component's own semantics. Do not re-implement its ARIA wiring, do not add roles it does not declare, and make sure every interactive element is reachable and operable from the keyboard with a visible focus state.
Styling: use Luc UI design tokens and the component's own props. Do not restyle with raw colour literals and do not override the component's internal structure with page CSS.
Motion: respect `prefers-reduced-motion`. The component already does, so do not disable it.
Reproduce this state:
```tsx
<TreemapChart
data={[
{
name: "Equity",
children: [
{ name: "US", value: 32 },
{ name: "Europe", value: 18 },
{ name: "Asia", value: 12 },
],
},
{
name: "Fixed income",
children: [{ name: "Sovereign", value: 14 }, { name: "Credit", value: 11 }],
},
{ name: "Alternatives", value: 9 },
{ name: "Cash", value: 4 },
]}
format={{ kind: "percent", decimals: 0 }}
height={340}
ariaLabel="Allocation by block"
state="ready"
/>
```Usage
The values are prepared by the caller: this component draws the points it is given and computes no statistic of its own, so units, scaling and any summary have to be settled before the data reaches it.
It is drawn by the ECharts engine.
Worked examples with real data are on the family overview: Multidimensional, network & hierarchy
import { TreemapChart } from "@luc/ui/charts";<TreemapChart
data={[
{
name: "Equity",
children: [
{ name: "US", value: 32 },
{ name: "Europe", value: 18 },
{ name: "Asia", value: 12 },
],
},
{
name: "Fixed income",
children: [{ name: "Sovereign", value: 14 }, { name: "Credit", value: 11 }],
},
{ name: "Alternatives", value: 9 },
{ name: "Cash", value: 4 },
]}
format={{ kind: "percent", decimals: 0 }}
height={340}
ariaLabel="Allocation by block"
/>Data contract
`data` is a nested hierarchy of `name`, optional `children` and numeric `value` leaves. The values determine area and must be non-negative at each branch.
Important configuration
Use `format` for the share unit, keep stable sibling order where the ranking matters, and state whether the displayed hierarchy is complete.
Guidelines
When not to use
Do not compare tiny areas precisely or use negative values; a treemap is a composition view, not a precise linear scale.
Configuration
| Export | Kind | Signature |
|---|---|---|
TreemapChart | 11 documented props | ({ data, format, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, }: TreemapChartProps) => import("@types/react").JSX.Element |
TreemapChart props
Type: TreemapChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
data | readonly HierarchyNode[] | — | |
description? | string | undefined | — | |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
onEvent? | ((event: EChartEvent) => void) | undefined | — | |
onReady? | ((chart: EChartsInstance) => void) | undefined | — | |
state? | ChartState | undefined | — | |
title? | string | undefined | — |
Accessibility
A chart is a picture of data, so it needs a name that states what it shows, and the numbers must exist as text somewhere on the page — in a table or a written summary — because a drawing is not readable by a screen reader and cannot be copied.
What happens on the server, and when hydration changes it.
Family
Multidimensional, network & hierarchy
When the relationship, not the value, is the finding.
Related