ComposeNavigatorDestinationBuilder

Artifact: androidx.navigation:navigation-compose

View Source

Added in 2.8.0

Common/AllAndroid/JVM

• Cmn

  @NavDestinationDsl
  class ComposeNavigatorDestinationBuilder : NavDestinationBuilder

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

---

DSL for constructing a new ComposeNavigator.Destination

Summary

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

Public functions
open ComposeNavigator.Destination	build() Build the NavDestination by calling Navigator.createDestination.	Cmn

Protected functions
open ComposeNavigator.Destination	instantiateDestination() Instantiate a new instance of D that will be passed to build.	Cmn

Public properties
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?	enterTransition	Cmn
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?	exitTransition	Cmn
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?	popEnterTransition	Cmn
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?	popExitTransition	Cmn
(AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?	sizeTransform	Cmn

Inherited functions

From androidx.navigation.NavDestinationBuilder Unit argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit) Add a NavArgument to this destination. Cmn Unit argument(name: String, argument: NavArgument) Add a NavArgument to this destination. Cmn inline Unit <T : Any> deepLink(basePath: String) Add a deep link to this destination. Cmn Unit deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn Unit deepLink(navDeepLink: NavDeepLink) Add a deep link to this destination. Cmn Unit deepLink(uriPattern: String) Add a deep link to this destination. Cmn inline Unit <T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn Unit <T : Any> deepLink(route: KClass<T>, basePath: String, navDeepLink: NavDeepLinkDslBuilder.() -> Unit) Add a deep link to this destination. Cmn

Inherited properties
From androidx.navigation.NavDestinationBuilder CharSequence? label The descriptive label of the destination Cmn Navigator<ComposeNavigator.Destination> navigator The navigator the destination that will be used in instantiateDestination to create the destination. Cmn String? route The destination's unique route. Cmn

Public constructors

ComposeNavigatorDestinationBuilder

Cmn

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

Cmn

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

Cmn

Added in 2.8.0

open fun build(): ComposeNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Protected functions

instantiateDestination

Cmn

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

Cmn

Added in 2.8.0

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

exitTransition

Cmn

Added in 2.8.0

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

popEnterTransition

Cmn

Added in 2.8.0

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

popExitTransition

Cmn

Added in 2.8.0

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

sizeTransform

Cmn

Added in 2.8.0

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