# Sankey Chart · Pro

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.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/sankey-chart
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Sankey Chart
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `links` | `{ source: string; target: string; value: number }[]` | — |  |
| `width / height` | `number` | `640 / 320` |  |
| `gap` | `number` | `14` |  |
| `format` | `(v: number) => string` | — |  |
| `title` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/sankey-chart