NavDisplay

Artifact: androidx.navigation3:navigation3-ui

Kotlin |Java

Cmn
```
object NavDisplay
```

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

Summary

Public functions
`Map<String, Any>`	`popTransitionSpec(popTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?)` 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`.	Cmn
`Map<String, Any>`	`predictivePopTransitionSpec( predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<*>>.(Int) -> ContentTransform? )` 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`.	Cmn
`Map<String, Any>`	`transitionSpec(transitionSpec: AnimatedContentTransitionScope<Scene<*>>.() -> ContentTransform?)` 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`.	Cmn

Public functions

popTransitionSpec

Cmn

Added in 1.0.0-rc01

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.

IMPORTANT NavDisplay only looks at the Scene.metadata to determine the popTransitionSpec, it is the responsibility of the Scene.metadata to decide which popTransitionSpec to return, whether that be from the NavEntry.metadata or something custom.

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-rc01

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.

IMPORTANT NavDisplay only looks at the Scene.metadata to determine the predictivePopTransitionSpec, it is the responsibility of the Scene.metadata to decide which predictivePopTransitionSpec to return, whether that be from the NavEntry.metadata or something custom.

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-rc01

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.

IMPORTANT NavDisplay only looks at the Scene.metadata to determine the transitionSpec, it is the responsibility of the Scene.metadata to decide which transitionSpec to return, whether that be from the NavEntry.metadata or something custom.

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`