viewcompose-host-android/com.viewcompose.host.android

Package-level declarations

Types

RenderSession

class RenderSession

Owns a retained ViewCompose render session and its mounted Android View tree.

UiHostAndroid

object UiHostAndroid

Identifies the Android host artifact in runtime diagnostics.

Functions

AndroidView

fun UiTreeBuilder.AndroidView(factory: (Context) -> View, update: (View) -> Unit = {}, key: Any? = null, modifier: Modifier = Modifier, onReset: (View) -> Unit? = null, onRelease: (View) -> Unit? = null, onCommit: (View) -> Unit? = null)

Mounts an Android View as a transaction-aware declarative node.

nativeView

fun Modifier.nativeView(key: Any = Unit, configure: (View) -> Unit): Modifier

Applies replay-safe configuration directly to a mounted Android View.

renderInto

fun renderInto(container: ViewGroup, debug: Boolean = false, debugTag: String = "ViewCompose", overlayHost: OverlayHost = OverlayHostDefaults.noOp, onRenderStats: (RenderStats) -> Unit? = null, onRenderResult: (RenderTreeResult) -> Unit? = null, onRenderFailure: (RenderFailure) -> Unit? = null, content: UiTreeBuilder.() -> Unit): RenderSession

Creates a retained session that renders content into container.

setUiContent

fun ComponentActivity.setUiContent(debug: Boolean = false, debugTag: String = "ViewCompose", dynamicColorPolicy: AndroidDynamicColorPolicy = AndroidDynamicColorPolicy.UseIfAvailable, themeRefreshController: AndroidThemeRefreshController? = null, overlayHostFactory: (ViewGroup) -> OverlayHost = { root -> OverlayHostDefaults.androidOrNoOp(root) }, onRenderStats: (RenderStats) -> Unit? = null, onRenderResult: (RenderTreeResult) -> Unit? = null, onRenderFailure: (RenderFailure) -> Unit? = null, content: UiTreeBuilder.(ViewGroup) -> Unit): ViewGroup

Installs a ViewCompose root as this Activity's content and starts its render session.

fun Fragment.setUiContent(debug: Boolean = false, debugTag: String = "ViewCompose", dynamicColorPolicy: AndroidDynamicColorPolicy = AndroidDynamicColorPolicy.UseIfAvailable, themeRefreshController: AndroidThemeRefreshController? = null, overlayHostFactory: (ViewGroup) -> OverlayHost = { root -> OverlayHostDefaults.androidOrNoOp(root) }, onRenderStats: (RenderStats) -> Unit? = null, onRenderResult: (RenderTreeResult) -> Unit? = null, onRenderFailure: (RenderFailure) -> Unit? = null, content: UiTreeBuilder.(ViewGroup) -> Unit): ViewGroup

Creates a Fragment ViewCompose root and binds its render session to the view lifecycle.

viewComposeSaveableStateRegistry

fun viewComposeSaveableStateRegistry(owner: SavedStateRegistryOwner): SaveableStateRegistry

Returns the ViewCompose saveable-state registry bound to owner.