Skip to contentVibraUI
Charts

Radar chart

Several measures on one common scale, as a shape you can compare against another.

One scale for every axis, or the shape means nothing — a radar is for scores and ratings already normalised to a common range, not for measures of different magnitude. It reads well between three and about eight axes. Two washes show through one another; a third does not, so turn fill off past two series and let the outlines carry it. Dots and the active dot wear a ring in var(--chart-surface, var(--card)) — set --chart-surface on the chart when it sits on the page instead of in a card. The data is also rendered as a visually hidden list.

Install

npx shadcn@latest add @vibra/radar-chart

Needs the @vibra registry in your components.json — set it up once.

Examples

Props

PropTypeDefaultDescription
dataChartDatum[]—The points to plot; each one holds the index value and a number per series key.
indexstring—The key holding each point's category — the month, the area, the source.
seriesChartSeries[]palette in orderThe measures to plot, as { key, label, color?, compareKey?, compareColor? }. A colour is a chart token, any CSS colour, or left out to take the next palette slot. compareKey names the same measure over the period before, drawn when compare is on; compareColor paints that ghost — var(--chart-neutral) keeps it grey under every preset.
valueFormatter(n: number) => stringthousands-separated numberFormats every number the chart prints: axis ticks, tooltip values, and the text summary.
indexFormatter(v: string | number) => stringthe value as-isFormats every index label, e.g. an ISO date into "Sep 4".
heightnumber280Plot height in pixels, axis band included.
legend"inline-end" | "bottom" | "none""inline-end"Where the series are named: beside their own last point, under the plot, or nowhere. Bar and stacked-bar default to bottom — a column has no last point to write a name beside.
annotationsChartAnnotation[]—Goal lines, event markers and bands drawn over the plot in tone tokens, and appended to the visually hidden rows as text. Each label is haloed in the plane the chart sits on — --chart-surface, else the card — so it reads where it crosses a column or a line; set --chart-surface on a chart drawn on another plane.
comparebooleanfalseDraws each series' compareKey as a dashed ghost behind it — in the series' own colour, or in its compareColor when it names one (var(--chart-neutral) keeps the period before grey under every preset) — and prints the delta in the tooltip row.
showLegendbooleantrueShows the legend. A single-series chart never draws one — there is only one colour, so the card title already names it.
showGridbooleantrueHairline reference lines behind the marks.
showTooltipbooleantrueShows the hover tooltip. Every value is in the chart's visually hidden list either way.
showXAxisbooleantrueShows the axis names around the outside. Without them the shape is unreadable.
showYAxisbooleantrueShows the radius scale, formatted with valueFormatter.
fillbooleantrueWashes the area inside each outline. Turn it off past two series.
dotsbooleanfalseMarks every axis crossing, not just the one under the pointer.

Dependencies

Source

components/ui/radar-chart.tsx
"use client"

import * as React from "react"
import {
  PolarAngleAxis,
  PolarGrid,
  PolarRadiusAxis,
  Radar,
  RadarChart as RechartsRadarChart,
} from "recharts"

import { cn } from "@/lib/utils"
import {
  ChartContainer,
  ChartLegend,
  ChartLegendContent,
  ChartTooltip,
  ChartTooltipContent,
} from "@/components/ui/chart"
import {
  AXIS_TICK,
  axisProps,
  buildChartConfig,
  chartDefaults,
  chartRows,
  chartSummary,
  defaultIndexFormatter,
  defaultValueFormatter,
  tooltipIndexLabel,
  type CommonChartProps,
} from "@/components/ui/chart-core"

export type RadarChartProps = CommonChartProps & {
  /** Washes the area inside each outline. Two filled shapes hide one another, so turn it off past two series. */
  fill?: boolean
  /** Marks every axis crossing, not just the one under the pointer. */
  dots?: boolean
}

// Two overlapping washes still read through one another; a third does not,
// which is the reason `fill` is a prop rather than the shape's only look.
const FILL_OPACITY = 0.16

