# Progress ring

> How much of a quota is used. Sample data: 72% of the token quota used, 7.2M used, 2.8M remaining, resets in 9 days.

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

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

```bash
npx shadcn add @chartory/progress-ring
```

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

usage.tsx:

```tsx
import { ProgressRing }
  from "@/components/chartory/progress-ring"

<ProgressRing
  data={tokenQuota}
  size="m"
/>
```

## Props

### `<ProgressRing>`

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

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

### ProgressRingData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| slices | ProgressRingSlice[] | Required | One entry per slice. |
| rows | ProgressRingRow[] | Required | One entry per row. |
| inner? | number | 0 | The inner radius. |
| track? | boolean | false | Draws the full ring in data/track behind the slices. |
| of? | number | — | The whole the values are a share of. |
| sep? | boolean | false | Strokes the slices apart in the background colour. |
| d? | number | — | The ring's diameter, in px. |
| center? | ProgressRingCenter | — | The text in the centre: value and caption. |

### ProgressRingSlice

One object per entry in slices.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| v | number | Required | The value. |
| tok | string | Required | The colour token, e.g. "data/primary". |

### ProgressRingRow

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. |

### ProgressRingCenter

The center object.

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

## Progress ring: a React and Figma chart in four sizes

### What does a progress ring show?

A progress ring fills a circle by the share used, with the percentage in the middle and the used, remaining and forecast amounts beside it. Use it for quotas, plan usage and goals with one limit.

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 Progress ring component?

It is one **<ProgressRing>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a share used of a total, and the rows beside it.

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 there one limit?** Yes means the progress ring fits.
- **Is it a share of a limit?** Yes means the progress ring fits.
- **Is the share used now enough?** Yes means the progress ring fits.

### When does another type fit better?

- **Several limits.** Use Limit tracks instead.
- **A reading against a threshold.** Use Gauge instead.
- **The spend over the month matters.** Use Budget runway instead.

## Progress ring questions

### Does the Progress ring 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/progress-ring. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

A share used of a total, and the rows beside it. 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/020-progress-ring 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.