androidx.navigation.dynamicfeatures.fragment

Classes

DynamicFragmentNavigator

The Navigator that enables navigating to destinations within dynamic feature modules.
DynamicFragmentNavigator.Destination

Destination for dynamic feature navigator.
DynamicFragmentNavigatorDestinationBuilder

DSL for constructing a new DynamicFragmentNavigator.Destination
DynamicNavHostFragment

The NavHostFragment for dynamic features.

Extension functions summary

inline Unit

This function is deprecated. Use routes to create your DynamicFragmentDestination instead
inline Unit

Construct a new DynamicFragmentNavigator.Destination
inline Unit
<F : Fragment, T : Any> DynamicNavGraphBuilder.fragment(
    typeMap: Map<KType, NavType<*>>
)

Construct a new DynamicFragmentNavigator.Destination
inline Unit

This function is deprecated. Use routes to create your DynamicFragmentDestination instead
inline Unit

Construct a new DynamicFragmentNavigator.Destination
inline Unit
<F : Fragment, T : Any> DynamicNavGraphBuilder.fragment(
    typeMap: Map<KType, NavType<*>>,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
)

Construct a new DynamicFragmentNavigator.Destination
inline Unit
<T : Any> DynamicNavGraphBuilder.fragment(
    fragmentClassName: String,
    typeMap: Map<KType, NavType<*>>,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
)

Construct a new DynamicFragmentNavigator.Destination
inline Unit
DynamicNavGraphBuilder.fragment(
    id: @IdRes Int,
    fragmentClassName: String,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
)

This function is deprecated. Use routes to create your DynamicFragmentDestination instead
inline Unit
DynamicNavGraphBuilder.fragment(
    route: String,
    fragmentClassName: String,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
)

Construct a new DynamicFragmentNavigator.Destination

Extension functions

fragment

inline fun <F : Fragment> DynamicNavGraphBuilder.fragment(id: @IdRes Int): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
id: @IdRes Int

Destination id.

fragment

inline fun <F : Fragment> DynamicNavGraphBuilder.fragment(route: String): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
route: String

Destination route.

fragment

inline fun <F : Fragment, T : Any> DynamicNavGraphBuilder.fragment(
    typeMap: Map<KType, NavType<*>> = emptyMap()
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
<T : Any>

the destination's unique route from a KClass
typeMap: Map<KType, NavType<*>> = emptyMap()

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.

fragment

inline fun <F : Fragment> DynamicNavGraphBuilder.fragment(
    id: @IdRes Int,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
id: @IdRes Int

Destination id.

fragment

inline fun <F : Fragment> DynamicNavGraphBuilder.fragment(
    route: String,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
route: String

Destination route.
builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit

the builder used to construct the fragment destination

fragment

inline fun <F : Fragment, T : Any> DynamicNavGraphBuilder.fragment(
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
<T : Any>

the destination's unique route from a KClass
typeMap: Map<KType, NavType<*>> = emptyMap()

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit

the builder used to construct the fragment destination

fragment

inline fun <T : Any> DynamicNavGraphBuilder.fragment(
    fragmentClassName: String,
    typeMap: Map<KType, NavType<*>> = emptyMap(),
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
<T : Any>

the destination's unique route from a KClass
fragmentClassName: String

Fully qualified class name of destination Fragment.
typeMap: Map<KType, NavType<*>> = emptyMap()

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit

the builder used to construct the fragment destination

fragment

inline fun DynamicNavGraphBuilder.fragment(
    id: @IdRes Int,
    fragmentClassName: String,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
id: @IdRes Int

Destination id.
fragmentClassName: String

Fully qualified class name of destination Fragment.

fragment

inline fun DynamicNavGraphBuilder.fragment(
    route: String,
    fragmentClassName: String,
    builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit
): Unit

Construct a new DynamicFragmentNavigator.Destination

Parameters
route: String

Destination route.
fragmentClassName: String

Fully qualified class name of destination Fragment.
builder: DynamicFragmentNavigatorDestinationBuilder.() -> Unit

the builder used to construct the fragment destination