Skip to main content

Area Chart

An area chart for showing how values (and, when stacked, a total and its parts) change over a continuous x axis. Compose the gridlines, axes, and one AreaChart.Area per series inside AreaChart.Root.

When to use

  • Show how the magnitude of a value changes over time. The fill gives the value weight.
  • Show a total and its parts over time with stacked areas.
  • Compare a few series that each fill from zero with overlapping areas.
  • Prefer LineChart to compare the shapes of trends, where filled areas would hide where the series cross.
  • Prefer BarChart to compare discrete categories by bar length from zero.

Stacked areas

Set stacked on the Root to show a total and its parts. The top edge of the stack is the total, and each band is the share of one series. Compose AreaChart.Legend on every multi-series chart.

Overlapping areas

Without stacked, every series fills from the zero baseline and the areas overlap. The 10% wash is what keeps this legible: with two series you can read both bands and the region where they cross. Every hover dot is a circle by default. Where bands cross, set shape on a series to give its dot a second encoding beside color (see Shapes below).

Overlap stops scaling: past two or three series the intersections turn to mud. When the series compose a meaningful total, stack them; when they don't, switch to a LineChart.

Shapes

An area chart wears its glyphs on the legend keys and the active-point dots: a filled band has no per-point mark, so the glyph shows in the legend and on the dots that ride the band edges at the crosshair.

There are eight glyphs: "circle", "square", "triangle", "diamond", "triangle-down", "plus", "cross", and "star". Every series wears "circle" until you set shape. Mantle doesn't pair a glyph with a color, so the second encoding is your choice. Set shape where color can't carry identity alone: a reader with a color vision deficiency, a grayscale print or export, forced-colors mode.

The example below pins a controlled activeIndex (falling back to a fixed point when the pointer leaves) so the dots stay visible without hovering. US East keeps the default circle, EU West sets "square", and AP South sets "star". Move the crosshair and each dot keeps its series' glyph at every position. Point shapes on the scatter plot page is the full family treatment.

Curve interpolation

curve picks the interpolation between points: "linear" (the default) draws straight segments, "monotone" smooths the band without overshooting the data, and "step" holds each value until the next point. Smoothing is presentation only: the plotted values, tooltip readout, and keyboard cursor are identical in both charts below.

Gaps in the data

null (or missing) values render as gaps by default: a hole in the band that says "no data here", which is usually the honest choice for missed scrapes and collection outages. Set connectNulls on the Area to join across the hole when the gap is a collection artifact rather than a real absence.

In a stacked chart a gap in one series contributes nothing to the stack at that x position, and the boundary stays continuous so the series above it don't tear.

No traffic yet

An all-zero series is data, not an empty state. Areas fill from the zero baseline, so the value axis stays anchored there and the baseline sits on the axis rather than floating through the middle of the plot. Keep the accessible name, the tooltip, and the data table: "0" is the answer, and a screen reader needs to hear it. Reach for mode="decorative" only when the values are a synthetic backdrop behind an empty-state message.

Reference lines

AreaChart.ReferenceLine paints a dashed horizontal marker at a y value (an SLO threshold, a budget, a capacity limit) with an optional label above its right end. Here the stacked total crosses provisioned capacity twice:

Live data

For live charts, append points to the end of a sliding window and let the chart do the rest. When appends arrive at a steady rate, the x domain scrolls at one constant speed. The chart measures the time between appends and glides the domain to each new target over that interval, so the newest point slides in from the right edge. A point that arrives early or late changes the speed from the current position, with no jump. The plotted data itself never wobbles: new data must never make old data appear to move. As the window slides, axis tick labels (and the gridlines that share their fade) fade in and out instead of popping between tick sets, and the marks dissolve through a fade band at the plot's left edge (a scroll mask), so points exiting the window slide out smoothly instead of being clipped away. The mask activates automatically when the chart detects a sliding window and retires on its own once the stream idles. prefers-reduced-motion snaps everything instantly: no glide, no fades.

Motion plays only while the chart is on screen. A chart that is near the viewport but off screen paints each append settled, with no glide. On a "point" scale (string x values), a window that slides to new categories snaps each area to its new values. The y axis still glides.

