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

navigate

suspend fun navigate(block: suspend NavigationBuilder.() -> Unit): NavigationOutcome(source)

Execute a navigation operation. Evaluates intercept guards and entry definitions before committing navigation.

io.github.syrou.reaktiv.navigation.layer.RenderLayer.SYSTEM navigatables bypass the bootstrap wait so they can appear above the loading screen immediately without waiting for startup to complete.

Return

NavigationOutcome describing whether the navigation succeeded, was dropped, rejected, or redirected. Callers can ignore the return value for fire-and-forget use.

suspend fun navigate(route: String, params: Params = Params.empty(), replaceCurrent: Boolean = false, config: NavigationBuilder.() -> Unit? = null): NavigationOutcome(source)

Navigate to a route with optional parameters and configuration.

Return

NavigationOutcome describing whether the navigation succeeded, was dropped, rejected, or redirected.

Parameters

route

Target route to navigate to

params

Parameters to pass to the destination screen

replaceCurrent

If true, replaces current entry instead of pushing new one

config

Optional additional navigation configuration