shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Chart Tooltip with Formatter

Q: How is the unit added to each value?

ChartTooltipContent's formatter returns each row's content: here the series' label from chartConfig, then the value with a muted kcal after it. React and Solid pass it in ChartContainer's tooltip prop; Vue and Svelte give ChartTooltipContent a formatter slot or snippet, inside the container's tooltip slot or renderTooltip snippet.

Q: How do I format the numbers themselves?

Format the number inside the formatter. value.toLocaleString() adds thousands separators, and Intl.NumberFormat with style: "currency" or style: "unit" writes dollars, percents or kilometers for the reader's locale.

Q: Can I keep the date above the rows?

hideLabel drops the date heading. The Label Formatter variant shows how to keep it and format it as a full date; the two options work together.

Q: Why do the numbers line up?

The value sits in font-mono tabular-nums, so every digit has the same width and the values line up down the column; the unit follows in a lighter weight with items-baseline.

A tooltip whose rows carry their own unit, 450 kcal not 450, with the date heading and the color dots dropped, on a stacked bar chart in Svelte.

PreviewCode

About

Reach for it when a bare number would be ambiguous: calories, minutes, dollars. Each row keeps the series name on the left and puts the value on the right with its unit in muted text, and the date heading and color dots are gone, so the tooltip is two compact lines.

Without dots, the names carry the series. That works with two well-named series; with more, or with similar names, keep the dots and use the Advanced variant.

Installation

Free with an account. It carries your token, so the CLI installs everything in one go.

Google GitHub

Use email insteadNo credit card

Usage

<script lang="ts">
import ChartTooltipFormatter from "@/components/charts/chart-tooltip-formatter.svelte";
</script>

<ChartTooltipFormatter />

Customize

ChartTooltipContent's formatter writes each row: the chartConfig label, then the value and kcal. It's in ChartContainer's tooltip options in React and Solid, a slot or snippet in Vue and Svelte.
hideLabel removes the date heading, so the rows are the whole tooltip.
The value uses font-mono tabular-nums and the unit text-muted-foreground, the same classes as the default rows.
Change the unit in one place, or derive it from your data if your series have different units.

FAQ

How is the unit added to each value?

ChartTooltipContent's formatter returns each row's content: here the series' label from chartConfig, then the value with a muted kcal after it. React and Solid pass it in ChartContainer's tooltip prop; Vue and Svelte give ChartTooltipContent a formatter slot or snippet, inside the container's tooltip slot or renderTooltip snippet.

Where did the color dots go?

Because the formatter draws the whole row, and this one draws no swatch. Add a size-2.5 rounded-[2px] square painted with var(--color-<key>) at the start of the row to bring it back, as the Advanced variant does.

How do I format the numbers themselves?

Format the number inside the formatter. value.toLocaleString() adds thousands separators, and Intl.NumberFormat with style: "currency" or style: "unit" writes dollars, percents or kilometers for the reader's locale.

Can I keep the date above the rows?

hideLabel drops the date heading. The Label Formatter variant shows how to keep it and format it as a full date; the two options work together.

Why do the numbers line up?

The value sits in font-mono tabular-nums, so every digit has the same width and the values line up down the column; the unit follows in a lighter weight with items-baseline.

API Reference

ChartContainer

<div> data-slot="chart"

PropType

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

CSS variableType

--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>

PropType

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>

PropType

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

KeyType

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

ExportType

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 }

Advanced Chart Tooltip
Tooltips
A tooltip with formatted values and a total row.
Chart Tooltip with Label Formatter
Tooltips
A tooltip whose label is formatted as a full date.
Chart Tooltip without Label
Tooltips
A tooltip with the series alone, no label above them.
Chart Tooltip with Icons
Tooltips
A tooltip with an icon beside each series.
Bar Chart with Labels
Bar charts
Each bar's value printed above it.
Chart Tooltip
Tooltips
The default tooltip: a label, then each series with its dot.

All 70 charts

Preview

About

Installation

Usage

Customize

FAQ

How is the unit added to each value?

Where did the color dots go?

How do I format the numbers themselves?

Can I keep the date above the rows?

Why do the numbers line up?

API Reference

ChartContainer

ChartTooltipContent

ChartLegend

ChartConfig

Helpers

Related

Advanced Chart Tooltip

Chart Tooltip with Label Formatter

Chart Tooltip without Label

Chart Tooltip with Icons

Bar Chart with Labels

Chart Tooltip