API reference
components/stat
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/stat";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | StatProps | Props accepted by Stat. |
| constant | Stat | A compact statistic presentation for caller-provided values. |
StatPropstype alias
Section titled “StatProps”type StatProps = object & Omit<HTMLAttributes<HTMLDListElement>, "children">;Props accepted by Stat.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
label |
ReactNode |
- |
value |
ReactNode |
- |
description? |
ReactNode |
- |
density? |
"regular" | "compact" |
Reduce internal padding when a statistic sits inside a compact card. |
Statconstant
Section titled “Stat”const Stat: ForwardRefExoticComponent< object & Omit<HTMLAttributes<HTMLDListElement>, "children"> & RefAttributes<HTMLDListElement>>;A compact statistic presentation for caller-provided values.