Charcoal UI

Sankey Chart

A flow diagram: nodes in columns sized by volume, curved bands that draw themselves between them, and hovering a band or node lights up its whole path.

Examples

Sankey Chart

API reference

PropTypeDefaultDescription
links{ source: string; target: string; value: number }[]—
width / heightnumber640 / 320
gapnumber14
format(v: number) => string—
titlestring—

About Sankey Chart

Sankey Chart draws flows between stages: nodes sit in columns sized by volume, curved bands draw themselves between them, and hovering or focusing a band or node lights up the full path through the chart.

Sankey Chart is an animated chart for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Sankey Chart

  • Revenue and cost breakdowns.
  • User journeys and funnels with branches.
  • Energy and budget flows.
  • Traffic sources to outcomes.

How it works

Layout is computed in the file from your links, with no chart library. Bands are SVG paths whose stroke width matches the value, the draw-in is a path length animation, and every node and band has a label for screen readers.

Each chart has a text alternative, hover tooltips are mirrored by keyboard focus where data points are interactive, and colour is never the only way a value is shown. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Sankey Chart

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change gap live, and the Code tab updates to match, so the snippet you copy already carries your values.

  • links.
  • width / height (number, default 640 / 320).
  • gap (number, default 14).
  • format ((v: number) => string).
  • title (string).

Goes well with Sankey Chart

These charts pieces share its tokens and motion language, so they sit together on one page without clashing.

  • Donut Chart: An animated React donut chart: segments draw in and thicken on hover
  • Activity Heatmap: A React contribution heatmap with four shades, tooltips and keyboard navigation
  • Sparkline: An animated React sparkline with fill, trend colour and a pulsing end dot
  • Line Chart: An animated React line chart with a snapping crosshair and multi-series tooltips
  • Area Chart: An animated React area chart with a comparison series and a target line

Install Sankey Chart

npx shadcn@latest add @charcoal/sankey-chart

Sankey Chart is part of Charcoal UI Pro. One seat unlocks all 393 Pro components, 112 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies sankey-chart.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

How do I install Sankey Chart?
Sankey Chart is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/sankey-chart. It copies sankey-chart.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Sankey Chart free for commercial use?
Sankey Chart needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Sankey Chart work with Next.js?
Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Sankey Chart?
Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Sankey Chart's props and get_install_command returns the exact command.

Sankey Chart as Markdown · llms.txt