This demo appends one point every 200ms to a sliding 60-point window. Each point derives from a pure formula over a tick counter and a fixed epoch, so every render is deterministic; a real chart would append measurements as they arrive.

Copy as markdown

AreaChart.CopyButton copies the chart's current rows to the clipboard as a machine-stable, GitHub-flavored markdown table: one x column plus one column per series in paint order (an ISO 8601 timestamp for every x on a time scale, plain un-separated numbers, an em dash for gaps), pasteable into Slack, issues, spreadsheets, and LLM chats. The button renders in flow where composed; Root is relatively positioned, so className can dock it over a corner.

Lists of charts

A page of 100 charts pays for the handful a reader can see. A dormant AreaChart.Root is a shell: the plot box, the named interaction overlay, and its screen-reader description. It holds no paint surface and no engine. The chart activates when it comes within one viewport of the visible area, takes focus, or prints. Activation runs outside React, on-screen charts first, in slices of a few milliseconds with a yield to the browser between them. Each chart paints in the task that activates it. A print paints every chart settled, with tick labels and gridlines at full opacity. The hover layers and the tooltip surface mount on the first hover. The screen-reader data table waits for focus alone: it mounts once a reader tabs into the chart, so a page of sparklines holds no hidden tables until a reader asks for one. Add content-visibility: auto to your list's cards as a complement: it skips style and layout for offscreen cards, and the chart's own gate already skips paint.

Wrap a list of interactive charts in AreaChart.List. The charts inside share one role="status" live region, so a page of 100 charts mounts one region instead of one per chart, plus one for each AreaChart.CopyButton. Each chart keeps its own tooltip, description, and data table. Charts of different families can share one List, so one AreaChart.List can hold a grid of bar, line, area, and scatter charts. A static chart has no tooltip and no live region, so a list of sparklines needs no List.

Modes

mode sets how much of the chart's contract a Root exposes. Pick by what a reader does with the chart.

modeUse it forA reader gets
"interactive" (default)A chart a reader explores: a dashboard panel, a detail page, a report with a question behind it.A named role="application" Tab stop, hover and keyboard point cursor, a tooltip readout, polite announcements, and an sr-only data table on focus.
"static"A chart a reader glances at while the exact values sit beside it: a sparkline in a table row or a card, a trend in a print report.A named role="img" with a text description (kind, count, range, series), no Tab stop, no hover, no tooltip, no table. animate defaults to false.
"decorative"A placeholder whose values are not information: synthetic an area behind an empty state, a hero backdrop.Nothing: hidden from assistive technology, out of the tab order, inert, every series in one neutral fill.

Noninteractive is not decorative. A sparkline beside a total still tells a reader when activity happened and how it varied, so it keeps a name and a description; only its values live in the text beside it. One hundred sparklines in a table as one hundred Tab stops is a focus order no reader wants, and a readout that only a pointer can reach fails WCAG 2.2 SC 2.1.1 (Keyboard), so "static" offers neither. A chart that is the only source of its values stays "interactive".

Static charts

Set mode="static" for a chart a reader glances at while the exact values sit beside it. The plot is a named role="img": it takes the same aria-label or aria-labelledby an interactive chart does, and its aria-describedby points at the description, so a screen reader hears the chart kind, the point count, the x range, and the series labels without a Tab stop. There is no interaction overlay: no hover band, no tooltip, no keyboard point cursor, no data table, and no live region, and a composed AreaChart.Tooltip has no effect. Pointer events pass through to the row or card behind it. The series keep their colors. animate defaults to false, because a list of sparklines that each play a reveal as the reader scrolls is motion with no information in it; pass animate to play the reveal. The interaction props (activeIndex, onActiveIndexChange, onDatumActivate) are forbidden at the type level. The Sparklines in a List recipe is the worked example.

<div className="flex items-center gap-2">	<AreaChart.Root		data={service.requests}		xKey="day"		mode="static"		aria-label={`Requests for ${service.name}, last 30 days`}		className="aspect-auto h-6 w-28"	>		<AreaChart.Area dataKey="count" label="Requests" color="blue" />	</AreaChart.Root>	<span className="text-muted text-xs tabular-nums">{compact(service.requestTotal)}</span></div>

