Sankey chart
Flows with validation, disclosures and path tracing. Same props and layout on both engines.
Install
Pick one engine. Both builds take the same props, so switching later changes only the import path.
Recharts
npx shadcn@latest add https://beautifulcharts.dev/r/instrument-sankey-chart-recharts.jsonimport { SankeyChart } from "@/components/beautiful-charts/themes/instrument/recharts/sankey-chart";
npm dependencies: recharts@^3.10.1
Apache ECharts
npx shadcn@latest add https://beautifulcharts.dev/r/instrument-sankey-chart-echarts.jsonimport { SankeyChart } from "@/components/beautiful-charts/themes/instrument/echarts/sankey-chart";
npm dependencies: echarts@^6.1.0
Example
A complete client module. Paste it into your app after installing the Recharts build; for ECharts, change recharts to echarts in the import. To pick options visually and copy the matching code, use the Customizer.
"use client";
import { SankeyChart } from "@/components/beautiful-charts/themes/instrument/recharts/sankey-chart";
const data = {
nodes: [
{ id: "visits", label: "Visits" }, { id: "signup", label: "Sign-ups" }, { id: "left", label: "Left" },
{ id: "trial", label: "Trials" }, { id: "paid", label: "Paid" }, { id: "churn", label: "Churned" },
],
links: [
{ source: "visits", target: "signup", value: 4200 }, { source: "visits", target: "left", value: 9800 },
{ source: "signup", target: "trial", value: 2600 }, { source: "trial", target: "paid", value: 880 },
{ source: "trial", target: "churn", value: 1720 },
],
};
// Selecting a node traces its path; `members` lists the links on it as indexes into `links`.
export function SignupFlow() {
return <SankeyChart data={data} title="From visit to paid" onSelectedChange={(selection) => console.log(selection?.datum.label, selection?.members)} />;
}
Sankey chart props
Generated from SankeyChartProps in the installed source, so this table and your editor's hints always agree. * marks a required prop.
| Prop | Type | Description |
|---|---|---|
| data* | SankeyData | Nodes and links. Links to unknown nodes, cycles and negative values are reported, never drawn as if valid. |
| config | ChartConfig | Keyed by node id: label, colour, format. |
| nodeWidth | number | Node width in px. |
| nodePadding | number | Vertical gap between nodes in a column, in px. |
| align | "justify" | "left" | "justify" puts sinks in the last column; "left" keeps each node at its depth. |
| linkColor | "source" | "target" | "gradient" | "neutral" | Link colour: from the source node, the target node, a gradient between them, or neutral. |
| labels | "outside" | "none" | Node labels beside the node, with or without the value. |
| showValues | boolean | Add each node's total beside its label. |
| curvature | number | Pixel curvature of links, 0–1. |
Apache ECharts build only
Escape hatches into the engine. Your option is deep-merged over the generated one, so you can change one nested setting without replacing a whole section.
| Prop | Type | Description |
|---|---|---|
| renderer | EChartsRenderer | "canvas" (default) or "svg". |
| option | OptionOverride | Deep-merged over the generated option, or (generated) => option. Links are custom series "links" (one item per link), nodes "nodes" (id = node id). |
Events
Every callback, and the payload types it receives. Indexes always point into the data you passed, even when a brush or grouping shows a subset.
| Prop | Type | Description |
|---|---|---|
| onSelectedChange | (selection: SankeySelection | null) => void | Called when a node is selected or cleared. The selection carries the node and every link on its traced path. |
| onActiveChange | (index: number | null) => void | Called as the hovered or focused row changes, or null when it leaves. |
| onReady | (chart: EChartsType) => void | Called once with the ECharts instance, e.g. to add event listeners. |
/** What a Sankey reports when a node is selected: the node, and every link on its traced path (as indexes into `links`). */
export type SankeySelection = Omit<Selection<SankeyNode>, "members"> & { members: number[] };
export type TooltipContext<TDatum> = {
datum: TDatum;
/** Index into the data you passed in. */
dataIndex: number;
/** Visible series at this index. `value` is your raw value; `share` is its part of the row in 100% mode. */
series: { key: string; label: ReactNode; value: number | null; share?: number | null | undefined; color: string; selected: boolean }[];
};Parts and styling hooks
Each part carries a data-slot attribute. Theme rules inside the chart are one attribute selector deep, so a selector such as .my-chart [data-slot="chart-title"] overrides them. These are the slots in the files this chart installs; parts a chart doesn't use are simply absent from its markup.
chartchart-bodychart-descriptionchart-eyebrowchart-footerchart-headerchart-headingchart-legendchart-legend-itemchart-legend-labelchart-legend-swatchchart-legend-valuechart-livechart-mainchart-plotchart-readoutchart-statchart-stat-notechart-stat-valuechart-statechart-state-boxchart-state-messagechart-statschart-tablechart-table-scrollchart-takeawaychart-titlechart-tooltipodometerodometer-digitodometer-glyphsodometer-reelodometer-signpartial-notereadout-deltareadout-unitreadout-valuesr-onlytooltip-memberstooltip-rowtooltip-titletooltip-valueProps every chart shares
Header, states, legend, tooltip, formatting, motion, sound and controlled interaction state. They work the same on every Instrument chart and both engines. The guide explains colours, controlled state and accessibility.
Show all 27 shared props
| Prop | Type | Description |
|---|---|---|
| locale | string | BCP 47 locale. Defaults to "en-US" so server and client render the same text. |
| timeZone | string | IANA time zone for dates. Defaults to "UTC" so server and client agree. |
| eyebrow | ReactNode | Small label above the title. |
| title | ReactNode | Card title. A string also names the chart for screen readers. |
| description | ReactNode | A line under the title. |
| takeaway | ReactNode | ((summary: string) => ReactNode) | false | The sentence under the title. Computed from the data by default; pass text, a function of the computed sentence, or false to hide it. |
| ariaDescription | string | Accessible summary for screen readers. Computed from the data by default. |
| motion | MotionPreference | "full" (default), "subtle" or "off". Reduced-motion settings always win. |
| motionOptions | MotionOptions | When the entrance plays. |
| sound | boolean | Sound cues on hover, scrub and select. Plays only if the visitor has also turned sound on for the page. |
| density | Density | "comfortable" (default) or "compact" for dashboards. |
| tooltip | TooltipOptions<TDatum> | false | Tooltip position, indicator, cursor and custom content, or false to turn it off. |
| valueFormatter | (value: number) => string | Values formatted for display. Series formatters in config win. |
| loading | boolean | Show the loading state. Over existing data, the old marks stay dimmed instead of vanishing. |
| error | string | null | An error message. Shows the error state in place of the plot. |
| emptyState | ReactNode | Shown instead of the plot when there is no data. |
| loadingState | ReactNode | Shown while loading is true and there is no data yet. |
| errorState | ReactNode | Shown when error is set. |
| selected | number | null | Controlled and uncontrolled interaction state. Point selection (selected) pins one row by its index in data. Series selection (selectedSeries) picks one series and dims the others. They are separate: picking a row doesn't pick a series. |
| defaultSelected | number | null | Initial selected row when uncontrolled. |
| activeIndex | number | null | Controlled hover or focus index, for syncing several charts on one cursor. |
| palette | "theme" | "shadcn" | Series colours: "theme" (default) uses the theme's designed palette; "shadcn" uses your --chart-1..5. --bc-series-N always wins. You can also opt a whole section in with the class bc-use-shadcn-colors. |
| table | boolean | Show the "Show data table" disclosure. On by default. |
| stats | ChartStat[] | A row of figures under the title, for dashboard cards and blocks. |
| footer | ReactNode | A line or action at the bottom of the card, e.g. a source note or a link. |
| className | string | Classes on the card, for spacing and layout. |
| height | number | Height of the plot area in px. The frame sizes around it. |