shadcn.io is not affiliated with official shadcn/ui
About
Pick it over the plain radial chart when the card has no legend and the names should sit on the data. It suits a few short names: five browsers fit, longer labels run past the bar. For long category names, a horizontal bar chart with labels inside the bars reads better.
Five rings over muted tracks start near six o'clock and sweep counterclockwise, Chrome on the inside. Each browser's name is written small and white where its ring begins, tilted with the arc.
Installation
Usage
<script setup lang="ts">
import ChartRadialLabel from "@/components/charts/chart-radial-label.vue";
</script><template>
<ChartRadialLabel />
</template>Customize
- The rings are two
radialBarAnglemarks on the browser band: the muted tracks at the largest value, which read the pointer, then the values in adecorative()layer, each in its browser'svar(--color-<browser>). - The names are a
radialTextmark in a third, decorativepolar()that starts where the rings do and turns once on an angle scale of 0 to 360, so a label'sangleis degrees from the rings' start. - Each label's radius is
38 + index * 16pixels, the middle of its ring.rotateis minus its angle, which lays it along the arc, and the text is the browser name with its first letter capitalized. - A label's angle is 5 degrees plus half its width at that radius (about 5 pixels a letter), so the name starts just past its ring's start, as Recharts'
insideStartdoes. - The tooltip passes
hideLabel,nameKey: "browser"andvalueKey: "visitors"toChartTooltipContent, so it shows the browser and its visitors.
FAQ
How are the names placed on the rings?
A radialText mark in its own decorative polar() layer, which starts where the rings start and reads degrees (0 to 360) and pixels (0 to 110). Each label sits in the middle of its ring, 38 + index * 16 pixels out, a little past the start, turned by minus its angle to lie along the ring, at fontSize: 11, filled white.
What happens to the labels if I add a browser?
The labels are worked out per row: ringWidth divides the 30 to 110 pixel band by the number of rows, so a sixth browser gets its label on its ring. If you change the band, change the 30 and 110 in ringWidth and the radius scale's range together, and keep names short so they stay inside the bar.
Are white labels readable on every color?
The labels are white on the ring's color. On light --chart-N colors the contrast drops, so pick darker chart colors or fill the text with var(--background). They're short names on purpose; the tooltip carries the value.
How do I change where the rings start?
polar() takes startAngle and endAngle in radians, with zero at twelve o'clock and positive values clockwise; rechartsAngle converts Recharts' degrees. Here the rings start at six o'clock, rechartsAngle(-90), and sweep counterclockwise, as shadcn/ui's Recharts version does. Move the labels' layer's startAngle with the rings'.
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.
#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.
@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
--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?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>
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-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
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
Radial Chart
Radial chartsOne ring per browser, each as long as its share.
Radial Chart with Grid
Radial chartsRadial bars over circular grid lines.
Bar Chart with Custom Labels
Bar chartsHorizontal bars with the name inside each bar and the value after it.
Pie Chart with Label List
Pie chartsEach slice's name printed inside it.
Radial Chart with Text
Radial chartsOne ring of progress with the total in its center.
Radial Chart with Custom Shape
Radial chartsA thick ring with a custom end angle and the total inside.