function RadarChart({
  className,
  data,
  index,
  series,
  valueFormatter = defaultValueFormatter,
  indexFormatter = defaultIndexFormatter,
  height = chartDefaults.height,
  showLegend = chartDefaults.showLegend,
  showGrid = chartDefaults.showGrid,
  showXAxis = chartDefaults.showXAxis,
  showYAxis = chartDefaults.showYAxis,
  showTooltip = chartDefaults.showTooltip,
  fill = true,
  dots = false,
  ...props
}: RadarChartProps) {
  const config = React.useMemo(() => buildChartConfig(series), [series])
  const rows = chartRows({ data, index, series, valueFormatter, indexFormatter })

  return (
    <div
      data-slot="radar-chart"
      data-fill={fill || undefined}
      data-dots={dots || undefined}
      className={cn("w-full", className)}
      {...props}
    >
      <ChartContainer
        config={config}
        role="img"
        aria-label={chartSummary("Radar chart", { data, index, series, indexFormatter })}
        className="aspect-auto w-full"
        style={{ height }}
      >
        <RechartsRadarChart
          // Named once, by the container's role="img" and its summary; recharts'
          // keyboard layer would add an unnamed role="application" tab stop inside it.
          accessibilityLayer={false}
          data={data} margin={{ top: 8, right: 8, bottom: 8, left: 8 }}>
          {showGrid ? <PolarGrid /> : null}

          {showXAxis ? (
            <PolarAngleAxis
              tick={AXIS_TICK}
              dataKey={index}
              tickLine={false}
              axisLine={false}
              fontSize={12}
              tickFormatter={(value) => indexFormatter(value)}
            />
          ) : null}

          {showYAxis ? (
            <PolarRadiusAxis
              tick={AXIS_TICK}
              {...axisProps}
              tickFormatter={(value) => valueFormatter(Number(value))}
            />
          ) : null}

          {showTooltip ? (
            <ChartTooltip
              content={
                <ChartTooltipContent
                  labelFormatter={(_, payload) => tooltipIndexLabel(payload, index, indexFormatter)}
                  // The primitive prints raw numbers, so the row is rebuilt here
                  // to put every value through the chart's valueFormatter.
                  formatter={(value, name, item) => (
                    <>
                      <span
                        className="size-2.5 shrink-0 rounded-[2px]"
                        style={{ backgroundColor: item.color }}
                      />
                      <div className="flex flex-1 items-center justify-between gap-3 leading-none">
                        <span className="text-muted-foreground">{name}</span>
                        <span className="font-medium tabular-nums">
                          {valueFormatter(Number(value))}
                        </span>
                      </div>
                    </>
                  )}
                />
              }
            />
          ) : null}

          {series.map((entry) => (
            <Radar
              key={entry.key}
              dataKey={entry.key}
              name={entry.label}
              stroke={`var(--color-${entry.key})`}
              strokeWidth={2}
              fill={`var(--color-${entry.key})`}
              fillOpacity={fill ? FILL_OPACITY : 0}
              // No draw-in (CONVENTIONS §6), in any mode: recharts' own default
              // answers only the OS setting, so under [data-motion="reduced"]
              // the shape still grew out of the centre.
              isAnimationActive={false}
              dot={
                dots
                  ? {
                      r: 3,
                      strokeWidth: 2,
                      // The ring is the surface showing through, so dots stay
                      // legible where two outlines cross.
                      stroke: "var(--chart-surface, var(--card))",
                      fill: `var(--color-${entry.key})`,
                    }
                  : false
              }
              activeDot={{ r: 4, strokeWidth: 2, stroke: "var(--chart-surface, var(--card))" }}
            />
          ))}

          {showLegend && series.length > 1 ? (
            <ChartLegend content={<ChartLegendContent />} />
          ) : null}
        </RechartsRadarChart>
      </ChartContainer>

      <ul
        data-slot="radar-chart-data"
        aria-label={chartSummary("Radar chart", { data, index, series, indexFormatter })}
        className="sr-only"
      >
        {rows.map((row, i) => (
          <li key={i}>{`${row.label}: ${row.readings}`}</li>
        ))}
      </ul>
    </div>
  )
}

export { RadarChart }
components/ui/chart-core.ts
import * as React from "react"

import { formatNumber } from "@/lib/format"
import type { ChartConfig } from "@/components/ui/chart"
import { isChartToken, type ChartToken } from "@/components/ui/percentage-bar"

