How do I install Activity Heatmap?

Activity Heatmap is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/activity-heatmap. It copies activity-heatmap.tsx into components/ui and installs motion, clsx, tailwind-merge.

Is Activity Heatmap free for commercial use?

Activity Heatmap needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.

Does Activity Heatmap work with Next.js?

Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.

Can an AI coding agent install Activity Heatmap?

Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Activity Heatmap's props and get_install_command returns the exact command.

Activity Heatmap

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.

Category: Display
Licence: Charcoal UI Pro
Built with: React 19, Tailwind CSS 4, Motion
Dependencies: motion, clsx, tailwind-merge

Examples

Activity Heatmap

API reference

Prop	Type	Default	Description
`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`	—

About Activity Heatmap

Activity Heatmap draws a cell per day in weekly columns, shaded in four steps of the accent colour, painting in column by column, with a tooltip that follows hover and the arrow keys.

Activity Heatmap is a display component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Activity Heatmap

Contribution and streak graphs.
Habit and fitness trackers.
Usage analytics.
Writing and learning progress.

How it works

It is a grid role with one focusable cell at a time; arrows move by day and week. format controls the tooltip and accessible label.

Interactive parts are buttons or links with accessible names, decorative layers are hidden from assistive tech, and everything is reachable by keyboard. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Activity Heatmap

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change weeks, cell, gap, color live, and the Code tab updates to match, so the snippet you copy already carries your values.

values (number[]): One per day, oldest first.
weeks (number, default 20).
color (string, default "var(--ember)").
cell (number, default 12).
gap (number, default 3).
format.

Goes well with Activity Heatmap

These display pieces share its tokens and motion language, so they sit together on one page without clashing.

Tilt Card: A 3D tilt card for React that leans toward the pointer with a moving glare
Spotlight Card: A React spotlight card: an accent glow follows the pointer across card and border
Sortable List: A drag-to-reorder React list with lifted shadows and keyboard sorting
Card Stack: A swipeable React card stack where the next card rises to meet you
Image Compare: A React before and after image comparison slider you can drag anywhere

Install Activity Heatmap

npx shadcn@latest add @charcoal/activity-heatmap

Activity Heatmap is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies activity-heatmap.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

How do I install Activity Heatmap?: Activity Heatmap is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/activity-heatmap. It copies activity-heatmap.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Activity Heatmap free for commercial use?: Activity Heatmap needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Activity Heatmap work with Next.js?: Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Activity Heatmap?: Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Activity Heatmap's props and get_install_command returns the exact command.

Activity Heatmap as Markdown · llms.txt