Skip to content

//workflow/com.squareup.workflow1.ui.compose/WorkflowRendering

WorkflowRendering

[androidJvm]
Content
@WorkflowUiExperimentalApi()
@Composable()

fun WorkflowRendering(rendering: Any, viewEnvironment: ViewEnvironment, modifier: Modifier = Modifier)
More info

Renders rendering into the composition using this ViewEnvironment‘s ViewRegistry to generate the view.

This function fulfills a similar role as WorkflowViewStub, but is much more convenient to use from Composable functions. Note, however, that just like WorkflowViewStub, it doesn’t matter whether the factory registered for the rendering is using classic Android views or Compose.

Example

data class FramedRendering(
val borderColor: Color,
val child: R
) : ComposeRendering {

@Composable override fun Content(viewEnvironment: ViewEnvironment) {
Surface(border = Border(borderColor, 8.dp)) {
WorkflowRendering(child, viewEnvironment)
}
}
}

Parameters

androidJvm

rendering

The workflow rendering to display. May be of any type for which a ViewFactory has been registered in viewEnvironment‘s ViewRegistry.

modifier

A Modifier that will be applied to composable used to show rendering.

Throws

kotlin.IllegalArgumentException

if no factory can be found for rendering‘s type.