# rememberBackdropScaffoldState

Common/AllAndroid/JVM

## Functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropScaffoldState` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material/rememberBackdropScaffoldState.composable#rememberBackdropScaffoldState(androidx.compose.material.BackdropValue,androidx.compose.animation.core.AnimationSpec,kotlin.Function1,androidx.compose.material.SnackbarHostState)( initialValue: https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropValue, animationSpec: https://developer.android.com/reference/kotlin/androidx/compose/animation/core/AnimationSpec<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html>, confirmStateChange: (https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, snackbarHostState: https://developer.android.com/reference/kotlin/androidx/compose/material/SnackbarHostState )` Create and `https://developer.android.com/reference/kotlin/androidx/compose/runtime/remember.composable#remember(kotlin.Function0)` a `https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropScaffoldState`. | Cmn |

## Functions

### rememberBackdropScaffoldState

Cmn Artifact: [androidx.compose.material:material](https://developer.android.com/jetpack/androidx/releases/compose-material) [View Source](https://cs.android.com/search?q=file:androidx/compose/material/BackdropScaffold.kt+function:rememberBackdropScaffoldState) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.0.0)

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

Create and `https://developer.android.com/reference/kotlin/androidx/compose/runtime/remember.composable#remember(kotlin.Function0)` a `https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropScaffoldState`.

| Parameters |
|---|---|
| `initialValue: https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropValue` | The initial value of the state. |
| `animationSpec: https://developer.android.com/reference/kotlin/androidx/compose/animation/core/AnimationSpec<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html> = BackdropScaffoldDefaults.AnimationSpec` | The default animation that will be used to animate to a new state. |
| `confirmStateChange: (https://developer.android.com/reference/kotlin/androidx/compose/material/BackdropValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = { true }` | Optional callback invoked to confirm or veto a pending state change. |
| `snackbarHostState: https://developer.android.com/reference/kotlin/androidx/compose/material/SnackbarHostState = remember { SnackbarHostState() }` | The `https://developer.android.com/reference/kotlin/androidx/compose/material/SnackbarHostState` used to show snackbars inside the scaffold. |