Popover

Displays a Popover.

Preview

Code

Usage

import { Popover } from "@/ui/popover";
import { DialogTrigger } from "@/ui/dialog";

<DialogTrigger>
  <Button size="icon">
    <BellIcon />
  </Button>
  <Popover showArrow>your content</Popover>
</DialogTrigger>

API Reference

Name	Type	Default	Description
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.
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	`Element`	`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.
offset	`number`	`8`	The additional offset applied along the main axis between the element and its anchor element.
placement	`Placement`	`bottom`	The placement of the element with respect to its anchor element.
containerPadding	`number`	`12`	The placement padding that should be applied between the element and its surrounding container.
crossOffset	`number`	`0`	The additional offset applied along the cross axis between the element and its anchor element.
shouldFlip	`boolean`	`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.
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.
isKeyboardDismissDisabled	`boolean`	`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.
boundaryElement	`Element`	`document.body`	Element that serves as the positioning boundary.
scrollRef	`RefObject<Element>`	`overlayRef`	A ref for the scrollable region within the overlay.
shouldUpdatePosition	`boolean`	`true`	Whether the overlay should update its position automatically.
arrowBoundaryOffset	`number`	`0`	The minimum distance the arrow's edge should be from the edge of the overlay element.
isOpen	`boolean`	—	Whether the overlay is open by default (controlled).
defaultOpen	`boolean`	—	Whether the overlay is open by default (uncontrolled).
children	`ReactNode \| function`	—	The children of the component. A function may be provided to alter the children based on component state.
className	`string \| function`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
style	`CSSProperties \| function`	—	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
onOpenChange	(isOpen: boolean) => void	Handler that is called when the overlay's open state changes.