PopoverContentProps

Extends

• Omit<AriaPopoverProps, "children">

Properties

aria-describedby?

optional aria-describedby: string

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

Inherited from

Omit.aria-describedby

---

aria-details?

optional aria-details: string

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

Inherited from

Omit.aria-details

---

aria-label?

optional aria-label: string

Defines a string value that labels the current element.

Inherited from

Omit.aria-label

---

aria-labelledby?

optional aria-labelledby: string

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

Inherited from

Omit.aria-labelledby

---

arrowBoundaryOffset?

optional arrowBoundaryOffset: number

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

Default

0

Inherited from

Omit.arrowBoundaryOffset

---

arrowRef?

optional arrowRef: RefObject<Element | null>

A ref for the popover arrow element.

Inherited from

Omit.arrowRef

---

boundaryElement?

optional boundaryElement: Element

Element that that serves as the positioning boundary.

Default

document.body

Inherited from

Omit.boundaryElement

---

children?

optional children: ReactNode | (props) => ReactNode

---

className?

optional className: string

The CSS className for the element. A function may be provided to compute the class based on component state.

Overrides

Omit.className

---

containerPadding?

optional containerPadding: number

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

Default

12

Inherited from

Omit.containerPadding

---

crossOffset?

optional crossOffset: number

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

Default

0

Inherited from

Omit.crossOffset

---

defaultOpen?

optional defaultOpen: boolean

Whether the overlay is open by default (uncontrolled).

Inherited from

Omit.defaultOpen

---

dir?

optional dir: string

Inherited from

Omit.dir

---

hidden?

optional hidden: boolean

Inherited from

Omit.hidden

---

inert?

optional inert: boolean

Inherited from

Omit.inert

---

isEntering?

optional isEntering: boolean

Whether the popover is currently performing an entry animation.

Inherited from

Omit.isEntering

---

isExiting?

optional isExiting: boolean

Whether the popover is currently performing an exit animation.

Inherited from

Omit.isExiting

---

isKeyboardDismissDisabled?

optional isKeyboardDismissDisabled: boolean

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.

Default

false

Inherited from

Omit.isKeyboardDismissDisabled

---

isNonModal?

optional 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.

Inherited from

Omit.isNonModal

---

isOpen?

optional isOpen: boolean

Whether the overlay is open by default (controlled).

Inherited from

Omit.isOpen

---

lang?

optional lang: string

Inherited from

Omit.lang

---

maxHeight?

optional maxHeight: number

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

Inherited from

Omit.maxHeight

---

offset?

optional offset: number

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

Default

8

Inherited from

Omit.offset

---

onAnimationEnd?

optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationEnd

---

onAnimationEndCapture?

optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationEndCapture

---

onAnimationIteration?

optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationIteration

---

onAnimationIterationCapture?

optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationIterationCapture

---

onAnimationStart?

optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationStart

---

onAnimationStartCapture?

optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationStartCapture

---

onAuxClick?

optional onAuxClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onAuxClick

---

onAuxClickCapture?

optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onAuxClickCapture

---

onClick?

optional onClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onClick

---

onClickCapture?

optional onClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onClickCapture

---

onContextMenu?

optional onContextMenu: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onContextMenu

---

onContextMenuCapture?

optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onContextMenuCapture

---

onDoubleClick?

optional onDoubleClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onDoubleClick

---

onDoubleClickCapture?

optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onDoubleClickCapture

---

onGotPointerCapture?

optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onGotPointerCapture

---

onGotPointerCaptureCapture?

optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onGotPointerCaptureCapture

---

onLostPointerCapture?

optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onLostPointerCapture

---

onLostPointerCaptureCapture?

optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onLostPointerCaptureCapture

---

onMouseDown?

optional onMouseDown: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseDown

---

onMouseDownCapture?

optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseDownCapture

---

onMouseEnter?

optional onMouseEnter: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseEnter

---

onMouseLeave?

optional onMouseLeave: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseLeave

---

onMouseMove?

optional onMouseMove: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseMove

---

onMouseMoveCapture?

optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseMoveCapture

---

onMouseOut?

optional onMouseOut: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOut

---

onMouseOutCapture?

optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOutCapture

