{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

BottomSheetDefaults

@ExperimentalMaterial3Api
public static class BottomSheetDefaults


Contains the default values used by ModalBottomSheet and BottomSheetScaffold.

Summary

Public fields

static @NonNull BottomSheetDefaults

Public methods

final void
@Composable
DragHandle(
    @NonNull Modifier modifier,
    @NonNull Dp width,
    @NonNull Dp height,
    @NonNull Shape shape,
    @NonNull Color color
)

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

final @NonNull Color

The default container color for a bottom sheet.

final @NonNull Dp

The default elevation for a bottom sheet.

final @NonNull Shape

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

final @NonNull Shape

The default shape for bottom sheets in a Hidden state.

final @NonNull Color

The default color of the scrim overlay for background content.

final @NonNull Dp

The default max width used by ModalBottomSheet and BottomSheetScaffold

final @NonNull Dp

The default peek height used by BottomSheetScaffold.

final @NonNull WindowInsets

Default insets to be used and consumed by the ModalBottomSheet window.

Public fields

INSTANCE

public static @NonNull BottomSheetDefaults INSTANCE

Public methods

DragHandle

@Composable
public final void DragHandle(
    @NonNull Modifier modifier,
    @NonNull Dp width,
    @NonNull Dp height,
    @NonNull Shape shape,
    @NonNull Color color
)

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

getContainerColor

@Composable
public final @NonNull Color getContainerColor()

The default container color for a bottom sheet.

getElevation

public final @NonNull Dp getElevation()

The default elevation for a bottom sheet.

getExpandedShape

@Composable
public final @NonNull Shape getExpandedShape()

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

getHiddenShape

@Composable
public final @NonNull Shape getHiddenShape()

The default shape for bottom sheets in a Hidden state.

getScrimColor

@Composable
public final @NonNull Color getScrimColor()

The default color of the scrim overlay for background content.

getSheetMaxWidth

public final @NonNull Dp getSheetMaxWidth()

The default max width used by ModalBottomSheet and BottomSheetScaffold

getSheetPeekHeight

public final @NonNull Dp getSheetPeekHeight()

The default peek height used by BottomSheetScaffold.

getWindowInsets

@Composable
public final @NonNull WindowInsets getWindowInsets()

Default insets to be used and consumed by the ModalBottomSheet window.