shadcn.io is not affiliated with official shadcn/ui
About
Use it when one chart should cover more than one metric and the reader picks: page views by device, sales by region. Each header button shows its series' total, so the number reads before the bars. To compare the series at once, use grouped bars or two lines.
Ninety-one daily bars fill the card's width, with a few dates along the bottom. Pressing Desktop or Mobile swaps the series and its color, and the tooltip names the full date.
Installation
Usage
import { ChartBarInteractive } from "@/components/charts/chart-bar-interactive";<ChartBarInteractive />Customize
- The rows are daily,
{ date, desktop, mobile }. The active key lives in component state (ReactuseState, a Vueref, Svelte$stateor a Solid signal) and the definition is rebuilt from it. barYreadsx: "date"and the active key for its height, and itsfillswitches betweenvar(--color-desktop)andvar(--color-mobile).- The header's totals are summed once from
chartData, not read from the chart. tickLabels: { thin: { minGap: 32 } }keeps the x axis to a few dates, not 91, formatted asApr 1. Acrosshairwithx: { band: true }shades the hovered day.ChartContainertrades the video aspect foraspect-auto h-[250px] w-full, and itstooltipprop setsnameKey: "views"and alabelFormatterfor the full date.
FAQ
How does the header switch the series?
Each button sets the active key in state, and the definition is derived from it, so the bars, their color and the tooltip change together. The buttons are real buttons with aria-pressed, so Tab and Enter work on them and a screen reader hears which one is on.
How do I add a third metric?
Add the field to every row, an entry to chartConfig with a label and a color, a sum to total, and the key to the ["desktop", "mobile"] list the header buttons map over. The bar color follows the key.
How do I show a shorter period?
Filter chartData before the chart reads it, as the Interactive Area Chart does with its 90, 30 and 7 day select. Fewer days give wider bars.
How are the dates formatted?
The rows keep ISO dates like 2024-04-01. The x axis tick format prints them as Apr 1 with toLocaleDateString, and the tooltip's labelFormatter as Apr 1, 2024. Change the locale or options in both.
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
Interactive Area Chart
Area chartsThree months of daily visitors with a time range select.
Interactive Line Chart
Line chartsThree months of daily values, switched between two series.
Multiple Bar Chart
Bar chartsTwo series grouped side by side for each month.
Bar Chart
Bar chartsOne series of rounded vertical bars, a month each.
Interactive Pie Chart
Pie chartsA donut whose active month is picked from a select.
Horizontal Bar Chart
Bar chartsHorizontal bars with the categories down the side.