# ComposeNavigatorDestinationBuilder

Artifact: [androidx.navigation:navigation-compose](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/compose/ComposeNavigatorDestinationBuilder.kt+class:androidx.navigation.compose.ComposeNavigatorDestinationBuilder) Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.8.0) Common/AllAndroid/JVM
- Cmn

  ```
  @NavDestinationDsl
  class ComposeNavigatorDestinationBuilder : NavDestinationBuilder<ComposeNavigator.Destination>
  ```

|---|---|---|
| [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)\<[ComposeNavigator.Destination](https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination)\> ||
|   | ↳ | [androidx.navigation.compose.ComposeNavigatorDestinationBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder) |

*** ** * ** ***

DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination`

## Summary

| ### Public constructors |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#ComposeNavigatorDestinationBuilder(androidx.navigation.compose.ComposeNavigator,kotlin.String,kotlin.Function2)( navigator: https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator, route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentScope.(https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination` | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#ComposeNavigatorDestinationBuilder(androidx.navigation.compose.ComposeNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.Function2)( navigator: https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator, 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<*>>, content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentScope.(https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination` | Cmn |

| ### Public functions |
|---|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#build()()` Build the NavDestination by calling `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#createDestination()`. | Cmn |

| ### Protected functions |
|---|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#instantiateDestination()()` Instantiate a new instance of `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder` that will be passed to `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#build()`. | Cmn |

| ### Public properties |
|---|---|---|
| `(https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentTransitionScope<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>.() -> https://developer.android.com/reference/kotlin/androidx/compose/animation/EnterTransition?)?` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#enterTransition()` | Cmn |
| `(https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentTransitionScope<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>.() -> https://developer.android.com/reference/kotlin/androidx/compose/animation/ExitTransition?)?` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#exitTransition()` | Cmn |
| `(https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentTransitionScope<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>.() -> https://developer.android.com/reference/kotlin/androidx/compose/animation/EnterTransition?)?` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#popEnterTransition()` | Cmn |
| `(https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentTransitionScope<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>.() -> https://developer.android.com/reference/kotlin/androidx/compose/animation/ExitTransition?)?` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#popExitTransition()` | Cmn |
| `(https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentTransitionScope<https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry>.() -> https://developer.android.com/reference/kotlin/androidx/compose/animation/SizeTransform?)?` | `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#sizeTransform()` | Cmn |

### 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` `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)`

Add a `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument` to this destination.
Cmn `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)`

Add a `https://developer.android.com/reference/kotlin/androidx/navigation/NavArgument` to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn `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)`

Add a deep link to this destination.
Cmn

### Inherited properties

From [androidx.navigation.NavDestinationBuilder](https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#label()`

The descriptive label of the destination
Cmn `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator<https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination>` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#navigator()`

The navigator the destination that will be used in `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#instantiateDestination()` to create the destination.
Cmn `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#route()`

The destination's unique route.
Cmn

## Public constructors

### ComposeNavigatorDestinationBuilder

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

```
ComposeNavigatorDestinationBuilder(
    navigator: ComposeNavigator,
    route: String,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit
)
```

DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination`

| Parameters |
|---|---|
| `navigator: https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator` | navigator used to create the destination |
| `route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | the destination's unique route |
| `content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentScope.(https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | composable for the destination |

### ComposeNavigatorDestinationBuilder

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

```
ComposeNavigatorDestinationBuilder(
    navigator: ComposeNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit
)
```

DSL for constructing a new `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator.Destination`

| Parameters |
|---|---|
| `navigator: https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigator` | navigator used to create the destination |
| `route: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<*>` | the destination's unique route from 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<*>>` | map of destination arguments' kotlin type `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html` to its respective custom `https://developer.android.com/reference/kotlin/androidx/navigation/NavType`. May be empty if `https://developer.android.com/reference/kotlin/androidx/navigation/compose/ComposeNavigatorDestinationBuilder#(androidx.navigation.compose.ComposeNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.Function2)` does not use custom NavTypes. |
| `content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/animation/AnimatedContentScope.(https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | composable for the destination |

## Public functions

### build

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

```
open fun build(): ComposeNavigator.Destination
```

Build the NavDestination by calling `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#createDestination()`.

## Protected functions

### instantiateDestination

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

```
protected open fun instantiateDestination(): ComposeNavigator.Destination
```

Instantiate a new instance of `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder` that will be passed to `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#build()`.

By default, this calls `https://developer.android.com/reference/kotlin/androidx/navigation/Navigator#createDestination()` on `https://developer.android.com/reference/kotlin/androidx/navigation/NavDestinationBuilder#navigator()`, but can be overridden to call a custom constructor, etc.

## Public properties

### enterTransition

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

```
var enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?
```

### exitTransition

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

```
var exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?
```

### popEnterTransition

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

```
var popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?
```

### popExitTransition

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

```
var popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?
```

### sizeTransform

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

```
var sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?
```