A popover component. Should be used with the usePopup hook to manage visibility state.

Parameters:
NameTypeDescription
propsobject

Component props.

Properties
NameTypeDescription
alignstring

The alignment of the popover, used with placement, one of left, right, 'top', or 'bottom'. if placement is top or bottom, align controls horizontal alignment. if placement is left or right, align controls vertical alignment.

autoPlacementboolean

Whether to autoplace the popover based on the trigger element.

childrenJSX.Element

The popover content.

containerRefobject | null

Ref to the container element.

customAttributesobject

Custom attributes for the component.

customClassesstring | Array | object

Custom classes for the component.

isHideboolean

Whether the popover is hidden.

isOpenboolean

Whether the popover is open.

isRevealboolean

Whether the popover is revealed.

placementstring

The placement of the popover, one of top, bottom, left, or right.

popoverAttributesobject

Custom attributes for the popover element.

popoverClassesstring | Array | object

Custom classes for the popover element.

popoverRefobject | null

Ref to the popover element.

triggerRefobject | null

Ref to the trigger element.

widthnumber

The width of the popover in pixels.

refobject | null

Ref to the component.

Since
  • 6.0.1
Source
Returns:

The popover component.

Type: 
JSX.Element