Skip to content

ErrorState

Failed-read state. Distinguish only authentication failure from everything else; one unreachable server surfaces under many transport codes (guidelines/app-state-honesty).

Prop Type Notes
title (required) React.ReactNode What failed: "We couldn't load your inbox."
note React.ReactNode What is now unknown: "Anything waiting on you is still waiting."
action React.ReactNode Usually a Try-again Button. Hold the error steady while a poll retries.
className string

Other props pass through to the root element (React.HTMLAttributes<HTMLDivElement>).

Preview

Declarations

TypeScript
export interface ErrorStateProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
  /** What failed: "We couldn't load your inbox." */
  title: React.ReactNode;
  /** What is now unknown: "Anything waiting on you is still waiting." */
  note?: React.ReactNode;
  /** Usually a Try-again Button. Hold the error steady while a poll retries. */
  action?: React.ReactNode;
  className?: string;
}

/**
 * Failed-read state. Distinguish only authentication failure from everything
 * else; one unreachable server surfaces under many transport codes
 * (guidelines/app-state-honesty).
 */
export function ErrorState(props: ErrorStateProps): React.JSX.Element;