Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
LayoutAndroid

Sheet

Present supplemental application content in a controlled native sheet.

Public APILumenSheetAndroid / Compose

Native example

Use Sheet

Use for supplemental editing or detail that should not replace the current screen. Keep form state and dismissal decisions application-owned.

Sheet rendered in the Android phone emulator Lumen playground
Captured exampleAndroid phone emulator
kotlin
LumenSheet(
    visible = showEditor,
    onDismiss = { showEditor = false },
    title = "Edit report"
) {
    ReportEditor()
}

Reference

Public API

The primary shared and platform-specific options exposed by LumenSheet.

APIValues or typeDefaultDescription
dismissibleBooleantrueAllows platform gestures, back actions, and backdrop dismissal. Set false while application work requires the sheet to remain open.
scrollableBooleantrueScrolls content with reachable actions. Short windows and accessibility text sizes may scroll the complete sheet; set false for application-owned lazy or virtualized containers.
—RefObject<HostInstance | null>undefinedOptionally focuses an accessible application-owned control after presentation and restores its trigger after closing.
visibleBooleanRequiredControls native sheet presentation.
title / descriptionNative localized textnil / undefinedProvides optional heading context.
onDismiss() -> VoidRequiredReturns presentation ownership to the application.
content / actionsNative view slotsActions optionalComposes application-owned content and actions.

Native behavior

Design and accessibility

When to use it

Use for supplemental editing or detail that should not replace the current screen. Keep form state and dismissal decisions application-owned.

Accessibility

The native modal presentation contains focus while preserving the semantics and reading order of application-owned content.

Shared component

Available on other platforms

React NativeApple / SwiftUI
Android docsCompose module