Box

Thin View primitive with no design assumptions, for ad-hoc layout.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• 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/box.tsx

Import

import { Box } from '@beemvp/beeui-ui';

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

pnpm beeui add box

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

• Primary export: Box
  • Also routed here, outside the Registry family:
    • box
  • Package export subpath: @beemvp/beeui-ui/box

Exported types: BoxProps

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 layout primitive — a thin View with no controlled props, callbacks, or design assumptions.

Props

BoxProps

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.

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, 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 box.tsx.
• Accessibility states and properties it sets: none set in box.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 ViewProps.
• 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__/class-name-merge-safety.test.tsx
• Additional fixture: apps/showcase/component-gallery/component-gallery.tsx
• Additional fixture: apps/showcase/component-gallery/select-showcase.tsx
• Additional fixture: apps/showcase/pattern-gallery/pattern-gallery.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

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: Box
  • Exported type surface:
    • BoxProps

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 Box is actually used: 51 lines in 5 places, of 6 in total — open the fixture for the remaining 1. 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, Popover, PopoverClose, PopoverContent, PopoverDescription, PopoverTitle, PopoverTrigger, Separator, Skeleton, Spinner, Switch, Text } from '@beemvp/beeui-ui';
import * as React from 'react';

lines 535–543:

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

lines 549–563:

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

lines 571–577:

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

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

  const [notifications, setNotifications] = React.useState(true);

lines 665–672:

              <Box className="flex-row items-center justify-between gap-4">
                <Text>Notifications</Text>
                <Switch
                  accessibilityLabel="Notifications"
                  onValueChange={setNotifications}
                  value={notifications}
                />
              </Box>

lines 877–888:

                <Box className="items-end">
                  <Popover>
                    <PopoverTrigger variant="outline">Near right edge</PopoverTrigger>
                    <PopoverContent align="start" placement="right" sideOffset={12}>
                      <PopoverTitle>Collision-aware placement</PopoverTitle>
                      <PopoverDescription>
                        Preferred placement is right; the resolver flips or shifts only when the viewport requires it.
                      </PopoverDescription>
                      <PopoverClose size="sm" variant="ghost">Close</PopoverClose>
                    </PopoverContent>
                  </Popover>
                </Box>

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

No component-specific limitation is curated here. Check Compatibility and the linked behavior contract for target-specific constraints.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source