When to use it
Use when a region or page cannot show its primary content. Keep retry and request policy in application state; use Banner when existing content remains useful.
FeedbackAndroid
Error state
Explain an unavailable region or page and offer application-owned recovery.
Native example
Use Error state
Use when a region or page cannot show its primary content. Keep retry and request policy in application state; use Banner when existing content remains useful.
LumenErrorState(
title = "Could not load projects",
description = "Check your connection and try again.",
kind = LumenErrorStateKind.Offline,
reference = "REQ-4F82",
actions = { LumenButton(onClick = ::retry) { Text("Try again") } }
)Reference
Public API
The primary shared and platform-specific options exposed by LumenErrorState.
| API | Values or type | Default | Description |
|---|---|---|---|
| title | String | Required | Names the unavailable content or failed operation. |
| kind | LumenErrorStateKind | error | Selects error or offline context and its default illustration. |
| layout | LumenErrorStateLayout | default | Adapts spacing and whether the state fills its available page height. |
| reference | String? | null | Shows a safe support reference without exposing technical details. |
| actions | (@Composable () -> Unit)? | null | Provides application-owned recovery actions. |
Native behavior
Design and accessibility
Accessibility
The title is a heading, recovery actions retain native focus order, and React Native and Compose expose configurable live-region behavior.
Shared component