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> = SwipeableDefaults.AnimationSpec, confirmStateChange: (BackdropValue) -> Boolean = { true }, snackbarHostState: SnackbarHostState = SnackbarHostState()) State of the BackdropScaffold composable. |
Public methods | |
---|---|
Unit |
Conceal the back layer, with an animation. |
Unit |
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 | |
---|---|
Properties | |
---|---|
Boolean |
Whether the back layer is concealed. |
Boolean |
Whether the back layer is revealed. |
SnackbarHostState |
The SnackbarHostState used to show snackbars inside the scaffold. |
Inherited properties | |
---|---|
Public constructors
<init>
BackdropScaffoldState(
initialValue: BackdropValue,
clock: AnimationClockObservable,
animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec,
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< |