DialogSceneStrategy

A SceneStrategy that displays entries that have added dialog to their NavEntry.metadata within a Dialog instance.

This strategy should always be added before any non-overlay scene strategies.

Summary

Nested types

The key for NavEntry.metadata or Scene.metadata to indicate that an entry should be displayed within a Dialog.

Public companion functions
Map<String, Any>
dialog(dialogProperties: DialogProperties)

Function to be called on the NavEntry.metadata to mark this entry as something that should be displayed within a Dialog.
Cmn

Public constructors
Cmn

Public functions
open Scene<T>?

Given a SceneStrategyScope, calculate whether this SceneStrategy should take on the task of rendering one or more of the entries in the scope.
Cmn

Inherited functions
From androidx.navigation3.scene.SceneStrategy
open infix SceneStrategy<T>
then(sceneStrategy: SceneStrategy<T>)

This function is deprecated. Deprecated in favor of List<SceneStrategy> APIs that take the output of this operator has been refactored to take a list of strategies instead.
Cmn

Public companion functions

dialog

Cmn
Added in 1.0.0
fun dialog(dialogProperties: DialogProperties = DialogProperties()): Map<String, Any>

Function to be called on the NavEntry.metadata to mark this entry as something that should be displayed within a Dialog.

Parameters
dialogProperties: DialogProperties = DialogProperties()

properties that should be passed to the containing Dialog.

Public constructors

DialogSceneStrategy

Cmn 
<T : Any> DialogSceneStrategy()

Public functions

calculateScene

Cmn 
open fun SceneStrategyScope<T>.calculateScene(entries: List<NavEntry<T>>): Scene<T>?

Given a SceneStrategyScope, calculate whether this SceneStrategy should take on the task of rendering one or more of the entries in the scope.

By returning a non-null Scene, your Scene takes on the responsibility of rendering the set of entries you declare in Scene.entries. If you return null, the next available SceneStrategy will be called.

Parameters
entries: List<NavEntry<T>>

The entries on the back stack that should be considered valid to render via a returned Scene.