Skip to content

//workflow/com.squareup.workflow1.ui.container/BodyAndModalsScreen

BodyAndModalsScreen

[jvm] @WorkflowUiExperimentalApi()

class BodyAndModalsScreen<B : Screen, M : Overlay>(body: B, modals: List<M>) : Screen

A screen that may stack a number of modal Overlays over a body. While modals are present, the body is expected to ignore any input events – touch, keyboard, etc.

UI kits are expected to provide handling for this class by default.

Constructors

BodyAndModalsScreen [jvm] fun <B : Screen, M : Overlay> BodyAndModalsScreen(body: B, vararg modals: M)
BodyAndModalsScreen [jvm] fun <B : Screen, M : Overlay> BodyAndModalsScreen(body: B, modals: List<M> = emptyList())

Functions

Name Summary
mapBody [jvm]
Content
fun <S : Screen> mapBody(transform: (B) -> S): BodyAndModalsScreen<S, M>


mapModals [jvm]
Content
fun <O : Overlay> mapModals(transform: (M) -> O): BodyAndModalsScreen<B, O>


Properties

Name Summary
body [jvm] val body: B
modals [jvm] val modals: List<M>