Returns Calendar
A monthly returns grid: green and red cells scaled by the size of the move, a compounded total per year, and a selectable month or year that dims the rest.
- 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
Returns Calendar
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
years | Record<string, (number | null)[]> | — | Monthly percent returns per year. |
About Returns Calendar
Returns Calendar lays out monthly returns as a grid of green and red cells scaled by the size of the move, with a compounded total per year. Select a month or a year and the rest dim back.
Returns Calendar 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 Returns Calendar
- Fund and strategy performance pages.
- Portfolio reports.
- Trading journals.
- Investor updates.
How it works
Yearly totals compound the monthly returns rather than summing them. Colour strength scales to the largest move, and every cell is a button with its month and return in its label.
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 Returns Calendar
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
Style it with className like any other element. It only uses your theme's tokens, so it follows light and dark mode without extra work.
- years: Monthly percent returns per year.
Goes well with Returns Calendar
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 Returns Calendar
npx shadcn@latest add @charcoal/returns-calendarReturns Calendar 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 returns-calendar.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 Returns Calendar?
- Returns Calendar is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/returns-calendar. It copies returns-calendar.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Returns Calendar free for commercial use?
- Returns Calendar 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 Returns Calendar 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 Returns Calendar?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Returns Calendar's props and get_install_command returns the exact command.