navigator-compose/com.kpstv.navigation.compose/NavOptions

NavOptions

data class NavOptions<T : Route>(singleTop: Boolean, popOptions: NavOptions.PopUpOptions<T>?, animationOptions: NavOptions.NavAnimation)
Content copied to clipboard

Set of options that can be optionally specified when navigating to new destination through ComposeNavigator.Controller.navigateTo.

These includes singleTop, popUpTo&withAnimation.

Constructors

Link copied to clipboard
fun <T : Route> NavOptions(singleTop: Boolean = false, popOptions: NavOptions.PopUpOptions<T>? = null, animationOptions: NavOptions.NavAnimation = NavAnimation())
Content copied to clipboard

Types

Link copied to clipboard
data class NavAnimation(target: TransitionKey, current: TransitionKey) : Parcelable
Content copied to clipboard
Link copied to clipboard
data class PopUpOptions<T : Route>(dest: KClass<out T>, inclusive: Boolean, all: Boolean)
Content copied to clipboard

Functions

Link copied to clipboard
fun popUpTo(destKey: KClass<out T>, options: NavOptions.PopUpOptions<T>.() -> Unit = {})
Content copied to clipboard

Pop up to a destination. Additional parameters can be set through options DSL.

Link copied to clipboard
fun withAnimation(options: NavOptions.NavAnimation.() -> Unit = {})
Content copied to clipboard

Customize transition for this navigation. You have to specify the transition for target & current destination.

Properties

Link copied to clipboard
var singleTop: Boolean = false
Content copied to clipboard

Ensures that there will be only once instance of this destination in the backstack.