Screen

Base application surface with semantic background and optional spacing; owns no safe-area behavior and offers only an opt-in scroll body.

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/screen.tsx

Import

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

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

pnpm beeui add screen

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

Exported types: ScreenProps

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 base application surface with a semantic background and optional spacing prop; it owns no safe-area behavior itself. scroll defaults to false (children render directly, unchanged); pass true for a keyboard-avoiding ScrollView body, or a ScrollViewProps object to override it (e.g. { keyboardShouldPersistTaps: 'always' }) — for the fuller Android focused-field scroll-into-view contract, use KeyboardAwareScreen instead.

Props

ScreenProps

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'	'none'	Preset horizontal/vertical padding: 'none' (0), 'sm', 'md', or 'lg'. Defaults to 'none'.
scroll	boolean | Omit<ScrollViewProps, 'children'>	false	Wraps children in a keyboard-avoiding ScrollView (behavior="padding" on iOS, matching KeyboardAwareScreen’s basic case) so a long form or list needs no hand-rolled ScrollView. Pass true for the default scroll body, or a ScrollViewProps object (excluding children) to override any of it — e.g. { keyboardShouldPersistTaps: 'always' }. Defaults to false: children render directly, unchanged. For the fuller Android focused-field scroll-into-view contract, use KeyboardAwareScreen instead.

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, but its source branches on Platform, so some behavior differs by target.

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 screen.tsx.
• Accessibility states and properties it sets: none set in screen.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: padding (4 values).
• 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__/component-contracts.test.tsx
• Additional fixture: apps/showcase/__tests__/screen-scroll-prop.test.tsx
• Additional fixture: apps/showcase/component-gallery/component-gallery.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: Screen
  • Exported type surface:
    • ScreenProps

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 Screen is actually used: 1 line 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. What follows the tag in the fixture is this family’s own content, which the live preview above already renders.

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

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

line 474:

    <Screen testID="component-gallery">

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

padding is a four-value preset applied to both axes at once: there is no per-axis, per-edge or token-level spacing control, so anything else comes from className. scroll’s keyboard-avoiding wrapper is the same basic case KeyboardAwareScreen covers more fully; it does not add safe-area edges of its own.

Related

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