Skip to content
Caps

components/stat

Type Aliases

Section titled “Type Aliases”

StatProps

Section titled “StatProps”

StatProps = object & Omit<HTMLAttributes<HTMLDListElement>>, "children">>

Props accepted by Stat.

Type Declaration

Section titled “Type Declaration”
label
Section titled “label”

label: ReactNode

value
Section titled “value”

value: ReactNode

description?
Section titled “description?”

optional description?: ReactNode

density?
Section titled “density?”

optional density?: "regular" | "compact"

Reduce internal padding when a statistic sits inside a compact card.

Variables

Section titled “Variables”

Stat

Section titled “Stat”

const Stat: ForwardRefExoticComponent<object & Omit<HTMLAttributes<HTMLDListElement>>, "children"> > & RefAttributes<HTMLDListElement>>>>

A compact statistic presentation for caller-provided values.