shadcn.io is not affiliated with official shadcn/ui
About
Stack the bars when the total matters and so does what it's made of: traffic by device, revenue by plan. Comparing the top segment from month to month is harder than with grouped bars, so use those when the parts matter more than the sum.
Each month is one bar, desktop at the bottom and mobile on top, rounded at both ends and square where the two meet. A legend under the chart names the two colors, and the tooltip lists both values without the month.
Installation
Usage
import { ChartBarStackedLegend } from "@/components/charts/chart-bar-stacked-legend";<ChartBarStackedLegend />Customize
- One
barYmark withlayout: stack({ order })piles the series in each month; the order array sets which one sits on the baseline. radiusis a function of the row:[0, 0, 4, 4]for desktop at the bottom,[4, 4, 0, 0]for mobile on top, so each stack reads as one shape.- The parts fill with
var(--color-desktop)andvar(--color-mobile)fromchartConfig. ChartLegend, a child ofChartContainer, draws a swatch and a label perchartConfigkey.keyspicks and orders the entries, andverticalAlignplaces it above or below.- The tooltip hides its title with
hideLabel, since the month is on the axis.
FAQ
How are the bars stacked?
layout: stack({ order: ["desktop", "mobile"] }) on barY: each series starts where the previous one ends, in that order from the baseline. Swap the array to put mobile at the bottom, and swap the two radius tuples with it.
How are only the outer corners rounded?
radius is a function of the row: desktop, at the bottom, gets [0, 0, 4, 4] and mobile, on top, [4, 4, 0, 0], so the stack is round at both ends and square where they meet. For deeper stacks, radius: { end: 4 } rounds only each stack's outer end.
How do I move or change the legend?
ChartLegend sits inside ChartContainer and reads each key's label and color from chartConfig. Set verticalAlign to top to put it above the chart, keys to choose and order its entries, and hideIcon to keep plain swatches.
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.
class?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?JSX.Element
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) => JSX.Element
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). Read the context's fields in JSX (context.points), so Solid tracks them.
- Type
(context: ChartTooltipBodyRenderContext) => JSX.Element
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) => JSX.Element
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) => JSX.Element
class?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"
class?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-solid 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
Multiple Bar Chart
Bar chartsTwo series grouped side by side for each month.
Stacked Area Chart
Area chartsTwo series stacked into one total, each band its own color.
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.
Stacked Radial Chart
Radial chartsTwo series stacked on a half ring, with their total.
Advanced Chart Tooltip
TooltipsA tooltip with formatted values and a total row.