ComposeNavigatorDestinationBuilder

@NavDestinationDsl
class ComposeNavigatorDestinationBuilder : NavDestinationBuilder

kotlin.Any
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.compose.ComposeNavigatorDestinationBuilder

DSL for constructing a new ComposeNavigator.Destination

Summary

Public constructors

DSL for constructing a new ComposeNavigator.Destination
ComposeNavigatorDestinationBuilder(
    navigator: ComposeNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit
)

DSL for constructing a new ComposeNavigator.Destination

Public functions
open ComposeNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Protected functions
open ComposeNavigator.Destination

Instantiate a new instance of D that will be passed to build.

Public properties
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition)?
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition)?
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition)?
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition)?
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform)?

Inherited functions
From androidx.navigation.NavDestinationBuilder
Unit
action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit)

This function is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
Unit
argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit)

Add a NavArgument to this destination.
Unit
argument(name: String, argument: NavArgument)

Add a NavArgument to this destination.
inline Unit
<T : Any> deepLink(basePath: String)

Add a deep link to this destination.
Unit
deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.
Unit
deepLink(navDeepLink: NavDeepLink)

Add a deep link to this destination.
Unit
deepLink(uriPattern: String)

Add a deep link to this destination.
inline Unit
<T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit)

Add a deep link to this destination.

Inherited properties
From androidx.navigation.NavDestinationBuilder
Int

The destination's unique ID.
CharSequence?

The descriptive label of the destination
Navigator<ComposeNavigator.Destination>

The navigator the destination that will be used in instantiateDestination to create the destination.
String?

The destination's unique route.

Public constructors

ComposeNavigatorDestinationBuilder

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

DSL for constructing a new ComposeNavigator.Destination

Parameters
navigator: ComposeNavigator

navigator used to create the destination
route: String

the destination's unique route
content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit

composable for the destination

ComposeNavigatorDestinationBuilder

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

DSL for constructing a new ComposeNavigator.Destination

Parameters
navigator: ComposeNavigator

navigator used to create the destination
route: KClass<*>

the destination's unique route from a KClass
typeMap: Map<KType, NavType<*>>

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit

composable for the destination

Public functions

build

Added in 2.8.0
open fun build(): ComposeNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Protected functions

instantiateDestination

Added in 2.8.0
protected open fun instantiateDestination(): ComposeNavigator.Destination

Instantiate a new instance of D that will be passed to build.

By default, this calls Navigator.createDestination on navigator, but can be overridden to call a custom constructor, etc.

Public properties

enterTransition

Added in 2.8.0
var enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition)?

exitTransition

Added in 2.8.0
var exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition)?

popEnterTransition

Added in 2.8.0
var popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition)?

popExitTransition

Added in 2.8.0
var popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition)?

sizeTransform

Added in 2.8.0
var sizeTransform: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform)?