# DialogSceneStrategy.Companion

Artifact: [androidx.navigation3:navigation3-ui](https://developer.android.com/jetpack/androidx/releases/navigation3) [View Source](https://cs.android.com/search?q=file:androidx/navigation3/scene/DialogScene.kt+class:androidx.navigation3.scene.DialogSceneStrategy.Companion) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0) Common/All
- Cmn

  ```
  object DialogSceneStrategy.Companion
  ```

*** ** * ** ***

## Summary

| ### Nested types |
|---|
| `object https://developer.android.com/reference/kotlin/androidx/navigation3/scene/DialogSceneStrategy.Companion.DialogKey : https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavMetadataKey<https://developer.android.com/reference/kotlin/androidx/compose/ui/window/DialogProperties>` 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)`. |

| ### Public functions |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | `https://developer.android.com/reference/kotlin/androidx/navigation3/scene/DialogSceneStrategy#dialog(androidx.compose.ui.window.DialogProperties)(dialogProperties: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/DialogProperties)` Function to be called on the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` to mark this entry as something that 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)`. | Cmn |

## Public functions

### dialog

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/navigation3#1.0.0)

```
fun dialog(dialogProperties: DialogProperties = DialogProperties()): Map<String, Any>
```

Function to be called on the `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#metadata()` to mark this entry as something that 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)`.

| Parameters |
|---|---|
| `dialogProperties: https://developer.android.com/reference/kotlin/androidx/compose/ui/window/DialogProperties = DialogProperties()` | properties that should be passed to the containing `https://developer.android.com/reference/kotlin/androidx/compose/ui/window/Dialog.composable#Dialog(kotlin.Function0,androidx.compose.ui.window.DialogProperties,kotlin.Function0)`. |