How do I install Depth Heatmap?

Depth 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/depth-heatmap. It copies depth-heatmap.tsx into components/ui and installs motion, clsx, tailwind-merge.

Is Depth Heatmap free for commercial use?

Depth 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 Depth 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 Depth Heatmap?

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

Depth Heatmap

Liquidity across price and time, painted column by column on a canvas, with the traded price traced on top and a readout of depth at the pointer.

Category: React Chart and Data Table Components
Licence: Charcoal UI Pro
Built with: React 19, Tailwind CSS 4, Motion
Dependencies: motion, clsx, tailwind-merge

Examples

Depth Heatmap

API reference

Prop	Type	Default	Description
`grid`	`number[][]`	—	Liquidity per [time][priceLevel].
`price`	`number[]`	—
`levels`	`string[]`	—
`height`	`number`	`300`
`color`	`string`	`"var(--ember)"`

About Depth Heatmap

Depth Heatmap paints liquidity across price and time column by column on a canvas, traces the traded price on top, and shows the depth at the pointer, so walls and gaps in the book stand out.

Depth Heatmap is an animated chart 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 Depth Heatmap

Order flow and liquidity analysis.
Crypto trading terminals.
Market microstructure research.
Visual dashboards for trading desks.

How it works

Canvas keeps thousands of cells fast. Intensity is scaled to the busiest cell, the price line is drawn over the heat, and the readout updates from the pointer position without re-rendering the canvas.

Each chart has a text alternative, hover tooltips are mirrored by keyboard focus where data points are interactive, and colour is never the only way a value is shown. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Depth 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 color, height live, and the Code tab updates to match, so the snippet you copy already carries your values.

grid (number[][]): Liquidity per [time][priceLevel].
price (number[]).
levels (string[]).
height (number, default 300).
color (string, default "var(--ember)").

Goes well with Depth Heatmap

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

Donut Chart: An animated React donut chart: segments draw in and thicken on hover
Activity Heatmap: A React contribution heatmap with four shades, tooltips and keyboard navigation
Sparkline: An animated React sparkline with fill, trend colour and a pulsing end dot
Line Chart: An animated React line chart with a snapping crosshair and multi-series tooltips
Area Chart: An animated React area chart with a comparison series and a target line

Install Depth Heatmap

npx shadcn@latest add @charcoal/depth-heatmap

Depth Heatmap is part of Charcoal UI Pro. One seat unlocks all 393 Pro components, 112 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 depth-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 Depth Heatmap?: Depth 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/depth-heatmap. It copies depth-heatmap.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Depth Heatmap free for commercial use?: Depth 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 Depth 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 Depth Heatmap?: Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Depth Heatmap's props and get_install_command returns the exact command.

Depth Heatmap as Markdown · llms.txt