rememberBackdropScaffoldState

Functions summary

BackdropScaffoldState
@Composable
rememberBackdropScaffoldState(
    initialValue: BackdropValue,
    animationSpec: AnimationSpec<Float>,
    confirmStateChange: (BackdropValue) -> Boolean,
    snackbarHostState: SnackbarHostState
)

Create and remember a BackdropScaffoldState.

Cmn

Functions

rememberBackdropScaffoldState

@Composable
fun rememberBackdropScaffoldState(
    initialValue: BackdropValue,
    animationSpec: AnimationSpec<Float> = BackdropScaffoldDefaults.AnimationSpec,
    confirmStateChange: (BackdropValue) -> Boolean = { true },
    snackbarHostState: SnackbarHostState = remember { SnackbarHostState() }
): BackdropScaffoldState

Create and remember a BackdropScaffoldState.

Parameters
initialValue: BackdropValue

The initial value of the state.

animationSpec: AnimationSpec<Float> = BackdropScaffoldDefaults.AnimationSpec

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 = remember { SnackbarHostState() }

The SnackbarHostState used to show snackbars inside the scaffold.