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

Screen

interface Screen : Navigatable(source)

A full-screen destination rendered in the RenderLayer.CONTENT layer.

Implement this interface on an object to define a screen in your navigation graph. Default transition values are null (no animation) for pop transitions and the navigatable defaults for enter/exit; override them as needed.

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

    @Composable
    override fun Content(params: Params) {
        Text("Home")
    }
}

See also

NavigationGraph

Properties

open override val actionResource: ActionResource?

backGestureEnabled

open val backGestureEnabled: Boolean

open val contentInsets: ContentInsets

open val dismissal: Dismissal

dismissIndicatorBackground

open val dismissIndicatorBackground: Color

dismissIndicatorColor

open val dismissIndicatorColor: Color

dismissIndicatorPlacement

open val dismissIndicatorPlacement: DismissIndicatorPlacement

open override val elevation: Float

Elevation within the layer (higher = on top)

enterTransition

abstract override val enterTransition: NavTransition

A screen always has an arrival, so these narrow the nullable spec to non-null.

abstract override val exitTransition: NavTransition

hiddenUrlParams

open val hiddenUrlParams: Set<String>

onDismissRequest

open val ~~onDismissRequest~~: suspend StoreAccessor.() -> Unit?

popEnterTransition

open override val popEnterTransition: NavTransition?

popExitTransition

open override val popExitTransition: NavTransition?

val TransitionSpec.presentsItself: Boolean

True when this node describes a surface of its own rather than deferring to what it contains.

open override val renderLayer: RenderLayer

Which layer this navigatable should render in

abstract val route: String

showsDismissIndicator

open val showsDismissIndicator: Boolean

open val ~~swipeToDismiss~~: Boolean

open override val titleResource: TitleResource?

Functions

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.