androidx.navigation.dynamicfeatures

Kotlin |Java

Classes

DynamicActivityNavigator	Dynamic feature navigator for Activity destinations.
DynamicActivityNavigatorDestinationBuilder	DSL for constructing a new DynamicActivityNavigator.Destination
DynamicExtras	Extras for dynamic navigators.
DynamicGraphNavigator	Navigator for graphs in dynamic feature modules.
DynamicIncludeGraphNavigator	Navigator for include-dynamic.
DynamicIncludeNavGraphBuilder	DSL for constructing a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph
DynamicInstallManager	Install manager for dynamic features.
DynamicInstallMonitor	Monitor installation progress of dynamic feature modules.
DynamicNavGraphBuilder	DSL for constructing a new DynamicGraphNavigator.DynamicNavGraph

Extension functions summary

For DynamicNavGraphBuilder
Unit	DynamicNavGraphBuilder.activity(@IdRes id: Int, builder: DynamicActivityNavigatorDestinationBuilder.() -> Unit) Construct a new DynamicActivityNavigator.Destination
Unit	DynamicNavGraphBuilder.includeDynamic(@IdRes id: Int, moduleName: String, graphResourceName: String) Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.
Unit	DynamicNavGraphBuilder.includeDynamic(@IdRes id: Int, moduleName: String, graphResourceName: String, builder: DynamicIncludeNavGraphBuilder.() -> Unit) Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.
Unit	DynamicNavGraphBuilder.navigation(@IdRes id: Int, @IdRes startDestination: Int, builder: DynamicNavGraphBuilder.() -> Unit) Construct a nested DynamicGraphNavigator.DynamicNavGraph

For NavController
NavGraph	NavController.createGraph(@IdRes id: Int = 0, @IdRes startDestination: Int, builder: DynamicNavGraphBuilder.() -> Unit) Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

For NavHost
NavGraph	NavHost.createGraph(@IdRes id: Int = 0, @IdRes startDestination: Int, builder: DynamicNavGraphBuilder.() -> Unit) Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

For NavigatorProvider
NavGraph	NavigatorProvider.navigation(@IdRes id: Int = 0, @IdRes startDestination: Int, builder: DynamicNavGraphBuilder.() -> Unit) Construct a new DynamicGraphNavigator.DynamicNavGraph

Extension functions

activity

inline fun DynamicNavGraphBuilder.activity(
    @IdRes id: Int, 
    builder: DynamicActivityNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicActivityNavigator.Destination

Parameters
id: Int	Destination id.

createGraph

inline fun NavController.createGraph(
    @IdRes id: Int = 0, 
    @IdRes startDestination: Int, 
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

createGraph

inline fun NavHost.createGraph(
    @IdRes id: Int = 0, 
    @IdRes startDestination: Int, 
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new androidx.navigation.NavGraph that supports dynamic navigation destinations

includeDynamic

inline fun DynamicNavGraphBuilder.includeDynamic(
    @IdRes id: Int, 
    moduleName: String, 
    graphResourceName: String
): Unit

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
id: Int	NavGraph id.
moduleName: String	Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.
graphResourceName: String	Graph's resource name without the navigation qualifier. This must not be an empty string.

includeDynamic

inline fun DynamicNavGraphBuilder.includeDynamic(
    @IdRes id: Int, 
    moduleName: String, 
    graphResourceName: String, 
    builder: DynamicIncludeNavGraphBuilder.() -> Unit
): Unit

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
id: Int	NavGraph id.
moduleName: String	Dynamic feature module name as defined in the module's AndroidManifest. This must not be an empty string.
graphResourceName: String	Graph's resource name without the navigation qualifier. This must not be an empty string.
builder: DynamicIncludeNavGraphBuilder.() -> Unit	Another builder for chaining.

navigation

inline fun DynamicNavGraphBuilder.navigation(
    @IdRes id: Int, 
    @IdRes startDestination: Int, 
    builder: DynamicNavGraphBuilder.() -> Unit
): Unit

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
id: Int	NavGraph id.
startDestination: Int	Id start destination in the graph
builder: DynamicNavGraphBuilder.() -> Unit	Another builder for chaining.

navigation

inline fun NavigatorProvider.navigation(
    @IdRes id: Int = 0, 
    @IdRes startDestination: Int, 
    builder: DynamicNavGraphBuilder.() -> Unit
): NavGraph

Construct a new DynamicGraphNavigator.DynamicNavGraph

Parameters
id: Int = 0	NavGraph id.
startDestination: Int	Id start destination in the graph
builder: DynamicNavGraphBuilder.() -> Unit	Another builder for chaining.