/** One point of a chart: the index value plus one number per series key. */
export type ChartDatum = Record<string, string | number | null | undefined>

/** One plotted measure — which key to read, what to call it, what to paint it. */
export type ChartSeries = {
  key: string
  label: string
  /** A chart token, or any CSS colour for a brand hue. Defaults to the palette in order. */
  color?: ChartToken | string
  /**
   * The key holding the same measure over the period before this one. Drawn as
   * a dashed ghost behind the series and printed in its tooltip row as a delta.
   */
  compareKey?: string
  /**
   * The colour the ghost is drawn in: a chart token or any CSS colour. Left
   * out, the ghost wears the series' own colour; `var(--chart-neutral)` keeps
   * the period before out of the palette, grey under every preset — including
   * one whose first slot follows a coloured accent.
   */
  compareColor?: ChartToken | string
}

/** The props every cartesian chart in the set accepts. */
export type CommonChartProps = React.ComponentProps<"div"> & {
  data: ChartDatum[]
  /** The key holding each point's category — the month, the day, the source. */
  index: string
  series: ChartSeries[]
  /** Formats every number the chart prints: axis ticks, tooltips, and the text summary. */
  valueFormatter?: (n: number) => string
  /** Formats every index label, e.g. an ISO date into "Sep 4". */
  indexFormatter?: (v: string | number) => string
  /** Plot height in pixels, axis band included. */
  height?: number
  showLegend?: boolean
  showGrid?: boolean
  showXAxis?: boolean
  showYAxis?: boolean
  showTooltip?: boolean
  /** Where the series are named: beside their last point, under the plot, or nowhere. */
  legend?: ChartLegendPlacement
  /** Goal lines, event markers and bands drawn over the plot and read out as text. */
  annotations?: ChartAnnotation[]
  /** Draws each series' `compareKey` as a dashed ghost behind it, in the series' `compareColor` if it names one, its own colour if not. */
  compare?: boolean
  className?: string
}

// The palette wraps rather than inventing a ninth hue: past eight series the
// colours stop being distinguishable, so fold the tail into an "Other" series.
const PALETTE_SIZE = 8

/**
 * A series' colour: a chart token becomes its CSS variable, any other string is
 * taken as a raw CSS colour, and a series that names none takes the next slot in
 * the palette, wrapping past the eighth.
 */
export function seriesColor(series: ChartSeries, i: number): string {
  const color = series.color
  if (color === undefined) return `var(--chart-${(i % PALETTE_SIZE) + 1})`
  return isChartToken(color) ? `var(--${color})` : color
}

/**
 * The ChartConfig the chart primitive needs — it turns each entry into a
 * `--color-<key>` custom property that recharts marks reference.
 */
export function buildChartConfig(series: ChartSeries[]): ChartConfig {
  // fromEntries defines own properties, so a series keyed "__proto__" lands as
  // data instead of reassigning the config object's prototype.
  return Object.fromEntries(
    series.map((entry, i) => [entry.key, { label: entry.label, color: seriesColor(entry, i) }])
  )
}

/**
 * The shared starting point: a 280px plot with both axes, a grid, direct labels
 * at the end of each series, and a tooltip. The value axis is on — a chart
 * without a printed scale is a shape, not a measurement — and the charts turn it
 * off themselves when the plot is too small to carry one (`fitsYAxis`).
 */
export const chartDefaults = {
  height: 280,
  showLegend: true,
  showGrid: true,
  showXAxis: true,
  showYAxis: true,
  showTooltip: true,
  legend: "inline-end",
} as const

/**
 * A drawn line: 2px with round caps and joins reads as a stroke at any size
 * and holds its own on a white sheet, where 1.5px thinned to a hair on a
 * high-density screen.
 */
export const STROKE_WIDTH = 2

/**
 * The gridline: the grid token, dashed, so a rule under the data reads as a
 * guide rather than as a border. Every cartesian chart spreads this onto its
 * CartesianGrid.
 */
export const GRID_PROPS = { stroke: "var(--chart-grid)", strokeDasharray: "3 3" } as const

