Safe Area

BeeUIProvider application root plus an explicit SafeArea surface with caller-owned edge selection.

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/safe-area.tsx

Import

import { BeeUIProvider, SafeArea } from '@beemvp/beeui-ui';

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

pnpm beeui add safe-area

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: BeeUIProvider SafeArea
  • Also routed here, outside the Registry family:
    • safe-area
  • Package export subpath: @beemvp/beeui-ui/safe-area

Exported types: BeeUIProviderProps, SafeAreaProps

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

BeeUIProvider (the application root) supplies safe-area measurement, the Toast runtime/viewport, and the shared anchored-overlay runtime to every descendant; SafeArea itself is a stateless surface with caller-owned edges selection — BeeUI never adds system insets to other components implicitly. BeeUIProvider accepts an optional toastPlacement ('top' | 'bottom'), forwarded to the Toast runtime; omitting it keeps the existing platform default (bottom on iOS/Android, top on Web).

Props

BeeUIProviderProps

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
syncUniwindInsets	boolean	true	Keeps Uniwind OSS safe-area utilities (pt-safe, bottom-safe, etc.) in sync with react-native-safe-area-context. Disable only when the application already owns that bridge elsewhere.
toastPlacement	ToastPlacement	—	Where the transient useToast() notification stack docks. Defaults to 'bottom' on native (so it clears the bottom tab bar / home indicator) and 'top' on Web.

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

SafeAreaProps

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 React.ComponentProps<typeof NativeSafeAreaView> — 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, react-native-safe-area-context, uniwind
• Registry dependency closure: core-cn, overlay-runtime, theme, toast
• 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 safe-area.tsx.
• Accessibility states and properties it sets: none set in safe-area.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<React.ComponentProps<typeof NativeSafeAreaProvider>, 'children'>, React.ComponentProps<typeof NativeSafeAreaView>.
• 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/__tests__/dynamic-type-fixture.test.tsx
• Additional fixture: apps/showcase/__tests__/issue-19-overlay-runtime.test.tsx
• Additional fixture: apps/showcase/__tests__/pattern-gallery.test.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: SafeArea
  • Public composition parts / helpers:
    • BeeUIProvider
  • Exported type surface:
    • BeeUIProviderProps
    • SafeAreaProps

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 Safe Area is actually used: 28 lines in 2 places, of 3 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 { AppHeader, Avatar, BottomActionBar, Button, HStack, SafeArea, Switch } from '@beemvp/beeui-ui';
import * as React from 'react';
import { Uniwind, useUniwind } from 'uniwind';

Fixture state this block reads (same file, lines 121-137, 458):

function ThemeToggle() {
  const { hasAdaptiveThemes, theme } = useUniwind();
  const activeTheme = hasAdaptiveThemes ? 'system' : theme;
  const nextTheme = activeTheme === 'system' ? 'light' : activeTheme === 'light' ? 'dark' : 'system';

  return (
    <Button
      accessibilityLabel={`Theme ${activeTheme}. Switch to ${nextTheme}`}
      onPress={() => Uniwind.setTheme(nextTheme)}
      size="sm"
      testID="component-gallery-theme-toggle"
      variant="outline"
    >
      {`Theme: ${activeTheme}`}
    </Button>
  );
}
  const { theme } = useUniwind();

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

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

lines 476–497:

      <SafeArea className="bg-surface" edges={['top', 'left', 'right']} testID="component-gallery-safe-area">
        <AppHeader
          description="Interactive React Native component playground built entirely from the public BeeUI API."
          testID="component-gallery-header"
          leading={
            <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>
          }
          title="Component Gallery"
          trailing={<ThemeToggle />}
        />
      </SafeArea>

lines 1094–1099:

      <SafeArea className="bg-surface" edges={['bottom', 'left', 'right']}>
        <BottomActionBar>
          <Button size="sm" variant="ghost">Cancel</Button>
          <Button size="sm">Save changes</Button>
        </BottomActionBar>
      </SafeArea>

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

SafeArea is a pass-through to react-native-safe-area-context’s own view: BeeUI adds no edges default and no inset arithmetic of its own, so which edges a surface pads is the caller’s to state. Uniwind’s safe-area utilities are fed only by the provider’s syncUniwindInsets bridge; turning it off leaves the application to push insets into Uniwind itself.

Implementation note: BeeUIProvider supplies safe-area measurement, the Toast runtime/viewport, and the shared anchored-overlay runtime.

Related

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