Stat

Metric card primitive for dashboard values.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Stat } from "@tavojs/ui/stat";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/stat.

When to use

Use it when

Use `Stat` for metric cards

Choose something else when

Avoid Stat when using data components as decorative layout containers.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Stat example

TSXCreate: src/components/examples/StatExample1.tsx

tsximport { Stat } from "@tavojs/ui/stat";

export function StatExample1() {
  return (
    <>
      <Stat label="Revenue" value="$84k" trend="+11%" tone="success" />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`label`	`Child`	—	Configures label for this component.
`value`	`Child`	—	Configures value for this component.
`hint`	`Child`	—	Configures hint for this component.
`trend`	`Child`	—	Configures trend for this component.
`tone`	`Tone`	—	Configures tone for this component.

Complete TypeScript API

Import from @tavojs/ui/stat. Published exports: Stat, StatProps.

`StatProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Stat.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Stat.
`id`	`string`	No	Inherited id attribute accepted by Stat.
`role`	`string`	No	Inherited role attribute accepted by Stat.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Stat.
`title`	`string`	No	Inherited title attribute accepted by Stat.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Stat.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Stat.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Stat.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Stat.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Stat.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Stat.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Stat.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Stat.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Stat.
`label`	`Child`	No	Configures label for this component.
`value`	`Child`	No	Configures value for this component.
`hint`	`Child`	No	Configures hint for this component.
`trend`	`Child`	No	Configures trend for this component.
`tone`	`Tone`	No	Configures tone for this component.

State ownership and DOM target

Concern	Contract
State	Props describe the displayed state. Update them from application data; the component does not fetch or advance that state itself.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Stat when using data components as decorative layout containers.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Data components should preserve readable order and expose labels for non-textual values.

Use captions or nearby headings for tables and charts.
Do not rely on color alone for status.
Keep values and labels available as text.

Component status

Contract	Current value
Maturity	stable
Category	data
Component import	`@tavojs/ui/stat`
Explicit CSS import	`@tavojs/ui/css/stat`
Preview	Interactive preview available on this page