> Documentation index: https://developer.android.com/reference/llms.txt

# FadeThroughNavigationTransitions

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3.md.txt) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/NavigationTransitions.kt+class:androidx.compose.material3.FadeThroughNavigationTransitions) Added in [1.6.0-alpha01](https://developer.android.com/jetpack/androidx/releases/compose-material3.md.txt#1.6.0-alpha01) Common/AllAndroid/JVM
- Cmn

  ```
  object FadeThroughNavigationTransitions
  ```

*** ** * ** ***

Provides fade through navigation transforms adhering to Material 3 motion specifications.

Use these animations for transitions between destinations without a strong spatial or directional relationship, such as switching between tabs in a bottom navigation bar. See [Material 3 transition patterns](https://m3.material.io/styles/motion/transitions/transition-patterns).

```kotlin
import androidx.compose.animation.DeferredAnimatedContent
import androidx.compose.animation.core.DeferredTransitionState
import androidx.compose.animation.core.rememberDeferredTransition
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.FadeThroughNavigationTransitions
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.unit.dp
import androidx.navigationevent.NavigationEvent

var targetTab by remember { mutableIntStateOf(1) }
var isGestureInProgress by remember { mutableStateOf(false) }
var backEvent by remember { mutableStateOf(NavigationEvent()) }

// TODO(b/561731740): Replace this manual navigation setup with NavDisplay once it adopts
//  MutableContentTransform, which provides built-in transition and back gesture handling.
val transitionState = remember { DeferredTransitionState(targetTab) }
val transition = rememberDeferredTransition(transitionState)

LaunchedEffect(isGestureInProgress, targetTab) {
    if (isGestureInProgress) {
        transitionState.defer(targetTab)
    } else {
        transitionState.animateTo(targetTab)
    }
}

val density = LocalDensity.current

transition.DeferredAnimatedContent(
    transitionSpec = { FadeThroughNavigationTransitions.transform() },
    mutableTransformSpec = {
        FadeThroughNavigationTransitions.predictiveBackTransform(
            backEvent = { backEvent },
            density = density,
        )
    },
) { tab ->
    Surface(
        modifier = Modifier.fillMaxSize(),
        color =
            if (tab == 1) {
                MaterialTheme.colorScheme.primaryContainer
            } else {
                MaterialTheme.colorScheme.tertiaryContainer
            },
    ) {
        Box(Modifier.fillMaxSize().padding(16.dp), contentAlignment = Alignment.Center) {
            Text("Tab $tab", style = MaterialTheme.typography.headlineLarge)
        }
    }
}
```

## Summary

| ### Public functions |
|---|---|---|
| `MutableContentTransform` | `predictiveBackTransform( backEvent: () -> NavigationEvent, density: Density )` Creates a `MutableContentTransform` configured for the gesture phase of a fade through predictive back transition. | Cmn |
| `ContentTransform` | `transform()` Creates a `ContentTransform` for a fade through transition. | Cmn |

## Public functions

### predictiveBackTransform

Cmn Added in [1.6.0-alpha01](https://developer.android.com/jetpack/androidx/releases/compose-material3.md.txt#1.6.0-alpha01)

```
fun predictiveBackTransform(
    backEvent: () -> NavigationEvent,
    density: Density
): MutableContentTransform
```

Creates a `MutableContentTransform` configured for the gesture phase of a fade through predictive back transition.

```kotlin
import androidx.compose.animation.DeferredAnimatedContent
import androidx.compose.animation.core.DeferredTransitionState
import androidx.compose.animation.core.rememberDeferredTransition
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.FadeThroughNavigationTransitions
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.unit.dp
import androidx.navigationevent.NavigationEvent

var targetTab by remember { mutableIntStateOf(1) }
var isGestureInProgress by remember { mutableStateOf(false) }
var backEvent by remember { mutableStateOf(NavigationEvent()) }

// TODO(b/561731740): Replace this manual navigation setup with NavDisplay once it adopts
//  MutableContentTransform, which provides built-in transition and back gesture handling.
val transitionState = remember { DeferredTransitionState(targetTab) }
val transition = rememberDeferredTransition(transitionState)

LaunchedEffect(isGestureInProgress, targetTab) {
    if (isGestureInProgress) {
        transitionState.defer(targetTab)
    } else {
        transitionState.animateTo(targetTab)
    }
}

val density = LocalDensity.current

transition.DeferredAnimatedContent(
    transitionSpec = { FadeThroughNavigationTransitions.transform() },
    mutableTransformSpec = {
        FadeThroughNavigationTransitions.predictiveBackTransform(
            backEvent = { backEvent },
            density = density,
        )
    },
) { tab ->
    Surface(
        modifier = Modifier.fillMaxSize(),
        color =
            if (tab == 1) {
                MaterialTheme.colorScheme.primaryContainer
            } else {
                MaterialTheme.colorScheme.tertiaryContainer
            },
    ) {
        Box(Modifier.fillMaxSize().padding(16.dp), contentAlignment = Alignment.Center) {
            Text("Tab $tab", style = MaterialTheme.typography.headlineLarge)
        }
    }
}
```

| Parameters |
|---|---|
| `backEvent: () -> NavigationEvent` | provider of the ongoing `NavigationEvent` |
| `density: Density` | the `Density` used to convert display bounds margins to pixels |

### transform

Cmn Added in [1.6.0-alpha01](https://developer.android.com/jetpack/androidx/releases/compose-material3.md.txt#1.6.0-alpha01)

```
fun transform(): ContentTransform
```

Creates a `ContentTransform` for a fade through transition.

```kotlin
import androidx.compose.animation.DeferredAnimatedContent
import androidx.compose.animation.core.DeferredTransitionState
import androidx.compose.animation.core.rememberDeferredTransition
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.FadeThroughNavigationTransitions
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.mutableIntStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.unit.dp
import androidx.navigationevent.NavigationEvent

var targetTab by remember { mutableIntStateOf(1) }
var isGestureInProgress by remember { mutableStateOf(false) }
var backEvent by remember { mutableStateOf(NavigationEvent()) }

// TODO(b/561731740): Replace this manual navigation setup with NavDisplay once it adopts
//  MutableContentTransform, which provides built-in transition and back gesture handling.
val transitionState = remember { DeferredTransitionState(targetTab) }
val transition = rememberDeferredTransition(transitionState)

LaunchedEffect(isGestureInProgress, targetTab) {
    if (isGestureInProgress) {
        transitionState.defer(targetTab)
    } else {
        transitionState.animateTo(targetTab)
    }
}

val density = LocalDensity.current

transition.DeferredAnimatedContent(
    transitionSpec = { FadeThroughNavigationTransitions.transform() },
    mutableTransformSpec = {
        FadeThroughNavigationTransitions.predictiveBackTransform(
            backEvent = { backEvent },
            density = density,
        )
    },
) { tab ->
    Surface(
        modifier = Modifier.fillMaxSize(),
        color =
            if (tab == 1) {
                MaterialTheme.colorScheme.primaryContainer
            } else {
                MaterialTheme.colorScheme.tertiaryContainer
            },
    ) {
        Box(Modifier.fillMaxSize().padding(16.dp), contentAlignment = Alignment.Center) {
            Text("Tab $tab", style = MaterialTheme.typography.headlineLarge)
        }
    }
}
```