# DynamicIncludeGraphNavigator

Artifact: [androidx.navigation:navigation-dynamic-features-runtime](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.kt+class:androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator) Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

*** ** * ** ***


```
@Navigator.Name(value = "include-dynamic")
class DynamicIncludeGraphNavigator : Navigator<DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator)\<[DynamicIncludeGraphNavigator.DynamicIncludeNavGraph](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph)\> ||
|   | ↳ | [androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator) |

*** ** * ** ***

Navigator for `include-dynamic`.

Use it for navigating to NavGraphs contained within a dynamic feature module.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph : https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination` The graph for dynamic-include. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#DynamicIncludeGraphNavigator(android.content.Context,androidx.navigation.NavigatorProvider,androidx.navigation.NavInflater,androidx.navigation.dynamicfeatures.DynamicInstallManager)( context: https://developer.android.com/reference/android/content/Context.html, navigatorProvider: https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorProvider, navInflater: https://developer.android.com/reference/kotlin/androidx/navigation/NavInflater, installManager: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicInstallManager )` |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#createDestination()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)( entries: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>, navOptions: https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions?, navigatorExtras: https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras? )` Navigates to a dynamically included graph from a `com.android.dynamic-feature` module. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#onRestoreState(android.os.Bundle)(savedState: https://developer.android.com/reference/android/os/Bundle.html)` |
| `open https://developer.android.com/reference/android/os/Bundle.html?` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#onSaveState()()` |

### Inherited functions

From [androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator) `open https://developer.android.com/reference/kotlin/androidx/navigation/NavDestination?` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#navigate(androidx.navigation.NavDestination,android.os.Bundle,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)(
destination: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph,
args: https://developer.android.com/reference/android/os/Bundle.html?,
navOptions: https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions?,
navigatorExtras: https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras?
)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/annotation/CallSuper
https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#onAttach(androidx.navigation.NavigatorState)(state: https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#onLaunchSingleTop(androidx.navigation.NavBackStackEntry)(backStackEntry: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#popBackStack()()` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#popBackStack(androidx.navigation.NavBackStackEntry,kotlin.Boolean)(popUpTo: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry, savedState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

### Inherited properties

From [androidx.navigation.Navigator](https://developer.android.com/reference/kotlin/androidx/navigation/Navigator) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#isAttached()` `https://developer.android.com/reference/kotlin/androidx/navigation/NavigatorState` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#state()`

## Public constructors

### DynamicIncludeGraphNavigator

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
DynamicIncludeGraphNavigator(
    context: Context,
    navigatorProvider: NavigatorProvider,
    navInflater: NavInflater,
    installManager: DynamicInstallManager
)
```

## Public functions

### createDestination

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
open fun createDestination(): DynamicIncludeGraphNavigator.DynamicIncludeNavGraph
```

### navigate

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

Navigates to a dynamically included graph from a `com.android.dynamic-feature` module.

| Parameters |
|---|---|
| `entries: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>` | destination(s) to navigate to |
| `navOptions: https://developer.android.com/reference/kotlin/androidx/navigation/NavOptions?` | additional options for navigation |
| `navigatorExtras: https://developer.android.com/reference/kotlin/androidx/navigation/Navigator.Extras?` | extras unique to your Navigator. |

| Throws |
|---|---|
| `https://developer.android.com/reference/android/content/res/Resources.NotFoundException.html` | if one of the `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)` does not have a valid `graphResourceName` and `graphPackage`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if one of the `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)` does not have a parent. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)` |   |

### onRestoreState

```
open fun onRestoreState(savedState: Bundle): Unit
```

### onSaveState

```
open fun onSaveState(): Bundle?
```