DynamicFeatureEntryProviderScope

class DynamicFeatureEntryProviderScope<T : Any> : EntryProviderScope<T>


Scope for constructing NavEntry instances and registering dynamic feature modules via dynamicFeatureModule in DynamicFeatureNavEntryDecorator.entryProvider.

Parameters
<T : Any>

the type of the NavEntry key

Summary

Public functions

Unit
<K : T> dynamicFeatureModule(
    initialKey: K,
    moduleName: String,
    entryProviderClassName: String,
    loadingContent: (@Composable (sessionState: SplitInstallSessionState) -> Unit)?
)

Registers a dynamic feature module inside this DynamicFeatureEntryProviderScope.

Inherited functions

From androidx.navigation3.runtime.EntryProviderScope
Unit
<K : T> addEntryProvider(
    clazz: KClass<K>,
    clazzContentKey: (key) -> Any,
    metadata: (K) -> Map<String, Any>,
    content: @Composable (K) -> Unit
)
Unit
<K : T> addEntryProvider(
    clazz: KClass<K>,
    clazzContentKey: (key) -> Any,
    metadata: Map<String, Any>,
    content: @Composable (K) -> Unit
)
Unit
<K : T> addEntryProvider(
    key: K,
    contentKey: Any,
    metadata: (K) -> Map<String, Any>,
    content: @Composable (K) -> Unit
)
Unit
<K : T> addEntryProvider(
    key: K,
    contentKey: Any,
    metadata: Map<String, Any>,
    content: @Composable (K) -> Unit
)
(T) -> NavEntry<T>
inline Unit
@ComposableInferredTarget(scheme = "[0[0]]")
<K : T> entry(
    noinline clazzContentKey: (key) -> Any,
    noinline metadata: (K) -> Map<String, Any>,
    noinline content: @Composable (K) -> Unit
)
inline Unit
@ComposableInferredTarget(scheme = "[0[0]]")
<K : T> entry(
    noinline clazzContentKey: (key) -> Any,
    metadata: Map<String, Any>,
    noinline content: @Composable (K) -> Unit
)
Unit
<K : T> EntryProviderScope<T>.entry(
    key: K,
    contentKey: Any,
    metadata: (K) -> Map<String, Any>,
    content: @Composable (K) -> Unit
)
Unit
<K : T> EntryProviderScope<T>.entry(
    key: K,
    contentKey: Any,
    metadata: Map<String, Any>,
    content: @Composable (K) -> Unit
)

Public functions

dynamicFeatureModule

Added in 1.3.0-alpha05
fun <K : T> dynamicFeatureModule(
    initialKey: K,
    moduleName: String,
    entryProviderClassName: String,
    loadingContent: (@Composable (sessionState: SplitInstallSessionState) -> Unit)? = null
): Unit

Registers a dynamic feature module inside this DynamicFeatureEntryProviderScope.

Lazily resolves destinations defined by the module once installed. Before installation, initialKey resolves to a temporary loading NavEntry intercepted by DynamicFeatureNavEntryDecorator.

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...") },
            )
        },
)
import androidx.compose.material3.Text
import androidx.navigation3.dynamicfeatures.DynamicFeatureModuleEntryProvider
import androidx.navigation3.runtime.EntryProviderScope
import androidx.navigation3.runtime.NavKey

// Defined in the `:checkout` dynamic feature module at
// `com.example.checkout.CheckoutEntryProvider`.
class CheckoutEntryProvider : DynamicFeatureModuleEntryProvider<NavKey> {
    override fun EntryProviderScope<NavKey>.buildEntries() {
        entry<CheckoutKey> {
            Text("Checkout Screen")
        }
        entry<OrderConfirmationKey> { key ->
            Text("Order Confirmed: ${key.orderId}")
        }
    }
}

// Defined in the `:promo` dynamic feature module at
// `com.example.promo.PromoEntryProvider`.
class PromoEntryProvider : DynamicFeatureModuleEntryProvider<NavKey> {
    override fun EntryProviderScope<NavKey>.buildEntries() {
        entry<PromoKey> {
            Text("Promo Screen")
        }
    }
}
Parameters
initialKey: K

The initial destination key for this module, defined in the common app module.

moduleName: String

The dynamic feature name.

entryProviderClassName: String

Fully qualified class name of the DynamicFeatureModuleEntryProvider implementation.

loadingContent: (@Composable (sessionState: SplitInstallSessionState) -> Unit)? = null

Optional module-specific content rendered while the module is not installed. If null, the decorator's defaultLoadingContent is used. Receives SplitInstallSessionState updates from SplitInstallManager and should handle states such as SplitInstallSessionStatus.DOWNLOADING, SplitInstallSessionStatus.FAILED, and SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION (see SplitInstallManager.startConfirmationDialogForResult).