AnyLumino
API referenceastryxsurfaces

Dialog

Render Astryx dialog content inline in notebook output.

Astryx Props

JSON-safe Dialog props forwarded to Astryx.

Supported Astryx props include:

  • isOpen (boolean; required): Whether the dialog is open.
  • onOpenChange ((isOpen: boolean) => unknown; required): Callback when dialog visibility changes.
  • children (ReactNode; required): Dialog content.
  • width (number or string): Width of the dialog in pixels or any CSS value.
  • maxHeight (number or string): Maximum height of the dialog.
  • position (DialogPosition): Static position for the dialog; centered by default when omitted.
  • variant ('standard' or 'fullscreen'): Dialog variant: fullscreen expands to fill the entire viewport.
  • purpose ('required' or 'form' or 'info'): Controls dismissal behavior: required disables Escape and backdrop click; form disables backdrop click after interaction; info allows both.
  • isInline (boolean): Renders dialog content inline without the <dialog> element, backdrop, or modal behavior. For documentation previews and showcases only.

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/Dialog.

Notes

The wrapper defaults to inline rendering to avoid modal focus-management conflicts inside Jupyter output areas. Set inline=False only when the surrounding notebook environment can safely host modal dialogs.

Functions

constructor__init__(children=None, *, open=True, inline=True, width=None, max_height=None, position=None, variant=None, purpose=None, **props) -> None
paramchildrenChildInput
= None

Dialog body content. Pass a widget, a sequence of widgets, or a mapping of slot names to widgets.

paramopenbool
= True

Controlled open state synchronized through is_open.

paraminlinebool
= True

Whether dialog content renders inline instead of using native modal behavior.

paramwidthint | float | str | None
= None

Dialog width.

parammax_heightint | float | str | None
= None

Maximum dialog height.

parampositionMapping[str, Any] | None
= None

Static top, right, bottom, and left position values.

paramvariantstr | None
= None

Standard or fullscreen dialog presentation.

parampurposestr | None
= None

Required, form, or informational dismissal behavior.

parampropsAny
= {}

Returns

None

On this page