Decorative charts

Set mode="decorative" to render the chart as a placeholder backdrop instead of real data: a synthetic area behind an empty state, an atmospheric hero graphic. A decorative chart keeps its visual rendering and animation but drops every layer that only makes sense for real data: it is hidden from assistive technology, removed from the tab order, and inert to pointer and keyboard, with no hover band, tooltip, sr-only data table, or live region. Because the values aren't information, mode="decorative" is mutually exclusive with the accessible-name props (aria-label / aria-labelledby) and the interaction props (activeIndex, onActiveIndexChange, onDatumActivate); the type won't compile with both.

A decorative chart also drops the series colors. Every series paints --color-chart-decorative, one neutral fill that outranks a series' color. A backdrop carries no series identity, and a hue on values that are not information invites a reader to decode it.

That fill is what keeps an overlaid message readable. Empty.Description sits on text-muted, which measures 4.88:1 on a bare light card: 0.38 over the 4.5:1 floor for 14px text, so any tint under that copy spends the headroom. --color-chart-decorative is the darkest neutral step that still clears the floor in both themes: 4.56:1 in light and 4.93:1 in dark. The message needs no scrim behind it, no dimming, and no blur. Redeclare the token on the Root to retune the fill (className="[--color-chart-decorative:var(--color-neutral-100)]") and re-measure the copy against the value you pick.

Reach for mode="decorative" over hand-rolled inert + CSS: it removes the interaction overlay at the source, so consumers never target chart internals to neutralize it. Keep the real empty-state message as a sibling of the chart (not inside it) so screen readers still announce it; the decorative chart itself is silent.

mode="decorative" says the values are not information; it is not a disabled flag (a chart is not a form control). For real data a reader only glances at, use mode="static".

Composition

Compose the parts of an AreaChart together to build your own:

AreaChart.Root├── AreaChart.Grid├── AreaChart.XAxis├── AreaChart.YAxis├── AreaChart.Area (one per series)├── AreaChart.ReferenceLine├── AreaChart.Tooltip├── AreaChart.Legend└── AreaChart.CopyButton
  • Root owns the data, the scales, the renderer, and the entire interaction contract. Every other part must be composed inside it.
  • Area registers one series per part; with stacked on the Root, areas stack in registration order with the first-registered series at the baseline.
  • Grid, XAxis, YAxis, and ReferenceLine register chart chrome that the Root paints. Omit a part to omit that chrome.
  • Tooltip customizes the always-on hover/keyboard readout; omitting it never removes the hover layer.
  • Legend renders series names keyed by color swatches as real DOM in flow below the plot. Always compose it on multi-series charts; it renders nothing for a single series.

The interaction layer ships with Root, and there is no part to add for it: a crosshair with an every-series tooltip, keyboard stepping with polite announcements, an sr-only description, and click, Enter, or Space activation. The sr-only data table mounts once the chart takes focus.

Wrap a list of Roots in AreaChart.List so they share one live region:

AreaChart.List└── AreaChart.Root (one per chart)

Stacking order

With stacked on the Root, series stack from the baseline up in registration order. Areas that mount together register in composition order, so the first Area sits on the baseline and each later Area stacks on top of it. An Area that mounts later stacks on top of every series already registered, whatever its position in the JSX. A dataKey that unmounts and returns goes back to its original position.

Reordering the parts of a mounted chart does not restack it. The position stays with the dataKey, so a series does not jump when you rename its label. The tooltip lists the top of the pile first, to match what a reader scans at the crosshair.

Fill, axes, and density

Each area fills with a 10% wash of its series color and has a 2px stroke on the band edge. An area chart therefore reads as a line chart with weight, and never as a saturated block that hides the grid and the other series.

Areas always fill from a zero baseline. The type fixes the y-domain minimum at 0 (yDomain?: [0, number | "auto"]), so a truncated-baseline area chart is not possible.

