# Age pyramid

> Two groups by age, back to back. Sample data: active customers by age, new against returning, 25–34 at 28% and 24%.

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

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

```bash
npx shadcn add @chartory/age-pyramid
```

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

usage.tsx:

```tsx
import { AgePyramid }
  from "@/components/chartory/age-pyramid"

<AgePyramid
  data={customerAges}
  size="m"
  legend
/>
```

## Props

### `<AgePyramid>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | AgePyramidData | 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. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### AgePyramidData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| max | number | Required | The top of the value scale. |
| aTok | string | Required | The colour token of the first side. |
| bTok | string | Required | The colour token of the second side. |
| rows | AgePyramidRow[] | Required | One entry per row. |

### AgePyramidRow

One object per entry in rows.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| a | number | Required | The value on the left (aTok). |
| b | number | Required | The value on the right (bTok). |

## Age pyramid: a React and Figma chart in four sizes

### What does an age pyramid show?

An age pyramid sets two groups back to back, with age bands as rows, so you compare their age mix in one shape. Use it for new against returning customers, users by gender or members by region.

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 Age pyramid component?

It is one **<AgePyramid>** 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 per age band for two groups.

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 groups?** Yes means the age pyramid fits.
- **Are the rows ordered bands?** Yes means the age pyramid fits.
- **Is it shares, not answers?** Yes means the age pyramid fits.

### When does another type fit better?

- **One group by age.** Use Horizontal bars instead.
- **Items with no order.** Use Dumbbell instead.
- **Survey answers on a scale.** Use Likert instead.

## Age pyramid questions

### Does the Age pyramid 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/age-pyramid. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

A share per age band for two groups. 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/082-pyramid-customers 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.
