Skip to main content

Module gauge

Module gauge 

Expand description

Gauges: ProgressRing (a countdown or progress ring with a centred readout) and BarGauge (a labelled horizontal bar).

The ring sweeps clockwise from 12 o’clock (-π/2) with a round-capped arc over a track that registers against the ground and leaves the fill at least 3:1 against it. Its fill is progress (the inverted fill), a measured level that turns warning and danger past GaugeThresholds, or a Tone. The bar fills a rounded track left to right. Every colour and size comes from the Theme.

Structs§

BarGauge
Labelled horizontal bar gauge — a rounded track with a left-anchored fill, a top-left label and a right-aligned value readout.
BarGaugeProps
A labelled level as a bar: a disk’s use, a quota, a battery. Its label stands over the track’s start and its readout over its end; the fill turns warning, then danger, as it fills, unless the share has no status.
GaugeReading
What an immediate-mode gauge paints: how full it is, in which colour, and the text around it. Either string may be empty.
GaugeStyle
Paint options of a BarGauge.
GaugeThresholds
Fraction thresholds (inclusive lower bounds) at which a gauge switches from success → warning → danger. The default mirrors the dashboard convention: >= 0.85 danger, >= 0.6 warning, else success.
ProgressRing
A retained progress ring. See ProgressRingFace.
ProgressRingFace
Immediate-mode progress ring: a countdown or progress with an optional centred readout.
ProgressRingProps
How full something is, as a ring: a countdown, a download, the one hero reading of a screen (a speed test). A regular or large ring holds its readout and what it measures.
RingReading
What a state-bound ring shows (ProgressRing::from_state).

Enums§

ProgressRingSize
How large a ProgressRing is. Each size reads from the theme’s metrics, so it follows the UI scale.