Skip to main content

Released documentation snapshot. This immutable manual describes viewcompose-preview:0.1.0-alpha02 from source revision 963e114e. For current guidance, open the current module catalog.

Preview Integration

viewcompose-preview connects ViewCompose UI code to development-time preview hosts. It provides the application theme-provider contract used by the static Layoutlib runner, a convenient Compose AndroidView bridge, and the first-party preview catalog and Paparazzi snapshot harness.

Artifact and stability​

dependencies {
    debugImplementation("com.viewcompose:viewcompose-preview:0.1.0-alpha01")
}
  • Stability: Alpha. The public bridge and theme-provider contracts may evolve with preview tooling before the stable line.
  • Runtime: Android API 24 or newer.
  • Recommended scope: debug, test, or dedicated preview source sets. Application release code does not need the Compose bridge or catalog.
  • Transitive API: preview-core annotations/protocol, widget-core DSL and theme types, and the Compose runtime, UI, and preview annotations required by the bridge.

Choose the preview path​

ViewCompose supports two complementary paths:

  1. The native static-preview path uses @ViewComposePreview, the Gradle plugin, an isolated Layoutlib worker, and PreviewThemeProvider. It produces deterministic PNG and diagnostic artifacts and is the source of truth for production-theme fidelity, source navigation, layout diagnostics, galleries, and CI rendering.
  2. ViewComposePreview and ViewComposePreviewWithRoot embed a ViewCompose render session in Compose Preview through AndroidView. They are convenient for existing Compose preview surfaces but use UiThemeDefaults rather than an application theme provider and do not export the static runner's diagnostic artifacts.

The similarly named APIs live in different packages: the static annotation is in com.viewcompose.preview.tooling; the Compose bridge function is in com.viewcompose.preview.

Application theme provider​

Implement PreviewThemeProvider and mark exactly one implementation in a previewed module with @ViewComposePreviewThemeProvider. The provider receives a context that already contains the requested density, font scale, viewport, locale, direction, and night-mode qualifiers. It returns one PreviewThemeResolution containing:

  • a themed Context used to construct the native root and Android Views;
  • matching UiThemeTokens installed around the ViewCompose DSL tree.

Keeping both results in one resolution prevents native Views and DSL components from silently using different themes. Providers should be stateless, preserve the supplied configuration, avoid dynamic machine-specific inputs, and not retain the context. The worker can instantiate a Kotlin object or a public no-argument class.

Compose Preview bridge​

ViewComposePreview is the default bridge for root-independent DSL content. ViewComposePreviewWithRoot supplies the bridge-owned Android ViewGroup for interop anchors. ViewComposePreviewHost is the lower-level form that also accepts an overlay backend.

The bridge remembers one Android root and render session. Content-only Compose recompositions reuse the session and request another ViewCompose render. Theme, debug configuration, overlay backend, or container changes recreate the session. Leaving the Compose composition disposes it. Content must not remove or retain the bridge-owned root.

ViewComposePreviewOptions selects light or dark UiThemeDefaults and optional render diagnostics. These options are intentionally small; static-preview configuration matrices belong to preview-core.

Catalog and snapshot coverage​

The internal catalog groups representative component, input, container, collection, navigation, feedback, modifier, animation, gesture, and graphics scenes. Parameterized Compose previews and Paparazzi snapshots share the same specifications, while guard tests enforce unique IDs, groups, titles, and the declared coverage target list.

Catalog types are internal test infrastructure rather than a public component-gallery API. Extend them when a new module or visual contract needs regression coverage, but keep application examples in the demo and user-facing documentation.

Testing and extension rules​

  • Prefer the static runner for production-theme and source-diagnostic acceptance tests.
  • Keep Compose bridge dependencies out of release configurations unless the application truly uses them at runtime.
  • Test theme providers in light/dark, locale, RTL, density, and font-scale variants.
  • Do not retain the provider context or the root supplied by ViewComposePreviewWithRoot.
  • Give every catalog specification a stable, unique ID; changing it renames snapshot history.
  • Pair new visual domains with coverage guard entries and Paparazzi snapshots.
  • Treat renderer or provider exceptions as preview failures; do not hide them with placeholder UI.

The complete generated reference is available in the viewcompose-preview API tree.

Compatibility notes​

The 0.1.0-alpha01 line establishes the coherent native/DSL theme resolution, retained Compose bridge session, explicit root-access overload, and shared catalog/snapshot coverage model. Static preview protocol compatibility remains owned by preview-core.