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

Package-level declarations

Types

AnimationDecision

data class AnimationDecision(val shouldAnimateEnter: Boolean, val shouldAnimateExit: Boolean, val isForward: Boolean, val enterTransition: NavTransition, val exitTransition: NavTransition)

Represents the decision of what animations should run for a navigation transition

CommonUrlEncoder

class CommonUrlEncoder : UrlEncoder

class RouteResolver

Functions

buildGraphHierarchyPath

fun buildGraphHierarchyPath(targetGraphId: String, graphDefinitions: Map<String, NavigationGraph>): List<NavigationGraph>

determineAnimationDecision

fun determineAnimationDecision(previousEntry: NavigationEntry, currentEntry: NavigationEntry, navModule: NavigationModule, isExplicitBackNavigation: Boolean = false): AnimationDecision

Centralized function to determine what animations should run for a navigation transition

determineContentAnimationDecision

fun determineContentAnimationDecision(previousEntry: NavigationEntry, currentEntry: NavigationEntry, navModule: NavigationModule, isExplicitBackNavigation: Boolean = false): AnimationDecision

findLayoutGraphsInHierarchy

fun findLayoutGraphsInHierarchy(currentGraphId: String, graphDefinitions: Map<String, NavigationGraph>): List<NavigationGraph>

findParentGraph

fun findParentGraph(targetGraph: NavigationGraph, graphDefinitions: Map<String, NavigationGraph>): NavigationGraph?

fun StoreAccessor.getFullPath(navigatable: Navigatable): String?

Get the full path for a Navigatable.

getNavigationModule

fun StoreAccessor.getNavigationModule(): NavigationModule

Convenience extension to get NavigationModule from a StoreAccessor (or Store).

NavigationDebugger

fun NavigationDebugger(navigationState: NavigationState, store: Store)

parseUrlWithQueryParams

fun parseUrlWithQueryParams(url: String): Pair<String, Map<String, String>>

Parse URL-style string with query parameters Returns a Pair of (cleanPath, queryParams)

requireFullPath

fun StoreAccessor.requireFullPath(navigatable: Navigatable): String

Get the full path for a Navigatable, throwing if not found.

resolveNavigatable

fun StoreAccessor.resolveNavigatable(entry: NavigationEntry): Navigatable?

Resolve the Navigatable for a NavigationEntry.