open-vault/ui/lib/core/stories/stat-text.md

1.2 KiB

StatText

StatText components are used to display a label and associated value beneath, with the option to include a description.

Params

Param Type Default Description
label string null The label for the statistic
value string null Value passed in, usually a number or statistic
size string null Sizing changes whether or not there is subtext. If there is subtext 's' and 'l' are valid sizes. If no subtext, then 'm' is also acceptable.
[subText] string SubText is optional and will display below the label

Example

<StatText @label="Active Clients" @stat="4,198" @size="l" @subText="These are the active client counts"/>

See