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

NavigationAction

@Serializable

sealed class NavigationAction : ModuleAction(source)

Inheritors

SetPendingNavigation

ClearPendingNavigation

BootstrapComplete

RemoveLoadingModals

SetCurrentTitle

Types

@Serializable

data class AtomicBatch(val actions: List<NavigationAction>) : NavigationAction, HighPriorityAction

@Serializable

object Back : NavigationAction, HighPriorityAction

BootstrapComplete

@Serializable

object BootstrapComplete : NavigationAction, HighPriorityAction

@Serializable

object ClearBackstack : NavigationAction, HighPriorityAction

ClearPendingNavigation

@Serializable

object ClearPendingNavigation : NavigationAction, HighPriorityAction

@Serializable

data class Navigate(val entry: NavigationEntry, val modalContext: ModalContext? = null, val dismissModals: Boolean = false) : NavigationAction, HighPriorityAction

@Serializable

data class PopUpTo(val route: String, val inclusive: Boolean, val entryToReAdd: NavigationEntry? = null) : NavigationAction, HighPriorityAction

RemoveLoadingModals

@Serializable

object RemoveLoadingModals : NavigationAction, HighPriorityAction

Removes all io.github.syrou.reaktiv.navigation.definition.LoadingModal entries from the backStack. Dispatched atomically with the navigation batch that follows guard or entry-definition evaluation, so the loading overlay and the destination appear/disappear in a single state emission with no intermediate flash.

@Serializable

data class Replace(val entry: NavigationEntry) : NavigationAction, HighPriorityAction

SetCurrentTitle

@Serializable

data class SetCurrentTitle(val title: String?) : NavigationAction

Sets NavigationState.currentTitle to the resolved title string for the current entry. Dispatched from io.github.syrou.reaktiv.navigation.ui.NavigationRender after invoking the current navigatable's io.github.syrou.reaktiv.navigation.definition.Navigatable.titleResource inside the Compose tree, where localization APIs like stringResource are available.

SetPendingNavigation

@Serializable

data class SetPendingNavigation(val pending: PendingNavigation) : NavigationAction, HighPriorityAction