# Activity Heatmap · Pro

A contribution-style heatmap: a cell per day in weekly columns, shaded in four steps of the accent, painting in column by column, with a tooltip that follows hover and the arrow keys.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/activity-heatmap
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Activity Heatmap
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `values` | `number[]` | — | One per day, oldest first. |
| `weeks` | `number` | `20` |  |
| `color` | `string` | `"var(--ember)"` |  |
| `cell` | `number` | `12` |  |
| `gap` | `number` | `3` |  |
| `format` | `(value: number, index: number) => string` | — |  |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/activity-heatmap