HierarchyTreeChart
Follow the relationship rather than the value — hover a mark to read its row.
@luc/ui/chartsWhat it shows
Read parent-child structure and optional values in a hierarchy, including collapsed branches.
Live preview
A three-level tree of the weights the caller supplied; collapse is a view state, never a recompute.
<HierarchyTreeChart
root={{
name: "Portfolio",
children: [
{
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 },
],
}}
orientation="left-right"
format={{ kind: "percent", decimals: 0 }}
height={320}
ariaLabel="Allocation tree"
/>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 { HierarchyTreeChart } from "@luc/ui/charts";
<HierarchyTreeChart
root={{
name: "Portfolio",
children: [
{
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 },
],
}}
orientation="left-right"
format={{ kind: "percent", decimals: 0 }}
height={320}
ariaLabel="Allocation tree"
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 `HierarchyTreeChart` from Luc UI. It is: Follow the relationship rather than the value — hover a mark to read its row.
Import it with: import { HierarchyTreeChart } 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={320}`, `state="ready"`, `ariaLabel="Allocation tree"`.
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
<HierarchyTreeChart
root={{
name: "Portfolio",
children: [
{
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 },
],
}}
orientation="left-right"
format={{ kind: "percent", decimals: 0 }}
height={320}
ariaLabel="Allocation tree"
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 { HierarchyTreeChart } from "@luc/ui/charts";<HierarchyTreeChart
root={{
name: "Portfolio",
children: [
{
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 },
],
}}
orientation="left-right"
format={{ kind: "percent", decimals: 0 }}
height={320}
ariaLabel="Allocation tree"
/>Data contract
`root` is a nested object with `name`, optional `value` and `children`; values are supplied at the nodes and not summed by the chart. `orientation` chooses the reading direction.
Important configuration
Set `orientation`, keep node names unique enough for the interaction, and format values only where they are part of the hierarchy.
Guidelines
When not to use
Do not use a tree for cross-links or for a flat list; those are network and list problems, not parent-child structure.
Configuration
| Export | Kind | Signature |
|---|---|---|
HierarchyTreeChart | 15 documented props | ({ root, orientation, edgeShape, labels, format, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, eager, }: HierarchyTreeChartProps) => import("@types/react… |
HierarchyTreeChart props
Type: HierarchyTreeChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
description? | string | undefined | — | |
eager? | boolean | undefined | — | Create the engine on mount rather than when the surface is approached. |
edgeShape? | "polyline" | "curve" | undefined | — | Path of labels drawn on the edges. |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
labels? | boolean | undefined | — | Show the leaf labels. Default `true`. |
onEvent? | ((event: EChartEvent) => void) | undefined | — | |
onReady? | ((chart: EChartsInstance) => void) | undefined | — | |
orientation? | "left-right" | "right-left" | "top-bottom" | "bottom-top" | "radial" | undefined | — | `left-right` is a dendrogram; `radial` is an org chart. Default `left-right`. |
root | HierarchyTreeNode | — | The root. A dendrogram of one leaf is a label, not a chart. |
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