# Box plot

> The spread of each group in five numbers. Sample data: response latency of five models, Atlas 3 to Nova, on a 0 to 1.2 s scale.

- Type 043 · Distribution
- Component: `<BoxPlot>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/box-plot` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/box-plot

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

```bash
npx shadcn add @chartory/box-plot
```

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

usage.tsx:

```tsx
import { BoxPlot }
  from "@/components/chartory/box-plot"

<BoxPlot
  data={modelLatency}
  size="m"
  legend
/>
```

## Props

### `<BoxPlot>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | BoxPlotData | 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. |
| legend | boolean | true | Shows the legend row under the plot. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### BoxPlotData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| max | number | Required | The top of the value scale. |
| ticks | string[] | Required | The axis tick labels. |
| rows | BoxPlotRow[] | Required | One entry per row. |

### BoxPlotRow

One object per entry in rows.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| q | [number, number, number, number, number] | Required | The five numbers: min, lower quartile, median, upper quartile, max. |
| out? | number[] | — | The outliers. |

## Box plot: a React and Figma chart in four sizes

### What does a box plot show?

A box plot sums up each group's values as a box for the middle half, a line for the median and whiskers for the range, with outliers as dots. Use it to compare the spread of response times, prices or scores across groups.

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 Box plot component?

It is one **<BoxPlot>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is five numbers per group and its outliers.

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?

- **Are several groups compared?** Yes means the box plot fits.
- **Is a summary enough?** Yes means the box plot fits.
- **Is it raw values, not estimates?** Yes means the box plot fits.

### When does another type fit better?

- **One group in full.** Use Histogram instead.
- **The full shape per group.** Use Ridgeline instead.
- **Estimates with intervals.** Use Dot plot with intervals instead.

## Box plot questions

### Does the Box plot 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/box-plot. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Five numbers per group and its outliers. 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/043-box-plot-latency 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.
