Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
FeedbackApple

Empty state

Explain missing content with supporting copy, an optional graphic, and a recovery action.

Public APILumenEmptyStateApple / 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 TV · tvOS 16+Apple Vision · visionOS 1+Apple Watch · watchOS 9+

Native example

Use Empty state

Explain why the state is empty and offer one useful next action when recovery is possible. Do not use for loading or error states.

Empty state rendered in the iPhone simulator Lumen playground
Verified runtime captureiPhone simulator
swift
LumenEmptyState(
    "No saved workspaces",
    systemName: "rectangle.stack",
    description: "Create a workspace to get started."
) {
    LumenButton("Create Workspace", action: createWorkspace)
}

Reference

Public API

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

APIValues or typeDefaultDescription
titleLocalizedStringKeyRequiredNames the empty state.
systemNameSF Symbol nameRequiredProvides an optional platform-native supporting graphic.
descriptionLocalizedStringKey?nilExplains the state or next step.
actions@ViewBuilder () -> ActionsEmptyViewProvides optional recovery actions.

Native behavior

Design and accessibility

When to use it

Explain why the state is empty and offer one useful next action when recovery is possible. Do not use for loading or error states.

Accessibility

The title, description, optional graphic, and recovery actions remain in a readable native order.

Shared component

Available on other platforms

React NativeAndroid / Compose
Apple docsSwiftUI package