# Streamgraph

> How the mix shifts through the year. Sample data: shipments by four modes, January to December, October at 47K.

- Type 014 · Change over time
- Component: `<Streamgraph>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/streamgraph` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/streamgraph

## 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 Streamgraph component to your project.

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

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

usage.tsx:

```tsx
import { Streamgraph }
  from "@/components/chartory/streamgraph"

<Streamgraph
  data={shipmentsByMode}
  size="m"
/>
```

## Props

### `<Streamgraph>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | StreamgraphData | 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. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### StreamgraphData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| now | number | Required | Where now is on the axis. |
| nowLabel | string | Required | The label at now. |
| xl | Record<number, string> | Required | The x axis labels, by index. |
| layers | StreamgraphLayer[] | Required | One entry per layer. |

### StreamgraphLayer

One object per entry in layers.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| name | string | Required | The name shown on the chart. |
| tok | string | Required | The colour token, e.g. "data/primary". |
| vals | number[] | Required | The values, in order. |

## Streamgraph: a React and Figma chart in four sizes

### What does a streamgraph show?

A streamgraph stacks several series around a centre line, so the total and each part's share flow as one shape. Thick and thin stretches show when each part grows or fades. Use it for a mix over a season, such as shipment modes or traffic sources.

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 Streamgraph component?

It is one **<Streamgraph>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is three to six parts, one value per period.

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 the parts add up to a whole?** Yes means the streamgraph fits.
- **Is the shape more important than exact values?** Yes means the streamgraph fits.
- **Are there many periods?** Yes means the streamgraph fits.

### When does another type fit better?

- **Each series is its own level.** Use Overlapping areas instead.
- **Exact values per period matter.** Use Stacked bars instead.
- **One period, one split.** Use Donut instead.

## Streamgraph questions

### Does the Streamgraph 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/streamgraph. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Three to six parts, one value per period. 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/014-streamgraph 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.