shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Chart Tooltip

Q: Why does the label show 2024-07-16 and not the weekday?

The tick format only changes the axis. The tooltip's label is the category value itself, the row's date. To format it, pass a labelFormatter through ChartContainer's tooltip prop, as the Label Formatter variant does.

Q: Why is the tooltip open before I hover?

defaultIndex on ChartContainer focuses a category on the first render: 1 here, so the second day's tooltip is open when the chart loads. Remove it and the tooltip waits for a pointer or a key.

Q: How do I rename the series or change their colors?

Change label and color in chartConfig. The rows read their name from label and their dot from the series color: chartColors(chartConfig) gives the bars var(--color-running) and var(--color-swimming), and the tooltip takes the same.

Q: How do I restyle the tooltip box?

The card is the cn-chart-tooltip class, which your style preset draws in your theme's background, border and shadow, so it follows dark mode on its own. Add classes through ChartTooltipContent's class to change its width or padding.

The tooltip every other variant starts from: the hovered day as a label, then each series with a color dot and its value, in Vue on TanStack Charts.

PreviewCode

About

Start here. Every other tooltip on this page changes one thing about this one: a bold label on top, then a row per series with a square dot in its color, its name, and its value in a monospace column. Use it whenever two or more series share a point and the reader needs the numbers.

Under it is a stack of running and swimming over six days in July, with weekday ticks and no value axis, so the tooltip is the only place the exact values show.

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 setup lang="ts">
import ChartTooltipDefault from "@/components/charts/chart-tooltip-default.vue";
</script>

<template>
  <ChartTooltipDefault />
</template>

Customize

fold turns each { date, running, swimming } row into one row per activity, and barY stacks them by z: "activity" in the order stack({ order }) gives.
The radius accessor rounds the bottom of running and the top of swimming, [0, 0, 4, 4] and [4, 4, 0, 0], so each day reads as one rounded bar.
chartTooltip() in the definition turns on focus grouped by day and TanStack's tooltip host, which opens below and after the pointer; ChartContainer renders ChartTooltipContent inside it with its defaults, the dot and the label.
Each row shows its segment's own value, not where the stack ends, so Swimming reads 420 and not 800.
defaultIndex on ChartContainer (1 here) opens the second day's tooltip before any pointer arrives.

FAQ

Why does the label show 2024-07-16 and not the weekday?

The tick format only changes the axis. The tooltip's label is the category value itself, the row's date. To format it, pass a labelFormatter through ChartContainer's tooltip prop, as the Label Formatter variant does.

Why does it list both series when I hover one segment?

Focus is grouped by day: the hovered bar's whole x group takes focus, so every series on that day gets a row, not only the segment under the pointer. The rows follow chartConfig's order.

Can I move the tooltip with the keyboard?

Yes. Tab to the chart and the arrow keys step from day to day, with the tooltip following. Enter or Space pins it and Escape closes it. The tooltip is a polite live region, so a screen reader reads each day's values.

Why is the tooltip open before I hover?

defaultIndex on ChartContainer focuses a category on the first render: 1 here, so the second day's tooltip is open when the chart loads. Remove it and the tooltip waits for a pointer or a key.

How do I rename the series or change their colors?

Change label and color in chartConfig. The rows read their name from label and their dot from the series color: chartColors(chartConfig) gives the bars var(--color-running) and var(--color-swimming), and the tooltip takes the same.

How do I restyle the tooltip box?

The card is the cn-chart-tooltip class, which your style preset draws in your theme's background, border and shadow, so it follows dark mode on its own. Add classes through ChartTooltipContent's class to change its width or padding.

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.

#default?slot

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

#tooltip?slot (ChartTooltipBodySlotContext)

A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). A scoped slot.

Type: slot (ChartTooltipBodySlotContext)

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.

EventType

@focus-change?(point: ChartPoint | null) => void

Called as the focused point changes: a pointer, a key or a tap.

Type: (point: ChartPoint | null) => void

@focus-group-change?(points: readonly ChartPoint[]) => void

Called with every point at the focused category (a stacked or grouped chart's).

Type: (points: readonly ChartPoint[]) => void

@select?(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?slot ({ value, item, index })

A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row. A scoped slot; the row's series key is item.key.

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-vue-next 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 }

Chart Tooltip with Line Indicator
Tooltips
A tooltip that marks each series with a line, not a dot.
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.
Stacked Bar Chart with Legend
Bar charts
Two series stacked in each bar, with a legend.
Multiple Bar Chart
Bar charts
Two series grouped side by side for each month.
Chart Tooltip without Indicator
Tooltips
A tooltip with no color indicator beside the series.

All 70 charts

Preview

About

Installation

Usage

Customize

FAQ

Why does the label show 2024-07-16 and not the weekday?

Why does it list both series when I hover one segment?

Can I move the tooltip with the keyboard?

Why is the tooltip open before I hover?

How do I rename the series or change their colors?

How do I restyle the tooltip box?

API Reference

ChartContainer

ChartTooltipContent

ChartLegend

ChartConfig

Helpers

Related

Chart Tooltip with Line Indicator

Chart Tooltip with Label Formatter

Chart Tooltip without Label

Stacked Bar Chart with Legend

Multiple Bar Chart

Chart Tooltip without Indicator