Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
FeedbackAndroid

Illustration

Render a built-in empty, success, error, or offline semantic scene.

Public APILumenIllustrationAndroid / Compose

Native example

Use Illustration

Use the built-in scene when its state matches the product message. Keep it decorative when the adjacent heading and description already communicate the same status.

Illustration rendered in the Android phone emulator Lumen playground
Verified runtime captureAndroid phone emulator
kotlin
LumenIllustration(
    variant = LumenIllustrationVariant.Success,
    label = "Saved successfully"
)

Reference

Public API

The primary shared and platform-specific options exposed by LumenIllustration.

APIValues or typeDefaultDescription
variantempty · success · error · offlineemptySelects the semantic scene.
toneauto · brand · accent · neutralautoUses the state color automatically or an explicit portable tone.
sizesm · md · lgmdSelects the shared 96, 128, or 176 unit dimension.
labelString?nullOptionally exposes the illustration as one labeled image.

Native behavior

Design and accessibility

When to use it

Use the built-in scene when its state matches the product message. Keep it decorative when the adjacent heading and description already communicate the same status.

Accessibility

Illustrations are decorative by default; an optional label exposes the complete scene as one image.

Shared component

Available on other platforms

React NativeApple / SwiftUI
Android docsCompose module