Skip to content
shadcn.io

shadcn.io is not affiliated with official shadcn/ui

Charts

Free

Radial Chart with Text

One rounded progress ring over a muted track, with its value, 200 visitors, written in the center. A single-number Vue chart on TanStack Charts.

Framework
Charting library

Preview

Preview width

About

Use it for one number with a sense of progress: a quota, a daily goal, storage used. The ring gives the card a shape, the center gives the value. For two parts of a total, the stacked radial chart splits the same ring; for a share of a whole, a donut with text.

A thin ring with rounded ends sweeps 250 degrees counterclockwise from three o'clock over a muted track. The value, 200, sits large in the center with Visitors under it.

Installation

Sign in to get your install command
Free with an account. It carries your token, so the CLI installs everything in one go.

Usage

<script setup lang="ts">
import ChartRadialText from "@/components/charts/chart-radial-text.vue";
</script>
<template>
  <ChartRadialText />
</template>

Customize

  • Two polar() layers: the first draws the muted track with its guides and the value ring, the second, decorative(), the center text. Each sets its own scales.
  • The value ring is a radialBarAngle on a one-band radius scale with range: [80, 90], filled with var(--color-safari) and cornerRadius: 10.
  • Its polar() sets startAngle and endAngle 250 degrees apart in radians, zero at twelve o'clock and clockwise; the angle scale fits the data, 0 to 200, so the value fills that sweep.
  • The track is two radialGrid guides on a pixels radius scale: a var(--muted) disc of radius 90 under a var(--background) disc of 80, both stroke: "none", leaving a ring.
  • The center labels are radialText marks at angle 0 and radius 0, moved with dy; change their text for your own number and unit.

FAQ

How do I make the ring show progress toward a goal?

The angle scale fits itself to the data, 0 to 200, the value itself, so the ring always fills the whole sweep. Its length comes from its polar()'s endAngle, 250 degrees from three o'clock. For real progress, give the angle scale scaleLinear().domain([0, goal]) and make the sweep a full or near-full circle.

How is the gray track drawn?

As Recharts draws it: two radialGrid guides on a pixels radius scale, a var(--muted) disc of radius 90 under a var(--background) disc of 80, which leaves a 10-pixel ring. Guides paint under the marks, so the value ring, on a radius band from 80 to 90, runs along it.

How is the text in the center drawn?

Two radialText marks at the center: 200 at fontSize: 36, bold, in var(--foreground), and Visitors 24 pixels lower in var(--muted-foreground). Format the number before it goes into text, with toLocaleString() for thousands.

How are the ends rounded?

cornerRadius: 10 on the ring's radialBarAngle, more than half its 8-pixel thickness, so both ends come out fully round. cornerRadius: "full" gives the same result for any thickness.

Is the value accessible?

The value is printed in the middle, so it doesn't depend on hover or color. ariaLabel names the chart by its card title. The number is SVG text, so also pass it in ChartContainer's ariaDescription, or keep it in the card's description.

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 }