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

Package-level declarations

Types

DialogSceneStrategy

class DialogSceneStrategy<T : Any> : SceneStrategy<T>

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

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

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

interface Scene<T : Any>

A specific scene to render 1 or more NavEntrys.

SceneDecoratorStrategy

fun interface SceneDecoratorStrategy<T : Any>

A strategy that tries to decorate a Scene given another Scene.

SceneDecoratorStrategyScope

class SceneDecoratorStrategyScope<T : Any> : SceneStrategyScope<T>

Scope used to create a Scene from another Scene.

class SceneInfo<T : Any>(val scene: Scene<T>) : NavigationEventInfo

Represents a snapshot of the visible destinations in a navigation container.

class SceneState<T : Any>

Class for holding the state associated with a scene

fun interface SceneStrategy<T : Any>

A strategy that tries to calculate a Scene given a list of NavEntrys.

SceneStrategyScope

open class SceneStrategyScope<T : Any>

Scope used to create a Scene from a list of NavEntrys.

SinglePaneSceneStrategy

class SinglePaneSceneStrategy<T : Any> : SceneStrategy<T>

A SceneStrategy that always creates a 1-entry Scene simply displaying the last entry in the list.

Functions

NavigationBackHandler

fun <T : Any> NavigationBackHandler(sceneState: SceneState<T>, state: NavigationEventState<SceneInfo<T>> = rememberNavigationEventState(sceneState), onBackCancelled: () -> Unit = {}, onBackCompleted: () -> Unit)

A composable that handles back navigation gestures for a SceneState, driven by a NavigationEventState.

rememberNavigationEventState

fun <T : Any> rememberNavigationEventState(sceneState: SceneState<T>): NavigationEventState<SceneInfo<T>>

Remembers and returns a NavigationEventState instance for a SceneState.

rememberSceneState

fun <T : Any> rememberSceneState(entries: List<NavEntry<T>>, sceneStrategies: List<SceneStrategy<T>>, sceneDecoratorStrategies: List<SceneDecoratorStrategy<T>> = emptyList(), sharedTransitionScope: SharedTransitionScope? = null, onBack: () -> Unit): SceneState<T>

Returns a SceneState that is remembered across compositions based on the parameters.