Charcoal UI

Order Book

A live order book: asks above and bids below with cumulative depth bars, the mid price and spread between them, rows that flash when their size changes, and a buy/sell balance meter.

Examples

Order Book

API reference

PropTypeDefaultDescription
bids / asks{ price: number; size: number }[]—
decimalsnumber2
rowsnumber8

About Order Book

Order Book lists asks above and bids below with cumulative depth bars, the mid price and spread between them, and rows that flash when their size changes. A meter shows the balance between buying and selling.

Order Book 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 Order Book

  • Crypto and stock trading screens.
  • Exchange and DEX interfaces.
  • Market data demos.
  • Auction and bidding tools.

How it works

Depth bars are scaled to the deepest cumulative level. Size changes flash green or red briefly, and prices use tabular figures with the decimals you set, so columns never jitter as data updates.

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 Order Book

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

  • bids / asks.
  • decimals (number, default 2).
  • rows (number, default 8).

Goes well with Order Book

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 Order Book

npx shadcn@latest add @charcoal/order-book

Order Book 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 order-book.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 Order Book?
Order Book is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/order-book. It copies order-book.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Order Book free for commercial use?
Order Book 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 Order Book 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 Order Book?
Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Order Book's props and get_install_command returns the exact command.

Order Book as Markdown · llms.txt