Large datasets decimate before they paint. Accessibility tells how the keyboard cursor steps through a decimated chart.

Color and accessibility

An area's 2px edge is the mark a reader decodes. The 10% wash under it is decorative: it gives the band weight, but the edge already draws the band's shape, so the wash needs no contrast of its own. WCAG 2.2 SC 1.4.11 Non-text Contrast asks for 3:1 between that edge and the card behind it. Like lines, the edges don't need to contrast with each other.

  • In dark mode, every color name clears 3:1 on the card. In light mode, every name does except yellow (2.94:1). For a yellow series, show its values as text beside the chart, or pick amber.
  • Pick colors that differ in lightness as well as hue. Mantle doesn't check that a set of names stays apart for a color-blind reader.
  • When bands overlap or sit side by side, set shape on each series. Its hover dot and legend key then carry a second encoding beside color (see Shapes).

The Bar Chart page covers the rest: mantle's stance on color, the exemptions SC 1.4.11 allows, and the eight-series limit.

Keep a chart to eight series

Past eight series, a reader cannot match each band to its legend key by color. Rank the series by the window's total, keep the top seven, and sum the rest into one "Other" series. Give the Other series color="neutral", so it reads as the tail and not as one more category. Keep it last, so it sits at the top of a stack. The Bar Chart page has a worked fold.

Accessibility

Every interactive chart must have an accessible name: the Root requires exactly one of aria-label or aria-labelledby, enforced at the type level. Prefer aria-labelledby referencing a visible title when the chart sits under a heading, so no duplicated text can drift. The name lands on the focusable interaction overlay, the chart's single named element (the paint surface itself is hidden from assistive technology, so the chart is never announced twice). A static chart names its plot role="img" instead and has no Tab stop. A decorative chart carries no real data, so it takes no accessible name and is hidden from assistive technology entirely.

The plot is a single tab stop with a keyboard point cursor:

KeyAction
TabFocus the plot.
← / →Step between data points.
Page Up / Page DownStep by larger jumps.
Home / EndJump to the first / last data point.
Enter / SpaceActivate the current data point (fires onDatumActivate).
EscapeDismiss the point cursor and tooltip.

Escape, Enter, and Space act only while a point is active. An idle Escape therefore reaches the surface around the chart, such as a panel that closes on Escape. A held Enter or Space activates once, and a chord with Alt, Ctrl, or Meta passes through to the browser. With a pointer, only the primary button activates a point. In forced-colors mode, the focused chart shows a focus outline, and the crosshair and the hover dots stay visible.

Keyboard stepping announces the x value and every series' value at it through a debounced polite live region, so rapid arrowing never floods the screen-reader queue. Announcements follow keyboard steps only: the chart doesn't announce a data update while the keyboard cursor rests on a point. When the labelFormat or valueFormat of a composed AreaChart.Tooltip returns a string or a number, the announcement uses it. A stacked chart announces the Total before the series values. The data table keeps the default number format.

The overlay's aria-describedby points at a screen-reader description, data-slot="area-chart-description", so a screen reader hears what the chart holds when it takes focus: the chart kind, the number of data points, the x range from the first point to the last, the series labels, and the keyboard instructions. For example: "Area chart with 30 data points from Jul 1, 2026 to Jul 30, 2026. Series: Requests, Errors. Use the left and right arrow keys to move between data points, …". An empty chart reads "Area chart with no data." in place of the count and range. Server HTML carries the plain count alone. The range waits for hydration, because Intl output differs by locale, and the series labels register in layout effects, so both render on the client.

Every chart also renders an sr-only data table of the plotted data once it takes focus, bounded to the first 150 rows with a caption stating the summarization when the data is larger. An AreaChart.Root mounts dormant and engages once focus lands inside it (the overlay is the Tab stop, and a focusable part composed inside the Root, such as AreaChart.CopyButton, counts too), and it never goes dormant again. Visibility paints the chart but never mounts the table. The Root stamps data-state="dormant", then data-state="engaged", and the table mounts with the flip, so a screen reader's table list names only the charts the reader has focused. The description above names what every chart holds, focused or not. Tooltips enhance, they never gate. The keyboard point cursor steps one point at a time, so it reaches every point. When the chart decimates (at 4 or more points per device-pixel column), each arrow key press moves one device-pixel column. The cursor then reaches one point per column. The table holds the first 150 rows, and AreaChart.CopyButton copies every row.

