State Message

Empty-state and error-state (with retry) composition for zero/failure surfaces.

Identity

Category: Overlays & feedback
Status: stable public Registry/export-map component family
Targets: iOS · Android · Web, subject to the compatibility contract
Prerequisites: @beemvp/beeui-ui installed (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/state-message.tsx

Import

import { EmptyState, ErrorState } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add state-message

Registry (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

Family exports: EmptyState ErrorState
- Also routed here, outside the Registry family:
  - state-message
- Package export subpath: @beemvp/beeui-ui/state-message

Exported types: EmptyStateProps, ErrorStateProps

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

Stateless empty-state (EmptyState) and error-state (ErrorState, with an optional retry action) composition for zero/failure surfaces; the caller owns the retry handler and any loading state around it.

Props

`EmptyStateProps`

Prop	Type	Default	Description
`action`	`React.ReactNode`	—	Rendered below the description with top padding (e.g. a retry or create button).
`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.
`description`	`React.ReactNode`	—	Secondary supporting text rendered beneath the primary label or title.
`icon`	`React.ReactNode`	—	Rendered above the title, inside a view marked as not an accessibility element of its own (purely decorative).
`title` (required)	`React.ReactNode`	—	The primary heading text for this surface.

Also carries every prop of Omit<ViewProps, 'children'> — that upstream contract is not reproduced here.

`ErrorStateProps`

Prop	Type	Default	Description
`title`	`React.ReactNode`	`'Something went wrong'`	The primary heading text for this surface.

Also carries every prop of Omit<EmptyStateProps, 'title'> — documented on the State Message 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

No additional provider is required by this family. BeeUIProvider remains 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

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

Roles this family assigns: none set in state-message.tsx.
Accessibility states and properties it sets: accessible — read from state-message.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

Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<ViewProps, 'children'>.
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

Primary executable fixture: apps/showcase/__tests__/table.test.tsx
Additional fixture: apps/showcase/component-gallery/component-gallery.tsx
Additional fixture: apps/showcase/patterns/commerce-social/screens/cart-screen.tsx
Additional fixture: apps/showcase/patterns/commerce-social/screens/messages-screen.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

basic — smallest meaningful complete usage
states — the states example

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

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

Family root / primary export: EmptyState
- Public composition parts / helpers:
  - ErrorState
- Exported type surface:
  - EmptyStateProps
  - ErrorStateProps

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

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where State Message 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 { Button, EmptyState, ErrorState, Separator } from '@beemvp/beeui-ui';

lines 580–589:

              <EmptyState
                action={<Button size="sm">Create record</Button>}
                description="Create your first record to get started."
                title="No records yet"
              />
              <Separator />
              <ErrorState
                action={<Button size="sm" variant="outline">Try again</Button>}
                description="The server could not load this section."
              />

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

ErrorState’s default title and description are English literals, so a localized app must pass both. EmptyState’s icon is wrapped in a view marked as not an accessibility element of its own and given no name, so an icon that carries meaning of its own needs that meaning repeated in title or description.