Overlay

Render content over a base Astryx surface or media widget.

Astryx Props

children, content, showOn, isOpen, scrim, position, and align are adapted by the named arguments above. **props keeps the wrapper forward-compatible with additional JSON-safe Astryx props.

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

Functions

constructor__init__(children, content, *, show_on='always', open=None, scrim='dark', position='fill', align='end', **props) -> None

paramchildrenChildInput

Base widget displayed beneath the overlay.

paramcontentstr | ChildInput

Text or widget rendered inside the overlay scrim.

paramshow_onstr

= 'always'

Visibility trigger: "always", "hover", "focus", or "hover-or-focus".

paramopenbool | None

= None

Optional visibility override. When omitted, show_on controls visibility.

paramscrimstr | bool

= 'dark'

Dark or light scrim, or False for no scrim.

parampositionstr

= 'fill'

Overlay placement: "fill", "bottom", or "top".

paramalignstr

= 'end'

Content alignment: "start", "center", or "end".

parampropsAny

= {}

Returns

None

Functions

On this page