shadcn.io is not affiliated with official shadcn/ui
About
Use it when the sum matters as much as the parts: calories across activities, revenue across products, time across tasks. It's the formatter variant plus one row: each series gets a swatch, its name and its value in kcal, then a rule and a Total in the same column.
The chart is a stack of running and swimming per day, so the bar's height already shows the total. The tooltip puts the exact number on it, which the chart has no axis to read from.
Installation
Usage
import { ChartTooltipAdvanced } from "@/components/charts/chart-tooltip-advanced";<ChartTooltipAdvanced />Customize
ChartTooltipContent'sformatterdraws each row: a swatch invar(--color-<key>), thechartConfiglabel, the value and a mutedkcal. React and Solid pass it inChartContainer'stooltipoptions, Vue and Svelte as a slot or snippet.- When
indexis 1, the last row, the formatter also draws the Total, the day's values added up, so it sits in the same column as the rows. hideLabeldrops the date heading, andw-[180px]on the content's class keeps the width steady.- When rows aren't enough,
ChartContainertakes a whole body of your own:renderTooltipin React and Solid, thetooltipslot in Vue, therenderTooltipsnippet in Svelte.
FAQ
How is the Total row added?
In ChartTooltipContent's formatter. It's called once per row with the value, the series key, the row and its index; on the last row it also draws a Total under a border-t rule, adding up the day's values. For a layout rows can't hold, render a whole body of your own: renderTooltip in React and Solid, the tooltip slot in Vue, the renderTooltip snippet in Svelte.
How do I total more than two series?
Draw the Total when the index is the last row's, and add the day's values over the chartConfig keys instead of naming running and swimming. Each row's point.datum keeps the original row's fields, so every series is there to sum. A new series also needs its field in fold's fields and stack's order.
How do I change the unit?
The kcal span sits in two places in formatter: after each value and after the total. Change both, or keep the unit next to the series in chartConfig and read it from there.
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
Chart Tooltip with Formatter
TooltipsA tooltip whose values carry their own units.
Chart Tooltip without Label
TooltipsA tooltip with the series alone, no label above them.
Stacked Bar Chart with Legend
Bar chartsTwo series stacked in each bar, with a legend.
Stacked Radial Chart
Radial chartsTwo series stacked on a half ring, with their total.
Chart Tooltip
TooltipsThe default tooltip: a label, then each series with its dot.
A tooltip that marks each series with a line, not a dot.