# Spiral year

> A year of weeks, wound into one coil. Sample data: active workspaces per week over one year, with a 9-week streak above 2K.

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

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

```bash
npx shadcn add @chartory/spiral-year
```

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

usage.tsx:

```tsx
import { SpiralYear }
  from "@/components/chartory/spiral-year"

<SpiralYear
  data={activeWorkspaces}
  size="m"
  legend
/>
```

## Props

### `<SpiralYear>`

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

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

### SpiralYearData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| vals | number[] | Required | The values, in order. |
| turns? | number | 2.5 | The number of turns. |
| center | [string, string, string][] | Required | The lines in the centre: [text style, text, tone]. |
| rows | SpiralYearRow[] | Required | One entry per row. |

### SpiralYearRow

One object per entry in rows.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| text | string | Required | The label as shown. |
| pct? | string | — | The share as shown, e.g. "42%". |
| tok? | string | — | The colour token, e.g. "data/primary". |
| tone? | string | — | The tone of the mark (a colour token). |
| h? | number | — | The row height in the side list, in px. |

## Spiral year chart: a React and Figma chart in four sizes

### What does a spiral year chart show?

A spiral year chart winds 52 weeks around a coil, so a whole year reads as one shape and busy and quiet stretches stand out. Notes mark launches and holidays. Use it for weekly activity where the yearly rhythm matters.

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 Spiral year component?

It is one **<SpiralYear>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is one value per week of a year.

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?

- **Is it one value per week?** Yes means the spiral year fits.
- **Is the yearly rhythm the point?** Yes means the spiral year fits.
- **Does it cover one year?** Yes means the spiral year fits.

### When does another type fit better?

- **One value per day.** Use Calendar heatmap instead.
- **Only the trend matters.** Use Line chart instead.
- **Monthly values in one ring.** Use Radial lollipop instead.

## Spiral year questions

### Does the Spiral year 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/spiral-year. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

One value per week of a year. 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/051-spiral-workspaces 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.