---

onMouseOver?

optional onMouseOver: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOver

---

onMouseOverCapture?

optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOverCapture

---

onMouseUp?

optional onMouseUp: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseUp

---

onMouseUpCapture?

optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseUpCapture

---

onOpenChange()?

optional onOpenChange: (isOpen) => void

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

Parameters

isOpen

boolean

Returns

void

Inherited from

Omit.onOpenChange

---

onPointerCancel?

optional onPointerCancel: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerCancel

---

onPointerCancelCapture?

optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerCancelCapture

---

onPointerDown?

optional onPointerDown: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerDown

---

onPointerDownCapture?

optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerDownCapture

---

onPointerEnter?

optional onPointerEnter: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerEnter

---

onPointerLeave?

optional onPointerLeave: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerLeave

---

onPointerMove?

optional onPointerMove: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerMove

---

onPointerMoveCapture?

optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerMoveCapture

---

onPointerOut?

optional onPointerOut: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOut

---

onPointerOutCapture?

optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOutCapture

---

onPointerOver?

optional onPointerOver: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOver

---

onPointerOverCapture?

optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOverCapture

---

onPointerUp?

optional onPointerUp: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerUp

---

onPointerUpCapture?

optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerUpCapture

---

onScroll?

optional onScroll: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScroll

---

onScrollCapture?

optional onScrollCapture: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScrollCapture

---

onTouchCancel?

optional onTouchCancel: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchCancel

---

onTouchCancelCapture?

optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchCancelCapture

---

onTouchEnd?

optional onTouchEnd: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchEnd

---

onTouchEndCapture?

optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchEndCapture

---

onTouchMove?

optional onTouchMove: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchMove

---

onTouchMoveCapture?

optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchMoveCapture

---

onTouchStart?

optional onTouchStart: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchStart

---

onTouchStartCapture?

optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchStartCapture

---

onTransitionCancel?

optional onTransitionCancel: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionCancel

---

onTransitionCancelCapture?

optional onTransitionCancelCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionCancelCapture

---

onTransitionEnd?

optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionEnd

---

onTransitionEndCapture?

optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionEndCapture

---

onTransitionRun?

optional onTransitionRun: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionRun

---

onTransitionRunCapture?

optional onTransitionRunCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionRunCapture

---

onTransitionStart?

optional onTransitionStart: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionStart

---

onTransitionStartCapture?

optional onTransitionStartCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionStartCapture

---

onWheel?

optional onWheel: WheelEventHandler<HTMLDivElement>

Inherited from

Omit.onWheel

---

onWheelCapture?

optional onWheelCapture: WheelEventHandler<HTMLDivElement>

Inherited from

Omit.onWheelCapture

---

placement?

optional placement: Placement

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

Default

'bottom'

Inherited from

Omit.placement

---

scrollRef?

optional scrollRef: RefObject<Element | null>

A ref for the scrollable region within the overlay.

Default

overlayRef

Inherited from

Omit.scrollRef

---

shouldCloseOnInteractOutside()?

optional shouldCloseOnInteractOutside: (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.

Parameters

element

Element

Returns

boolean

Inherited from

Omit.shouldCloseOnInteractOutside

---

shouldFlip?

optional shouldFlip: boolean

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.

Default

true

Inherited from

Omit.shouldFlip

---

shouldUpdatePosition?

optional shouldUpdatePosition: boolean

Whether the overlay should update its position automatically.

Default

true

Inherited from

Omit.shouldUpdatePosition

---

slot?

optional slot: string | null

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.

Inherited from

Omit.slot

---

style?

optional style: StyleOrFunction<PopoverRenderProps>

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

Inherited from

Omit.style

---

translate?

optional translate: "yes" | "no"

Inherited from

Omit.translate

---

trigger?

optional 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.

Inherited from

Omit.trigger

---

triggerRef?

optional triggerRef: RefObject<Element | null>

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.

Inherited from

Omit.triggerRef

---

UNSTABLE_portalContainer?

optional UNSTABLE_portalContainer: Element

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

Default

document.body

Deprecated

• Use a parent UNSAFE_PortalProvider to set your portal container instead.

Inherited from

Omit.UNSTABLE_portalContainer