Beautiful Charts
Get Pro

TreemapFree

Areas true to value, grouped one level, labels only where they fit; zero, negative and missing values are named instead of drawn.

npx shadcn@latest add https://beautifulcharts.dev/r/treemap.json

Engine: ·

Code

"use client";

import { TreemapChart } from "@/components/beautiful-charts/themes/instrument/recharts/treemap-chart";

// Area is proportional to value. Zero, negative and missing values can't be areas, so they're named under the chart.
const data = [
  { area: "Compute", item: "Instances", usd: 18400 }, { area: "Compute", item: "Functions", usd: 3200 },
  { area: "Storage", item: "Objects", usd: 6100 }, { area: "Storage", item: "Backups", usd: 2400 },
  { area: "Network", item: "Egress", usd: 4800 }, { area: "Network", item: "Credit", usd: -900 },
];

export function CloudSpend() {
  return <TreemapChart data={data} nameKey="item" valueKey="usd" groupKey="area" valueFormatter={(v) => `$${(v / 1000).toFixed(1)}k`} title="Where the money goes" />;
}

Props

  • nameKey*

    keyof TDatum & string

    The field naming each tile.

  • valueKey*

    keyof TDatum & string

    The field holding each tile's value (its area).

  • groupKey

    keyof TDatum & string

    A field grouping tiles one level: each group gets a block, tiled inside. Group names are the keys of config.

  • colorBy

    "group" | "tile" | "value"

    "group" (default when grouped) colours by group; "tile" gives every tile its own palette colour; "value" uses one colour.

  • gap

    number

    Space between tiles in px (default 2).

  • radius

    number

    Tile corner radius in px (default 4).

Props every chart shares (32): data, config, header, states, legend, tooltip, formatting, motion and selection

  • data*

    TDatum[]

    Your rows, as they are. Missing values (null, undefined, NaN) stay missing and are never drawn as zero.

  • locale

    string

    BCP 47 locale. Defaults to "en-US" so server and client render the same text.

  • timeZone

    string

    IANA time zone for dates. Defaults to "UTC" so server and client agree.

  • config

    ChartConfig

    Per-series label, colour, icon, format and style, keyed by series key. shadcn ChartConfig works as it is.

  • eyebrow

    ReactNode

    Small label above the title.

  • title

    ReactNode

    Card title. A string also names the chart for screen readers.

  • description

    ReactNode

    A line under the title.

  • takeaway

    ReactNode | ((summary: string) => ReactNode) | false

    The sentence under the title. Computed from the data by default; pass text, a function of the computed sentence, or false to hide it.

  • ariaDescription

    string

    Accessible summary for screen readers. Computed from the data by default.

  • motion

    MotionPreference

    "full" (default), "subtle" or "off". Reduced-motion settings always win.

  • motionOptions

    MotionOptions

    When the entrance plays.

  • sound

    boolean

    Sound cues on hover, scrub and select. Plays only if the visitor has also turned sound on for the page.

  • density

    Density

    "comfortable" (default) or "compact" for dashboards.

  • legend

    LegendOptions | false

    Legend position, alignment, shape and click action, or false to hide it.

  • tooltip

    TooltipOptions<TDatum> | false

    Tooltip position, indicator, cursor and custom content, or false to turn it off.

  • valueFormatter

    (value: number) => string

    Values formatted for display. Series formatters in config win.

  • loading

    boolean

    Show the loading state. Over existing data, the old marks stay dimmed instead of vanishing.

  • error

    string | null

    An error message. Shows the error state in place of the plot.

  • emptyState

    ReactNode

    Shown instead of the plot when there is no data.

  • loadingState

    ReactNode

    Shown while loading is true and there is no data yet.

  • errorState

    ReactNode

    Shown when error is set.

  • selected

    number | null

    Controlled and uncontrolled interaction state. Point selection (selected) pins one row by its index in data. Series selection (selectedSeries) picks one series and dims the others. They are separate: picking a row doesn't pick a series.

  • defaultSelected

    number | null

    Initial selected row when uncontrolled.

  • hidden

    string[]

    Controlled hidden series keys.

  • defaultHidden

    string[]

    Series hidden at first when uncontrolled.

  • activeIndex

    number | null

    Controlled hover or focus index, for syncing several charts on one cursor.

  • palette

    "theme" | "shadcn"

    Series colours: "theme" (default) uses the theme's designed palette; "shadcn" uses your --chart-1..5. --bc-series-N always wins. You can also opt a whole section in with the class bc-use-shadcn-colors.

  • table

    boolean

    Show the "Show data table" disclosure. On by default.

  • stats

    ChartStat[]

    A row of figures under the title, for dashboard cards and blocks.

  • footer

    ReactNode

    A line or action at the bottom of the card, e.g. a source note or a link.

  • className

    string

    Classes on the card, for spacing and layout.

  • height

    number

    Height of the plot area in px. The frame sizes around it.

Events (4)

  • onSelectedChange

    (selection: Selection<TDatum> | null) => void

    Called when a row is selected or cleared, by pointer, keyboard or the data table.

  • onHiddenChange

    (hidden: string[]) => void

    Called when the legend hides or shows a series.

  • onActiveChange

    (index: number | null) => void

    Called as the hovered or focused row changes, or null when it leaves.

  • onReady

    (chart: EChartsType) => void

    Called once with the ECharts instance, e.g. to add event listeners.

Apache ECharts build only (2)

  • renderer

    EChartsRenderer

    "canvas" (default) or "svg".

  • option

    OptionOverride

    Deep-merged over the generated option, or (generated) => option. Tiles are custom series "tiles" (one item per tile).

Accessibility, keyboard and motion

Pointer
Hover a tile to show its value and share of its group; click pins it.
Keyboard
Tab lands once on the plot. Left and Right move between points (the first press goes to the latest), Up and Down change series, Home and End jump to the ends, Enter or Space pins, Escape clears.
Screen readers
Every move is announced as a sentence, not coordinates. "Show data table" opens the numbers as a real table, and missing values stay empty, never zero.
Motion
Tiles fade in, staggered, then their labels. With reduced motion everything appears settled at once, and nothing depends on the motion to be read.

Related