Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Line Chart with Custom Labels

A line across five browsers with each point labeled by its browser's name, so the categories read without an x axis, in Vue with TanStack Charts.

Framework
Charting library

Preview

Preview width

About

Pick it when the points are named categories and you'd rather name them on the chart than under it. The names sit next to the data, so the eye doesn't travel to an axis and back. For values instead of names, use the Line Chart with Labels; when color should carry the category, the colored dots version.

A natural curve through five browsers, Chrome to Other, with a dot on each point and the browser's name above it in the text color. There's no x axis, the margins leave room for the end labels, and the tooltip shows the visitor count alone.

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 setup lang="ts">
import ChartLineLabelCustom from "@/components/charts/chart-line-label-custom.vue";
</script>
<template>
  <ChartLineLabelCustom />
</template>

Customize

  • Rows are { browser, visitors, fill }. The line reads x: "browser" and y: "visitors" and strokes with var(--color-visitors).
  • A decorative text mark prints the names: its text turns each row's browser key into a display name, with dy: -15 above the point and fill: "var(--foreground)".
  • The display names live in chartConfig (chrome: { label: "Chrome" }), the same labels the tooltip and a legend read.
  • The x scale has no axis (axis: false), since the labels replace it, and the definition's margins keep the first and last names inside the card.
  • ChartContainer's tooltip passes hideLabel, indicator: "line" and nameKey: "visitors".

FAQ

Where do the label names come from?

From the row's browser key, which the text mark's text function looks up in chartConfig: chrome prints as Chrome. The tooltip and any legend read the same entries, so renaming a browser there renames it everywhere.

Can a label show the name and the value?

Yes. Return both from text, the name and row.visitors. Keep it short: five points leave little room, and long labels collide at the ends.

What about long category names?

Shorten them in text (cut to a length and add an ellipsis), set anchor to "start" or "end" so the first and last labels grow inward, or tilt them with rotate. The full name can stay in the tooltip.

Should I bring back the x axis?

Not while every point has a label: the names would appear twice. Bring it back if you label only some points, or if the line has more categories than fit as labels.

Does the order of the rows matter?

Yes. The line connects the browsers in row order, so sort the rows by visitors for a clean falloff. In any other order the line zigzags, and the Bar Chart with Custom Labels says the same thing more plainly.

How do screen readers get the browser names?

The labels are SVG text inside an element with role="img", so screen readers skip them and read the chart's name, the card title. Tab in and the arrow keys move between browsers, with each count announced. Remove hideLabel from the tooltip options so the browser is announced too.

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