Skip to content

StandardSideSheet

Signature

@Composable
fun StandardSideSheet(
modifier: Modifier = Modifier,
sheetState: SideSheetState = rememberSideSheetState(SideSheetValue.Expanded),
sheetWidth: Dp = SideSheetDefaults.SheetMaxWidth,
edge: SideSheetEdge = SideSheetEdge.End,
gesturesEnabled: Boolean = true,
shape: Shape = SideSheetDefaults.standardShape(),
colors: SideSheetColors = SideSheetDefaults.colors(),
content: @Composable ColumnScope.() -> Unit,
)

Parameters

ParameterTypeDefaultDescription
modifierModifierModifierModifier for the sheet surface
sheetStateSideSheetStaterememberSideSheetState(Expanded)State controlling visibility and drag
sheetWidthDp360.dpWidth of the sheet
edgeSideSheetEdgeEndWhich edge the sheet is anchored to
gesturesEnabledBooleantrueWhether swipe gestures are enabled
shapeShapeRectangleShapeShape of the sheet surface
colorsSideSheetColorsSideSheetDefaults.colors()Color configuration
content@Composable ColumnScope.() -> UnitRequiredSheet content

Behavior

  • Renders inline in the layout (no popup, no scrim)
  • Defaults to Expanded state
  • Intended for use inside a Row alongside main content
  • No elevation shadow by default