For AI agents: the documentation index is at /llms.txt, and any docs page is available as Markdown by appending .md to its URL.

Sankey Chart

Verified

A sankey chart for flow between stages.

When to use

Use when: Flow between stages, such as visitors to signups to paid.
Avoid when: There is no flow between stages; use a Bar Chart or Funnel Chart.

Installation

bunx shelf add chart-sankey

The source lands in src/components/ui/chart-sankey.tsx, along with any Shelf items it builds on, and .shelf/lock.json records what was installed. It's yours to edit.

Usage

import * as Chart from "@/components/ui/chart-sankey";

<SankeyChart aria-label="Visitor flow" data={{ nodes, links }}>
  <Chart.Tooltip />
</SankeyChart>

Built on

Packages: @stylexjs/stylex, recharts
Shelf items: Chart, foundations
Figma: Optional native Figma library. See Designers.

Verified

Size: 1.2 kB gzipped on its own, 79 kB with the Shelf items and packages it builds on. JS and CSS in a production build, without React.
Accessibility: Axe passes on 1 story
Behavior: 1 interaction test in Storybook
React Compiler: Compiles with React Compiler
React Doctor: React Doctor finds nothing