Sheet

Gesture-driven bottom sheet with detents on the shared overlay runtime.

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: Overlays & feedback
• 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/sheet.tsx

Import

import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHandle, SheetProvider, SheetTitle, SheetTrigger } from '@beemvp/beeui-ui';

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

pnpm beeui add sheet

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: Sheet SheetClose SheetContent SheetDescription SheetFooter SheetHandle SheetProvider SheetTitle SheetTrigger
  • Also routed here, outside the Registry family:
    • sheet
  • Package export subpath: @beemvp/beeui-ui/sheet

Exported types: SheetCloseProps, SheetContentProps, SheetDescriptionProps, SheetFooterProps, SheetHandleProps, SheetProps, SheetProviderProps, SheetSnapPoint, SheetTitleProps, SheetTriggerProps

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

Controlled (open+onOpenChange) or uncontrolled (defaultOpen) gesture-driven bottom sheet on the shared overlay runtime; dismissal (backdrop press, swipe, Web Escape, Android hardware back) routes through the same dismissOnRequestClose/onRequestClose contract Dialog uses.

Props

SheetCloseProps

SheetCloseProps is exactly ButtonProps.

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
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.
labelClassName	string	—	Extra utility classes for the label text specifically, merged after the component’s own.
loading	boolean	false	Shows a spinner in place of the label, sets aria-busy, and disables presses. Defaults to false.
size	'sm' | 'md' | 'lg' | 'icon'	'md'	Chooses this element’s size from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there.
variant	'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive'	'primary'	Chooses this element’s variant from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there.

Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children'> — that upstream contract is not reproduced here.

SheetContentProps

