NavDisplay

Artifact: androidx.navigation3:navigation3-ui

View Source

Added in 1.0.0-alpha10

---

Kotlin |Java

public static class NavDisplay

---

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

Summary

Public fields
static @NonNull NavDisplay	INSTANCE

Public methods
final @NonNull Map<@NonNull String, @NonNull Object>	popTransitionSpec(     @NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> popTransitionSpec ) 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.
final @NonNull Map<@NonNull String, @NonNull Object>	predictivePopTransitionSpec(     @NonNull Function2<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, @NonNull Integer, ContentTransform> predictivePopTransitionSpec ) 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.
final @NonNull Map<@NonNull String, @NonNull Object>	transitionSpec(     @NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> transitionSpec ) Function to be called on the NavEntry.metadata to notify the NavDisplay that the content should be animated using the provided ContentTransform.

Public fields

INSTANCE

Added in 1.0.0-alpha10

public static @NonNull NavDisplay INSTANCE

Public methods

popTransitionSpec

Added in 1.0.0-alpha10

public final @NonNull Map<@NonNull String, @NonNull Object> popTransitionSpec(
    @NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> popTransitionSpec
)

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
@NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> popTransitionSpec	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

Added in 1.0.0-alpha10

public final @NonNull Map<@NonNull String, @NonNull Object> predictivePopTransitionSpec(
    @NonNull Function2<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, @NonNull Integer, ContentTransform> predictivePopTransitionSpec
)

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
@NonNull Function2<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, @NonNull Integer, ContentTransform> predictivePopTransitionSpec	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

Added in 1.0.0-alpha10

public final @NonNull Map<@NonNull String, @NonNull Object> transitionSpec(
    @NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> transitionSpec
)

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

Parameters
@NonNull Function1<@NonNull AnimatedContentTransitionScope<@NonNull Scene<@NonNull ?>>, ContentTransform> transitionSpec	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