The table doubles as the chart's machine-readable surface. On a "time" scale, every row header carries its x (a Date, an epoch number, or a date string) as an ISO 8601 timestamp in <time dateTime>. Value cells carry the raw number in data-value, so agents and scrapers read precise data from the DOM without reverse-engineering locale formatting. A row whose x has no text form, such as null or a date that doesn't parse, shows an em dash. Assistive tech still hears the human-formatted text, and the table itself is addressable at data-slot="area-chart-data-table". To reach it, an agent focuses the chart (a scroll into view is not enough), then waits for data-state="engaged" on the Root. AreaChart.CopyButton hands over the same rows as markdown with neither step.

The Bar Chart page lists the accessibility limits that every chart family shares, such as the pause control that a live chart needs from your page.

API Reference

AreaChart.Area, AreaChart.Grid, AreaChart.XAxis, AreaChart.YAxis, and AreaChart.ReferenceLine are renderless: they register configuration with the Root, which paints everything onto one surface: an <svg>. They accept no className, style, or other DOM props. AreaChart.Tooltip and AreaChart.Legend accept div props: the legend renders a real DOM element in flow, and the tooltip forwards its div props onto the tooltip element the Root renders. AreaChart.CopyButton also renders real DOM: an icon button that accepts button props. AreaChart.List renders a div around a list of Roots.

AreaChart.Root

The root of an area chart: owns the data, the scales, the renderer, and the entire interaction contract. Renders a <div> wrapping the plot and is generic over TDatum, the row type of data.

All props from div, plus:

PropTypeDefaultDescription
datareadonly TDatum[]Rows of data; each AreaChart.Area reads one numeric key per row.
xKeyExtract<keyof TDatum, string>The key of each row's x value.
aria-labelstringThe chart's accessible name. Exactly one of aria-label or aria-labelledby is required, enforced at the type level. Required unless mode is \"decorative\", which forbids it.
aria-labelledbystringThe id of a visible element that names the chart. Preferred over aria-label when the chart sits under a visible heading. Required unless mode is \"decorative\", which forbids it.
mode?"interactive" | "static" | "decorative""interactive"How much of the contract the Root exposes: explore it ("interactive"), glance at it with its values beside it ("static": a named role="img", no Tab stop, no tooltip, no table, animate off by default), or paint a placeholder ("decorative": hidden from assistive technology, one neutral fill). The name props are required unless decorative, and the interaction props are allowed only when interactive. See Modes.
xScale"time" | "linear" | "point"auto-detectedOverride the auto-detected x scale (Date values → "time", numbers → "linear", strings → "point").
yDomain[0, number | "auto"][0, "auto"]Override the automatic y maximum. The minimum is always the zero baseline.
stackedbooleanfalseStack the series in registration order, the first-registered series at the baseline.
animatebooleantrueAnimate enter/update transitions. When the chart first comes into view, each area sweeps in from the left. prefers-reduced-motion always wins.
pendingbooleanfalseHold the previous render at reduced opacity while fresh data loads. Never swap a chart that has rendered once for a skeleton.
activeIndexnumber | nullControlled active datum index (null = none). Omit for uncontrolled hover. Allowed only when mode is "interactive".
onActiveIndexChange(index: number | null) => voidNotified when hover or keyboard stepping moves the active index. Allowed only when mode is "interactive".
onDatumActivate(event: ChartDatumEvent) => voidNotified on datum activation: a mark click, or Enter/Space on the focused chart. Allowed only when mode is "interactive".

ChartDatumEvent is importable from @ngrok/mantle/area-chart: { index: number; xValue: string | number | Date; datum: object; dataKey: string | null } (datum is the original row; narrow it to your row type), where dataKey names the series nearest the pointer on mouse activation and is null for keyboard activation.

Data attributes

