Class

ComposeNavigatorDestinationBuilder

DSL for constructing a new ComposeNavigator.Destination

Source set: Common
@NavDestinationDsl
public class ComposeNavigatorDestinationBuilder :
    NavDestinationBuilder<ComposeNavigator.Destination>

DSL for constructing a new ComposeNavigator.Destination

Secondary Constructors

public constructor(
    navigator: ComposeNavigator,
    route: String,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit,
) : super(navigator, route) {
    this.composeNavigator = navigator
    this.content = content
}

DSL for constructing a new ComposeNavigator.Destination

Parameters

navigator navigator used to create the destination
route the destination's unique route
content composable for the destination
public constructor(
    navigator: ComposeNavigator,
    route: KClass<*>,
    typeMap: Map<KType, @JvmSuppressWildcards NavType<*>>,
    content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit,
) : super(navigator, route, typeMap) {
    this.composeNavigator = navigator
    this.content = content
}

DSL for constructing a new ComposeNavigator.Destination

Parameters

navigator navigator used to create the destination
route the destination's unique route from a KClass
typeMap map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
content composable for the destination

Properties

enterTransition

Source set: Common
public var enterTransition:
    (@JvmSuppressWildcards
    AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?

exitTransition

Source set: Common
public var exitTransition:
    (@JvmSuppressWildcards
    AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?

popEnterTransition

Source set: Common
public var popEnterTransition:
    (@JvmSuppressWildcards
    AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)?

popExitTransition

Source set: Common
public var popExitTransition:
    (@JvmSuppressWildcards
    AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)?

sizeTransform

Source set: Common
public var sizeTransform:
    (@JvmSuppressWildcards
    AnimatedContentTransitionScope<NavBackStackEntry>.() -> SizeTransform?)?

Last updated: