Skip to content

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

EnvironmentScreen

[jvm] @WorkflowUiExperimentalApi()

class EnvironmentScreen<V : Screen>(wrapped: V, environment: ViewEnvironment) : Compatible, Screen

Pairs a wrapped rendering with a environment to support its display. Typically the rendering type (RenderingT) of the root of a UI workflow, but can be used at any point to modify the ViewEnvironment received from a parent view.

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

Constructors

EnvironmentScreen [jvm] fun <V : Screen> EnvironmentScreen(wrapped: V, environment: ViewEnvironment = ViewEnvironment.EMPTY)

Properties

Name Summary
compatibilityKey [jvm] open override val compatibilityKey: StringEnsures that we make the decision to update or replace the root view based on the wrapped wrapped.
environment [jvm] val environment: ViewEnvironment
wrapped [jvm] val wrapped: V