navease-runtime/io.github.alimsrepo.navease.internal.navigation.ui/NavDisplay

NavDisplay

Object that indicates the features that can be handled by the NavDisplay

Types

object PopTransitionKey : NavMetadataKey<AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform>

The key for NavEntry.metadata or Scene.metadata to notify the NavDisplay of how the content should be animated when popping from backstack.

PredictivePopTransitionKey

object PredictivePopTransitionKey : NavMetadataKey<AnimatedContentTransitionScope<Scene<*>>.(Int) -> ContentTransform?>

The key for NavEntry.metadata or Scene.metadata to notify the NavDisplay of how the content should be animated when popping from backstack using a Predictive back gesture.

TransitionKey

object TransitionKey : NavMetadataKey<AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform>

The key for NavEntry.metadata or Scene.metadata to notify the NavDisplay of how the content should be animated when adding to the backstack.

Functions

popTransitionSpec

fun popTransitionSpec(popTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?): Map<String, Any>

Function to be called on the NavEntry.metadata or Scene.metadata to notify the NavDisplay that, when popping from backstack, the content should be animated using the provided ContentTransform.

predictivePopTransitionSpec

fun predictivePopTransitionSpec(predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.(Int) -> ContentTransform?): Map<String, Any>

Function to be called on the NavEntry.metadata or Scene.metadata to notify the NavDisplay that, when popping from backstack using a Predictive back gesture, the content should be animated using the provided ContentTransform.

transitionSpec

fun transitionSpec(transitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?): Map<String, Any>

Function to be called on the NavEntry.metadata or Scene.metadata to notify the NavDisplay of how the content should be animated using the provided ContentTransform.