Prop	Type	Default	Description
bridgeContexts	readonly SheetBridgeContext[]	—	Consumer-owned React contexts that need bridging only on native gorhom portals. Web and the fallback RN Modal preserve context already, so they accept this for signature parity and ignore it.
avoidKeyboard	boolean	true	Declares the keyboard-interaction contract, but this cross-platform skeleton does not itself read the flag: it relies on the platform’s own default Modal keyboard behavior. Defaults to true. #158 (native) and #159 (Web) drive real, platform-appropriate keyboard avoidance from it — per ADR-006 native and Web keyboard interaction are not the same problem and are not expected to share one implementation (#157).
closeOnBackdropPress	boolean	true	Backdrop dismissal policy. Defaults to true, matching DialogContent.
containerClassName	string	—	Extra utility classes for the overlay’s container element, merged after the component’s own.
dismissOnRequestClose	boolean	true	Whether a native request-close (Android Back, iOS swipe) actually closes the Sheet.
enableSwipeToDismiss	boolean	true	Swipe/gesture dismissal contract (#157, per ADR-006). This cross-platform skeleton has no drag gesture and never reads this value; #158’s optional @gorhom/bottom-sheet native adapter is the actual driver of real swipe-to-dismiss from this same flag.
handleClassName	string	—	Applied to the default SheetHandle when showHandle is true.
initialSnapIndex	number	0	Index into snapPoints the sheet renders at. Contract-only static sizing signal for this skeleton (see {@link SheetSnapPoint}); #158 drives real interactive snapping from the same snapPoints/initialSnapIndex pair.
modalProps	SheetModalProps	—	Forwarded to the underlying React Native Modal, minus the props this component already controls (animationType may still be overridden here; presentationStyle/transparent/visible cannot).
onRequestClose	() => void	—	Called whenever a native request-close source (Android hardware back, iOS/other native modal dismissal) fires, before this sheet applies its own dismissOnRequestClose policy. Does not by itself close the sheet.
overlayClassName	string	—	Extra utility classes for the backdrop element behind the surface, merged after the component’s own.
overlayProps	Omit<PressableProps, 'children' | 'onPress'>	—	Forwarded to the backdrop Pressable, excluding children and onPress which this component owns.
overlayTestID	string	—	testID applied to the backdrop Pressable, for targeting it in tests.
showHandle	boolean	true	Renders the default drag-handle affordance above children. Defaults to true.
snapPoints	readonly SheetSnapPoint[]	—	Snap points / presentation sizes. See {@link SheetSnapPoint}.

Also carries every prop of Omit<ViewProps, 'accessibilityRole' | 'accessibilityViewIsModal' | 'role'> — that upstream contract is not reproduced here.

Platform differences (native vs. Web):

• avoidKeyboard is accepted on Web for API parity but has no effect there.
• bridgeContexts is accepted on Web for API parity but has no effect there.
• enableSwipeToDismiss is accepted on Web for API parity but has no effect there.
• modalProps is accepted on Web for API parity but has no effect there.

SheetDescriptionProps

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
accessibilityLabel	—
children	—
className	—
nativeID	—

Also carries every prop of Omit<TextProps, 'tone' | 'variant'> — documented on the Text page, not reproduced here.

SheetFooterProps

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.

SheetHandleProps

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

Also carries every prop of Omit<ViewProps, 'accessibilityRole' | 'role'> — that upstream contract is not reproduced here.

SheetProps

one of the following mutually exclusive variants:

Variant SheetControlledProps:

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
defaultOpen	never	false	Not accepted in the controlled variant, where open already owns the state. Pass defaultOpen on its own, without open, to use the uncontrolled variant.
onOpenChange (required)	(open: boolean) => void	—	Applies a requested open state, and is required here because the controlled variant never updates its own visibility. If this does not change open, nothing does.
open (required)	boolean	—	Current open state, owned by the caller; supplying a defined value alongside onOpenChange is what selects the controlled variant. Passing open without an onOpenChange function warns in development and falls back to uncontrolled behavior.

Variant SheetUncontrolledProps:

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
defaultOpen	boolean	false	Open state to start from, read once when the component mounts, so later changes to it are ignored. Defaults to false; drive visibility with open + onOpenChange instead when it needs to change.
onOpenChange	(open: boolean) => void	—	Notified after the open state changes, and optional here because the uncontrolled variant updates its own state either way.
open	undefined	—	Must be left undefined in the uncontrolled variant, because a defined open together with onOpenChange selects the controlled variant instead.

SheetProviderProps

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.

SheetTitleProps

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
accessibilityLabel	—
children	—
className	—
nativeID	—

Also carries every prop of Omit<TextProps, 'accessibilityRole' | 'role' | 'variant'> — documented on the Text page, not reproduced here.

SheetTriggerProps

SheetTriggerProps is exactly ButtonProps.

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
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.
labelClassName	string	—	Extra utility classes for the label text specifically, merged after the component’s own.
loading	boolean	false	Shows a spinner in place of the label, sets aria-busy, and disables presses. Defaults to false.
size	'sm' | 'md' | 'lg' | 'icon'	'md'	Chooses this element’s size from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there.
variant	'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive'	'primary'	Chooses this element’s variant from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there.

Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children'> — that upstream contract is not reproduced here.

This is the pressable itself — the same variant/size/press API as Button — so icon/label children go directly inside it. Do not nest a second pressable (an icon button, or an avatar wrapped for press) inside a *Trigger: on Web that renders one interactive element inside another, which React flags as invalid DOM nesting. For an icon-only or avatar trigger, set variant="ghost" (and size/className as needed) on the trigger itself instead of wrapping a second pressable.

Related exported types:

• SheetSnapPoint — alias of ``${number}% | number.

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

• BeeUIProvider must wrap SheetProvider. On native, SheetProvider owns gorhom’s gesture/modal provider boundary so the store-backed portal is created below BeeUI runtime contexts; Web/fallback SheetProvider is a pass-through.
• Peer/native dependencies visible to this Registry item: @gorhom/bottom-sheet, react, react-native, react-native-gesture-handler, react-native-reanimated, react-native-worklets
• Registry dependency closure: button, core-cn, overlay-runtime, sheet-context-bridge, text, theme, theme-scope-bridge, toast-runtime-bridge
• On Web this family renders from sheet.web.tsx, which does not import @gorhom/bottom-sheet, react-native-gesture-handler, react-native-reanimated, react-native-worklets: those peers serve the native implementation.
• 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 is split by platform and renders from sheet.web.tsx (Web), sheet.native.tsx (iOS and Android). Where the two shapes differ, the difference is listed under the affected type above rather than summarised here.

This family has platform-split source files. The bundler selects the native/Web implementation; do not infer native runtime behavior from the Web preview.

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: dialog, header — set in sheet.tsx, sheet.web.tsx, sheet.native.tsx by the components themselves, not by the caller.
• Accessibility states and properties it sets: accessibilityElementsHidden, accessibilityHint, accessibilityLabel, accessibilityLabelledBy, accessible, hidden, modal — read from sheet.tsx, sheet.web.tsx, sheet.native.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: size (4 values), variant (5 values), tone (8 values, inherited from TextProps).
• Class-name surfaces: className, containerClassName, handleClassName, labelClassName, overlayClassName.

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/app-providers.native.tsx
• Additional fixture: apps/showcase/component-gallery/component-gallery.tsx
• Additional fixture: apps/showcase/runtime-smoke/l10n-stress-acceptance.tsx
• Additional fixture: apps/showcase/runtime-smoke/runtime-acceptance.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: Sheet
  • Public composition parts / helpers:
    • SheetClose
    • SheetContent
    • SheetDescription
    • SheetFooter
    • SheetHandle
    • SheetProvider
    • SheetTitle
    • SheetTrigger
  • Exported type surface:
    • SheetCloseProps
    • SheetContentProps
    • SheetDescriptionProps
    • SheetFooterProps
    • SheetHandleProps
    • SheetProps
    • SheetProviderProps
    • SheetSnapPoint
    • SheetTitleProps
    • SheetTriggerProps

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 Sheet is actually used: 15 lines 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. The rest of that file exercises other families and is not reproduced here.

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

import { Field, Input, Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetTitle, SheetTrigger } from '@beemvp/beeui-ui';

lines 754–768:

                <Sheet>
                  <SheetTrigger testID="sheet-demo-trigger">Open Sheet</SheetTrigger>
                  <SheetContent overlayTestID="sheet-demo-overlay" testID="sheet-demo-content">
                    <SheetTitle>Filters</SheetTitle>
                    <SheetDescription>Refine results by category and price.</SheetDescription>
                    <Field label="Search">
                      <Input accessibilityLabel="Sheet search" testID="sheet-demo-input" />
                    </Field>
                    <SheetFooter>
                      <SheetClose testID="sheet-demo-close" variant="outline">
                        Close
                      </SheetClose>
                    </SheetFooter>
                  </SheetContent>
                </Sheet>

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

• Passing open without onOpenChange leaves the value read-only: the component renders what you passed and can never change it. It warns in development builds rather than failing silently in production.
• Requires @gorhom/bottom-sheet, react-native-gesture-handler, react-native-reanimated, react-native-worklets to be installed by the consuming app. They are optional peers of @beemvp/beeui-ui, so nothing installs them for you, and a target that never renders this family does not need it.
• On Web, avoidKeyboard, bridgeContexts, enableSwipeToDismiss, modalProps are accepted for API parity and read by nothing: setting them changes no behavior there.

Implementation note: Native apps mount SheetProvider below BeeUIProvider; it owns @gorhom/bottom-sheet + gesture-handler root wiring, while Web/fallback is pass-through. The family remains platform-split.

Related

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