Properties
| Property | Type | Description |
|---|---|---|
children | ReactNode | |
width | stringnumber | A fixed width for the popover. |
offset | numberDefault: 8 | The additional offset applied along the main axis between the element and its anchor element. |
translate | yesno | |
arrowBoundaryOffset | numberDefault: 0 | The minimum distance the arrow's edge should be from the edge of the overlay element. |
className | ClassNameOrFunction<PopoverRenderProps>Default: 'react-aria-Popover' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. |
triggerRef | RefObject<Element> | 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. |
isEntering | boolean | Whether the popover is currently performing an entry animation. |
isExiting | boolean | Whether the popover is currently performing an exit animation. |
UNSTABLE_portalContainer | ElementDefault: document.body | The container element in which the overlay portal will be placed. This may have unknown behavior depending on where it is portalled to. @deprecated - Use a parent UNSAFE_PortalProvider to set your portal container instead. |
placement | PlacementDefault: 'bottom' | The placement of the element with respect to its anchor element. |
containerPadding | numberDefault: 12 | The placement padding that should be applied between the element and its surrounding container. |
crossOffset | numberDefault: 0 | The additional offset applied along the cross axis between the element and its anchor element. |
shouldFlip | booleanDefault: true | 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. |
isOpen | boolean | Whether the overlay is open by default (controlled). |
defaultOpen | boolean | Whether the overlay is open by default (uncontrolled). |
style | StyleOrFunction<TooltipRenderProps> | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. |
render | DOMRenderFunction<"div", TooltipRenderProps> | 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. |
dir | string | |
lang | string | |
hidden | boolean | |
inert | boolean | |
wrapWith | ReactElement<unknown, string | JSXElementConstructor<any>> | |
ref | Ref<HTMLSpanElement> | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see React Docs |
key | Key | |
slot | string | 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. |
boundaryElement | ElementDefault: document.body | Element that that serves as the positioning boundary. |
arrowRef | RefObject<Element> | A ref for the popover arrow element. |
scrollRef | RefObject<Element>Default: overlayRef | A ref for the scrollable region within the overlay. |
shouldUpdatePosition | booleanDefault: true | Whether the overlay should update its position automatically. |
maxHeight | number | The maxHeight specified for the overlay element. By default, it will take all space up to the current viewport height. |
getTargetRect | ((target: Element) => DOMRect)Default: target.getBoundingClientRect() | 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. @param target - The target element. |
isNonModal | boolean | 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. |
isKeyboardDismissDisabled | booleanDefault: false | 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. |
shouldCloseOnInteractOutside | ((element: Element) => boolean) | 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. |
trigger | string | 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. |
isDialogContent | boolean | Whether the popover contains a dialog. |
controller | OverlayController | An overlay controller to control the popover state. |
Events
| Property | Type | Description |
|---|---|---|
onOpenChange | ((isOpen: boolean) => void) | Handler that is called when the overlay's open state changes. |
onClick | MouseEventHandler<HTMLDivElement> | |
onClickCapture | MouseEventHandler<HTMLDivElement> | |
onAuxClick | MouseEventHandler<HTMLDivElement> | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | |
onContextMenu | MouseEventHandler<HTMLDivElement> | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | |
onMouseDown | MouseEventHandler<HTMLDivElement> | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | |
onMouseMove | MouseEventHandler<HTMLDivElement> | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | |
onMouseOut | MouseEventHandler<HTMLDivElement> | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | |
onMouseOver | MouseEventHandler<HTMLDivElement> | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | |
onMouseUp | MouseEventHandler<HTMLDivElement> | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | |
onTouchMove | TouchEventHandler<HTMLDivElement> | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | |
onTouchStart | TouchEventHandler<HTMLDivElement> | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | |
onPointerDown | PointerEventHandler<HTMLDivElement> | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | |
onPointerMove | PointerEventHandler<HTMLDivElement> | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | |
onPointerUp | PointerEventHandler<HTMLDivElement> | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | |
onPointerOver | PointerEventHandler<HTMLDivElement> | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | |
onPointerOut | PointerEventHandler<HTMLDivElement> | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | |
onScroll | UIEventHandler<HTMLDivElement> | |
onScrollCapture | UIEventHandler<HTMLDivElement> | |
onWheel | WheelEventHandler<HTMLDivElement> | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> |
Accessibility
| Property | Type | Description |
|---|---|---|
aria-label | string | Defines a string value that labels the current element. |
aria-labelledby | string | Identifies the element (or elements) that labels the current element. |
aria-describedby | string | Identifies the element (or elements) that describes the object. |
aria-details | string | Identifies the element (or elements) that provide a detailed, extended description for the object. |