# DynamicIncludeNavGraphBuilderKt

Added in 2.3.0

*** ** * ** ***


```
public final class DynamicIncludeNavGraphBuilderKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final void` | `[includeDynamic](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.Int,kotlin.String,kotlin.String))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/IdRes int id, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName )` **This method is deprecated.** Use routes to include your DynamicNavGraph instead |
| `static final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap )` Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`. |
| `static final void` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.String)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html route, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName )` Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`. |
| `static final void` | `[includeDynamic](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.Int,kotlin.String,kotlin.String,kotlin.Function1))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/IdRes int id, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder )` **This method is deprecated.** Use routes to include your DynamicNavGraph instead |
| `static final void` | `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map,kotlin.Function1)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder )` Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`. |
| `static final void` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.String,kotlin.Function1)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicNavGraphBuilder receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html route, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder )` Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`. |

## Public methods

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic) Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0) Deprecated in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final void [includeDynamic](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.Int,kotlin.String,kotlin.String))(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)
```

> [!CAUTION]
> **This method is deprecated.**   
> Use routes to include your DynamicNavGraph instead, use this instead:
>
> ```
> includeDynamic(route = id.toString(), moduleName, graphResourceName)
> ```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IdRes int id` | NavGraph id. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic)

```
public static final void <T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)
```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html>` | the graph's unique route as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap` | A mapping of KType to custom NavType\<\*\> in the `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/package-summary#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map)`. May be empty if `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/package-summary#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map)` does not use custom NavTypes. |

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic) Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)
```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html route` | NavGraph route. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic) Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0) Deprecated in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final void [includeDynamic](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilderKt#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.Int,kotlin.String,kotlin.String,kotlin.Function1))(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilder, Unit> builder
)
```

> [!CAUTION]
> **This method is deprecated.**   
> Use routes to include your DynamicNavGraph instead, use this instead:
>
> ```
> includeDynamic(route = id.toString(), moduleName, graphResourceName) { builder.invoke() }
> ```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IdRes int id` | NavGraph id. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder` | Another builder for chaining. |

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic)

```
public static final void <T extends Object> includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilder, Unit> builder
)
```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html>` | the graph's unique route as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap` | A mapping of KType to custom NavType\<\*\> in the `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/package-summary#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map,kotlin.Function1)`. May be empty if `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/package-summary#(androidx.navigation.dynamicfeatures.DynamicNavGraphBuilder).includeDynamic(kotlin.String,kotlin.String,kotlin.collections.Map,kotlin.Function1)` does not use custom NavTypes. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder` | Another builder for chaining. |

### includeDynamic

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/DynamicIncludeNavGraphBuilder.kt+function:includeDynamic) Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public static final void includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilder, Unit> builder
)
```

Construct a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html route` | NavGraph route. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> builder` | Another builder for chaining. |