Data AttributeValueDescription
data-slot"area-chart"The Root wrapper, with any forwarded chain ahead of it.
data-slot"area-chart-plot"The plot box. Every overlay layer positions against it, and the resize observer measures it.
data-slot"area-chart-svg"The <svg> the marks paint on. Always aria-hidden. Engine-owned: it is absent from server HTML and from a dormant chart, and the Root inserts it when the chart activates (near the viewport, on focus, or before print).
data-slot"area-chart-crosshair"The vertical hairline snapped to the active x. The engine writes its geometry as an inline style. Engine-owned: it is absent from server HTML. The engine appends it on the first hover, keyboard step, or controlled activeIndex that names a datum. It stays until the Root destroys the engine, such as when mode leaves "interactive". Interactive charts only: a static or decorative chart inserts the surface alone.
data-slot"area-chart-hover-band"The category highlight; an area chart never shows it. Engine-owned: it is absent from server HTML. The engine appends it on the first hover, keyboard step, or controlled activeIndex that names a datum. It stays until the Root destroys the engine, such as when mode leaves "interactive". Interactive charts only: a static or decorative chart inserts the surface alone.
data-slot"area-chart-markers"The container the engine syncs one hover dot per series into. Engine-owned: it is absent from server HTML. The engine appends it on the first hover, keyboard step, or controlled activeIndex that names a datum. It stays until the Root destroys the engine, such as when mode leaves "interactive". Interactive charts only: a static or decorative chart inserts the surface alone.
data-slot"area-chart-tooltip"The tooltip surface. The Root renders it on the first hover or keyboard step and keeps it; AreaChart.Tooltip configures it. A chart nobody points at holds none.
data-slot"area-chart-description"The sr-only description the overlay's aria-describedby points at: the chart kind, the point count, the x range, the series labels, and, on an interactive chart, the keyboard instructions. Omitted when mode="decorative".
data-slot"area-chart-data-table"The sr-only data table. Mounts once focus lands inside the chart (data-state flips to "engaged") and stays. Interactive charts only.
data-state"dormant" | "engaged"On the Root. Flips to "engaged" once focus lands inside the chart, and never flips back. The data table mounts with it. Visibility paints the chart but never flips it. Interactive charts only.
data-slot"chart-active-point"One hover dot inside the markers layer. Also carries data-shape.
data-shape"circle" | "square" | "triangle" | "diamond" | "triangle-down" | "plus" | "cross" | "star"On each hover dot, naming the glyph its series wears: the shape it set, else "circle". The dot clips itself to that glyph, so target this only to restyle a dot.

AreaChart.Area

One area series. Renders nothing itself: it registers the series with the chart, which paints it. Compose one Area per series.

PropTypeDefaultDescription
dataKeystringThe row key this series reads its numeric values from.
label?stringdataKeyDisplay name for the legend, tooltip, and data table.
colorColor | stringThe color the series paints: a mantle color name (the same Color that Badge takes) or any CSS color. Required. Give an "Other" series "neutral". See Chart color tokens.
curve?"linear" | "monotone" | "step""linear"Interpolation between points: straight segments, smoothed without overshoot, or held steps.
connectNulls?booleanfalseJoin across null/missing values instead of leaving gaps. Gaps are the default and usually correct.
shape?"circle" | "square" | "triangle" | "diamond" | "triangle-down" | "plus" | "cross" | "star""circle"The glyph the hover dot and legend key wear. Set it for a second encoding beside color. See Shapes.

AreaChart.Grid

Horizontal hairline gridlines behind the areas (renderless; the chart paints it). Omit the part to omit the grid.

PropTypeDefaultDescription
lines"horizontal" | "vertical" | "both""horizontal"Which gridlines to draw.

AreaChart.XAxis

Tick labels along the bottom of the plot (renderless; the chart paints it). Labels that would collide are skipped, never rotated.

PropTypeDefaultDescription
tickFormat(value: string | number | Date, context: { defaultLabel: string }) => stringFormat a tick label. Receives the row's x value: the category value on point scales, a Date on time scales, and a number on linear scales. The second argument is { defaultLabel }: the label the axis paints without a formatter.
tickCountnumberdensity-derivedTarget tick count (continuous scales only). Approximate: a linear axis over integer-only x values never renders fractional ticks.

