# Hex grid

> Where clicks pile up on a page. Sample data: clicks on three key pages, product 16.1K, home 14.2K, checkout 8.3K.

- Type 028 · Space and place
- Component: `<HexGrid>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/hex-grid` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/hex-grid

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

```bash
npx shadcn add @chartory/hex-grid
```

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

usage.tsx:

```tsx
import { HexGrid }
  from "@/components/chartory/hex-grid"

<HexGrid
  data={pageClicks}
  size="m"
/>
```

## Props

### `<HexGrid>`

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

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

### HexGridData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| panels | HexGridPanel[] | Required | One entry per panel. |

### HexGridPanel

One object per entry in panels.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| name | string | Required | The name shown on the chart. |
| sub | string | Required | The second line under the label. |
| blobs | [number, number, number, number][] | Required | The blobs. |

## Hex grid: a React and Figma chart in four sizes

### What does a hex grid show?

A hex grid divides an area into hexagons and shades each one by how many events fall in it, so dense spots show without thousands of dots. Use it for click maps, store traffic or any events placed on a surface.

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 Hex grid component?

It is one **<HexGrid>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a few hot spots per page (x, y, spread and weight) and a click count.

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 events placed on a surface?** Yes means the hex grid fits.
- **Are there many events?** Yes means the hex grid fits.
- **Is it a page or floor, not a map?** Yes means the hex grid fits.

### When does another type fit better?

- **Counts on a grid of two axes.** Use Heatmap instead.
- **A few points with values.** Use Scatter instead.
- **Countries on a map.** Use Tile map instead.

## Hex grid questions

### Does the Hex grid 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/hex-grid. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

A few hot spots per page (x, y, spread and weight) and a click count. 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/028-hexbin 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.