AnyLumino
API referenceastryxdata

Banner

Render an Astryx banner for prominent status messages.

Astryx Props

JSON-safe Banner props forwarded to Astryx.

Supported Astryx props include:

  • status ('info' or 'warning' or 'error' or 'success'; required): Status type controlling icon and color.
  • title (ReactNode; required): Title text or ReactNode displayed in the header.
  • description (ReactNode): Description text rendered below the title in the header.
  • icon (ReactNode): Override the default status icon.
  • isDismissable (boolean): Whether the banner can be dismissed by the user.
  • onDismiss (() => void): Called when the dismiss button is clicked; banner hides itself regardless of whether this is provided.
  • endContent (ReactNode): Action content rendered in the header area, end-aligned. Typically a button or link.
  • container ('card' or 'section'): Container type: card has border-radius; section is full-width with no border-radius for page-level use.
  • children (ReactNode): Content rendered in the card-background area below the colored header.
  • defaultIsExpanded (boolean): Whether the content area (children) starts expanded. Only relevant when children are provided.
  • 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/Banner.

Functions

constructor__init__(title, *, status='info', description='', dismissable=None, container=None, expanded=None, action_callbacks=None, **props) -> None
paramtitlestr

Dialog or empty-state title.

paramstatusstr
= 'info'

Validation or status record displayed by Astryx.

paramdescriptionstr
= ''

Supporting description text.

paramdismissablebool | None
= None

Whether the user can dismiss the banner.

paramcontainerstr | None
= None

Card or section container presentation.

paramexpandedbool | None
= None

Whether child content starts expanded.

paramaction_callbacksIterable[Callable[[ComponentWidget, Any], None]] | None
= None

Python callbacks receiving the "dismiss" action identifier.

parampropsAny
= {}

Returns

None

On this page