navease-runtime/io.github.alimsrepo.navease.internal.navigation.scene/OverlayScene

OverlayScene

interface OverlayScene<T : Any> : Scene<T>

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.

Important Implementations of this interface should either be data classes, or implement equals and hashcode to ensure that the same Scene is used when appropriate.

Properties

content

abstract val content: @Composable () -> Unit

The content rendering the Scene itself.

entries

abstract val entries: List<NavEntry<T>>

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

key

abstract val key: Any

The key identifying the Scene. This key will be combined with the class of the Scene to determine the key that drives the transition in the top-level animation for the NavDisplay.

metadata

open val metadata: Map<String, Any>

Provide Scene-specific information to io.github.alimsrepo.navease.internal.navigation.ui.NavDisplay.

overlaidEntries

abstract val overlaidEntries: List<NavEntry<T>>

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

previousEntries

abstract val previousEntries: List<NavEntry<T>>

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

Functions

onRemove

open suspend fun onRemove()

Callback that is invoked after this OverlayScene is popped from the backStack, but before it leaves composition.