Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Pie Chart with Legend

A pie with a legend under it, each browser's name beside its swatch, for when labels on the slices would crowd. For Vue on TanStack Charts.

Framework
Charting library

Preview

Preview width

About

Use it when slice labels would crowd or the names are long: the legend moves them under the pie and lets the slices stay clean. If the slices are big enough, the Pie Chart with Label List saves the legend's height.

Five browser slices fill the pie, and under it a centered, wrapping row of small square swatches with the browser names. The chart is 300px tall at most, to fit both.

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 ChartPieLegend from "@/components/charts/chart-pie-legend.vue";
</script>
<template>
  <ChartPieLegend />
</template>

Customize

  • ChartLegend goes inside ChartContainer, after the chart: the container is a column, and the legend takes its height from the pie's.
  • keys={chartData.map((item) => item.browser)} lists the browsers in slice order. Without it the legend lists every chartConfig entry with a color, so visitors, which only has a label, stays out either way.
  • There's no tooltip, as upstream: { focus: false } in place of chartTooltip() leaves nothing to focus. hideIcon keeps swatches even when entries have icons.
  • ChartContainer is mx-auto aspect-square max-h-[300px], 50px taller than the other pies to leave room for the legend.

FAQ

How is the legend added?

Put ChartLegend inside ChartContainer, after the chart. It lists every chartConfig entry with a color, each with a swatch in var(--color-<key>) and its label, and the container gives it the space under the pie.

How do I change the legend's order?

By default ChartLegend lists the config's colored entries in their order, which Biome keeps alphabetical. This chart passes keys={chartData.map((item) => item.browser)}, so the legend follows the slices; reorder that list, or pass a subset, to change what it shows.

How does the legend lay out on small screens?

It wraps: upstream's classes on ChartLegend, -translate-y-2 flex-wrap gap-2 *:basis-1/4 *:justify-center, fit four items to a row and pull the legend up toward the pie. verticalAlign="top" puts it above the pie instead.

Is the legend part of the chart's SVG?

ChartLegend is plain HTML under the chart, not part of the SVG, so it reflows and its labels can be selected, translated and read by screen readers as text.

Can I add the counts on hover?

Like upstream, this version has none: defineChart's second argument is { focus: false }. Pass chartTooltip({ focus: "nearest" }) there instead and give ChartContainer tooltip={{ hideLabel: true, valueKey: "visitors" }}, as the plain pie 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.

#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