shadcn.io is not affiliated with official shadcn/ui
About
Use it when there are two series but only one should be on screen, and the totals matter as much as the shape. The header doubles as a summary: each button shows its series' total for the period. For both series at once, use the Multiple Line Chart; for a filled look with a range select, the Interactive Area Chart.
A monotone line runs through 91 days, April to June 2024, without dots. The x axis prints a date every week or two, and the tooltip shows the full date and the value, labeled Page Views. The chart is 250px tall and fills the card's width.
Installation
Usage
import { ChartLineInteractive } from "@/components/charts/chart-line-interactive";<ChartLineInteractive />Customize
- The rows are daily,
{ date, desktop, mobile }. OnelineYreadsx: "date"andyfrom the active series, and strokes with that series'var(--color-<key>). - The active series is state (React
useState, a Vueref, Svelte$stateor a Solid signal) and the definition is derived from it, so a click rebuilds the line and the chart tweens to it. - The totals are summed once from
chartDatafor the buttons; they don't depend on the active series. - Ninety-one dates don't fit as labels. The x axis thins them with
tickLabels: { thin: { minGap: 32 } }and prints the rest asApr 10through its tickformat. Acrosshair({ y: false })first inmarksdraws the hover line. ChartContainergetsaspect-auto h-[250px] w-fullon its class; itstooltippasses alabelFormatterfor the full date andnameKey: "views"for the Page Views label.
FAQ
How does the series switch work?
Each header button sets the active key, desktop or mobile, held in React useState, a Vue ref, Svelte $state or a Solid signal. The definition is derived from that key, so the line's y and its var(--color-<key>) stroke change together, and the line tweens to the new values.
How do I add a third series?
Add the field to every row, an entry in chartConfig with a label and a --chart-N color, the key to the list the header buttons are built from, and its sum to the total object beside the definition.
How do I add a date range?
Keep the range in state next to the series, filter chartData by date before the definition reads it, and add a select, as the Interactive Area Chart does with its 7, 30 and 90 day options.
Why don't all the dates show on the axis?
Ninety-one labels would overlap. The x axis's tickLabels: { thin: { minGap: 32 } } drops any label closer than 32px to the one before, as Recharts' minTickGap does, and its tick format prints the rest as Apr 10. The tooltip shows the full date for any day you hover or reach with the arrow keys.
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
Multiple Line Chart
Line chartsTwo series as lines on the same axes.
Interactive Area Chart
Area chartsThree months of daily visitors with a time range select.
Interactive Bar Chart
Bar chartsThree months of daily bars, switched between two series.
A tooltip whose label is formatted as a full date.
Line Chart
Line chartsOne series as a smooth line over six months.
Linear Line Chart
Line chartsStraight segments between points, no smoothing.