reaktiv-navigation/io.github.syrou.reaktiv.navigation.ui

Package-level declarations

Types

LayerAnimationState

data class LayerAnimationState(val currentEntry: NavigationEntry, val previousEntry: NavigationEntry?, val animationDecision: AnimationDecision?, val aliveEntries: List<NavigationEntry>, val isBackNavigation: Boolean)

Animation state for content layer rendering

ModalEntryState

data class ModalEntryState(val entry: NavigationEntry, val isEntering: Boolean, val isExiting: Boolean)

State for individual modal entries

NavigationAnimations

object NavigationAnimations

Unified animation system for all navigation layers

NavigationChromeState

class NavigationChromeState

Everything a navigation header needs, derived from the current navigation state.

Properties

LocalDismissIndicatorBackground

val LocalDismissIndicatorBackground: ProvidableCompositionLocal<Color>

LocalDismissIndicatorColor

val LocalDismissIndicatorColor: ProvidableCompositionLocal<Color>

LocalNavigationBackgroundColor

val LocalNavigationBackgroundColor: ProvidableCompositionLocal<Color>

CompositionLocal for providing default background color to navigation containers

LocalNavigationChromeInsets

val LocalNavigationChromeInsets: ProvidableCompositionLocal<PaddingValues>

Space the navigation header occupies, for screens that render beneath it.

LocalNavigationModule

val LocalNavigationModule: ProvidableCompositionLocal<NavigationModule>

CompositionLocal that provides the active NavigationModule to the Compose tree.

Functions

currentActionResource

fun currentActionResource(): ActionResource?

Returns the ActionResource of the currently visible screen, or null if the screen does not define one.

currentNavigatable

fun currentNavigatable(): Navigatable

Returns the Navigatable bound to the current entry.

currentPaneColumn

fun currentPaneColumn(): Int?

fun currentTitle(): String?

Returns the resolved title of the currently visible screen, or null if the screen does not define a io.github.syrou.reaktiv.navigation.definition.Navigatable.titleResource.

NavigationBackgroundProvider

fun NavigationBackgroundProvider(backgroundColor: Color = Color.Unspecified, dismissIndicatorColor: Color = Color.Unspecified, dismissIndicatorBackground: Color = Color.Unspecified, content: @Composable () -> Unit)

Provides a default background color for navigation containers

NavigationRender

fun NavigationRender(modifier: Modifier = Modifier, handlePlatformBack: Boolean = true)

Root composable that drives the navigation UI.

fun previousTitle(): String?

Title of the entry that a back navigation would reveal, or null at the root of the stack.

rememberLayerAnimationState

fun rememberLayerAnimationState(currentEntry: NavigationEntry): LayerAnimationState

Manages animation state for content layer screen transitions

rememberModalAnimationState

fun ~~rememberModalAnimationState~~(entries: List<NavigationEntry>): List<ModalEntryState>

Manages animation state for modal overlays

rememberNavigationBackgroundColor

fun rememberNavigationBackgroundColor(): Color

Gets the current navigation background color from the composition

rememberNavigationChrome

fun rememberNavigationChrome(): NavigationChromeState

Derives the values a navigation header needs from the current navigation state.

UnifiedLayerRenderer

fun UnifiedLayerRenderer(layerType: RenderLayer, entries: List<NavigationEntry>, graphDefinitions: Map<String, NavigationGraph>, evaluationOverlay: LoadingModal? = null)

Unified layer renderer that handles all navigation layer types consistently