Stat Card

A single labeled metric — the building block of dashboards, scorecards, and "key results" rows. Renders: label / value / optional delta / optional icon. The `tone` variant pairs the delta accent with one of four semantic colors (default / success / warning…

data displayserver320pxuiv1.2.0

Preview

Stat Card — live renderblocks-statcard--default

Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.

Install

Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.

Via shadcn URL
npx shadcn@latest add https://ds.interlace.tools/r/stat-card.json
With the @interlace alias
npx shadcn@latest add @interlace/stat-card

Behavior

What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.

Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is success on background at 7.28:1 (harbor · light), against a floor of 3:1.

Measured WCAG contrast ratios per token pair and theme
PairinterlacelightinterlacedarkharborlightharbordarkFloor
success on backgroundsuccess tint on the page surface7.68:110.30:17.28:19.86:13.0:1SC 1.4.11
destructive on backgrounddestructive tint on the page surface8.31:110.43:17.60:110.03:13.0:1SC 1.4.11
success on cardsuccess tint inside a card7.68:19.54:17.68:18.95:13.0:1SC 1.4.11
muted-foreground on backgroundsecondary copy9.41:111.32:17.82:19.52:14.5:1SC 1.4.3
warning on cardwarning tint inside a card9.07:18.54:19.07:18.01:13.0:1SC 1.4.11
destructive on carddestructive tint inside a card8.31:19.66:18.02:19.09:13.0:1SC 1.4.11
muted-foreground on cardsecondary copy in a card9.41:110.48:18.25:18.64:14.5:1SC 1.4.3
warning on backgroundwarning tint on the page surface9.07:19.22:18.60:18.83:13.0:1SC 1.4.11
card-foreground on cardcopy in a card19.65:115.71:118.72:114.69:14.5:1SC 1.4.3

Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.

Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.

Render boundary
server component

Renders during SSR / RSC with no hydration cost. It can be imported from a server component without pulling the page into the client.

Minimum viewport
MIN_VIEWPORT = 320

Declared, not assumed. Below 320 CSS px the preflight contract draws a dev-mode outline — how to switch it on.

Coverage gate
not in the gate

The 100% gate currently covers src/charts/**/*.{ts,tsx} and src/lib/**/*.{ts,tsx} and src/primitives/{button-variants,data-state-model,meter-scale,skeleton-variants}.ts and src/primitives/{alert,aspect-ratio,avatar,badge,box,breadcrumb,button,callout,card,checkbox,container,data-state,focus-ring,grade-badge,grid,input,label,meter,pagination,published-date,reading-time,section,section-boundary,separator,skip-link,stack,stat-strip,tag,textarea,typography,visually-hidden}.tsx. This file is outside it — the glob widens in phase 7.2.

History

This component is at v1.2.0, first shipped in @interlace/ui 1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.

@interlace/ui 1.1.01 entry

Import

3 named exports — pull the parts you need.

Public API
import { MIN_VIEWPORT, StatCard, statCardVariants } from '@/components/ui/patterns/stat-card';

Anatomy

Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.

StatCard                         (article — data-min-viewport=320)
    ├─ <div>                       (header row — label + icon)
    │   ├─ Typography ui-sm        (label)
    │   └─ {icon}                  (lucide icon, optional)
    ├─ Typography h2               (value — tabular numerals)
    ├─ {delta}                     (optional — "+12.3% · 30d" — tone-tinted)
    └─ {footnote}                  (optional smaller meta — "since launch")

Variants

Closed prop unions enforced by class-variance-authority. See Storybook's Variants story for the rendered matrix.

  • tone
    • defaultdefault
    • success
    • warning
    • danger

API reference

Parsed from the type declarations in the source — the same file the install writes into your tree, so this table can't drift from the component you get.

StatCardProps

Also accepts every <article> attribute. Plus the variant props listed above.

PropTypeDescription
labelReact.ReactNode
valueReact.ReactNode
deltaReact.ReactNodeOptional change/trend line — e.g. "+12.3% · 30d". Inherits the tone color.
footnoteReact.ReactNodeOptional secondary line under the delta — e.g. "since launch".
iconReact.ReactNodeOptional lucide icon — pinned to the top-right of the card.
loadingbooleanWhen true, render a `<Skeleton variant="stat-card" />` placeholder.

Skeleton

Pass loading and the component renders a shape-matched <Skeleton /> in its own place — same box, so nothing reflows when the data lands. Below is the same story with loading={true}.

Stat Card — loading stateblocks-statcard--loading
Usage
<MIN_VIEWPORT loading={isPending} />

Accessibility

Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.

What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.

Focus + keyboard behaviour
Native element semantics — no interaction layer to get wrong.
Focus ring (WCAG 2.2 SC 2.4.13)
Not focusable — no focus indicator required.
Reduced motion
No animation to gate.
ARIA in the source
None — semantics come from the element or the Base UI primitive rather than hand-written ARIA.

Examples

4 more states from the same story file.

R-rule compliance

Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.

RuleConceptWhere
R4Extends native el + VariantProps`React.ComponentProps<'article'> & VariantProps<...>`
R6data-slot + data-tone`data-slot="stat-card"` + `data-tone`
R7cn + ...rest`cn(statCardVariants(...), className)` + `{...props}`
R8Enums for tone`tone = default
R10Composition seams`icon` / `delta` / `footnote` props
R14Declares min viewport`data-min-viewport={String(MIN_VIEWPORT)}` + exported const
R19Tokens onlytone classes map to semantic tokens
R20AAA contrasttable above — every tone measured in both schemes
R25Server componentNo hooks → no `'use client'`

Minimum viewport

This primitive declares MIN_VIEWPORT = 320 CSS px (DESIGN_PRINCIPLES #14). When mounted in a container narrower than this, the preflight contract draws a dev-mode outline so the regression is visible during local development.

Opt-in to the dev-mode warning
<body data-interlace-dev>...</body>

Add the data-interlace-dev attribute to the body in development builds only — preflight then outlines any primitive whose container is below its declared data-min-viewport.

Dependencies

Base UI primitive
Native / no Base UI dependency
Lucide icons
none
NPM dependencies
  • class-variance-authority

Source

The full implementation — components/ui/patterns/stat-card.tsx once installed.

169 lines · TypeScript
import * as React from 'react';

// @interlace/stat-card v1.2.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/stat-card
// What changed since: https://ds.interlace.tools/c/stat-card#history
// Generated banner — keep it, the upgrade diff reads this version.

/**
 * @interlace/ui — StatCard
 *
 * A single labeled metric — the building block of dashboards, scorecards,
 * and "key results" rows. Renders: label / value / optional delta / optional
 * icon. The `tone` variant pairs the delta accent with one of four semantic
 * colors (default / success / warning / danger).
 *
 * Numbers are rendered with `font-variant-numeric: tabular-nums` (inherited
 * from preflight when wrapped in a `[data-tabular-nums]` container or table)
 * — set `data-tabular-nums` on the StatCard root to opt in.
 *
 * ## Anatomy

…149 more lines…

Registry JSON

The raw registry record — what the shadcn CLI fetches.