AnyLumino
API referenceastryxdata

EmptyState

Render an Astryx empty-state message.

Astryx Props

JSON-safe EmptyState props forwarded to Astryx.

Supported Astryx props include:

  • title (string; required): Primary message rendered as an <h3> heading inside the empty state.
  • description (string): Optional secondary text providing additional context below the title.
  • icon (ReactNode): Optional icon or illustration displayed above the title; rendered as decorative (aria-hidden="true").
  • actions (ReactNode): Optional action buttons displayed below the description, laid out horizontally by default and stacked vertically when isCompact is true.
  • headingLevel (1 or 2 or 3 or 4 or 5 or 6): Controls the rendered HTML heading tag (h1-h6) to fit the document outline.
  • isCompact (boolean): Enables the compact variant with reduced spacing for constrained content areas.
  • xstyle (StyleXStyles): StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value, not an inline style object like style={{}}.

Props typed as React nodes, render functions, event handlers, refs, or StyleX styles are documented for Astryx parity but cannot be serialized directly from Python unless the wrapper adapts them.

See Astryx component docs: https://astryx.atmeta.com/components/EmptyState.

Functions

constructor__init__(title, *, description='', heading_level=None, compact=None, **props) -> None
paramtitlestr

Dialog or empty-state title.

paramdescriptionstr
= ''

Supporting description text.

paramheading_levelint | None
= None

Semantic heading level.

paramcompactbool | None
= None

Whether to use reduced spacing.

parampropsAny
= {}

Returns

None

On this page