Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

Stat

A billing snapshot with values, trends and context.

Preview

Live preview

Changes apply to this preview only.

Billing snapshot

The current subscription at a glance.

Seats
12 of 20Increased +3

Invite up to eight more teammates

Renewal
19 Oct 2026

Auto-renew is onactive

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Dashboard

Four metrics from a single reporting period, each labelled as a group.

Open preview

Sizes

sm, md and lg scale the icon, the value and the supporting type together.

Open preview

Trends

Up and down use success and danger tokens; neutral stays muted. The arrow and the hidden label remain when colour is unavailable.

Open preview

Usage

Use label, value and supporting context consistently; distinguish period change from an absolute value.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluStatProps

Type source
PimoluStatProps public API
NameTypeDefaultDescription
labelRequiredstring—Metric name, also used to label the group.
valueRequiredReactNode—Main metric value.
deltaReactNode—Change value, for example "+12.4%".
trendPimoluStatTrend | undefined"neutral"Direction of the change. Defaults to "neutral".
descriptionReactNode—Supporting context under the value.
iconReactNode—Decorative leading icon.
sizePimoluStatSize | undefined"md"Visual size. Defaults to "md".
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
classNamestring | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
childrenReactNode—Standard React/HTML attribute.
onChangeChangeEventHandler<HTMLDivElement, Element> | undefined—Standard React/HTML attribute.
onClickMouseEventHandler<HTMLDivElement> | undefined—Standard React/HTML attribute.
labelRequired

string

No default extracted.

Metric name, also used to label the group.

valueRequired

ReactNode

No default extracted.

Main metric value.

delta

ReactNode

No default extracted.

Change value, for example "+12.4%".

trend

PimoluStatTrend | undefined

Default: "neutral"

Direction of the change. Defaults to "neutral".

description

ReactNode

No default extracted.

Supporting context under the value.

icon

ReactNode

No default extracted.

Decorative leading icon.

size

PimoluStatSize | undefined

Default: "md"

Visual size. Defaults to "md".

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

className

string | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

children

ReactNode

No default extracted.

Standard React/HTML attribute.

onChange

ChangeEventHandler<HTMLDivElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

onClick

MouseEventHandler<HTMLDivElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • State the direction and meaning in text, including when a decrease is favorable.
Read the accessibility guide →