A specific scene to render 1 or more NavEntry instances as an overlay.

It is expected that the content is rendered in one or more separate windows (e.g., a dialog, popup window, etc.) that are visible above any additional Scene instances calculated from the overlaidEntries.

When processing overlaidEntries, expect processing of each SceneStrategy to restart from the first strategy. This may result in multiple instances of the same OverlayScene to be shown simultaneously, making a unique key even more important.

Summary

Public properties
List<NavEntry<T>>

The NavEntrys that should be handled by another Scene that sits below this Scene.
Cmn

Inherited properties
From androidx.navigation3.ui.Scene
@Composable () -> Unit

The content rendering the Scene itself.
Cmn
List<NavEntry<T>>

The list of NavEntrys that can be displayed in this scene.
Cmn
Any

The key identifying the Scene.
Cmn
List<NavEntry<T>>

The resulting NavEntrys that should be computed after pressing back updates the backstack.
Cmn

Public properties

overlaidEntries

Cmn
Added in 1.0.0-alpha02
val overlaidEntries: List<NavEntry<T>>

The NavEntrys that should be handled by another Scene that sits below this Scene.

This must always be a non-empty list to correctly display entries below the overlay.