Stay organized with collections
Save and categorize content based on your preferences.
public final class NavDisplayInfo implements NavigationEventInfo
Represents a snapshot of the visible destinations in a navigation container.
This class provides the necessary context for building animations during navigation gestures, like predictive back. It's a simple data holder that feeds into the NavigationEventState.
During a gesture, the InProgress state provides two instances of this info:
You can use these two snapshots, along with NavigationEventState.progress, to create a smooth visual transition between destinations.
Summary
Public methods |
boolean |
|
final @NonNull List<@NonNull Object> |
A list of unique keys for the visible navigation destinations, typically ordered from the bottom to the top of the back stack.
|
int |
|
@NonNull String |
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[],[],null,["NavDisplayInfo \nArtifact: [androidx.navigation3:navigation3-ui](/jetpack/androidx/releases/navigation3) \n[View Source](https://cs.android.com/search?q=file:androidx/navigation3/ui/NavDisplayInfo.kt+class:androidx.navigation3.ui.NavDisplayInfo) \nAdded in [1.0.0-alpha08](/jetpack/androidx/releases/navigation3#1.0.0-alpha08)\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/androidx/navigation3/ui/NavDisplayInfo \"View this page in Kotlin\") \\|Java\n\n\n```\npublic final class NavDisplayInfo implements NavigationEventInfo\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nRepresents a snapshot of the visible destinations in a navigation container.\n\nThis class provides the necessary context for building animations during navigation gestures, like predictive back. It's a simple data holder that feeds into the [NavigationEventState](/reference/androidx/navigationevent/NavigationEventState).\n\nDuring a gesture, the [InProgress](/reference/androidx/navigationevent/NavigationEventState.InProgress) state provides two instances of this info:\n\n- [InProgress.currentInfo](/reference/androidx/navigationevent/NavigationEventState.InProgress#currentInfo()): The state you're navigating *to*.\n\n- [InProgress.previousInfo](/reference/androidx/navigationevent/NavigationEventState.InProgress#previousInfo()): The state you're navigating *from*.\n\nYou can use these two snapshots, along with [NavigationEventState.progress](/reference/androidx/navigationevent/NavigationEventState#progress()), to create a smooth visual transition between destinations.\n\nSummary \n\n| Public methods |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `boolean` | [equals](/reference/androidx/navigation3/ui/NavDisplayInfo#equals(kotlin.Any))`(`[Object](https://developer.android.com/reference/java/lang/Object.html)` other)` |\n| `final @`[NonNull](/reference/androidx/annotation/NonNull)` `[List](https://developer.android.com/reference/java/util/List.html)`\u003c@`[NonNull](/reference/androidx/annotation/NonNull)` `[Object](https://developer.android.com/reference/java/lang/Object.html)`\u003e` | [getVisibleEntries](/reference/androidx/navigation3/ui/NavDisplayInfo#getVisibleEntries())`()` A list of unique keys for the visible navigation destinations, typically ordered from the bottom to the top of the back stack. |\n| `int` | [hashCode](/reference/androidx/navigation3/ui/NavDisplayInfo#hashCode())`()` |\n| `@`[NonNull](/reference/androidx/annotation/NonNull)` `[String](https://developer.android.com/reference/java/lang/String.html) | [toString](/reference/androidx/navigation3/ui/NavDisplayInfo#toString())`()` |\n\nPublic methods \n\nequals \n\n```\npublic boolean equals(Object other)\n``` \n\ngetVisibleEntries \nAdded in [1.0.0-alpha08](/jetpack/androidx/releases/navigation3#1.0.0-alpha08) \n\n```\npublic final @NonNull List\u003c@NonNull Object\u003e getVisibleEntries()\n```\n\nA list of unique keys for the visible navigation destinations, typically ordered from the bottom to the top of the back stack. \n\nhashCode \n\n```\npublic int hashCode()\n``` \n\ntoString \n\n```\npublic @NonNull String toString()\n```"]]
