Interface PopoverProps

Identifies the element (or elements) that describes the object.

Identifies the element (or elements) that provide a detailed, extended description for the object.

Defines a string value that labels the current element.

Identifies the element (or elements) that labels the current element.

The minimum distance the arrow's edge should be from the edge of the overlay element.

A ref for the popover arrow element.

Element that that serves as the positioning boundary.

The placement padding that should be applied between the element and its surrounding container.

The additional offset applied along the cross axis between the element and its anchor element.

Whether the overlay is open by default (uncontrolled).

Overrides the target element's bounding rectangle. Useful for positioning relative to a specific point such as the mouse cursor (e.g. context menus) or text selection.

Whether the popover is currently performing an entry animation.

Whether the popover is currently performing an exit animation.

Whether pressing the escape key to close the popover should be disabled.

Most popovers should not use this option. When set to true, an alternative way to close the popover with a keyboard must be provided.

Whether the popover is non-modal, i.e. elements outside the popover may be interacted with by assistive technologies.

Most popovers should not use this option as it may negatively impact the screen reader experience. Only use with components such as combobox, which are designed to handle this situation carefully.

Whether the overlay is open by default (controlled).

The maxHeight specified for the overlay element. By default, it will take all space up to the current viewport height.

The additional offset applied along the main axis between the element and its anchor element.

Handler that is called when the target element and all descendants lose focus.

Handler that is called when the target element or a descendant receives focus.

Handler that is called when the the focus within state changes.

Handler that is called when the overlay's open state changes.

The placement of the element with respect to its anchor element.

Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

Requirements:

• You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
• Only a single root DOM element can be rendered (no fragments).
• You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.

A ref for the scrollable region within the overlay.

When user interacts with the argument element outside of the popover ref, return true if onClose should be called. This gives you a chance to filter out interaction with elements that should not dismiss the popover. By default, onClose will always be called on interaction outside the popover ref.

Whether the element should flip its orientation (e.g. top to bottom or left to right) when there is insufficient room for it to render completely.

Whether the popover should appear and disappear without an entry or exit animation. This is used by components such as PreviewTrigger to skip animations when quickly swapping between overlays.

Whether the overlay should update its position automatically.

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

The inline style for the element. A function may be provided to compute the style based on component state.

A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs.

The name of the component that triggered the popover. This is reflected on the element as the data-trigger attribute, and can be used to provide specific styles for the popover depending on which element triggered it.

The ref for the element which the popover positions itself with respect to.

When used within a trigger component such as DialogTrigger, MenuTrigger, Select, etc., this is set automatically. It is only required when used standalone.

The container element in which the overlay portal will be placed. This may have unknown behavior depending on where it is portalled to.