AnyLumino
API referenceastryxsurfaces

Popover

Render click-triggered popover content.

Astryx Props

JSON-safe Popover props forwarded to Astryx.

Supported Astryx props include:

  • children (ReactNode or render function): Trigger content. Automatic mode requires a button or role=button descendant; render-function mode receives trigger props.
  • anchorRef (React.RefObject<HTMLElement>): External button or role=button anchor used for sibling-mode rendering.
  • content (ReactNode; required): Popover dialog content.
  • placement (LayerPlacement; default 'below'): Placement relative to the trigger.
  • alignment (LayerAlignment; default 'start'): Alignment along the placement axis.
  • isOpen (boolean): Controlled open state.
  • onOpenChange ((isOpen: boolean) => void): Called when popover visibility changes.
  • isEnabled (boolean; default true): Disables trigger interactions when false.
  • width (number or string; default 'auto'): Popover container width. Numbers are pixels; strings are CSS values.
  • label (string): Accessible label for the popover dialog.
  • hasCloseButton (boolean): Includes a hidden close button for keyboard users.
  • closeButtonLabel (string; default 'Close popover'): Accessible label for the hidden close button.
  • hasAutoFocus (boolean; default true): Auto-focuses the first focusable element when opened.
  • data-testid (string): Test selector for the popover container.
  • xstyle (StyleXStyles): StyleX styles for the popover content.
  • className (string): CSS class names for the popover content.
  • style (CSSProperties): Inline styles for the popover content.

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

Functions

constructor__init__(content, trigger, *, label, placement=None, alignment=None, open=None, enabled=None, width=None, close_button=None, auto_focus=None, **props) -> None
paramcontentstr | ChildInput

Overlay or tooltip content.

paramtriggerChildInput

Trigger content used by disclosure or overlay components.

paramlabelstr

Visible or accessible label for the component.

paramplacementstr | None
= None

Placement relative to the trigger.

paramalignmentstr | None
= None

Alignment along the placement axis.

paramopenbool | None
= None

Optional controlled open state.

paramenabledbool | None
= None

Whether trigger interaction is enabled.

paramwidthint | float | str | None
= None

Popover width.

paramclose_buttonbool | None
= None

Whether to include the accessible close button.

paramauto_focusbool | None
= None

Whether content receives focus when opened.

parampropsAny
= {}

Returns

None

On this page