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

Summary

Public functions
Map<String, Any>

Function to be called on the NavEntry.metadata to notify the NavDisplay that, when popping from backstack, the content should be animated using the provided ContentTransform.
Cmn
Map<String, Any>

Function to be called on the NavEntry.metadata to notify the NavDisplay that, when popping from backstack using a Predictive back gesture, the content should be animated using the provided ContentTransform.
Cmn
Map<String, Any>

Function to be called on the NavEntry.metadata to notify the NavDisplay that the content should be animated using the provided ContentTransform.
Cmn

Public functions

popTransitionSpec

Cmn
Added in 1.0.0-alpha10
fun popTransitionSpec(popTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?): Map<String, Any>

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

Parameters
popTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?

the ContentTransform to be used when popping from backstack. If this is null, the transition will fallback to the transition set on the NavDisplay

predictivePopTransitionSpec

Cmn
Added in 1.0.0-alpha10
fun predictivePopTransitionSpec(
    predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.(Int) -> ContentTransform?
): Map<String, Any>

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

Parameters
predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.(Int) -> ContentTransform?

the ContentTransform to be used when popping from backStack with predictive back gesture. If this is null, the transition will fallback to the transition set on the NavDisplay

transitionSpec

Cmn
Added in 1.0.0-alpha10
fun transitionSpec(transitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?): Map<String, Any>

Function to be called on the NavEntry.metadata to notify the NavDisplay that the content should be animated using the provided ContentTransform.

Parameters
transitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?

the ContentTransform to be used when adding to the backstack. If this is null, the transition will fallback to the transition set on the NavDisplay