public interface OverlayScene<T extends Object> extends Scene

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 methods
abstract @NonNull List<@NonNull NavEntry<@NonNull T>>

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

Inherited methods
From androidx.navigation3.ui.Scene
abstract @Composable @NonNull Function0<Unit>

The content rendering the Scene itself.
abstract @NonNull List<@NonNull NavEntry<@NonNull T>>

The list of NavEntrys that can be displayed in this scene.
abstract @NonNull Object

The key identifying the Scene.
abstract @NonNull List<@NonNull NavEntry<@NonNull T>>

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

Public methods

getOverlaidEntries

Added in 1.0.0-alpha02
abstract @NonNull List<@NonNull NavEntry<@NonNull T>> getOverlaidEntries()

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.