SankeyChart
Follow the relationship rather than the value — hover a mark to read its row.
@luc/ui/chartsWhat it shows
Follow quantities through a network of directed stages, where link width carries flow.
Live preview
Prepared node and link lists whose flows balance at every node — the chart aggregates nothing.
<SankeyChart
nodes={[
{ name: "Organic", tone: "accent" },
{ name: "Paid", tone: "info" },
{ name: "Referral", tone: "neutral" },
{ name: "Visit" },
{ name: "Signup" },
{ name: "Trial" },
{ name: "Paid plan" },
]}
links={[
{ source: "Organic", target: "Visit", value: 520 },
{ source: "Paid", target: "Visit", value: 310 },
{ source: "Referral", target: "Visit", value: 150 },
{ source: "Visit", target: "Signup", value: 384 },
{ source: "Visit", target: "Trial", value: 96 },
{ source: "Signup", target: "Trial", value: 212 },
{ source: "Trial", target: "Paid plan", value: 96 },
{ source: "Signup", target: "Paid plan", value: 172 },
]}
format={{ kind: "integer" }}
height={380}
ariaLabel="Acquisition to retention"
/>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 { SankeyChart } from "@luc/ui/charts";
<SankeyChart
nodes={[
{ name: "Organic", tone: "accent" },
{ name: "Paid", tone: "info" },
{ name: "Referral", tone: "neutral" },
{ name: "Visit" },
{ name: "Signup" },
{ name: "Trial" },
{ name: "Paid plan" },
]}
links={[
{ source: "Organic", target: "Visit", value: 520 },
{ source: "Paid", target: "Visit", value: 310 },
{ source: "Referral", target: "Visit", value: 150 },
{ source: "Visit", target: "Signup", value: 384 },
{ source: "Visit", target: "Trial", value: 96 },
{ source: "Signup", target: "Trial", value: 212 },
{ source: "Trial", target: "Paid plan", value: 96 },
{ source: "Signup", target: "Paid plan", value: 172 },
]}
format={{ kind: "integer" }}
height={380}
ariaLabel="Acquisition to retention"
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 `SankeyChart` from Luc UI. It is: Follow the relationship rather than the value — hover a mark to read its row.
Import it with: import { SankeyChart } 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={380}`, `state="ready"`, `ariaLabel="Acquisition to retention"`.
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
<SankeyChart
nodes={[
{ name: "Organic", tone: "accent" },
{ name: "Paid", tone: "info" },
{ name: "Referral", tone: "neutral" },
{ name: "Visit" },
{ name: "Signup" },
{ name: "Trial" },
{ name: "Paid plan" },
]}
links={[
{ source: "Organic", target: "Visit", value: 520 },
{ source: "Paid", target: "Visit", value: 310 },
{ source: "Referral", target: "Visit", value: 150 },
{ source: "Visit", target: "Signup", value: 384 },
{ source: "Visit", target: "Trial", value: 96 },
{ source: "Signup", target: "Trial", value: 212 },
{ source: "Trial", target: "Paid plan", value: 96 },
{ source: "Signup", target: "Paid plan", value: 172 },
]}
format={{ kind: "integer" }}
height={380}
ariaLabel="Acquisition to retention"
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 { SankeyChart } from "@luc/ui/charts";<SankeyChart
nodes={[
{ name: "Organic", tone: "accent" },
{ name: "Paid", tone: "info" },
{ name: "Referral", tone: "neutral" },
{ name: "Visit" },
{ name: "Signup" },
{ name: "Trial" },
{ name: "Paid plan" },
]}
links={[
{ source: "Organic", target: "Visit", value: 520 },
{ source: "Paid", target: "Visit", value: 310 },
{ source: "Referral", target: "Visit", value: 150 },
{ source: "Visit", target: "Signup", value: 384 },
{ source: "Visit", target: "Trial", value: 96 },
{ source: "Signup", target: "Trial", value: 212 },
{ source: "Trial", target: "Paid plan", value: 96 },
{ source: "Signup", target: "Paid plan", value: 172 },
]}
format={{ kind: "integer" }}
height={380}
ariaLabel="Acquisition to retention"
/>Data contract
`nodes` supplies unique ids and labels; `links` supplies `source`, `target` and numeric `value`; `format` names the flow unit. The caller must reconcile flows at each node.
Important configuration
Keep node ids stable, order stages deliberately, and label the flow unit; the chart does not aggregate or balance missing links.
Guidelines
When not to use
Do not use Sankey for unordered correlations or for flows whose node totals do not reconcile; width would imply a conservation the data lacks.
Configuration
| Export | Kind | Signature |
|---|---|---|
SankeyChart | 12 documented props | ({ nodes, links, format, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, }: SankeyChartProps) => import("@types/react").JSX.Element |
SankeyChart props
Type: SankeyChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
description? | string | undefined | — | |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
links | readonly SankeyLink[] | — | |
nodes | readonly SankeyNode[] | — | |
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