Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Chart Tooltip with Label Formatter

A tooltip whose heading turns the raw 2024-07-16 into a full date, the format a reader expects, above each series and its value, in Svelte.

Framework
Charting library

Preview

Preview width

About

Use it whenever the x value is a raw key the reader shouldn't have to decode: an ISO date, an id, a timestamp. The ticks stay short weekdays, and the tooltip spells the date out with month, day and year above the usual rows with dots.

It's the default tooltip plus one function, so it's the variant to copy into any time series.

Installation

Sign in to get your install command
Free with an account. It carries your token, so the CLI installs everything in one go.
GoogleGitHub
Use email insteadNo credit card

Usage

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

Customize

  • labelFormatter in ChartContainer's tooltip options receives the hovered date and returns the heading.
  • The tick format on the x scale and labelFormatter are separate, so the axis and the tooltip can use different formats.
  • Date-only strings parse as UTC; add timeZone: "UTC" when you format them so the day doesn't shift west of UTC.
  • The rows and their dots are the default's.

FAQ

How is the label formatted?

labelFormatter in ChartContainer's tooltip options takes the label text (the hovered date, as a string) and the focused points, and returns the heading: new Date(label).toLocaleDateString("en-US", { month: "long", day: "numeric", year: "numeric" }).

Why does the tooltip show the day before?

new Date("2024-07-16") is midnight UTC. West of UTC, that's still July 15 locally, and toLocaleDateString formats the local date. Add timeZone: "UTC" to the options, or build the date from its parts, and the label matches the data. The weekday ticks have the same catch.

How do I show a shorter date?

Change the options: { weekday: "long" } for Tuesday, { month: "short", day: "numeric" } for Jul 16. Pass undefined as the locale to use the reader's own.

Why don't the ticks show the full date too?

The axis and the tooltip format separately. The ticks keep a short weekday so six fit across, and the tooltip has room for the full date.

Is labelFormatter only for dates?

It receives the label text and the focused points, so anything you can compute from them works: a week number, a quarter, the day's total. To show a fixed heading instead, pass label, or labelKey as the Custom Label variant does.

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 }
All 70 charts