HoverCard

Attach a hover card with richer preview content.

Astryx Props

JSON-safe HoverCard props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode; required): Trigger content.
content (ReactNode; required): Interactive hover card content.
placement (LayerPlacement; default 'above'): Placement relative to the anchor.
alignment (LayerAlignment; default 'center'): Alignment along the placement axis.
delay (number; default 300): Delay in milliseconds before showing on hover.
hideDelay (number; default 200): Delay in milliseconds before hiding after mouse or focus leave.
focusTrigger ('auto' or 'always' or 'never'; default 'auto'): Controls whether focus opens the hover card.
isEnabled (boolean; default true): Enables or disables hover and focus triggers.
onOpenChange ((isOpen: boolean) => void): Called when hover card visibility changes.
hasHoverIndication ('auto' or boolean; default 'auto'): Controls dashed underline hover indication on the trigger.
isOpen (boolean): Controlled open state.
isDefaultOpen (boolean): Initial uncontrolled open state.
xstyle (StyleXStyles): StyleX styles for the hover card content.
className (string): CSS class names for the hover card content.
style (CSSProperties): Inline styles for the hover card 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/HoverCard.

Functions

constructor__init__

(content, trigger, *, label='', placement=None, alignment=None, delay=None, hide_delay=None, enabled=None, open=None, default_open=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.

paramdelayint | None

= None

Show delay in milliseconds.

paramhide_delayint | None

= None

Hide delay in milliseconds.

paramenabledbool | None

= None

Whether hover and focus triggers are enabled.

paramopenbool | None

= None

Optional controlled open state.

paramdefault_openbool | None

= None

Initial uncontrolled open state.

parampropsAny

= {}

Returns

None

Functions

On this page