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

# DynamicFeatureNavEntryDecorator

Artifact: [androidx.navigation3:navigation3-dynamic-features](https://developer.android.com/jetpack/androidx/releases/navigation3.md.txt) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/dynamicfeatures/DynamicFeatureNavEntryDecorator.kt+class:androidx.navigation3.dynamicfeatures.DynamicFeatureNavEntryDecorator) Added in [1.3.0-alpha05](https://developer.android.com/jetpack/androidx/releases/navigation3.md.txt#1.3.0-alpha05)


```
class DynamicFeatureNavEntryDecorator<T : Any> : NavEntryDecorator<T>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.navigation3.runtime.NavEntryDecorator](https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntryDecorator.md.txt)\<T\> ||
|   | ↳ | [androidx.navigation3.dynamicfeatures.DynamicFeatureNavEntryDecorator](https://developer.android.com/reference/kotlin/androidx/navigation3/dynamicfeatures/DynamicFeatureNavEntryDecorator.md.txt) |

*** ** * ** ***

A Navigation 3 `NavEntryDecorator` that intercepts dynamic destinations registered via `DynamicFeatureEntryProviderScope.dynamicFeatureModule`.

- When the module is **installed**: lazily resolves and renders the dynamic module's initial destination in-place.

- When the module is **not installed** : initiates installation via `SplitInstallManager` and renders the module's `loadingContent` or `defaultLoadingContent` with the current `SplitInstallSessionState`. The loading content should handle states emitted by `SplitInstallManager`, including `SplitInstallSessionStatus.FAILED` and `SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION` (see `SplitInstallManager.startConfirmationDialogForResult`).

```kotlin
import androidx.activity.compose.LocalActivity
import androidx.compose.foundation.layout.Column
import androidx.compose.material3.Button
import androidx.compose.material3.CircularProgressIndicator
import androidx.compose.material3.Text
import androidx.compose.runtime.LaunchedEffect
import androidx.navigation3.dynamicfeatures.rememberDynamicFeatureNavEntryDecorator
import androidx.navigation3.dynamicfeatures.rememberSplitInstallManager
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
import androidx.navigation3.ui.NavDisplay

val backStack = rememberNavBackStack(HomeKey)
val splitInstallManager = rememberSplitInstallManager()
val dynamicFeatureDecorator =
    rememberDynamicFeatureNavEntryDecorator<NavKey>(
        splitInstallManager = splitInstallManager,
        defaultLoadingContent = { sessionState ->
            when (sessionState.status()) {
                SplitInstallSessionStatus.DOWNLOADING -> {
                    val progress =
                        if (sessionState.totalBytesToDownload() > 0) {
                            sessionState.bytesDownloaded().toFloat() /
                                sessionState.totalBytesToDownload()
                        } else {
                            0f
                        }
                    CircularProgressIndicator(progress = { progress })
                }
                SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION -> {
                    val activity = LocalActivity.current
                    LaunchedEffect(sessionState.sessionId()) {
                        if (activity != null) {
                            splitInstallManager.startConfirmationDialogForResult(
                                sessionState,
                                activity,
                                100,
                            )
                        }
                    }
                }
                SplitInstallSessionStatus.FAILED -> {
                    Column {
                        Text("Installation failed (error ${sessionState.errorCode()})")
                        Button(onClick = { backStack.removeLastOrNull() }) { Text("Go Back") }
                    }
                }
                else -> CircularProgressIndicator()
            }
        },
    )

NavDisplay(
    backStack = backStack,
    onBack = { backStack.removeLastOrNull() },
    entryDecorators =
        listOf(
            rememberSaveableStateHolderNavEntryDecorator(),
            dynamicFeatureDecorator,
        ),
    entryProvider =
        dynamicFeatureDecorator.entryProvider {
            entry<HomeKey> {
                Column {
                    Button(onClick = { backStack.add(CheckoutKey) }) { Text("Go to Checkout") }
                    Button(onClick = { backStack.add(PromoKey) }) { Text("View Promo") }
                }
            }
            dynamicFeatureModule(
                initialKey = CheckoutKey,
                moduleName = "checkout",
                entryProviderClassName = "com.example.checkout.CheckoutEntryProvider",
            )
            dynamicFeatureModule(
                initialKey = PromoKey,
                moduleName = "promo",
                entryProviderClassName = "com.example.promo.PromoEntryProvider",
                loadingContent = { Text("Loading promo...") },
            )
        },
)
```

## Summary

| ### Public constructors |
|---|
| `<T : Any> DynamicFeatureNavEntryDecorator( splitInstallManager: SplitInstallManager, defaultLoadingContent: @Composable (sessionState: SplitInstallSessionState) -> Unit )` |

| ### Public functions |
|---|---|
| `(T) -> NavEntry<T>` | `entryProvider( fallback: (unknownScreen) -> NavEntry<T>, builder: DynamicFeatureEntryProviderScope<T>.() -> Unit )` Provides a `DynamicFeatureEntryProviderScope` to build an entryProvider that resolves both regular `NavEntry` destinations and dynamic feature modules registered with `DynamicFeatureEntryProviderScope.dynamicFeatureModule`. |

## Public constructors

### DynamicFeatureNavEntryDecorator

```
<T : Any> DynamicFeatureNavEntryDecorator(
    splitInstallManager: SplitInstallManager,
    defaultLoadingContent: @Composable (sessionState: SplitInstallSessionState) -> Unit
)
```

## Public functions

### entryProvider

```
fun entryProvider(
    fallback: (unknownScreen) -> NavEntry<T> = {
            throw IllegalStateException("Unknown screen $it")
        },
    builder: DynamicFeatureEntryProviderScope<T>.() -> Unit
): (T) -> NavEntry<T>
```

Provides a `DynamicFeatureEntryProviderScope` to build an entryProvider that resolves both regular `NavEntry` destinations and dynamic feature modules registered with `DynamicFeatureEntryProviderScope.dynamicFeatureModule`.

```kotlin
import androidx.activity.compose.LocalActivity
import androidx.compose.foundation.layout.Column
import androidx.compose.material3.Button
import androidx.compose.material3.CircularProgressIndicator
import androidx.compose.material3.Text
import androidx.compose.runtime.LaunchedEffect
import androidx.navigation3.dynamicfeatures.rememberDynamicFeatureNavEntryDecorator
import androidx.navigation3.dynamicfeatures.rememberSplitInstallManager
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
import androidx.navigation3.ui.NavDisplay

val backStack = rememberNavBackStack(HomeKey)
val splitInstallManager = rememberSplitInstallManager()
val dynamicFeatureDecorator =
    rememberDynamicFeatureNavEntryDecorator<NavKey>(
        splitInstallManager = splitInstallManager,
        defaultLoadingContent = { sessionState ->
            when (sessionState.status()) {
                SplitInstallSessionStatus.DOWNLOADING -> {
                    val progress =
                        if (sessionState.totalBytesToDownload() > 0) {
                            sessionState.bytesDownloaded().toFloat() /
                                sessionState.totalBytesToDownload()
                        } else {
                            0f
                        }
                    CircularProgressIndicator(progress = { progress })
                }
                SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION -> {
                    val activity = LocalActivity.current
                    LaunchedEffect(sessionState.sessionId()) {
                        if (activity != null) {
                            splitInstallManager.startConfirmationDialogForResult(
                                sessionState,
                                activity,
                                100,
                            )
                        }
                    }
                }
                SplitInstallSessionStatus.FAILED -> {
                    Column {
                        Text("Installation failed (error ${sessionState.errorCode()})")
                        Button(onClick = { backStack.removeLastOrNull() }) { Text("Go Back") }
                    }
                }
                else -> CircularProgressIndicator()
            }
        },
    )

NavDisplay(
    backStack = backStack,
    onBack = { backStack.removeLastOrNull() },
    entryDecorators =
        listOf(
            rememberSaveableStateHolderNavEntryDecorator(),
            dynamicFeatureDecorator,
        ),
    entryProvider =
        dynamicFeatureDecorator.entryProvider {
            entry<HomeKey> {
                Column {
                    Button(onClick = { backStack.add(CheckoutKey) }) { Text("Go to Checkout") }
                    Button(onClick = { backStack.add(PromoKey) }) { Text("View Promo") }
                }
            }
            dynamicFeatureModule(
                initialKey = CheckoutKey,
                moduleName = "checkout",
                entryProviderClassName = "com.example.checkout.CheckoutEntryProvider",
            )
            dynamicFeatureModule(
                initialKey = PromoKey,
                moduleName = "promo",
                entryProviderClassName = "com.example.promo.PromoEntryProvider",
                loadingContent = { Text("Loading promo...") },
            )
        },
)
```

| Parameters |
|---|---|
| `fallback: (unknownScreen) -> NavEntry<T> = { throw IllegalStateException("Unknown screen $it") }` | the fallback `NavEntry` when neither this provider nor any registered dynamic module can find an entry associated with a given key on the backStack |
| `builder: DynamicFeatureEntryProviderScope<T>.() -> Unit` | the DSL extension that provides a `DynamicFeatureEntryProviderScope` to build an entryProvider |

| Returns |
|---|---|
| `(T) -> NavEntry<T>` | an entryProvider that provides the `NavEntry` associated with a given key |