modules/bottom-sheet/README.md
A custom Expo module that provides native bottom sheet functionality for iOS and Android, using platform-specific native bottom sheet implementations (UISheetPresentationController on iOS, Material BottomSheetDialog on Android).
This module wraps native bottom sheet components to provide a React Native interface with cross-platform consistency. It uses native presentation APIs rather than JavaScript-based animations for better performance and native behavior.
Key features:
UISheetPresentationController (iOS 15+)BottomSheetDialog with BottomSheetBehaviorThe module exposes a React component that handles rendering and state management:
The component uses a class-based approach to expose imperative methods (present(), dismiss(), dismissAll()).
SheetViewController
UISheetPresentationControllerDelegate for drag eventsOnLayoutChangeListener to observe content height nativelyBottomSheetBehavior for drag and snap behaviorBoth platforms detect content height changes natively without JS bridge round-trips:
bounds propertyOnLayoutChangeListener on child views (catches React Native's direct layout() calls)This eliminates layout jank when content changes (e.g., keyboard appearance, dynamic content loading).
interface BottomSheetViewProps {
children: React.ReactNode
// Appearance
cornerRadius?: number
backgroundColor?: ColorValue
containerBackgroundColor?: ColorValue
// Behavior
preventDismiss?: boolean // Disable swipe-to-dismiss
preventExpansion?: boolean // Lock to initial height (no full-screen)
disableDrag?: boolean // Disable drag handle (Android only)
fullHeight?: boolean // Start at full screen height
// Height constraints
minHeight?: number // Minimum height in dp
maxHeight?: number // Maximum height in dp
// iOS 26+ transition
sourceViewTag?: number // View tag for zoom transition origin
// Events
onAttemptDismiss?: (event: BottomSheetAttemptDismissEvent) => void
onSnapPointChange?: (event: BottomSheetSnapPointChangeEvent) => void
onStateChange?: (event: BottomSheetStateChangeEvent) => void
}
closed: Sheet is dismissedclosing: Sheet is animating closedopen: Sheet is fully visibleopening: Sheet is animating openHidden (0): DismissedPartial (1): Half-expanded / content heightFull (2): Expanded to screen heightimport {BottomSheet, BottomSheetProvider, BottomSheetOutlet} from '@modules/bottom-sheet'
// In your app root:
function App() {
return (
<BottomSheetProvider>
<YourApp />
<BottomSheetOutlet />
</BottomSheetProvider>
)
}
// In a component:
function MyComponent() {
const sheetRef = useRef<BottomSheet>(null)
const openSheet = () => {
sheetRef.current?.present()
}
const closeSheet = () => {
sheetRef.current?.dismiss()
}
return (
<>
<Button onPress={openSheet} title="Open Sheet" />
<BottomSheet
ref={sheetRef}
cornerRadius={16}
backgroundColor="white"
onStateChange={(e) => console.log(e.nativeEvent.state)}
>
<View style={{padding: 20}}>
<Text>Sheet content</Text>
<Button onPress={closeSheet} title="Close" />
</View>
</BottomSheet>
</>
)
}
The module supports nesting sheets by using BottomSheetPortalProvider within sheet content:
<BottomSheet ref={outerSheetRef}>
<BottomSheetPortalProvider>
<Button onPress={() => innerSheetRef.current?.present()} />
<BottomSheet ref={innerSheetRef}>
<Text>Inner sheet content</Text>
</BottomSheet>
</BottomSheetPortalProvider>
</BottomSheet>
import {BottomSheetNativeComponent} from '@modules/bottom-sheet'
BottomSheetNativeComponent.dismissAll()
iOS 15 Compatibility: On iOS 15, custom detents are not available, so the module uses .medium() detent and applies extra styling to prevent visual issues.
iOS 26+ Zoom Transitions: When sourceViewTag is provided on iOS 26+, the sheet zooms from the specified view.
Detent Selection: The module automatically chooses between custom detents, .medium(), and .large() based on content height and screen size.
Edge-to-Edge: The module handles edge-to-edge display correctly across API levels:
currentWindowMetricsgetRealSize()Status/Nav Bar Appearance: Preserves light/dark appearance from the host activity and reapplies it to the sheet dialog.
Drag Handling: On full-height sheets with preventDismiss, dragging is disabled to prevent accidental dismissal (since there's no half-expanded snap point to land on).
Layout Updates During Gestures: Content height changes are deferred during drag gestures to prevent fighting the user's input.
overflow: hidden)preventDismiss + preventExpansion)index.ts - Public API exportssrc/BottomSheet.types.ts - TypeScript type definitionssrc/BottomSheet.tsx - Native component (re-export)src/BottomSheet.web.tsx - Web stubsrc/BottomSheetNativeComponent.tsx - Native wrapper with portal integrationsrc/BottomSheetNativeComponent.web.tsx - Web stub for native componentsrc/BottomSheetPortal.tsx - Portal context and providerssrc/lib/Portal.tsx - Generic portal implementationios/BottomSheetModule.swift - Module definitionios/SheetView.swift - Main view implementationios/SheetViewController.swift - View controller for sheet presentationios/SheetManager.swift - Singleton for tracking active sheetsios/Util.swift - Screen height utilityandroid/src/main/java/expo/modules/bottomsheet/BottomSheetModule.kt - Module definitionandroid/src/main/java/expo/modules/bottomsheet/BottomSheetView.kt - Main view implementationandroid/src/main/java/expo/modules/bottomsheet/DialogRootViewGroup.kt - Dialog root view groupandroid/src/main/java/expo/modules/bottomsheet/SheetManager.kt - Sheet tracking singletonexpo-module.config.json - Expo module configuration