Skip to content
BeeUI

Skeleton

Decorative static loading placeholder surface.

Identity

Section titled “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/skeleton.tsx

Import

Section titled “Import”
import { Skeleton, skeletonVariants } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add skeleton

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

Section titled “Composition and public API”
  • Family exports: Skeleton skeletonVariants
    • Also routed here, outside the Registry family:
      • skeleton
    • Package export subpath: @beemvp/beeui-ui/skeleton

Exported types: SkeletonProps

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 decorative static loading placeholder; it is hidden from the accessibility tree and carries no loading-state callbacks.

Props

Section titled “Props”

SkeletonProps

Section titled “SkeletonProps”
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.
variant 'block' | 'circle' | 'text' 'block' Chooses this element’s variant from skeletonVariants’s presets, declared in packages/ui/src/components/skeleton.tsx — the classes each value applies are there.

Also carries every prop of Omit<ViewProps, 'accessible' | 'aria-hidden'> — that upstream contract is 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. BeeUIProvider remains the recommended application root.
  • Peer/native dependencies visible to this Registry item: react, react-native
  • Registry dependency closure: core-cn, 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 skeleton.tsx.
  • Accessibility states and properties it sets: accessible, hidden — read from skeleton.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: variant (3 values) — the values are in the props tables above.
  • 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”

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: Skeleton
    • Public composition parts / helpers:
      • skeletonVariants
    • Exported type surface:
      • SkeletonProps

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 Skeleton is actually used: 22 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 { Box, Button, Card, EmptyState, ErrorState, Separator, Skeleton, Text } from '@beemvp/beeui-ui';

lines 569–590:

            <Card className="gap-4">
              <Text variant="heading">Loading and state surfaces</Text>
              <Box className="flex-row items-center gap-3">
                <Skeleton className="h-12 w-12" variant="circle" />
                <Box className="flex-1 gap-2">
                  <Skeleton className="w-2/3" variant="text" />
                  <Skeleton className="w-full" variant="text" />
                </Box>
              </Box>
              <Skeleton className="h-24 w-full" />
              <Separator />
              <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."
              />
            </Card>

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”

There is no width, height or repeat-count prop, so a placeholder’s size and how many are drawn come from the caller’s own layout; everything else is plain view props, minus the two accessibility flags the component fixes to keep the placeholder out of the accessibility tree.

Section titled “Related”