# rememberSwipeToDismissBoxState

## Functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissBoxState` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable [rememberSwipeToDismissBoxState](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/rememberSwipeToDismissBoxState.composable#rememberSwipeToDismissBoxState(androidx.compose.animation.core.AnimationSpec,kotlin.Function1))( 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/wear/compose/material/SwipeToDismissValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` **This function is deprecated.** Please import rememberSwipeToDismissBoxState from androidx.wear.compose.foundation. |

## Functions

### rememberSwipeToDismissBoxState

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

```
@Composable
fun [rememberSwipeToDismissBoxState](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/rememberSwipeToDismissBoxState.composable#rememberSwipeToDismissBoxState(androidx.compose.animation.core.AnimationSpec,kotlin.Function1))(
    animationSpec: AnimationSpec<Float> = SWIPE_TO_DISMISS_BOX_ANIMATION_SPEC,
    confirmStateChange: (SwipeToDismissValue) -> Boolean = { true }
): SwipeToDismissBoxState
```

> [!CAUTION]
> **This function is deprecated.**   
> Please import rememberSwipeToDismissBoxState from androidx.wear.compose.foundation, use this instead:
>
> ```kotlin
> androidx.wear.compose.foundation.rememberSwipeToDismissBoxState(
> ```

Create a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissBoxState` and remember it.

| Parameters |
|---|---|
| `animationSpec: https://developer.android.com/reference/kotlin/androidx/compose/animation/core/AnimationSpec<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html> = SWIPE_TO_DISMISS_BOX_ANIMATION_SPEC` | The default animation used to animate to a new state. |
| `confirmStateChange: (https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = { true }` | Optional callback to confirm or veto a pending state change. |