Meter

Scalar measurement within a known range (e.g. disk usage, signal strength).

Generated from the package's public source.

API

                        deriveMeterStatus(value: number, low?: number, high?: number, optimum?: number): MeterStatus

class?: string
high?: number — High threshold — values at or above this are considered "danger" when optimum is low.
low?: number — Low threshold — values at or below this are considered "danger" when optimum is high.
max?: number — Maximum bound. Defaults to 1.
min?: number — Minimum bound. Defaults to 0.
optimum?: number — The optimum value — determines which end of the range is "safe".
value: number — Current value. Must be between min and max.

children: Element

Meter status derivation logic — pure function, no JSX dependencies.

                        Root(props: MeterProps): Element

class?: string
high?: number — High threshold — values at or above this are considered "danger" when optimum is low.
low?: number — Low threshold — values at or below this are considered "danger" when optimum is high.
max?: number — Maximum bound. Defaults to 1.
min?: number — Minimum bound. Defaults to 0.
optimum?: number — The optimum value — determines which end of the range is "safe".
value: number — Current value. Must be between min and max.

children: Element