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

LoadingModal

A full-screen SYSTEM overlay shown while a guard or entry definition is evaluating.

Automatically shown by evaluateWithThreshold when evaluation exceeds the configured loading threshold, and removed atomically once navigation commits.

Sits at the bottom of the SYSTEM layer (elevation = 0f) so that user-triggered SYSTEM modals (e.g. system alerts) always render above it.

Stacking order within RenderLayer.SYSTEM:

LoadingModal → zIndex(9001f + 0f) = 9001f
Normal SYSTEM Modal → zIndex(9001f + 1000f) = 10001f

Usage:

object AuthLoadingScreen : LoadingModal {
    override val route = "auth-loading"
    override val enterTransition = NavTransition.Fade
    override val exitTransition = NavTransition.FadeOut
    override val requiresAuth = false

    @Composable
    override fun Content(params: Params) { /* loading UI */}
}

Properties

actionResource

open override val actionResource: ActionResource?

backgroundDimAlpha

open val backgroundDimAlpha: Float

dismissable

open override val dismissable: Boolean

When true (the default), the system back gesture/button dismisses this modal via navigateBack. Set to false for mandatory modals that must not be dismissed by the user. Also gates tapOutsideToDismiss — if this is false, tapping outside does nothing even when tapOutsideToDismiss is true.

elevation

open override val elevation: Float

Elevation within the layer (higher = on top)

enterTransition

abstract val enterTransition: NavTransition

exitTransition

abstract val exitTransition: NavTransition

popEnterTransition

open override val popEnterTransition: NavTransition?

popExitTransition

open override val popExitTransition: NavTransition?

renderLayer

open override val renderLayer: RenderLayer

Which layer this navigatable should render in

requiresAuth

abstract val requiresAuth: Boolean

route

abstract val route: String

shouldDimBackground

open override val shouldDimBackground: Boolean

tapOutsideToDismiss

open override val tapOutsideToDismiss: Boolean

When true (the default), tapping on the dim background outside the modal content calls navigateBack. The dim layer always captures all taps regardless of this flag, preventing clicks from passing through to screens behind the modal.

titleResource

open override val titleResource: TitleResource?

Functions

Content

@Composable

abstract fun Content(params: Params)

onLifecycleCreated

open suspend fun onLifecycleCreated(lifecycle: BackstackLifecycle)

Called when this navigatable is added to the backstack.

toNavigationEntry

fun Navigatable.toNavigationEntry(path: String, params: Params = Params.empty(), stackPosition: Int = 0): NavigationEntry

Creates a NavigationEntry for this Navigatable at the given path.