BackdropScaffoldState

Kotlin |Java

@Stable class BackdropScaffoldState : SwipeableState<BackdropValue>

kotlin.Any
↳	androidx.compose.material.SwipeableState<androidx.compose.material.BackdropValue>
	↳	androidx.compose.material.BackdropScaffoldState

State of the BackdropScaffold composable.

Summary

Public constructors
<init>(initialValue: BackdropValue, clock: AnimationClockObservable, animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec, confirmStateChange: (BackdropValue) -> Boolean = { true }, snackbarHostState: SnackbarHostState = SnackbarHostState()) State of the BackdropScaffold composable.

Public methods
Unit	conceal(onConcealed: () -> Unit = null) Conceal the back layer, with an animation.
Unit	reveal(onRevealed: () -> Unit = null) Reveal the back layer, with an animation.

Companion functions
Saver<BackdropScaffoldState, *>	Saver(clock: AnimationClockObservable, animationSpec: AnimationSpec<Float>, confirmStateChange: (BackdropValue) -> Boolean, snackbarHostState: SnackbarHostState) The default Saver implementation for BackdropScaffoldState.

Inherited functions
From class SwipeableState Unit animateTo(targetValue: T, anim: AnimationSpec<Float> = animationSpec, onEnd: (AnimationEndReason, T) -> Unit = null) Set the state to the target value by starting an animation. Unit snapTo(targetValue: T) Set the state to the target value immediately, without any animation.

Properties
Boolean	isConcealed Whether the back layer is concealed.
Boolean	isRevealed Whether the back layer is revealed.
SnackbarHostState	snackbarHostState The SnackbarHostState used to show snackbars inside the scaffold.

Inherited properties

From class SwipeableState Float direction The direction in which the swipeable is moving, relative to the current value. This will be either 1f if it is is moving from left to right or top to bottom, -1f if it is moving from right to left or bottom to top, or 0f if no swipe or animation is in progress. Boolean isAnimationRunning Whether the state is currently animating. State<Float> offset The current position (in pixels) of the swipeable. You should use this state to offset your content accordingly. The recommended way is to use Modifier.offsetPx. This includes the resistance by default, if resistance is enabled. State<Float> overflow The amount by which the swipeable has been swiped past its bounds. SwipeProgress<T> progress Information about the ongoing swipe or animation, if any. See SwipeProgress for details. If no swipe or animation is in progress, this returns SwipeProgress(value, value, 1f). T targetValue The target value of the state. If a swipe is in progress, this is the value that the swipeable would animate to if the swipe finished. If an animation is running, this is the target value of that animation. Finally, if no swipe or animation is in progress, this is the same as the value. T value The current value of the state. If no swipe or animation is in progress, this corresponds to the anchor at which the swipeable is currently settled. If a swipe or animation is in progress, this corresponds the last anchor at which the swipeable was settled before the swipe or animation started.

Public constructors

<init>

BackdropScaffoldState(
    initialValue: BackdropValue, 
    clock: AnimationClockObservable, 
    animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec, 
    confirmStateChange: (BackdropValue) -> Boolean = { true }, 
    snackbarHostState: SnackbarHostState = SnackbarHostState())

State of the BackdropScaffold composable.

Parameters
initialValue: BackdropValue	The initial value of the state.
clock: AnimationClockObservable	The animation clock that will be used to drive the animations.
animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec	The default animation that will be used to animate to a new state.
confirmStateChange: (BackdropValue) -> Boolean = { true }	Optional callback invoked to confirm or veto a pending state change.
snackbarHostState: SnackbarHostState = SnackbarHostState()	The SnackbarHostState used to show snackbars inside the scaffold.

Public methods

conceal

fun conceal(onConcealed: () -> Unit = null): Unit

Conceal the back layer, with an animation.

Parameters
onConcealed: () -> Unit = null	Optional callback invoked when the back layer has been concealed.

reveal

fun reveal(onRevealed: () -> Unit = null): Unit

Reveal the back layer, with an animation.

Parameters
onRevealed: () -> Unit = null	Optional callback invoked when the back layer has been revealed.

Properties

isConcealed

val isConcealed: Boolean

Whether the back layer is concealed.

isRevealed

val isRevealed: Boolean

Whether the back layer is revealed.

snackbarHostState

val snackbarHostState: SnackbarHostState

The SnackbarHostState used to show snackbars inside the scaffold.

Companion functions

Saver

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

The default Saver implementation for BackdropScaffoldState.