# Gauge

> One reading on a dial, with a limit marked. Sample data: fleet utilisation today, overload above 85%.

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

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

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

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

usage.tsx:

```tsx
import { Gauge }
  from "@/components/chartory/gauge"

<Gauge
  data={fleetUtilisation}
  size="m"
/>
```

## Props

### `<Gauge>`

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

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

### GaugeData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| v | number | Required | The value. |
| warn | number | Required | Where the warning range starts. |
| center? | string | — | The value in the centre. |
| caps | string | Required | The caption under the value. |

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

### What does a gauge chart show?

A gauge chart shows one value on a half dial with its limit marked, so a single reading and how close it is to the line come through at a glance. Use it for utilisation, load and other values with a clear threshold.

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

It is one **<Gauge>** 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 from 0 to 100%, a threshold and a label.

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?** Yes means the gauge fits.
- **Is there a threshold?** Yes means the gauge fits.
- **Is the reading now, not a trend?** Yes means the gauge fits.

### When does another type fit better?

- **Several values side by side.** Use Bullet instead.
- **A share of a quota.** Use Progress ring instead.
- **The value over time.** Use Target trend instead.

## Gauge questions

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

### Can my coding agent install it?

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

### What data does it expect?

One value from 0 to 100%, a threshold and a label. 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/021-gauge 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.