AreaChart.YAxis

Value tick labels along the left of the plot (renderless; the chart paints it). Ticks land on clean thousands-separated numbers.

PropTypeDefaultDescription
tickFormat(value: number, context: { defaultLabel: string; step: number }) => stringthousands-separatedFormat a tick label. The second argument carries the tick step and the defaultLabel the axis paints without a formatter, so a formatter can add a unit to defaultLabel and keep its precision.
tickCountnumber5Maximum tick count. When omitted, the axis aims for about 5 ticks. The axis can render fewer: ticks land on human-friendly steps, a vertical axis keeps about 28px for each tick, and a label that would overlap its neighbor is skipped. Integer-valued data never renders fractional ticks.

AreaChart.ReferenceLine

A dashed horizontal marker at a y value, such as an SLO threshold, a budget, or a limit (renderless; the chart paints it).

PropTypeDefaultDescription
ynumberThe y value the line marks.
labelstringA short label painted above the line's right end.
colorColor | stringthe neutral reference colorLine color: a mantle color name or any CSS color.

AreaChart.Tooltip

Customizes the hover/keyboard tooltip readout. The tooltip itself is part of AreaChart.Root's interaction contract and renders even when this part is absent. Compose it to format the label or values, append a footer, or replace the content entirely.

A children readout renders inside a <div data-slot="area-chart-tooltip-label">. When it goes away, React removes that div instead of your own text nodes: a browser translation engine reparents text nodes, and a removal aimed at one throws. The div is display: contents, so it adds no box and your content stays a direct layout child of the parent. To style it as a box, set a display of your own on it first. Browser translation covers the mechanism and the rules your own components need.

All props from div (forwarded onto the tooltip element the Root renders) except children, plus:

PropTypeDefaultDescription
labelFormat(value: string | number | Date) => ReactNodeFormat the x/label row of the readout.
valueFormat(value: number, dataKey: string) => ReactNodeFormat each series value.
indicator"line" | "none""line"The per-series color key: a short stroke or nothing.
footerReactNode | (snapshot: HoverSnapshot) => ReactNodeExtra content appended below the series rows (e.g. a "view logs" hint).
children(snapshot: HoverSnapshot) => ReactNodeReplace the entire readout.

The HoverSnapshot passed to footer and children describes the active x position: { index, xValue, datum, points, viaKeyboard }, where points holds every series' value at that position. Stacked, the rows run from the top of the pile back to the baseline; unstacked, they follow registration order.

Data attributes

Data AttributeValueDescription
data-slot"area-chart-tooltip-label"On the <div> wrapping a children readout. The default readout has none.

AreaChart.Legend

The legend: series names keyed by swatches carrying each series' color and glyph, rendered as real DOM in flow below the plot. Always compose it on multi-series charts: identity must never rely on color-matching alone. It renders nothing for a single series (the chart's title already names it). The legend is at most 64px tall (max-h-16) and scrolls past that, so many series never take the plot's height in a fixed-height Root. Set a max-h-* class in className to change the bound.

A children render prop renders inside a <div data-slot="area-chart-legend-label">. When it goes away, React removes that div instead of your own text nodes: a browser translation engine reparents text nodes, and a removal aimed at one throws. The div is display: contents, so it adds no box and your content stays a direct layout child of the parent. To style it as a box, set a display of your own on it first. Browser translation covers the mechanism and the rules your own components need.

All props from div except children, plus:

PropTypeDefaultDescription
children(series: SeriesMeta[]) => ReactNodeReplace the default legend items; receives the registered series.

Each SeriesMeta is { dataKey, label, mark, color, colorInput, shape, texture }, where color is the CSS color string the series paints with and shape is the resolved glyph: the shape the series set, else "circle".

Data attributes

