shadcn.io is not affiliated with official shadcn/ui
About
Use it when the total matters and so does its split: traffic by device, revenue by plan, tickets by team. The top edge is the total; the boundary inside it is the split. For shares rather than amounts, use the expanded version. For series that don't add up to anything, use a multiple line chart.
Mobile sits at the bottom with desktop stacked on it, each a smooth curve with a 40% fill in its own color. Hovering a month lists both values with a dot beside each.
Installation
Usage
import { ChartAreaStacked } from "@/components/charts/chart-area-stacked";<ChartAreaStacked />Customize
foldturns each month'sdesktopandmobilefields into rows of{ month, series, visitors }, andstackRowsYstacks them: each row gets ay1and ay2, mobile first, as itsordersays.- One
areaYmark fills each band fromy1toy2withz: "series".color: chartColors(chartConfig, ["mobile", "desktop"])in the definition paints the series withvar(--color-mobile)andvar(--color-desktop), in tooltip order. - A
decorativelineYalongy2draws each band's top edge, and adotinsidewhenFocusedmarks the hovered month. - The tooltip uses the default
dotindicator and shows each band's own value, the segment's length rather than its top edge.
FAQ
How do I choose which series sits at the bottom?
stackRowsY's order lists the series from the bottom up: ["mobile", "desktop"] puts mobile underneath. Swap the two to put desktop at the bottom; the colors stay with their keys.
How do I stack a third series?
Add the field to every row, to the fields that fold reads, to stackRowsY's order and to the keys chartColors gets, with a chartConfig entry on var(--chart-3). Past two series, readers need a key for the colors: add a ChartLegend, as the Area Chart with Legend does.
How do I show the total in the tooltip?
The tooltip lists one row per band, each with its own value, not the running sum. For a total row, give ChartTooltipContent a formatter that adds one after the last item, as the Advanced Tooltip chart does: item.point.datum is the folded row, which keeps the month's desktop and mobile.
Can the areas overlap instead of stacking?
Skip stackRowsY and give areaY the folded rows with y1: 0 and y2: "visitors". Explicit ends opt out of stacking, so each band starts at zero. Lower fillOpacity so the back one shows through.
API Reference
ChartContainer
<div> data-slot="chart"
configChartConfig
Each series' label, icon and color, read by the tooltip and the legend.
definitionChartDefinition
The chart: defineChart(spec, chartTooltip()), its data, marks, scales and axes, and the tooltip's focus.
ariaLabelstring
The chart's accessible name: the card's title.
ariaDescription?string
The chart's accessible description.
className?string
The container's size: aspect-auto h-[250px] w-full, mx-auto aspect-square max-h-[250px]. It's aspect-video by default.
children?ReactNode
What sits under the chart inside the container: a ChartLegend.
tooltip?ChartTooltipContentProps | false
ChartTooltipContent's props (indicator, hideLabel, formatter…) for the default body, or false for TanStack's own tooltip body.
- Type
ChartTooltipContentProps | false
renderTooltip?(context: ChartTooltipBodyRenderContext) => ReactNode
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color).
- Type
(context: ChartTooltipBodyRenderContext) => ReactNode
defaultIndex?number
The category whose tooltip shows before any pointer, as Recharts' defaultIndex.
height?number
A fixed height in pixels for the chart, in place of the container's.
aspectRatio?number
A width-to-height ratio for the chart, in place of the container's height.
initialWidth?number
The width the chart renders at before it's measured.
onFocusChange?(point: ChartPoint | null) => void
Called as the focused point changes: a pointer, a key or a tap.
- Type
(point: ChartPoint | null) => void
onFocusGroupChange?(points: readonly ChartPoint[]) => void
Called with every point at the focused category (a stacked or grouped chart's).
- Type
(points: readonly ChartPoint[]) => void
onSelect?(point: ChartPoint | null) => void
Called when a point is clicked or picked with Enter.
- Type
(point: ChartPoint | null) => void
--color-<key>?color
Each config key's color (its theme color in light and dark), set on the container: the marks paint with var(--color-<key>).
ChartTooltipContent
<div>
pointsreadonly ChartPoint[]
The focused points, from the tooltip's context. ChartContainer passes them to its default body; a body of your own passes its context's.
indicator?"dot" | "line" | "dashed"
The indicator's shape beside each row.
- Type
"dot" | "line" | "dashed"- Default
"dot"
hideLabel?boolean
Hides the label above the rows (the focused category).
- Default
false
hideIndicator?boolean
Hides each row's color indicator.
- Default
false
label?string
The label's text in place of the focused category, looked up in config.
labelKey?string
The datum field (or config key) the label is read from, looked up in config.
nameKey?string
The datum field (or config key) each row's series is read from: a pie's browser.
valueKey?string
The datum field each row's value is read from, for points that carry geometry rather than values (a pie's, from pie()).
color?string
One indicator color for every row, in place of each series' own.
labelFormatter?(label: string, points: readonly ChartPoint[]) => string
Formats the label (the config's label or the category), with the rows' points: a date written out, a unit.
- Type
(label: string, points: readonly ChartPoint[]) => string
formatter?(value: number | string, name: string, item: ChartTooltipItem, index: number) => ReactNode
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row.
- Type
(value: number | string, name: string, item: ChartTooltipItem, index: number) => ReactNode
className?string
Classes for the tooltip's card.
ChartLegend
<div>
config?ChartConfig
The series to list: the container's config by default.
keys?readonly string[]
The series keys to list, in order: every key with a color by default.
hideIcon?boolean
Hides each series' icon (from config), leaving its color swatch.
- Default
false
verticalAlign?"top" | "bottom"
Above the chart or under it.
- Type
"top" | "bottom"- Default
"bottom"
className?string
Classes for the legend's row.
ChartConfig
label?string
The series' name in the tooltip and the legend.
icon?Component
An icon beside its name in the legend and the tooltip (a lucide-react icon).
color?string
Its color in both themes: a token (var(--chart-1)) or any CSS color.
theme?{ light: string; dark: string }
A color for each theme, in place of color.
Helpers
chartTooltip?(settings?: ChartTooltipSettings) => ChartDefinitionOptions
defineChart's second argument for a chart with a tooltip: what a pointer or a key focuses (group-x, each category's series, by default), the focus ring, and the host ChartContainer draws its body in.
- Type
(settings?: ChartTooltipSettings) => ChartDefinitionOptions
chartTheme?ChartTheme
defineChart's theme in the site's tokens: the text, the grid and the palette (--chart-1 to --chart-5).
chartColors?(config: ChartConfig, keys?: readonly string[]) => { domain: string[]; range: string[] }
defineChart's color: each series key (in config order, or keys') painted var(--color-<key>), for marks with a color channel.
- Type
(config: ChartConfig, keys?: readonly string[]) => { domain: string[]; range: string[] }
chartLinearScale?() => LinearScale
A value axis drawn as Recharts draws its default one: zero in the domain, five nice ticks. Pass it as a factory: y: { scale: chartLinearScale }.
- Type
() => LinearScale
curveNatural?CurveFactory
D3's natural curve, for a smooth line or area: curve: d3Curve(curveNatural).
curveStep?CurveFactory
D3's step curve, for a line or area that holds each value: curve: d3Curve(curveStep).
curveMonotoneX?CurveFactory
D3's monotone curve, smooth without overshooting a point: curve: d3Curve(curveMonotoneX).
curveLinearClosed?CurveFactory
D3's closed linear curve: a radar's polygon (curve: curveLinearClosed on radialLine and radialArea).
useChart?() => { config: ChartConfig }
The config of the ChartContainer around a component of your own (a custom tooltip body or legend).
- Type
() => { config: ChartConfig }
Related
Expanded Stacked Area Chart
Area chartsStacked areas expanded to 100%, so each band reads as a share.
Area Chart with Legend
Area chartsStacked areas with a legend naming each series.
Gradient Area Chart
Area chartsAreas filled with a vertical gradient that fades to the axis.
Stacked Bar Chart with Legend
Bar chartsTwo series stacked in each bar, with a legend.
Multiple Line Chart
Line chartsTwo series as lines on the same axes.
Area Chart with Axes
Area chartsStacked areas with both axes and their tick labels drawn.