DynamicFeatureModuleEntryProvider

interface DynamicFeatureModuleEntryProvider<K : Any>


Interface that defines how to build NavEntry instances for a DynamicFeatureEntryProviderScope.dynamicFeatureModule.

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")
        }
    }
}

Summary

Public functions

Unit

Builds NavEntry instances for K within the receiver EntryProviderScope.

Public functions

EntryProviderScope.buildEntries

fun EntryProviderScope<K>.buildEntries(): Unit

Builds NavEntry instances for K within the receiver EntryProviderScope.