# Sankey

> Where things come from and where they go. Sample data: sessions from four sources to four outcomes, search 4,200, purchased 2,100.

- Type 031 · Flow between steps
- Component: `<Sankey>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/sankey` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/sankey

## Installation

1. **Set up the registry once.** This chart is free in Hearth and MIT licensed: no token. Add @chartory to components.json once (the URL alone, no headers), or skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Sankey component to your project.

```bash
npx shadcn add @chartory/sankey
```

3. **Use it.** Pass your rows. The props are the Figma properties.

usage.tsx:

```tsx
import { Sankey }
  from "@/components/chartory/sankey"

<Sankey
  data={sessionFlow}
  size="m"
/>
```

## Props

### `<Sankey>`

Every prop but data is a Figma property with the same name and values.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | SankeyData | Required | The chart's data. The tables below list every field. |
| size | "xs" \| "s" \| "m" \| "l" | "m" | The size class. Each one is laid out again from the data. |

### SankeyData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| left | SankeyLeft[] | Required | The nodes in the left column. |
| right | SankeyRight[] | Required | The nodes in the right column. |
| flows | [number, number, number][] | Required | The flows: [from index, to index, value]. |

### SankeyLeft

One object per entry in left.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| tok | string | Required | The colour token, e.g. "data/primary". |
| v | number | Required | The value. |

### SankeyRight

One object per entry in right.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| v | number | Required | The value. |

## Sankey diagram: a React and Figma chart in four sizes

### What does a sankey diagram show?

A Sankey diagram draws flows from sources on the left to outcomes on the right, with each band as wide as its amount. You see which source feeds which outcome. Use it for sessions from channel to result, budget from team to spend or energy from source to use.

Chartory ships it as a Figma component and a React component with the same name. The code installs from the shadcn registry with one command and lands in your project as a file you own.

### What is the Sankey component?

It is one **<Sankey>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is amounts from each source to each outcome.

Sizes **XS**, **S**, **M** and **L** re-lay the chart out from the data instead of scaling it, so labels stay readable at every size.

### When should I use it?

- **Do flows split and merge?** Yes means the sankey fits.
- **Is there a left and a right side?** Yes means the sankey fits.
- **Are they amounts, not steps?** Yes means the sankey fits.

### When does another type fit better?

- **One path that narrows.** Use Funnel instead.
- **Flows between peers.** Use Chord instead.
- **Steps from one total to another.** Use Waterfall instead.

## Sankey questions

### Does the Sankey chart work with shadcn/ui?

Yes. It installs through the shadcn registry with the shadcn CLI, and the file lands in your project.

### How do I install it?

It is free in Hearth and MIT licensed: add the @chartory registry URL once, no token, then run npx shadcn add @chartory/sankey. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the sankey chart; the agent runs the same command and you review the diff.

### What data does it expect?

Amounts from each source to each outcome. The sample data comes with the component, and the props table lists every field.

### Which sizes does it ship in?

XS, S, M and L, in Figma and in code. Each size is laid out again from the data, so text and lines keep their size.

### Is it in the Figma file too?

Yes. chart/031-sankey has the same properties as the component.

### Does it follow light and dark mode?

Yes. Every paint is a token, so the chart follows light and dark mode and the collection you pick.

### Which plan has the code?

None for Hearth: it is free in the public registry, no token. The Signal collection (@chartory/signal) comes with Code and Complete.