# Sunburst

> Parts and their sub-parts, in rings. Sample data: $48.2K spend this month by team, research $20.2K, agents $3.0K.

- Type 022 · Part of a whole
- Component: `<Sunburst>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/sunburst` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/sunburst

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

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

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

usage.tsx:

```tsx
import { Sunburst }
  from "@/components/chartory/sunburst"

<Sunburst
  data={spendByTeam}
  size="m"
/>
```

## Props

### `<Sunburst>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | SunburstData | 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. |

### SunburstData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| center | SunburstCenter | Required | The text in the centre: value and caption. |
| groups | SunburstGroup[] | Required | One entry per group. |

### SunburstCenter

The center object.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| value | string | Required | The value as shown. |
| caps | string | Required | The caption under the value. |

### SunburstGroup

One object per entry in groups.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| tok | string | Required | The colour token, e.g. "data/primary". |
| items | [string, number][] | Required | One entry per item. |

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

### What does a sunburst chart show?

A sunburst chart shows a total in the centre, its parts in the first ring and each part's sub-parts in the ring outside it. Use it for spend by team and model, sales by category and product, or any two-level breakdown.

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

It is one **<Sunburst>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a total, parts and sub-parts.

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 there two levels?** Yes means the sunburst fits.
- **Is the round shape wanted?** Yes means the sunburst fits.
- **Are the parts few?** Yes means the sunburst fits.

### When does another type fit better?

- **One level of parts.** Use Donut instead.
- **Two levels as rectangles.** Use Icicle instead.
- **Many parts in groups.** Use Treemap instead.

## Sunburst questions

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

### Can my coding agent install it?

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

### What data does it expect?

A total, parts and sub-parts. 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/022-sunburst 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.
