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

NavigationBuilder

class NavigationBuilder(storeAccessor: StoreAccessor, encoder: DualNavigationParameterEncoder = DualNavigationParameterEncoder())(source)

Builder for creating atomic navigation operations.

Provides a DSL for chaining multiple navigation actions into a single atomic operation. All operations are validated and executed together to ensure consistent navigation state.

Example usage:

store.navigation {
    clearBackStack()
    navigateTo("home")
    navigateTo<ProfileScreen> { param("userId", "123") }
}

Parameters

storeAccessor

Accessor for the store to execute operations

encoder

Parameter encoder for serialization

Constructors

NavigationBuilder

constructor(storeAccessor: StoreAccessor, encoder: DualNavigationParameterEncoder = DualNavigationParameterEncoder())

Properties

fullPath

val Navigatable.fullPath: String

Get the full path for a Navigatable within the navigation builder context.

Functions

clearBackStack

fun clearBackStack(): NavigationBuilder

dismissModals

fun dismissModals(): NavigationBuilder

Dismiss any active modals as part of all navigation operations in this block

navigateBack

fun navigateBack(): NavigationBuilder

navigateTo

inline suspend fun <T : Screen> navigateTo(replaceCurrent: Boolean = false, synthesizeBackstack: Boolean = false): NavigationBuilder

fun navigateTo(navigatable: Navigatable, replaceCurrent: Boolean = false, synthesizeBackstack: Boolean = false): NavigationBuilder

Navigate to a Navigatable instance with full-path resolution.

inline suspend fun <T : Navigatable> navigateTo(replaceCurrent: Boolean = false, preferredGraphId: String? = null, synthesizeBackstack: Boolean = false, noinline paramBuilder: NavigationParameterBuilder.() -> Unit? = null): NavigationBuilder

Navigate to a screen type with optional parameters.

fun navigateTo(path: String, replaceCurrent: Boolean = false, synthesizeBackstack: Boolean = false, paramBuilder: NavigationParameterBuilder.() -> Unit? = null): NavigationBuilder

Navigate to a path with optional parameters.

param

fun param(key: String, value: Any): NavigationBuilder

params

fun params(params: Params): NavigationBuilder

popUpTo

inline suspend fun <T : Navigatable> popUpTo(inclusive: Boolean = false, preferredGraphId: String? = null, fallback: String? = null): NavigationBuilder

Pop back to a specific screen type in the navigation stack.

fun popUpTo(path: String, inclusive: Boolean = false, fallback: String? = null): NavigationBuilder

Pop back to a specific route in the navigation stack.

put

inline fun <T : Any> put(key: String, value: T): NavigationBuilder

putBoolean

fun putBoolean(key: String, value: Boolean): NavigationBuilder

putDouble

fun putDouble(key: String, value: Double): NavigationBuilder

putFloat

fun putFloat(key: String, value: Float): NavigationBuilder

putInt

fun putInt(key: String, value: Int): NavigationBuilder

putLong

fun putLong(key: String, value: Long): NavigationBuilder

putRaw

fun putRaw(key: String, value: Any): NavigationBuilder

putString

fun putString(key: String, value: String): NavigationBuilder

resumePendingNavigation

fun resumePendingNavigation(): NavigationBuilder

Resume the pending navigation stored by GuardResult.PendAndRedirectTo, expanding it into a synthesized backstack at the point this operation appears in the chain.