# NavMetadataKey

Artifact: [androidx.navigation3:navigation3-runtime](https://developer.android.com/jetpack/androidx/releases/navigation3) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/runtime/NavMetadataKey.kt+class:androidx.navigation3.runtime.NavMetadataKey) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.1.0) Common/AllAndroid/JVM
- Cmn

  ```
  interface NavMetadataKey<T : Any>
  ```
Known direct subclasses [DialogSceneStrategy.Companion.DialogKey](https://developer.android.com/reference/kotlin/androidx/navigation3/scene/DialogSceneStrategy.Companion.DialogKey), [NavDisplay.PopTransitionKey](https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.PopTransitionKey), [NavDisplay.PredictivePopTransitionKey](https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.PredictivePopTransitionKey), [NavDisplay.TransitionKey](https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.TransitionKey), [TitleMetadataKey](https://developer.android.com/reference/kotlin/androidx/navigation3/scene/TitleMetadataKey), [UrlMetadataKey](https://developer.android.com/reference/kotlin/androidx/navigation3/scene/UrlMetadataKey)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/DialogSceneStrategy.Companion.DialogKey` | The key for `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` or `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene#metadata()` to indicate that an entry should be displayed within a `https://developer.android.com/reference/kotlin/androidx/compose/ui/window/Dialog.composable#Dialog(kotlin.Function0,androidx.compose.ui.window.DialogProperties,kotlin.Function0)`. |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.PopTransitionKey` | The key for `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` or `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene#metadata()` to notify the `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay` of how the content should be animated when popping from backstack. |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.PredictivePopTransitionKey` | The key for `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` or `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene#metadata()` to notify the `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay` of how the content should be animated when popping from backstack using a Predictive back gesture. |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay.TransitionKey` | The key for `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` or `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/Scene#metadata()` to notify the `https://developer.android.com/reference/kotlin/androidx/navigation3/ui/NavDisplay` of how the content should be animated when adding to the backstack. |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/TitleMetadataKey` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavMetadataKey` for defining a localized or dynamic title for a navigation scene or entry. |
| `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/UrlMetadataKey` | `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavMetadataKey` for defining a URL or location path representation for a navigation scene or entry. |

*** ** * ** ***

The base Key to be associated with value of type `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavMetadataKey`.

The `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/package-summary#metadata(kotlin.Function1)` DSL only accepts metadata keys that implements this interface