/**
 * The dot under the pointer: 3.5px of the series' own colour, ringed in the
 * surface it sits on so it stays legible where two lines cross.
 * --chart-surface falls back to the card a chart normally lives on; set it on
 * any ancestor when the chart sits on another plane.
 */
export const ACTIVE_DOT = { r: 3.5, strokeWidth: 2, stroke: "var(--chart-surface, var(--card))" } as const

/**
 * The corner a column turns, and the gap between two segments of one stack. A
 * stack is rounded as one shape — the top corners on the topmost segment, the
 * bottom corners on the lowest — so a bar reads as a printed block rather than
 * a pile of separately rounded tiles.
 */
export const BAR_RADIUS = 6
export const BAR_GAP = 1

/** Axis chrome: no rule and no tick marks, so only the labels carry the scale. */
export const axisProps = { tickLine: false, axisLine: false, tickMargin: 8, fontSize: 12 } as const

/**
 * The paint every axis label takes: --chart-axis, the token §3.8 names for the
 * printed scale. recharts writes fill="#666" onto its own
 * tick text, and the primitive's `.recharts-cartesian-axis-tick text` rule does
 * not reach it — recharts 3 nests labels under
 * `.recharts-cartesian-axis-tick-labels` instead — so #666 survived on the card
 * at 3.16:1 in dark. Passing the fill as a tick prop puts it on the element
 * itself, where nothing has to match a selector.
 */
export const AXIS_TICK = { fill: "var(--chart-axis)" } as const

/** Chart numbers fall back to thousands-separated values when no valueFormatter is given. */
export function defaultValueFormatter(value: number): string {
  return formatNumber(value)
}

/** Index labels print as they arrive unless the chart is given an indexFormatter. */
export function defaultIndexFormatter(value: string | number): string {
  return String(value)
}

/** What the text helpers need to turn a chart's data back into words. */
export type ChartTextOptions = {
  data: ChartDatum[]
  index: string
  series: ChartSeries[]
  valueFormatter?: (n: number) => string
  indexFormatter?: (v: string | number) => string
}

function readIndex(datum: ChartDatum, index: string, format: (v: string | number) => string) {
  const raw = datum[index]
  return typeof raw === "string" || typeof raw === "number" ? format(raw) : ""
}

function readValue(raw: ChartDatum[string], format: (n: number) => string) {
  return typeof raw === "number" && Number.isFinite(raw) ? format(raw) : "no data"
}

function joinLabels(labels: string[]): string {
  if (labels.length < 2) return labels.join("")
  return `${labels.slice(0, -1).join(", ")} and ${labels[labels.length - 1]}`
}

/**
 * The plotted data as text, one row per point. Every chart renders this into a
 * visually hidden list, so the numbers are readable without pointing at a tooltip.
 */
export function chartRows(options: ChartTextOptions): { label: string; readings: string }[] {
  const {
    data,
    index,
    series,
    valueFormatter = defaultValueFormatter,
    indexFormatter = defaultIndexFormatter,
  } = options

  return data.map((datum) => ({
    label: readIndex(datum, index, indexFormatter),
    readings: series
      .map((entry) => `${entry.label} ${readValue(datum[entry.key], valueFormatter)}`)
      .join(", "),
  }))
}

/**
 * The heading for a tooltip: the point's own index value, read straight off the
 * datum. The primitive resolves its label through the config, which only works
 * when the index is a string — reading the datum keeps numeric indexes intact.
 */
export function tooltipIndexLabel(
  payload: ReadonlyArray<{ payload?: unknown }> | undefined,
  index: string,
  format: (v: string | number) => string = defaultIndexFormatter
): string {
  const datum = payload?.[0]?.payload
  const raw = datum && typeof datum === "object" ? (datum as ChartDatum)[index] : undefined
  return typeof raw === "string" || typeof raw === "number" ? format(raw) : ""
}

/** A one-sentence description of what a chart plots, used as its accessible name. */
export function chartSummary(kind: string, options: ChartTextOptions): string {
  const { data, index, series, indexFormatter = defaultIndexFormatter } = options
  if (series.length === 0) return `${kind} with no series.`

  const labels = joinLabels(series.map((entry) => entry.label))
  if (data.length === 0) return `${kind} of ${labels} by ${index}. No data.`

  const first = readIndex(data[0], index, indexFormatter)
  const last = readIndex(data[data.length - 1], index, indexFormatter)
  const count = `${data.length} point${data.length === 1 ? "" : "s"}`
  return `${kind} of ${labels} by ${index}, ${count} from ${first} to ${last}.`
}

