# 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")
public final class DynamicIncludeGraphNavigator extends Navigator<@NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.navigation.Navigator](https://developer.android.com/reference/androidx/navigation/Navigator)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [DynamicIncludeGraphNavigator.DynamicIncludeNavGraph](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph)\> ||
|   | ↳ | [androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator) |

*** ** * ** ***

Navigator for `include-dynamic`.

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

## Summary

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

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

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#createDestination()()` |
| `void` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry> entries, https://developer.android.com/reference/androidx/navigation/NavOptions navOptions, https://developer.android.com/reference/androidx/navigation/Navigator.Extras navigatorExtras )` Navigates to a dynamically included graph from a `com.android.dynamic-feature` module. |
| `void` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#onRestoreState(android.os.Bundle)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html savedState)` |
| `https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator#onSaveState()()` |

### Inherited methods

From [androidx.navigation.Navigator](https://developer.android.com/reference/androidx/navigation/Navigator) `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavigatorState` `https://developer.android.com/reference/androidx/navigation/Navigator#getState()()` `final boolean` `https://developer.android.com/reference/androidx/navigation/Navigator#isAttached()()` `https://developer.android.com/reference/androidx/navigation/NavDestination` `https://developer.android.com/reference/androidx/navigation/Navigator#navigate(androidx.navigation.NavDestination,android.os.Bundle,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph destination,
https://developer.android.com/reference/android/os/Bundle.html args,
https://developer.android.com/reference/androidx/navigation/NavOptions navOptions,
https://developer.android.com/reference/androidx/navigation/Navigator.Extras navigatorExtras
)` `void` `@https://developer.android.com/reference/androidx/annotation/CallSuper
https://developer.android.com/reference/androidx/navigation/Navigator#onAttach(androidx.navigation.NavigatorState)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavigatorState state)` `void` `https://developer.android.com/reference/androidx/navigation/Navigator#onLaunchSingleTop(androidx.navigation.NavBackStackEntry)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry backStackEntry)` `boolean` `https://developer.android.com/reference/androidx/navigation/Navigator#popBackStack()()` `void` `https://developer.android.com/reference/androidx/navigation/Navigator#popBackStack(androidx.navigation.NavBackStackEntry,kotlin.Boolean)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry popUpTo, boolean savedState)`

## Public constructors

### DynamicIncludeGraphNavigator

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

```
public DynamicIncludeGraphNavigator(
    @NonNull Context context,
    @NonNull NavigatorProvider navigatorProvider,
    @NonNull NavInflater navInflater,
    @NonNull DynamicInstallManager installManager
)
```

## Public methods

### createDestination

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

```
public @NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph createDestination()
```

### navigate

```
public void navigate(
    @NonNull List<@NonNull NavBackStackEntry> entries,
    NavOptions navOptions,
    Navigator.Extras navigatorExtras
)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavBackStackEntry> entries` | destination(s) to navigate to |
| `https://developer.android.com/reference/androidx/navigation/NavOptions navOptions` | additional options for navigation |
| `https://developer.android.com/reference/androidx/navigation/Navigator.Extras navigatorExtras` | 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/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/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/androidx/navigation/Navigator#navigate(kotlin.collections.List,androidx.navigation.NavOptions,androidx.navigation.Navigator.Extras)` |   |

### onRestoreState

```
public void onRestoreState(@NonNull Bundle savedState)
```

### onSaveState

```
public Bundle onSaveState()
```