Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
FeedbackReact Native

Error state

Explain an unavailable region or page and offer application-owned recovery.

Public APILumenErrorStateReact Native

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.

Open the Error state demo
View captured React Native example
Error state rendered in the Expo web renderer Lumen playground
Captured exampleExpo web renderer
tsx
<LumenErrorState
  kind="offline"
  title="Could not load projects"
  description="Check your connection and try again."
  reference="REQ-4F82"
  actions={<LumenButton onPress={retry}>Try again</LumenButton>}
/>

Reference

Public API

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

APIValues or typeDefaultDescription
titlestringRequiredNames the unavailable content or failed operation.
kinderror | offlineerrorSelects error or offline context and its default illustration.
layoutcompact | default | pagedefaultAdapts spacing and whether the state fills its available page height.
referencestringundefinedShows a safe support reference without exposing technical details.
actionsReactNodeundefinedProvides application-owned recovery actions.

Native behavior

Design and accessibility

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.

Accessibility

The title is a heading, recovery actions retain native focus order, and React Native and Compose expose configurable live-region behavior.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives