Common
> **Deprecated** Deprecated in favor of navigation builder that supports AnimatedContent
navigation
```kotlin
public fun NavGraphBuilder.navigation(
startDestination: String,
route: String,
arguments: List = emptyList(),
deepLinks: List = emptyList(),
builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| startDestination | the starting destination's route for this NavGraph |
| route | the destination's unique route |
| arguments | list of arguments to associate with destination |
| deepLinks | list of deep links to associate with the destinations |
| builder | the builder used to construct the graph |
Common
> **Deprecated** Deprecated in favor of navigation builder that supports sizeTransform
navigation
```kotlin
public fun NavGraphBuilder.navigation(
startDestination: String,
route: String,
arguments: List = emptyList(),
deepLinks: List = emptyList(),
enterTransition: (AnimatedContentTransitionScope.() -> EnterTransition?)? =
null,
exitTransition: (AnimatedContentTransitionScope.() -> ExitTransition?)? =
null,
popEnterTransition:
(AnimatedContentTransitionScope.() -> EnterTransition?)? =
enterTransition,
popExitTransition: (AnimatedContentTransitionScope.() -> ExitTransition?)? =
exitTransition,
builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| startDestination | the starting destination's route for this NavGraph |
| route | the destination's unique route |
| arguments | list of arguments to associate with destination |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |
Common
```kotlin
public fun NavGraphBuilder.navigation(
startDestination: String,
route: String,
arguments: List = emptyList(),
deepLinks: List = emptyList(),
enterTransition:
(@JvmSuppressWildcards
AnimatedContentTransitionScope.() -> EnterTransition?)? =
null,
exitTransition:
(@JvmSuppressWildcards
AnimatedContentTransitionScope.() -> ExitTransition?)? =
null,
popEnterTransition:
(@JvmSuppressWildcards
AnimatedContentTransitionScope.() -> EnterTransition?)? =
enterTransition,
popExitTransition:
(@JvmSuppressWildcards
AnimatedContentTransitionScope.() -> ExitTransition?)? =
exitTransition,
sizeTransform:
(@JvmSuppressWildcards
AnimatedContentTransitionScope.() -> SizeTransform?)? =
null,
builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| startDestination | the starting destination's route for this NavGraph |
| route | the destination's unique route |
| arguments | list of arguments to associate with destination |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| sizeTransform | callback to define the size transform for destinations in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |
navigation
Common
```kotlin
public inline fun NavGraphBuilder.navigation(
startDestination: KClass<*>,
typeMap: Map> = emptyMap(),
deepLinks: List = emptyList(),
noinline enterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
null,
noinline exitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
null,
noinline popEnterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
enterTransition,
noinline popExitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
exitTransition,
noinline sizeTransform:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
SizeTransform?)? =
null,
noinline builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| T | the destination's unique route from a KClass |
| startDestination | the starting destination's route from `KClass` for this NavGraph |
| typeMap | map of destination arguments' kotlin type `KType` to its respective custom `NavType`. May be empty if `T` does not use custom NavTypes. |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| sizeTransform | callback to define the size transform for destinations in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |
Common
```kotlin
public fun NavGraphBuilder.navigation(
startDestination: KClass<*>,
route: KClass,
typeMap: Map> = emptyMap(),
deepLinks: List = emptyList(),
enterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
null,
exitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
null,
popEnterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
enterTransition,
popExitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
exitTransition,
sizeTransform:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
SizeTransform?)? =
null,
builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| route | the destination's unique route from a KClass |
| startDestination | the starting destination's route from `KClass` for this NavGraph |
| typeMap | map of destination arguments' kotlin type `KType` to its respective custom `NavType`. May be empty if `route` does not use custom NavTypes. |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| sizeTransform | callback to define the size transform for destinations in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |
navigation
Common
```kotlin
public inline fun NavGraphBuilder.navigation(
startDestination: Any,
typeMap: Map> = emptyMap(),
deepLinks: List = emptyList(),
noinline enterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
null,
noinline exitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
null,
noinline popEnterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
enterTransition,
noinline popExitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
exitTransition,
noinline sizeTransform:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
SizeTransform?)? =
null,
noinline builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| T | the destination's unique route from a KClass |
| startDestination | the starting destination's route from an Object for this NavGraph |
| typeMap | map of destination arguments' kotlin type `KType` to its respective custom `NavType`. May be empty if `T` does not use custom NavTypes. |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| sizeTransform | callback to define the size transform for destinations in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |
Common
```kotlin
public fun NavGraphBuilder.navigation(
startDestination: Any,
route: KClass,
typeMap: Map> = emptyMap(),
deepLinks: List = emptyList(),
enterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
null,
exitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
null,
popEnterTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
EnterTransition?)? =
enterTransition,
popExitTransition:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
ExitTransition?)? =
exitTransition,
sizeTransform:
(AnimatedContentTransitionScope.() -> @JvmSuppressWildcards
SizeTransform?)? =
null,
builder: NavGraphBuilder.() -> Unit,
)
```
Construct a nested `NavGraph`
#### Parameters
| | |
| --- | --- |
| route | the destination's unique route from a KClass |
| startDestination | the starting destination's route from an Object for this NavGraph |
| typeMap | map of destination arguments' kotlin type `KType` to its respective custom `NavType`. May be empty if `route` does not use custom NavTypes. |
| deepLinks | list of deep links to associate with the destinations |
| enterTransition | callback to define enter transitions for destination in this NavGraph |
| exitTransition | callback to define exit transitions for destination in this NavGraph |
| popEnterTransition | callback to define pop enter transitions for destination in this NavGraph |
| popExitTransition | callback to define pop exit transitions for destination in this NavGraph |
| sizeTransform | callback to define the size transform for destinations in this NavGraph |
| builder | the builder used to construct the graph |
#### Returns
| | |
| --- | --- |
| | the newly constructed nested NavGraph |