Gauge

One value against a range, with thresholds.

import { Gauge } from '@textui/core';

<Gauge
  value={82}
  label="Disk"
  thresholds={[{ at: 75, tone: 'warning' }, { at: 90, tone: 'danger' }]}
/>

Props

| Prop | Type | Default | | | — | — | — | — | | value | number | required | | | min | number | 0 | | | max | number | 100 | | | label | string | | | | thresholds | { at: number; tone: 'default' \| 'primary' \| 'secondary' \| 'accent' \| 'success' \| 'warning' \| 'danger' \| 'info' \| 'muted' }[] | [] | Bands that colour the reading by range. | | format | (value: number) => string | | | | gaugeWidth | number | 20 | |

Plus everything on BoxProps.

Role: meter.

thresholds are what makes this different from a Progress bar: the gauge recolours itself as the value crosses each one, so “how full” and “is that bad” are one glance instead of two.

They are read in order, so list them ascending. min and max default to 0 and 100.

See also

  • Progress - a task completing rather than a level
  • StatusDot - the state without the number

Back to top

MIT licensed. Pre-1.0 - the surface is still moving.