GaugeChart

Radial gauge chart for KPI and status display

Usage

GaugeChart displays a single value on a radial arc:

72
import { GaugeChart } from '@mantine/charts';

function Demo() {
  return <GaugeChart value={72} size={200} thickness={12} />;
}

Sections

Use sections to split the arc into threshold bands. Each section ends at its value, the last section should end at max. With sections, the whole arc is colored, use the target marker to show where the value falls:

72
import { GaugeChart } from '@mantine/charts';
import { sections } from './data';

function Demo() {
  return <GaugeChart value={72} sections={sections} />;
}

Target marker

Set target to draw a line marker across the arc at the given value. Use targetColor and targetSize to change its color and thickness:

72
import { GaugeChart } from '@mantine/charts';
import { sections } from './data';

function Demo() {
  return <GaugeChart value={72} target={75} sections={sections} />;
}

Start and end angle

startAngle and endAngle set the span of the arc in degrees. 0 is the top of the chart, positive values go clockwise:

72
import { GaugeChart } from '@mantine/charts';

function Demo() {
  return <GaugeChart value={72} startAngle={-90} endAngle={90} />;
}

A span of 360 degrees renders a full circle. Set endAngle lower than startAngle to draw the arc counter-clockwise:

import { GaugeChart } from '@mantine/charts';

function Demo() {
  return (
    <>
      {/* Full circle */}
      <GaugeChart value={72} startAngle={0} endAngle={360} />

      {/* Counter-clockwise */}
      <GaugeChart value={72} startAngle={120} endAngle={-120} />
    </>
  );
}

Thickness

thickness sets the width of the arc, size sets the width of the chart. The height follows the arc proportions:

72
72
import { GaugeChart } from '@mantine/charts';
import { Group } from '@mantine/core';

function Demo() {
  return (
    <Group>
      <GaugeChart value={72} thickness={6} size={160} />
      <GaugeChart value={72} thickness={20} size={160} />
    </Group>
  );
}

Value formatter

Use valueFormatter to format the value in the center label. Screen readers announce the same formatted value:

72.5%
import { GaugeChart } from '@mantine/charts';

function Demo() {
  return <GaugeChart value={72.456} valueFormatter={(value) => `${value.toFixed(1)}%`} />;
}

Custom label

Use label prop to replace the center label with any React node:

72%

CPU Usage

import { GaugeChart } from '@mantine/charts';
import { Text } from '@mantine/core';

function Demo() {
  return (
    <GaugeChart
      value={72}
      aria-label="CPU usage"
      label={
        <div>
          <Text ta="center" fz="xl" fw="var(--mantine-font-weight-medium)" c="bright">
            72%
          </Text>
          <Text ta="center" size="sm">
            CPU Usage
          </Text>
        </div>
      }
    />
  );
}

Round caps

Set roundCaps to round the endpoints of the arc:

72
72
72
import { GaugeChart } from '@mantine/charts';
import { Group } from '@mantine/core';

function Demo() {
  return (
    <Group>
      <GaugeChart value={72} roundCaps size={160} />
      <GaugeChart value={72} roundCaps={false} size={160} />
      <GaugeChart
        value={72}
        roundCaps
        size={160}
        sections={[
          { value: 60, color: 'teal' },
          { value: 80, color: 'yellow' },
          { value: 100, color: 'red' },
        ]}
      />
    </Group>
  );
}

Accessibility

Set aria-label to name the metric, even when the chart has a visible label:

import { GaugeChart } from '@mantine/charts';

function Demo() {
  return <GaugeChart value={72} aria-label="CPU utilization" />;
}