# Area

> A trend with weight under it. Sample data: spot price, Sep 10 to Oct 9.

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

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

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

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

usage.tsx:

```tsx
import { Area }
  from "@/components/chartory/area"

<Area
  data={spotPrice}
  size="m"
/>
```

## Props

### `<Area>`

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

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

### AreaData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| vals | number[] | Required | The values, in order. |
| min | number | Required | The bottom of the value scale. |
| max | number | Required | The top of the value scale. |
| ticks | string[] | Required | The axis tick labels. |
| xl | Record<number, string> | Required | The x axis labels, by index. |
| yW? | number | 36 | The width of the y axis label column, in px. |
| smooth? | boolean | false | Draws the line as a curve. |
| area? | "flat" \| "gradient" | — | The fill under the line. |
| dots? | number[] \| "all" | — | Which points get a dot. |
| end? | boolean | false | Labels the last point. |
| tip? | AreaTip | — | The highlighted point: index and label. |

### AreaTip

The tip object.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| i | number | Required | The index of the item it belongs to. |
| text | string | Required | The label as shown. |

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

### What does an area chart show?

An area chart is a line chart with the space below it filled, so the trend also reads as an amount. The fill fades toward the axis and keeps the line in front. Use it for prices, balances and volumes where the level matters as much as the direction.

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

It is one **<Area>** 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 point in time.

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 series?** Yes means the area fits.
- **Does the level matter, not only the trend?** Yes means the area fits.
- **Is one value per period enough?** Yes means the area fits.

### When does another type fit better?

- **Several fills stack up and hide.** Use Overlapping areas instead.
- **Only the direction matters.** Use Line chart instead.
- **Open, high, low and close matter.** Use Candlestick instead.

## Area chart questions

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

### Can my coding agent install it?

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

### What data does it expect?

One value per point in time. 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/011-area 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.