reaktiv-navigation/io.github.syrou.reaktiv.navigation.transition/NavTransition

NavTransition

@Serializable

sealed class NavTransition(source)

Describes the animation style used when a screen enters or exits the composition.

Assign these to a Screen or Modal's enterTransition / exitTransition properties. Call resolve to obtain a ResolvedNavTransition with concrete animation lambdas.

object HomeScreen : Screen {
    override val route = "home"
    override val enterTransition = NavTransition.SlideInRight
    override val exitTransition = NavTransition.SlideOutLeft
}

Inheritors

MaterialSlideIn

MaterialSlideOut

Types

object Companion

@Serializable

class Custom(val durationMillis: Int = DEFAULT_ANIMATION_DURATION, val alpha: (Float) -> Float = { 1f }, val scaleX: (Float) -> Float = { 1f }, val scaleY: (Float) -> Float = { 1f }, val translationX: (Float) -> Float = { 0f }, val translationY: (Float) -> Float = { 0f }, val rotationZ: (Float) -> Float = { 0f }) : NavTransition

Fully custom transition using per-frame transform lambdas.

@Serializable

data object Fade : NavTransition

Cross-fade in — opacity goes from 0 to 1.

@Serializable

data object FadeOut : NavTransition

Cross-fade out — opacity goes from 1 to 0.

@Serializable

data object IOSSlideIn : NavTransition

iOS-style push: new screen slides in from the right edge.

@Serializable

data object IOSSlideOut : NavTransition

iOS-style pop: outgoing screen slides left with a parallax scale-down effect.

MaterialSlideIn

@Serializable

data object MaterialSlideIn : NavTransition

Material Design 3 forward enter: slide in from right with subtle scale and fade.

MaterialSlideOut

@Serializable

data object MaterialSlideOut : NavTransition

Material Design 3 forward exit: slide out to the left with a trailing fade.

@Serializable

data object None : NavTransition

No animation; the screen appears or disappears instantly.

@Serializable

class Scale(val durationMillis: Int = DEFAULT_ANIMATION_DURATION) : NavTransition

Screen scales up (80 % → 100 %) while fading in.

@Serializable

class ScaleOut(val durationMillis: Int = DEFAULT_ANIMATION_DURATION) : NavTransition

Screen scales down (100 % → 80 %) while fading out.

@Serializable

data object SlideInLeft : NavTransition

Screen slides in from the left edge.

@Serializable

data object SlideInRight : NavTransition

Screen slides in from the right edge.

@Serializable

data object SlideOutBottom : NavTransition

Screen slides down and exits through the bottom edge.

@Serializable

data object SlideOutLeft : NavTransition

Screen slides out toward the left edge.

@Serializable

data object SlideOutRight : NavTransition

Screen slides out toward the right edge.

@Serializable

data object SlideUpBottom : NavTransition

Screen slides up from the bottom edge.

@Serializable

data object StackPop : NavTransition

Card-stack pop: outgoing screen falls down and fades out.

@Serializable

data object StackPush : NavTransition

Card-stack push: new screen rises from the bottom with a scale-up and fade.

Properties

@Transient

open val durationMillis: Int

Functions

fun NavTransition.resolve(screenWidth: Float, screenHeight: Float, isForward: Boolean = true): ResolvedNavTransition

Resolves this NavTransition into a ResolvedNavTransition with concrete per-frame lambdas.