/* -------------------------------------------------------------------------- */
/* Annotations                                                                 */
/* -------------------------------------------------------------------------- */

/** Where a chart names its series. */
export type ChartLegendPlacement = "inline-end" | "bottom" | "none"

/** The meanings an annotation can carry; each resolves to a token, never a literal. */
export type ChartAnnotationTone = "neutral" | "brand" | "positive" | "negative" | "warning" | "info"

export type ChartAnnotation =
  /** A threshold across the plot: a goal, a limit, an included allowance. */
  | { kind: "line"; axis?: "x" | "y"; value: number | string; label: string; tone?: ChartAnnotationTone }
  /** A moment on the index axis: a launch, a deploy, an incident. */
  | { kind: "event"; x: number | string; label: string; tone?: ChartAnnotationTone; href?: string }
  /**
   * A stretch of the index axis: a freeze, an outage, a campaign. The label
   * reads from the band's start; `align: "end"` hangs it from the band's end
   * instead, for a band that runs to the edge of the plot — a 59px word over
   * a 30px band at the right edge otherwise runs out of the plot.
   */
  | {
      kind: "band"
      from: number | string
      to: number | string
      label: string
      tone?: ChartAnnotationTone
      align?: "start" | "end"
    }

const ANNOTATION_PAINT: Record<ChartAnnotationTone, string> = {
  neutral: "var(--faint-foreground)",
  brand: "var(--brand)",
  positive: "var(--chart-positive)",
  negative: "var(--chart-negative)",
  warning: "var(--warning)",
  info: "var(--info)",
}

/**
 * The paint a *meaning* takes, as opposed to a category.
 *
 * A series that is coded by status — 200/429/500, up/down, paid/overdue — is
 * not one of eight interchangeable hues: it has to resolve to the semantic
 * tokens, or a reader learns the wrong colour for "failed" on one page and
 * carries it to the next. Categories keep the palette; meanings come from here.
 */
export const CHART_TONES = {
  positive: "var(--chart-positive)",
  negative: "var(--chart-negative)",
  neutral: "var(--chart-neutral)",
  warning: "var(--warning)",
  info: "var(--info)",
} as const

export type ChartTone = keyof typeof CHART_TONES

export function chartTone(tone: ChartTone): string {
  return CHART_TONES[tone]
}

/** The token an annotation's tone paints in. */
export function annotationPaint(tone: ChartAnnotationTone = "neutral"): string {
  return ANNOTATION_PAINT[tone] ?? ANNOTATION_PAINT.neutral
}

/** The numbers an annotation pins to the value axis, so the scale can hold them. */
export function annotationValues(annotation: ChartAnnotation): number[] {
  if (annotation.kind === "line" && annotation.axis !== "x" && typeof annotation.value === "number")
    return [annotation.value]
  return []
}

/**
 * Every annotation as a line of text, appended to a chart's visually hidden
 * rows: a goal line a sighted reader can see has to be readable too.
 */
export function annotationRows(
  annotations: ChartAnnotation[] = [],
  options: {
    valueFormatter?: (n: number) => string
    indexFormatter?: (v: string | number) => string
  } = {}
): string[] {
  const {
    valueFormatter = defaultValueFormatter,
    indexFormatter = defaultIndexFormatter,
  } = options
  const at = (value: number | string) =>
    typeof value === "number" ? valueFormatter(value) : indexFormatter(value)

  return annotations.map((annotation) => {
    if (annotation.kind === "line")
      return `${annotation.label}: ${
        annotation.axis === "x" ? indexFormatter(annotation.value) : at(annotation.value)
      }`
    if (annotation.kind === "event") return `${annotation.label} at ${indexFormatter(annotation.x)}`
    return `${annotation.label}: ${indexFormatter(annotation.from)} to ${indexFormatter(annotation.to)}`
  })
}