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

Package-level declarations

Types

NavigationAction

@Serializable

sealed class NavigationAction : ModuleAction

NavigationBreadcrumb

@Serializable

data class NavigationBreadcrumb(val label: String, val path: String, val isGraph: Boolean)

A single step in the breadcrumb trail derived from the current navigation path.

NavigationLogic

class NavigationLogic : ModuleLogic

NavigationModule

class NavigationModule : ModuleWithLogic<NavigationState, NavigationAction, NavigationLogic> , CustomTypeRegistrar

The MVLI module that owns the navigation system.

NavigationOutcome

sealed class NavigationOutcome

Result of a NavigationLogic.navigate call.

NavigationState

@Serializable

data class NavigationState(val currentEntry: NavigationEntry, val backStack: List<NavigationEntry>, val screenRetentionDuration: Duration, val derived: NavigationProjection, val activeModalContexts: Map<String, ModalContext>, val lastNavigationAction: NavigationAction? = null, val pendingNavigation: PendingNavigation? = null, val isBootstrapping: Boolean = true, val isEvaluatingNavigation: Boolean = false, val activeScrub: ScrubState? = null, val startFailure: StartFailure? = null, val windowWidthClass: WindowWidthClass? = null) : ModuleState

Immutable snapshot of the navigation system's runtime state.

PrecomputedNavigationData

data class PrecomputedNavigationData(val routeResolver: RouteResolver, val availableNavigatables: Map<String, Navigatable>, val graphDefinitions: Map<String, NavigationGraph>, val graphHierarchies: Map<String, List<String>>, val navigatableToGraph: Map<Navigatable, String>, val routeToNavigatable: Map<String, Navigatable>, val navigatableToFullPath: Map<Navigatable, String>, val notFoundScreen: Screen? = null, val crashScreen: Screen? = null, val interceptsByGraphId: Map<String, InterceptDefinition> = emptyMap(), val interceptsByPath: Map<String, InterceptDefinition> = emptyMap(), val graphEntries: Map<String, EntryDefinition> = emptyMap(), val deepLinkAliases: List<DeepLinkAlias> = emptyList(), val loadingModal: LoadingModal? = null)

@Serializable

data class ScrubState(val type: ScrubType, val topKey: String, val revealedKey: String? = null, val progress: Float = 0.0f)

@Serializable

enum ScrubType : Enum<ScrubType>

TraverseDirection

@Serializable

enum TraverseDirection : Enum<TraverseDirection>

TraversePresentation

@Serializable

enum TraversePresentation : Enum<TraversePresentation>

Functions

createNavigationModule

fun createNavigationModule(block: GraphBasedBuilder.() -> Unit): NavigationModule

DSL entry point for creating a NavigationModule.