Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
FeedbackApple

Illustration

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

Public APILumenIllustrationApple / SwiftUISwift product: LumenUI

Apple availability

Supported native targets

Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.

iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple Vision · visionOS 1+

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 iPhone simulator Lumen playground
Verified runtime captureiPhone simulator
swift
LumenIllustration(
    variant: .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?nilOptionally 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 NativeAndroid / Compose
Apple docsSwiftUI package