rememberDynamicFeatureNavEntryDecorator

Functions summary

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

Remembers a DynamicFeatureNavEntryDecorator that manages dynamic feature module delivery using a SplitInstallManager.

Functions

rememberDynamicFeatureNavEntryDecorator

@Composable
fun <T : Any> rememberDynamicFeatureNavEntryDecorator(
    splitInstallManager: SplitInstallManager = rememberSplitInstallManager(),
    defaultLoadingContent: @Composable (sessionState: SplitInstallSessionState) -> Unit
): DynamicFeatureNavEntryDecorator<T>

Remembers a DynamicFeatureNavEntryDecorator that manages dynamic feature module delivery using a SplitInstallManager.

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
splitInstallManager: SplitInstallManager = rememberSplitInstallManager()

The SplitInstallManager used to drive installation. Defaults to rememberSplitInstallManager.

defaultLoadingContent: @Composable (sessionState: SplitInstallSessionState) -> Unit

Fallback content rendered while a module is not installed if it does not provide its own loadingContent in DynamicFeatureEntryProviderScope.dynamicFeatureModule. Receives SplitInstallSessionState updates from SplitInstallManager and should handle states such as SplitInstallSessionStatus.DOWNLOADING, SplitInstallSessionStatus.FAILED, and SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION (see SplitInstallManager.startConfirmationDialogForResult).