Leave Yamada UI a star

Star
Yamada UIYamada UIv1.6.4

Stat

Stat is used to display numbers or data within a box.

Source@yamada-ui/stat

Props

StatProps

centerContent

Description

If true, container will center its children regardless of their width.

Type

boolean

Default

false

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

helperMessage

Description

The stat helper message to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

helperMessageProps

Description

Props for stat helper message component.

Type

StatHelperMessageProps

icon

Description

The stat icon to use.

Type

"decrease" | "increase"

iconProps

Description

Props for stat icon component.

Type

Omit<StatIconProps, "type">

label

Description

The stat label to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

labelProps

Description

Props for stat label component.

Type

StatLabelProps

number

Description

The stat number to use.

Type

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

numberProps

Description

Props for stat number component.

Type

StatNumberProps

size

Description

The size of the Stat.

Type

string

variant

Description

The variant of the Stat.

Type

string

StatHelperMessageProps

StatIconProps

size

Deprecated

Description

The CSS font-size property.

Deprecated

Use fontSize instead.

Type

UIValue<number | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "large" | "medium" | "small" | "x-large" | "x-small" | "xx-large" | "xx-small" | "xxx-large" | ... 17 more ... | "xs">

type

Type

"decrease" | "increase"

Default

increase

StatLabelProps

StatNumberProps

Edit this page on GitHub

PreviousCardNextTable