BackdropScaffoldState

fun Saver(
    animationSpec: AnimationSpec<Float>,
    confirmStateChange: (BackdropValue) -> Boolean,
    snackbarHostState: SnackbarHostState,
    density: Density
): Saver<BackdropScaffoldState, *>

The default Saver implementation for BackdropScaffoldState.

suspend fun conceal(): Unit

Conceal the back layer with animation and suspend until it if fully concealed or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

fun progress(from: BackdropValue, to: BackdropValue): @FloatRange(from = 0.0, to = 1.0) Float

The fraction of the offset between from and to, as a fraction between 0f..1f, or 1f if from is equal to to.

fun requireOffset(): Float

Require the current offset.

suspend fun reveal(): Unit

Reveal the back layer with animation and suspend until it if fully revealed or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

val confirmValueChange: (BackdropValue) -> Boolean

Optional callback invoked to confirm or veto a pending state change.

val currentValue: BackdropValue

The current value of the BottomSheetState.

val isConcealed: Boolean

Whether the back layer is concealed.

val isRevealed: Boolean

Whether the back layer is revealed.

val snackbarHostState: SnackbarHostState

The SnackbarHostState used to show snackbars inside the scaffold.

val targetValue: BackdropValue

The target value the state will settle at once the current interaction ends, or the currentValue if there is no interaction in progress.