# DynamicIncludeNavGraphBuilder

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

*** ** * ** ***


```
@NavDestinationDsl
class DynamicIncludeNavGraphBuilder : NavDestinationBuilder<DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>
```

<br />

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

*** ** * ** ***

DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

## Summary

| ### Public constructors |
|---|
| `[DynamicIncludeNavGraphBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.Int,kotlin.String,kotlin.String))( dynamicIncludeGraphNavigator: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator, id: @https://developer.android.com/reference/kotlin/androidx/annotation/IdRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, moduleName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, graphResourceName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html )` **This function is deprecated.** Use routes to create your DynamicIncludeNavGraphBuilder instead |
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.String,kotlin.String,kotlin.String)( dynamicIncludeGraphNavigator: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator, route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, moduleName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, graphResourceName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html )` |
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)( dynamicIncludeGraphNavigator: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator, route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<*>, typeMap: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, https://developer.android.com/reference/kotlin/androidx/navigation/NavType<*>>, moduleName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, graphResourceName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html )` DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#build()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#graphPackage()` Destination NavGraph's resource package as defined in the module's `AndroidManifest`. |

### Inherited functions

From [androidx.navigation.NavDestinationBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[action](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#action(kotlin.Int,kotlin.Function1))(actionId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, actionBuilder: https://developer.android.com/reference/kotlin/androidx/navigation/NavActionBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)`

**This function is deprecated.** Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#argument(kotlin.String,kotlin.Function1)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, argumentBuilder: https://developer.android.com/reference/kotlin/androidx/navigation/NavArgumentBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#argument(kotlin.String,androidx.navigation.NavArgument)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, argument: https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument)` `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.String)(basePath: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.Function1)(navDeepLink: https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkDslBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(androidx.navigation.NavDeepLink)(navDeepLink: https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLink)` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.String)(uriPattern: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.String,kotlin.Function1)(basePath: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, noinline navDeepLink: https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkDslBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.reflect.KClass,kotlin.String,kotlin.Function1)(route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<T>, basePath: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, navDeepLink: https://developer.android.com/reference/kotlin/androidx/navigation/NavDeepLinkDslBuilder.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` `open https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#instantiateDestination()()`

### Inherited properties

From [androidx.navigation.NavDestinationBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#id()` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#label()` `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator<https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#navigator()` `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#route()`

## Public constructors

### DynamicIncludeNavGraphBuilder

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)

```
[DynamicIncludeNavGraphBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.Int,kotlin.String,kotlin.String))(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    id: @IdRes Int,
    moduleName: String,
    graphResourceName: String
)
```

> [!CAUTION]
> **This function is deprecated.**   
> Use routes to create your DynamicIncludeNavGraphBuilder instead, use this instead:
>
> ```kotlin
> DynamicIncludeNavGraphBuilder(dynamicIncludeGraphNavigator, route = id.toString(), moduleName, graphResourceName)
> ```

### DynamicIncludeNavGraphBuilder

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

```
DynamicIncludeNavGraphBuilder(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    route: String,
    moduleName: String,
    graphResourceName: String
)
```

### DynamicIncludeNavGraphBuilder

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

```
DynamicIncludeNavGraphBuilder(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    moduleName: String,
    graphResourceName: String
)
```

DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

| Parameters |
|---|---|
| `dynamicIncludeGraphNavigator: https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator` | navigator used to create the destination |
| `route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<*>` | the graph's unique route as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `typeMap: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, https://developer.android.com/reference/kotlin/androidx/navigation/NavType<*>>` | A mapping of KType to custom NavType\<\*\> in the `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)`. May be empty if `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)` does not use custom NavTypes. |
| `moduleName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `graphResourceName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder` | the newly created NavGraph |

## Public functions

### build

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

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

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | The `https://developer.android.com/reference/kotlin/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.DynamicNavGraph` |

## Public properties

### graphPackage

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

```
var graphPackage: String?
```

Destination NavGraph's resource package as defined in the module's `AndroidManifest`. This generally does not need to be manually set and will be set `applicationId.moduleName` if left null.

This cannot be an empty string.