shadcn.io is not affiliated with official shadcn/ui
About
This is the dashboard chart: a long daily series where the reader picks the window. Use it when one view has to serve both the quarter and the last week. For two series people compare one at a time, the Interactive Bar Chart switches between them instead.
Desktop and mobile stack as smooth curves with gradient fills, under date labels spaced so they don't collide. A select in the header filters to the last 90, 30 or 7 days, the tooltip shows the date, and a legend sits under the plot.
Installation
Usage
<script lang="ts">
import ChartAreaInteractive from "@/components/charts/chart-area-interactive.svelte";
</script><ChartAreaInteractive />Customize
- The range lives in state (React
useState, a Vueref, Svelte$stateor a Solid signal), and the rows are filtered by it before they reach the marks. - The definition is derived from the range (
useMemo,computed,$derivedorcreateMemo), so it's rebuilt only when the select changes. ChartTooltipContentgets alabelFormatterthat prints the hovered date asApr 10, and thedotindicator.- The gradients are the Gradient Area Chart's: one per series in the definition's
gradients, used asurl(#<id>)fills. ChartContainerhasaspect-auto h-[250px] w-fullin its class: a fixed height at the card's full width.
FAQ
How does the range filter work?
The rows run from April 1 to June 30, 2024. The select's value (90d, 30d or 7d) sets how many days to count back from June 30, and only the rows from that date on reach the chart. With live data, count back from today or ask your API for the range.
Does it animate when the range changes?
The definition is rebuilt from the selected range (useMemo, computed, $derived or createMemo), and TanStack tweens the areas to their new shape over 400ms. Under reduced motion they snap into place.
Why does the select disappear on phones?
Its trigger has hidden sm:flex, as in shadcn/ui's original, so below the sm breakpoint the chart shows the full 90 days. Remove hidden to keep the select on small screens.
How do I plot my own dates?
Give each row an ISO date (2024-04-01) and the two values. The label formatters parse it with new Date(), which reads a day-only date as midnight UTC: format with timeZone: "UTC" or readers west of UTC see the day before.
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?Snippet
What sits under the chart inside the container: a ChartLegend.
tooltip?(ChartTooltipContentOptions & { class?: string }) | false
ChartTooltipContent's options (indicator, hideLabel, labelFormatter…) for the default body, or false for TanStack's own tooltip body.
- Type
(ChartTooltipContentOptions & { class?: string }) | false
renderTooltip?Snippet<[ChartTooltipBodySnippetContext]>
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). A snippet.
- Type
Snippet<[ChartTooltipBodySnippetContext]>
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?Snippet<[{ index, item, name, value }]>
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row. A snippet.
- Type
Snippet<[{ index, item, name, value }]>
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-svelte 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 Bar Chart
Bar chartsThree months of daily bars, switched between two series.
Interactive Line Chart
Line chartsThree months of daily values, switched between two series.
Gradient Area Chart
Area chartsAreas filled with a vertical gradient that fades to the axis.
Interactive Pie Chart
Pie chartsA donut whose active month is picked from a select.
A tooltip whose label is formatted as a full date.
Area Chart with Legend
Area chartsStacked areas with a legend naming each series.