Skip to content

Card

Elevated/outlined surface with variant and spacing contract.

  • Category: Layout & surfaces
  • 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/card.tsx
import { Card, cardVariants } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add card

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.

  • Family exports: Card cardVariants
    • Also routed here, outside the Registry family:
      • card
    • Package export subpath: @beemvp/beeui-ui/card

Exported types: CardProps

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.

Stateless elevated/outlined surface driven by a variant and spacing prop; no controlled state or callbacks.

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.
padding 'none' | 'sm' | 'md' | 'lg' 'md' Chooses this element’s padding from cardVariants’s presets, declared in packages/ui/src/components/card.tsx — the classes each value applies are there.
variant 'surface' | 'outlined' | 'raised' | 'muted' 'outlined' Chooses this element’s variant from cardVariants’s presets, declared in packages/ui/src/components/card.tsx — the classes each value applies are there.

Also carries every prop of ViewProps — 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.

  • 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.

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.

  • Roles this family assigns: none set in card.tsx.
  • Accessibility states and properties it sets: none set in card.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.

  • Style axes: padding (4 values), variant (4 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.

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.

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.

  • Family root / primary export: Card
    • Public composition parts / helpers:
      • cardVariants
    • Exported type surface:
      • CardProps

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.

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Card is actually used: 96 lines in 3 places, of 7 in total — open the fixture for the remaining 4. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. Other uses of this family, and the parts of the file exercising other families, are not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { Badge, Box, Button, Card, DescriptionItem, DescriptionList, EmptyState, ErrorState, IconButton, ListItem, Progress, Section, Separator, SettingsItem, Skeleton, Spinner, Switch, Text } from '@beemvp/beeui-ui';
import * as React from 'react';
import { Uniwind, useUniwind } from 'uniwind';

lines 529–565:

<Card className="gap-4" variant="raised">
<Section
action={<IconButton accessibilityLabel="Add item" variant="outline">+</IconButton>}
description="Variants, disabled state, and loading behavior."
title="Actions"
>
<Box className="gap-3">
<Button>Primary action</Button>
<Button variant="secondary">Secondary action</Button>
<Button variant="outline">Outline action</Button>
<Button variant="ghost">Ghost action</Button>
<Button variant="destructive">Destructive action</Button>
<Button disabled>Disabled action</Button>
<Button loading>Loading action</Button>
</Box>
</Section>
</Card>
<Card className="gap-4" variant="muted">
<Text variant="heading">Status and feedback</Text>
<Box className="flex-row flex-wrap gap-2">
<Badge>Primary</Badge>
<Badge variant="secondary">Secondary</Badge>
<Badge variant="success">Success</Badge>
<Badge variant="warning">Warning</Badge>
<Badge variant="destructive">Error</Badge>
<Badge variant="info">Info</Badge>
</Box>
<Separator />
<Box className="flex-row items-center gap-5">
<Spinner testID="spinner-default" />
<Spinner tone="success" />
<Spinner tone="warning" />
<Spinner testID="spinner-destructive" tone="destructive" />
</Box>
<Progress accessibilityLabel="Profile completion" value={72} />
</Card>

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>

Fixture state this block reads (same file, lines 458, 461):

const { theme } = useUniwind();
const [notifications, setNotifications] = React.useState(true);

lines 1046–1082:

<Card className="gap-4">
<Section description="Read-only application information patterns." title="Metadata and rows">
<DescriptionList>
<DescriptionItem label="Runtime" value="React Native 0.86.2" />
<DescriptionItem label="Styling" value="Uniwind 1.10.1" />
<DescriptionItem
description="Generated and compiled in CI"
label="Native verification"
value="Expo + bare RN"
/>
</DescriptionList>
<Separator />
<ListItem
description="Open your profile"
onPress={() => undefined}
title="Profile"
trailing={<Badge variant="success">Active</Badge>}
/>
<SettingsItem
description="Changes app appearance"
onPress={() => undefined}
title="Appearance"
value={theme}
/>
<SettingsItem
description="Native preference control"
title="Push notifications"
trailing={
<Switch
accessibilityLabel="Push notifications"
onValueChange={setNotifications}
value={notifications}
/>
}
/>
</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.

Card is one styled view with a variant and a padding step: there are no header/footer parts and no press handling, because its props extend React Native’s view props rather than its pressable props. A tappable card has to be composed by wrapping it.