# SwipeDismissableSceneStrategy

Artifact: [androidx.wear.compose:compose-navigation3](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy.kt+class:androidx.wear.compose.navigation3.SwipeDismissableSceneStrategy) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)


```
class SwipeDismissableSceneStrategy<T : Any> : SceneStrategy<T>
```

<br />

*** ** * ** ***

A `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategy` that displays entries within a Wear Material component.

Below API level 36, content of the current entry (the last entry on the backstack) is displayed within a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/BasicSwipeToDismissBox.composable#BasicSwipeToDismissBox(androidx.wear.compose.foundation.SwipeToDismissBoxState,androidx.compose.ui.Modifier,kotlin.Any,kotlin.Any,kotlin.Boolean,kotlin.Function2)` to detect swipe back gestures.

API level 36 onwards, `https://developer.android.com/reference/kotlin/androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy` listens to platform predictive back events for navigation, and `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/BasicSwipeToDismissBox.composable#BasicSwipeToDismissBox(androidx.wear.compose.foundation.SwipeToDismissBoxState,androidx.compose.ui.Modifier,kotlin.Any,kotlin.Any,kotlin.Boolean,kotlin.Function2)` is not used for swipe gesture detection. Also, transition specifications can be overridden at `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry` level.

Example of a `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay` with `https://developer.android.com/reference/kotlin/androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy` alternating between list and detail entries:

```kotlin
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.ui.NavDisplay
import androidx.wear.compose.foundation.lazy.TransformingLazyColumn
import androidx.wear.compose.foundation.lazy.items
import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState
import androidx.wear.compose.material3.Button
import androidx.wear.compose.material3.Card
import androidx.wear.compose.material3.EdgeButton
import androidx.wear.compose.material3.ListHeader
import androidx.wear.compose.material3.ScreenScaffold
import androidx.wear.compose.material3.SurfaceTransformation
import androidx.wear.compose.material3.Text
import androidx.wear.compose.material3.TitleCard
import androidx.wear.compose.material3.lazy.rememberTransformationSpec
import androidx.wear.compose.material3.lazy.transformedHeight
import androidx.wear.compose.navigation3.rememberSwipeDismissableSceneStrategy

// Example of using a NavDisplay with SwipeDismissableSceneStrategy for list-detail navigation.

// Strongly-typed, serializable navigation destinations are defined at global scope as follows:
// @Serializable object NotificationList : NavKey
// @Serializable data class NotificationDetail(val id: Int) : NavKey

// NotificationItem needs to be defined at top-level or class-level to ensure stability in
// Compose:
// data class NotificationItem(val id: Int, val title: String, val body: String)
val backStack = rememberNavBackStack(NotificationList)

val notifications = remember {
    listOf(
        NotificationItem(
            0,
            "☕ Coffee Break? Grab a pick-me-up",
            "Step away from the screen and grab a pick-me-up. Step away from the screen and grab a pick-me-up.",
        ),
        NotificationItem(
            1,
            "🌟 You're Awesome!",
            "Just a little reminder in case you forgot 😊",
        ),
        NotificationItem(
            2,
            "👀 Did you know our latest feature?",
            "Check out [app name]'s latest feature update.",
        ),
        NotificationItem(
            3,
            "📅 Appointment Time In 15 Minutes",
            "Your meeting with [name] is in 15 minutes.",
        ),
    )
}

NavDisplay(
    backStack = backStack,
    sceneStrategies = listOf(rememberSwipeDismissableSceneStrategy()),
    entryProvider =
        entryProvider {
            entry<NotificationList> {
                val state = rememberTransformingLazyColumnState()
                val transformationSpec = rememberTransformationSpec()
                ScreenScaffold(
                    state,
                    edgeButton = { EdgeButton(onClick = onExit) { Text("Exit") } },
                ) { contentPadding ->
                    TransformingLazyColumn(state = state, contentPadding = contentPadding) {
                        item {
                            ListHeader(
                                transformation = SurfaceTransformation(transformationSpec),
                                modifier =
                                    Modifier.transformedHeight(this, transformationSpec)
                                        .animateItem(),
                            ) {
                                Text("Notifications")
                            }
                        }
                        items(notifications) { notification ->
                            Card(
                                onClick = {
                                    backStack.add(NotificationDetail(notification.id))
                                },
                                transformation = SurfaceTransformation(transformationSpec),
                                modifier =
                                    Modifier.fillMaxWidth()
                                        .transformedHeight(this, transformationSpec)
                                        .animateItem(),
                            ) {
                                Text(notification.title)
                            }
                        }
                    }
                }
            }

            entry<NotificationDetail> { key ->
                val item = requireNotNull(notifications.find { item -> item.id == key.id })
                ScreenScaffold { contentPadding ->
                    Box(
                        Modifier.fillMaxSize().padding(contentPadding),
                        contentAlignment = Alignment.Center,
                    ) {
                        TitleCard(title = { Text(item.title) }, content = { Text(item.body) })
                    }
                }
            }
        },
)
```

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | the type of the backstack keys |

## Summary

| ### Public constructors |
|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy#SwipeDismissableSceneStrategy(kotlin.Boolean)(isUserSwipeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene<T>?` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategyScope<T>.https://developer.android.com/reference/kotlin/androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy#(androidx.navigation3.scene.SceneStrategyScope).calculateScene(kotlin.collections.List)(entries: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry<T>>)` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy#isUserSwipeEnabled()` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` Whether swipe-to-dismiss gesture is enabled. |

### Inherited functions

From [androidx.navigation3.scene.SceneStrategy](https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategy) `open infix https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategy<T>` `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategy#then(androidx.navigation3.scene.SceneStrategy)(sceneStrategy: https://developer.android.com/reference/kotlin/androidx/navigation3/scene/SceneStrategy<T>)`

## Public constructors

### SwipeDismissableSceneStrategy

```
<T : Any> SwipeDismissableSceneStrategy(isUserSwipeEnabled: Boolean = true)
```

| Parameters |
|---|---|
| `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | the type of the backstack keys |
| `isUserSwipeEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` Whether swipe-to-dismiss gesture is enabled. |

## Public functions

### SceneStrategyScope.calculateScene

Artifact: [androidx.wear.compose:compose-navigation3](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/navigation3/SwipeDismissableSceneStrategy.kt+function:calculateScene) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
open fun SceneStrategyScope<T>.calculateScene(entries: List<NavEntry<T>>): Scene<T>?
```

## Public properties

### isUserSwipeEnabled

Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
val isUserSwipeEnabled: Boolean
```

`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` Whether swipe-to-dismiss gesture is enabled.