Skip to content

Stack

Typed direction/gap/alignment/wrap layout over View, with HStack/VStack specializations.

  • 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/stack.tsx
import { HStack, Stack, stackVariants, VStack } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add stack

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: HStack Stack stackVariants VStack
    • Also routed here, outside the Registry family:
      • stack
    • Package export subpath: @beemvp/beeui-ui/stack

Exported types: HStackProps, StackProps, VStackProps

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 typed direction/gap/alignment/wrap layout over View; HStack defaults cross-axis alignment to center (still overridable) and VStack is the vertical specialization — no controlled state.

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
align 'center'

Also carries every prop of Omit<StackProps, 'direction'> — documented on the Stack page, not reproduced here.

Prop Type Default Description
align 'start' | 'center' | 'end' | 'stretch' 'stretch' Chooses this element’s align from stackVariants’s presets, declared in packages/ui/src/components/stack.tsx — the classes each value applies are there.
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.
direction 'horizontal' | 'vertical' 'vertical' Chooses this element’s direction from stackVariants’s presets, declared in packages/ui/src/components/stack.tsx — the classes each value applies are there.
gap 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' 'md' Chooses this element’s gap from stackVariants’s presets, declared in packages/ui/src/components/stack.tsx — the classes each value applies are there.
justify 'start' | 'center' | 'end' | 'between' | 'around' | 'evenly' 'start' Chooses this element’s justify from stackVariants’s presets, declared in packages/ui/src/components/stack.tsx — the classes each value applies are there.
wrap boolean false Chooses this element’s wrap from stackVariants’s presets, declared in packages/ui/src/components/stack.tsx — the classes each value applies are there.

Also carries every prop of ViewProps — that upstream contract is not reproduced here.

No own fields; this type is exactly the base(s) below.

Also carries every prop of Omit<StackProps, 'direction'> — documented on the Stack 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.

  • 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 stack.tsx.
  • Accessibility states and properties it sets: none set in stack.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: align (4 values), gap (6 values), justify (6 values), direction (2 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: Stack
    • Public composition parts / helpers:
      • HStack
      • stackVariants
      • VStack
    • Exported type surface:
      • HStackProps
      • StackProps
      • VStackProps

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 Stack is actually used: 51 lines in 6 places, of 11 in total — open the fixture for the remaining 5. 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 { Avatar, Button, Field, HStack, Input, Link, Popover, PopoverClose, PopoverContent, PopoverDescription, PopoverTitle, PopoverTrigger, Stack, Stat, StatHelpText, StatLabel, StatValue, Text, Tooltip, TooltipContent, TooltipTrigger, VStack } from '@beemvp/beeui-ui';

Placeholder for a prop this fixture receives (not fixture source — substitute your own handler):

const children: string = undefined as never;
const description: string = undefined as never;

lines 141–144:

<VStack gap="xs">
<Text variant="heading">{children}</Text>
<Text tone="muted">{description}</Text>
</VStack>

Placeholder for a prop this fixture receives (not fixture source — substitute your own handler):

const onBack: () => void = () => {};

lines 481–492:

<HStack gap="sm">
<Button
accessibilityLabel="Back to Showcase home"
testID="component-gallery-back"
onPress={onBack}
size="sm"
variant="ghost"
>
Back
</Button>
<Avatar accessibilityLabel="BeeUI" fallback="BU" />
</HStack>

Fixture state this block reads (same file, line 148-170):

function PlacementPopover({ placement }: { placement: 'top' | 'right' | 'bottom' | 'left' }) {
return (
<Popover>
<PopoverTrigger size="sm" variant="outline">
{placement}
</PopoverTrigger>
<PopoverContent placement={placement} testID={`popover-${placement}-content`}>
<PopoverTitle>{`${placement[0].toUpperCase()}${placement.slice(1)} placement`}</PopoverTitle>
<PopoverDescription>
This surface is positioned by the shared anchored-overlay geometry kernel.
</PopoverDescription>
{placement === 'bottom' ? (
<Field label="Note">
<Input accessibilityLabel="Popover note" testID="popover-demo-input" />
</Field>
) : null}
<PopoverClose size="sm" variant="ghost">
Close
</PopoverClose>
</PopoverContent>
</Popover>
);
}

lines 777–782:

<HStack gap="sm" wrap>
<PlacementPopover placement="top" />
<PlacementPopover placement="right" />
<PlacementPopover placement="bottom" />
<PlacementPopover placement="left" />
</HStack>

lines 832–841:

<HStack gap="sm" wrap>
<Tooltip>
<TooltipTrigger testID="tooltip-demo-trigger" variant="outline">
Autosave
</TooltipTrigger>
<TooltipContent testID="tooltip-demo-content">
Saved automatically every 30 seconds
</TooltipContent>
</Tooltip>
</HStack>

lines 990–1002:

<Stack gap="lg">
<HStack gap="lg" wrap>
<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>
</HStack>

lines 1084–1089:

<VStack gap="xs">
<Text tone="muted" variant="caption">
Navigation remains application-owned. This showcase intentionally has no router or docs-site framework.
</Text>
<Link onPress={() => undefined}>Open documentation</Link>
</VStack>

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.

HStack and VStack do not accept direction — their axis is fixed. gap is a six-step token scale, so an arbitrary spacing value has to come through className.