Data AttributeValueDescription
data-slot"area-chart-legend"The legend list. AreaChart.Legend renders it in flow below the plot.
data-slot"area-chart-legend-label"On the <div> wrapping a children render prop. The default legend has none.
data-shape"circle" | "square" | "triangle" | "diamond" | "triangle-down" | "plus" | "cross" | "star"On each series' swatch, naming the glyph its AreaChart.Area wears. The swatch clips itself to that glyph, so target this only to restyle a key.

AreaChart.CopyButton

A button that copies the chart's current data to the clipboard as a GitHub-flavored markdown table: one x column plus one column per series in paint order. Values are machine-stable (an ISO 8601 timestamp for every x on a time scale, plain un-separated numbers, an em dash for gaps), so the paste target receives parseable data, not locale formatting. Renders an icon button in flow where composed; Root is relatively positioned, so className can dock it over a corner (e.g. absolute right-0 top-0).

All props from button, plus:

PropTypeDefaultDescription
label?string"Copy data as Markdown"The accessible name, rendered as the button's aria-label.
onCopy?(value: string) => voidCallback fired after a successful copy, passes the serialized markdown.
onCopyError?(error: unknown) => voidCallback fired when an error occurs during copying.
asChild?booleanfalseCompose the copy behavior onto your own element instead of the default button.

While a copy is fresh, an always-mounted role="status" element beside the button announces "Copied" to a screen reader.

Data AttributeValueDescription
data-slot"area-chart-copy-button"The button the part renders.

AreaChart.List

Groups a list of charts, such as one chart per card, so they share one role="status" live region. A page of 100 charts mounts one region instead of one per chart, plus one for each AreaChart.CopyButton. Each chart keeps its own tooltip, description, and data table. Charts of different families can share one List. See Lists of charts.

Renders a div (area-chart-list) that holds the charts in a display: contents wrapper (area-chart-list-items), so a grid or flex layout on the List reaches the cards, and the live region as its last child. AreaChart.List takes no asChild: a list element such as ul cannot hold the live region as a child.

All props from div.

Data AttributeValueDescription
data-slot"area-chart-list"The List wrapper, with any forwarded chain ahead of it. It takes the className and the other div props.
data-slot"area-chart-list-items"The display: contents wrapper around the charts, so a grid or flex layout on the List lays out the cards.

Chart color tokens

Each color name has one chart token, --color-chart-<name>. A series with color="blue" paints --color-chart-blue, and so do its legend key and hover dot.

CSS VariableDescription
--color-chart-<hue>One token for each hue: amber, blue, cyan, emerald, fuchsia, gray, green, indigo, lime, orange, pink, purple, red, rose, sky, teal, violet, and yellow. Dark mode paints the hue's 500 step. Light mode paints its 600 step, because 500 reads washed out on a white card.
--color-chart-<status>One token for each functional name. Each aliases the hue its status color uses: accent and info paint sky, danger paints rose, important paints purple, success paints emerald, and warning paints amber. neutral paints neutral-500 in dark mode and neutral-600 in light mode.
--color-chart-decorativeThe neutral fill every series wears on a decorative chart, in place of its own color.

A series that means good or bad, such as an error rate or a success rate, wears a functional name (danger, success), not a hue.

A CSS string in color is the escape hatch. A raw hex value can't follow the two themes, so prefer a var(--token) that each theme declares. Mantle measures its named tokens only, so check a color you set for 3:1 against the card in both themes.

Series identity and color

Set a series' color in one of two places:

  • color on AreaChart.Area, a color name or any CSS color string. It changes that series alone.
  • A token redeclared on AreaChart.Root, such as className="[--color-chart-blue:var(--color-brand)]". Every series on that chart with color="blue" picks up the new value, and so do its legend key, band fill, and hover dot.

The chart paints every token as CSS, so the browser resolves it inside the Root's own cascade, with no computed-style read and no hidden probe element. A declaration scoped to one Root wins for that chart alone, and sibling charts on the page keep the theme value. Declare the same custom property higher up (on a dashboard wrapper, or at :root) to retheme a whole subtree.

The example below rethemes blue to a brand orange, so HTTP paints #d07c00. TLS paints a CSS string, var(--color-accent-600), which each theme declares.