DynamicGraphNavigator

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

Added in 2.3.0

---

Kotlin |Java

@<Error class: unknown class>
class DynamicGraphNavigator : NavGraphNavigator

kotlin.Any
↳	androidx.navigation.Navigator
	↳	androidx.navigation.NavGraphNavigator
		↳	androidx.navigation.dynamicfeatures.DynamicGraphNavigator

---

Navigator for graphs in dynamic feature modules.

This class handles navigating to a progress destination when the installation of a dynamic feature module is required. By default, the progress destination set by installDefaultProgressDestination will be used, but this can be overridden by setting the app:progressDestinationId attribute in your navigation XML file.

Summary

Nested types
class DynamicGraphNavigator.DynamicNavGraph : NavGraph The NavGraph for dynamic features.

Public constructors
DynamicGraphNavigator(     navigatorProvider: NavigatorProvider,     installManager: DynamicInstallManager )

Public functions
open DynamicGraphNavigator.DynamicNavGraph	createDestination() Create a destination for the DynamicNavGraph.
Unit	installDefaultProgressDestination(     progressDestinationSupplier: () -> NavDestination ) Installs the default progress destination to this graph via a lambda.
open Unit	navigate(     entries: List<NavBackStackEntry>,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigate to a destination.
open Unit	onRestoreState(savedState: Bundle)
open Bundle?	onSaveState()

Inherited functions

From androidx.navigation.Navigator open NavDestination? navigate(     destination: NavGraph,     args: SavedState?,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) open Unit @CallSuper onAttach(state: NavigatorState) open Unit onLaunchSingleTop(backStackEntry: NavBackStackEntry) open Unit onRestoreState(savedState: SavedState) open Boolean popBackStack() open Unit popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

Inherited properties
From androidx.navigation.NavGraphNavigator StateFlow<List<NavBackStackEntry>> backStack
From androidx.navigation.Navigator Boolean isAttached NavigatorState state

Public constructors

DynamicGraphNavigator

Added in 2.3.0

DynamicGraphNavigator(
    navigatorProvider: NavigatorProvider,
    installManager: DynamicInstallManager
)

Public functions

createDestination

Added in 2.3.0

open fun createDestination(): DynamicGraphNavigator.DynamicNavGraph

Create a destination for the DynamicNavGraph.

Returns
DynamicGraphNavigator.DynamicNavGraph	The created graph.

installDefaultProgressDestination

fun installDefaultProgressDestination(
    progressDestinationSupplier: () -> NavDestination
): Unit

Installs the default progress destination to this graph via a lambda. This supplies a NavDestination to use when the actual destination is not installed at navigation time.

This must be called before you call androidx.navigation.NavController.setGraph to ensure that all DynamicNavGraph instances have the correct progress destination installed in onRestoreState.

Parameters
progressDestinationSupplier: () -> NavDestination	The default progress destination supplier.

navigate

open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

Navigate to a destination.

In case the destination module is installed the navigation will trigger directly. Otherwise the dynamic feature module is requested and navigation is postponed until the module has successfully been installed.

onRestoreState

open fun onRestoreState(savedState: Bundle): Unit

onSaveState

open fun onSaveState(): Bundle?