Design/net.ikea.skapa.ui.components/BottomSheet

BottomSheet

@Composable
fun BottomSheet(sheetContent: @Composable () -> Unit, modifier: Modifier = Modifier, sheetState: SheetState = rememberSheetState(SheetValue.Hidden), modalHeaderParams: ModalHeaderParams? = null, sheetFooterParams: ModalsActionFooterParams? = null, dividers: Boolean = false, background: Color = SkapaTheme.colors.elevation2, contentHorizontalPadding: Dp = SheetPropsM2.DefaultPadding, onDismiss: () -> Unit? = null)

Deprecated (with error)

This BottomSheet component is based on Material2. Migrate to Sheet based on Material3.Have a look at the components sample, net.ikea.skapa.ui.samples.SheetM3Sample

Replace with

Sheet(onDismiss = onDismiss, modifier = modifier, sheetState = sheetState /* TODO */, modalHeader = modalHeaderParams /* TODO */, sheetFooterParams = sheetFooterParams, dividers = dividers, background = background, contentHorizontalPadding = contentHorizontalPadding /* TODO */, content = sheetContent)
Content copied to clipboard

Sheet is a modal window that dims and disables the parent view allowing for a short, focused task or providing additional information before returning to the main screen. They are an alternative to inline menus and simple dialogs, providing additional room for content, iconography, and actions.

Parameters

sheetContent

The content of the bottom sheet.

modifier

Optional Modifier for the entire component.

sheetState

SheetState The state of the bottom sheet.

modalHeaderParams

ModalHeaderParams if provided, will add a fixed ModalHeader component on top of the sheet layout

sheetFooterParams

ModalsActionFooterParams if provided, will add a fixed ModalsActionFooter at the bottom of the sheet layout

dividers

Top and Bottom dividers to highlight content division with Header and Footer

contentHorizontalPadding

The padding applied to the sheet content.

background

The background color of the sheet.

onDismiss

optional. Sets a callback for when this Sheet dismisses itself.

See also

Samples

net.ikea.skapa.ui.samples.SheetSample