BottomSheetDefaults

public object BottomSheetDefaults

Contains the default values used by ModalBottomSheet and BottomSheetScaffold.

Properties

HiddenShape

public val HiddenShape: Shape

The default shape for bottom sheets in a Hidden state.

ExpandedShape

public val ExpandedShape: Shape

The default shape for a bottom sheets in PartiallyExpanded and Expanded states.

ContainerColor

public val ContainerColor: Color

The default container color for a bottom sheet.

Elevation

public val Elevation: Dp = SheetBottomTokens.DockedModalContainerElevation

The default elevation for a bottom sheet.

ScrimColor

public val ScrimColor: Color

The default color of the scrim overlay for background content.

SheetPeekHeight

public val SheetPeekHeight: Dp = 56.dp

The default peek height used by BottomSheetScaffold.

SheetMaxWidth

public val SheetMaxWidth: Dp = 640.dp

The default max width used by ModalBottomSheet and BottomSheetScaffold

windowInsets

@Deprecated(
        level = DeprecationLevel.WARNING,
        message = "Renamed as modalWindowInsets.",
        replaceWith = ReplaceWith("modalWindowInsets"),
    )
    public val windowInsets: WindowInsets

Default insets to be used and consumed by the ModalBottomSheet's content.

standardWindowInsets

public val standardWindowInsets: WindowInsets

Default insets to be used and consumed by the BottomSheet's content.

modalWindowInsets

public val modalWindowInsets: WindowInsets

Default insets to be used and consumed by the ModalBottomSheet's content.

Functions

DragHandle

@Composable
    public fun DragHandle(
        modifier: Modifier = Modifier,
        width: Dp = SheetBottomTokens.DockedDragHandleWidth,
        height: Dp = SheetBottomTokens.DockedDragHandleHeight,
        shape: Shape = MaterialTheme.shapes.extraLarge,
        color: Color = SheetBottomTokens.DockedDragHandleColor.value,
    )

The optional visual marker placed on top of a bottom sheet to indicate it may be dragged.