Stat
Layout-only metric composition (label/value/help text) with no formatting or state ownership.
Identity
Section titled “Identity”- Category: Data display
- Status: stable public Registry/export-map component family
- Targets: iOS · Android · Web, subject to the compatibility contract
- Prerequisites:
@beemvp/beeui-uiinstalled (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup. - Source:
packages/ui/src/components/stat.tsx
Import
Section titled “Import”import { Stat, StatHelpText, StatLabel, StatValue } from '@beemvp/beeui-ui';There is no documented deep/private source import. For source ownership from a BeeUI checkout:
pnpm beeui add statRegistry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.
Composition and public API
Section titled “Composition and public API”- Family exports:
StatStatHelpTextStatLabelStatValue- Also routed here, outside the Registry family:
stat
- Package export subpath:
@beemvp/beeui-ui/stat
- Also routed here, outside the Registry family:
Exported types: StatHelpTextProps, StatLabelProps, StatProps, StatValueProps
The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.
State and behavior contract
Section titled “State and behavior contract”Stateless layout-only metric composition (StatLabel/StatValue/StatHelpText); it owns no number formatting or state.
StatHelpTextProps
Section titled “StatHelpTextProps”This type adds no fields of its own. These are the props the implementation reads from the base type below; everything else is passed straight through.
| Prop | Default |
|---|---|
tone |
'muted' |
Also carries every prop of Omit<TextProps, 'variant'> — documented on the Text page, not reproduced here.
StatLabelProps
Section titled “StatLabelProps”This type adds no fields of its own. These are the props the implementation reads from the base type below; everything else is passed straight through.
| Prop | Default |
|---|---|
tone |
'muted' |
Also carries every prop of Omit<TextProps, 'variant'> — documented on the Text page, not reproduced here.
StatProps
Section titled “StatProps”| Prop | Type | Default | Description |
|---|---|---|---|
className |
string |
— | Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee. |
Also carries every prop of ViewProps — that upstream contract is not reproduced here.
StatValueProps
Section titled “StatValueProps”No own fields; this type is exactly the base(s) below.
Also carries every prop of Omit<TextProps, 'variant'> — documented on the Text page, not reproduced here.
The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.
Provider and dependencies
Section titled “Provider and dependencies”- No additional provider is required by this family.
BeeUIProviderremains the recommended application root. - Peer/native dependencies visible to this Registry item:
react,react-native - Registry dependency closure:
core-cn,text,theme - Safe-area ownership remains explicit: shell surfaces touching system edges opt into
SafeArea; components do not silently invent app-shell insets. - Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.
Platform behavior
Section titled “Platform behavior”This family ships no platform-specific file, and its own source takes no Platform branch.
The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.
Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.
Accessibility
Section titled “Accessibility”- Roles this family assigns: none set in
stat.tsx. - Accessibility states and properties it sets: none set in
stat.tsx.
Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.
Styling and theming
Section titled “Styling and theming”- Style axes:
tone(8 values, inherited fromTextProps). - Class-name surfaces:
className.
Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.
Executable examples
Section titled “Executable examples”- Primary executable fixture:
apps/showcase/__tests__/application-primitives.test.tsx - Additional fixture:
apps/showcase/component-gallery/component-gallery.tsx - Additional fixture:
apps/showcase/patterns/dashboard-finance/components/metric-card.tsx - Additional fixture:
apps/showcase/patterns/dashboard-finance/screens/analytics-screen.tsx
Addressable examples
Section titled “Addressable examples”Each link below opens the Showcase at that exact example, not at the top of the gallery:
basic— smallest meaningful complete usage
The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.
Live Web preview
Section titled “Live Web preview”This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.
Composition anatomy
Section titled “Composition anatomy”- Family root / primary export:
Stat- Public composition parts / helpers:
StatHelpTextStatLabelStatValue
- Exported type surface:
StatHelpTextPropsStatLabelPropsStatPropsStatValueProps
- Public composition parts / helpers:
The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.
Verified example source
Section titled “Verified example source”These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Stat is actually used: 10 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.
Imports the examples below need (a filtered subset of the fixture’s own top-level imports):
import { Stat, StatHelpText, StatLabel, StatValue } from '@beemvp/beeui-ui'; <Stat className="min-w-32 flex-1"> <StatLabel>API surface</StatLabel> <StatValue>Public</StatValue> <StatHelpText>Only @beemvp/beeui-ui exports</StatHelpText> </Stat> <Stat className="min-w-32 flex-1"> <StatLabel>Verification</StatLabel> <StatValue>Cross-platform</StatValue> <StatHelpText>Web, Android, and iOS gates</StatHelpText> </Stat>Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.
Limitations
Section titled “Limitations”StatLabel, StatValue and StatHelpText do not accept a typography variant: their roles are fixed. Stat adds no accessibility grouping, so the three parts are exposed as separate pieces of text rather than one labelled metric.