DynamicGraphNavigator
class DynamicGraphNavigator : NavGraphNavigator
kotlin.Any | |||
↳ | androidx.navigation.Navigator<androidx.navigation.NavGraph> | ||
↳ | 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 classes | |
---|---|
The NavGraph for dynamic features. |
Public constructors | |
---|---|
Navigator for graphs in dynamic feature modules. |
Public methods | |
---|---|
DynamicGraphNavigator.DynamicNavGraph |
Create a destination for the DynamicNavGraph. |
Unit |
Installs the default progress destination to this graph via a lambda. |
NavDestination? |
navigate(: NavGraph, : Bundle?, : NavOptions?, : Navigator.Extras?) Navigate to a destination. |
Unit | |
Bundle? |
Inherited functions | |
---|---|
Public constructors
<init>
DynamicGraphNavigator(
: NavigatorProvider,
: DynamicInstallManager)
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.
Public methods
createDestination
fun createDestination(): DynamicGraphNavigator.DynamicNavGraph
Create a destination for the DynamicNavGraph.
Return | |
---|---|
The created graph. |
installDefaultProgressDestination
fun installDefaultProgressDestination(: () -> 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 | |
---|---|
: () -> NavDestination | The default progress destination supplier. |
navigate
fun navigate(
: NavGraph,
: Bundle?,
: NavOptions?,
: Navigator.Extras?