shadcn.io is not affiliated with official shadcn/ui
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
Usage
import { ChartPieLegend } from "@/components/charts/chart-pie-legend";<ChartPieLegend />Customize
ChartLegendgoes insideChartContainer, 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 everychartConfigentry with a color, sovisitors, which only has a label, stays out either way.- There's no tooltip, as upstream:
{ focus: false }in place ofchartTooltip()leaves nothing to focus.hideIconkeeps swatches even when entries have icons. ChartContainerismx-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.
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?JSX.Element
What sits under the chart inside the container: a ChartLegend.
tooltip?ChartTooltipContentProps | false
ChartTooltipContent's props (indicator, hideLabel, formatter…) for the default body, or false for TanStack's own tooltip body.
- Type
ChartTooltipContentProps | false
renderTooltip?(context: ChartTooltipBodyRenderContext) => JSX.Element
A whole tooltip body of your own, in place of ChartTooltipContent: it gets the focused points (each with its datum, group and color). Read the context's fields in JSX (context.points), so Solid tracks them.
- Type
(context: ChartTooltipBodyRenderContext) => JSX.Element
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?(value: number | string, name: string, item: ChartTooltipItem, index: number) => JSX.Element
A row's content in place of its indicator, name and value, as shadcn's formatter: a unit, a currency, a total row.
- Type
(value: number | string, name: string, item: ChartTooltipItem, index: number) => JSX.Element
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-solid 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
Pie Chart with Label List
Pie chartsEach slice's name printed inside it.
Pie Chart
Pie chartsA plain pie, one slice per browser.
Area Chart with Legend
Area chartsStacked areas with a legend naming each series.
Stacked Bar Chart with Legend
Bar chartsTwo series stacked in each bar, with a legend.
Radar Chart with Legend
Radar chartsTwo radar series with a legend naming them.
Pie Chart with Labels
Pie chartsEach slice's value printed beside it.