shadcn.io is not affiliated with official shadcn/ui
About
Use it when people need the numbers, not only the shape: a report, a slide, a screenshot in a ticket. Labels suit a handful of points; past ten or so they collide. To name categories instead of printing values, see the Line Chart with Custom Labels.
A natural curve through six months with a dot on each point and its value in small text above it. The top margin is larger so the highest label isn't cut off, and the tooltip shows the month and value with a line indicator.
Installation
Usage
<script lang="ts">
import ChartLineLabel from "@/components/charts/chart-line-label.svelte";
</script><ChartLineLabel />Customize
- A decorative
textmark over the same rows prints the labels:x: "month",y: "desktop",text: "desktop"for the value anddy: -15to lift it above the point. A decorativedotmark marks each point. fill: "var(--foreground)"andfontSize: 12keep the labels in the text color, not the series color, so they read in both themes.textalso takes a function of the row, so formatting is plain code:toLocaleString()for separators, a prefix for currency.dymoves the text but doesn't make room for it. Labels over the highest point need a larger topmarginin the definition.ChartContainer'stooltippasses{ indicator: "line" }and keeps the label, so the tooltip shows the month.
FAQ
How do I format the labels?
The text mark's text names the field, "desktop". Pass a function of the row instead: return row.desktop.toLocaleString() for separators, or add a currency sign or a unit there. The tooltip doesn't read it; its rows take a formatter in ChartContainer's tooltip options.
How do I move the labels closer to the points?
Change dy on the text mark: -15 lifts each label's middle 15px above its point, near where Recharts' offset={12} puts it. A smaller number brings it closer; a larger one needs more top margin (20 here), or the highest label clips.
What if the labels overlap?
The text mark doesn't push labels apart. Use fewer points or a smaller fontSize, or make text a function that returns null for the rows you want unlabeled, such as every other month.
Can I label only the highest and lowest months?
Yes. Make text a function that returns the value only for the rows you want, for example when row.desktop equals the highest or lowest value in chartData, and null for the rest.
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
Line Chart with Custom Labels
Line chartsEach point labeled with its category's name, in its color.
Line Chart with Dots
Line chartsA line with a dot on every data point.
Bar Chart with Labels
Bar chartsEach bar's value printed above it.
Pie Chart with Labels
Pie chartsEach slice's value printed beside it.
Area Chart with Axes
Area chartsStacked areas with both axes and their tick labels drawn.
Line Chart
Line chartsOne series as a smooth line over six months.