Popover

Use Popover for contextual information or lightweight controls. Compose its portal, positioning wrapper and popup separately. Use Dropdown for menus, pickers and panels with higher-level navigation.

Usage

Uncontrolled state

Use defaultOpen to set the initial visibility. The popover owns subsequent changes from its trigger, close controls, and dismissal interactions.

import { Button } from 'twenty-ui/primitives/input';
import { Popover } from 'twenty-ui/primitives/surfaces';

export const ContactDetailsPopover = () => (
  <Popover.Root defaultOpen={false}>
    <Popover.Trigger render={<Button>Show details</Button>} />
    <Popover.Portal>
      <Popover.Positioner align="start">
        <Popover.Popup
          style={{ boxSizing: 'border-box', width: 260, padding: 16, gap: 12 }}
        >
          <Popover.Title>Contact details</Popover.Title>
          <Popover.Description>
            Reach Alex at alex@example.com.
          </Popover.Description>
          <Popover.Close
            style={{ alignSelf: 'flex-end' }}
            render={<Button size="sm">Close</Button>}
          />
        </Popover.Popup>
      </Popover.Positioner>
    </Popover.Portal>
  </Popover.Root>
);

defaultOpen defaults to false, so it can be omitted. Use Title and Description to identify the popup. The trigger renders a button by default; render lets you supply a compatible element.

Placement comparison

Compare the supported sides with and without an arrow. These open examples keep each popup beside its trigger for inspection; use the Display example to try opening and dismissing a popover.

Anatomy

Keep the trigger and popup inside Popover.Root. The popup can contain text, form controls, and actions.

Popover.Root
├── Popover.Trigger
└── Popover.Portal
    ├── Popover.Backdrop (optional)
    └── Popover.Positioner
        └── Popover.Popup
            ├── Popover.Arrow (optional)
            └── Popover.Viewport (optional)
                ├── Popover.Title
                ├── Popover.Description
                └── Popover.Close

Part	Purpose and native target
`Root`	Owns state, triggers and interactions. Renders no DOM element.
`Trigger`	Opens the popup and supplies its default anchor. Targets a button.
`Portal`	Chooses the destination. Native props, handlers, `render` and ref target its div.
`Positioner`	Owns anchors, alignment, offsets and collision handling. Targets its div.
`Popup`	Renders content and manages focus. Targets its div.
`Arrow`	Optional styled arrow inside Popup. Targets its div.
`Backdrop`	Optional upstream backdrop inside Portal. Targets its div.
`Viewport`	Optional transition container for changing content. Targets its div.
`Title`	Supplies a visible accessible name. Targets an h2.
`Description`	Associates explanatory text. Targets a paragraph.
`Close`	Requests closing. Targets a button.

All rendered parts support the installed Base UI native attributes, handlers, refs and element/function render composition. Custom components must forward the supplied props and ref. Every part has a public Popover<Part>Props and Popover<Part>State type. PopoverRootProps and PopoverTriggerProps preserve payload generics. PopoverHandle, PopoverRootActions, PopoverRootChangeEventDetails and PopoverRootChangeEventReason are also exported from twenty-ui/primitives/surfaces.

Controlled state

Pass open and update it with onOpenChange to own the same popover’s visibility in React state.

import { useState } from 'react';
import { Button } from 'twenty-ui/primitives/input';
import { Popover } from 'twenty-ui/primitives/surfaces';

export const ContactDetailsPopover = () => {
  const [open, setOpen] = useState(false);

  return (
    <Popover.Root open={open} onOpenChange={setOpen}>
      <Popover.Trigger render={<Button>Show details</Button>} />
      <Popover.Portal>
        <Popover.Positioner align="start">
          <Popover.Popup
            style={{
              boxSizing: 'border-box',
              width: 260,
              padding: 16,
              gap: 12,
            }}
          >
            <Popover.Title>Contact details</Popover.Title>
            <Popover.Description>
              Reach Alex at alex@example.com.
            </Popover.Description>
            <Popover.Close
              style={{ alignSelf: 'flex-end' }}
              render={<Button size="sm">Close</Button>}
            />
          </Popover.Popup>
        </Popover.Positioner>
      </Popover.Portal>
    </Popover.Root>
  );
};

onOpenChange receives the next boolean and event details, including changes requested by the trigger, close controls, Escape, and outside interaction.

Compose with buttons

Pass a Twenty UI Button through render to use it as the trigger or close control. The popover keeps its open state, keyboard behavior, and focus handling.

import { Button } from 'twenty-ui/primitives/input';
import { Popover } from 'twenty-ui/primitives/surfaces';

export const ImportHelp = () => (
  <Popover.Root>
    <Popover.Trigger render={<Button variant="outline">Import help</Button>} />
    <Popover.Portal>
      <Popover.Positioner align="start">
        <Popover.Popup
          style={{ boxSizing: 'border-box', width: 260, padding: 16, gap: 12 }}
        >
          <Popover.Arrow />
          <Popover.Title>Import a CSV file</Popover.Title>
          <Popover.Description>
            Use a header row to identify your columns.
          </Popover.Description>
          <Popover.Close
            style={{ alignSelf: 'flex-end' }}
            render={<Button size="sm">Got it</Button>}
          />
        </Popover.Popup>
      </Popover.Positioner>
    </Popover.Portal>
  </Popover.Root>
);

render composes behavior onto the supplied button. Custom wrapper components must forward the supplied props and ref to preserve that behavior.

Placement and focus

Positioner defaults to side="bottom", align="center" and sideOffset={8}. It accepts the full installed Base UI contract, including element/ref/function/virtual anchors, functional offsets, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky and disableAnchorTracking. DirectionProvider controls logical positioning and supplies the DOM direction. An explicit dir can override the native attribute; use the provider to change logical side placement.

import { useRef } from 'react';
import { Popover } from 'twenty-ui/primitives/surfaces';

export const AnchoredHelp = () => {
  const anchor = useRef<HTMLDivElement>(null);

  return (
    <div ref={anchor}>
      <Popover.Root>
        <Popover.Trigger>Help</Popover.Trigger>
        <Popover.Portal>
          <Popover.Positioner
            anchor={anchor}
            side="inline-end"
            align="start"
            sideOffset={({ anchor }) => anchor.width / 2}
            collisionBoundary="clipping-ancestors"
            collisionAvoidance={{ side: 'flip', align: 'shift' }}
            collisionPadding={8}
            positionMethod="fixed"
          >
            <Popover.Popup aria-label="Help">
              <Popover.Arrow />
              Contextual help
            </Popover.Popup>
          </Popover.Positioner>
        </Popover.Portal>
      </Popover.Root>
    </div>
  );
};

Escape closes the popup and restores focus to its trigger. Outside interaction dismisses it by default. Popup.initialFocus and Popup.finalFocus accept the upstream focus targets and callbacks. Root.modal retains Base UI’s nonmodal default, modal and trap-focus modes for standalone usage.

Portal destinations and theme

Set container and keepMounted on Portal:

Container	Resolution
Omitted or `undefined`	Uses the nearest scoped ThemeProvider container. Without one, Base UI uses its parent portal or document body.
`null`	Waits without rendering portal content until the container changes. It does not fall back to the theme or body.
Element, ShadowRoot or ref	Passes the supplied target unchanged to Base UI. An unresolved ref retains Base UI’s parent-portal/body fallback; use explicit null when waiting is required.

The default scoped destination preserves its CSS tokens and color scheme. An explicit destination inherits CSS from its actual DOM scope. Put it inside the intended theme scope, or supply the theme styles there. ShadowRoot targets need the library’s CSS and theme styles in that shadow tree. React theme context and provided text direction remain available across portals. This API does not expand the renderer’s permitted portal destinations.

Detached triggers and payloads

Popover.createHandle<TPayload>() connects detached triggers to a root and exposes open(triggerId), close() and isOpen. Popover.Handle is the installed upstream handle constructor. Root’s render function receives the active payload. Call imperative actions from event handlers or effects.

import { useState } from 'react';
import { Popover } from 'twenty-ui/primitives/surfaces';

export const OwnerHelp = () => {
  const [handle] = useState(() => Popover.createHandle<{ name: string }>());

  return (
    <>
      <Popover.Trigger handle={handle} id="owner" payload={{ name: 'Alice' }}>
        Owner
      </Popover.Trigger>
      <Popover.Root handle={handle}>
        {({ payload }) => (
          <Popover.Portal>
            <Popover.Positioner align="start">
              <Popover.Popup aria-label="Account owner">
                {payload?.name}
                <Popover.Close>Close</Popover.Close>
              </Popover.Popup>
            </Popover.Positioner>
          </Popover.Portal>
        )}
      </Popover.Root>
    </>
  );
};

onOpenChange preserves reason, event, trigger, cancel() and preventUnmountOnClose(). Controlled roots retain triggerId; uncontrolled roots retain defaultTriggerId. actionsRef exposes the upstream close/unmount actions.

Migration

Move container and keepMounted from Popup to Portal. Move placement, anchor and collision props to Positioner. Replace Popup.arrow with an explicit Popover.Arrow child. Popup’s native props, handlers, focus props and ref continue to target the content element. Dropdown.Content keeps its existing convenient assembly. Inside front components, use nonmodal composition within the existing scoped portal policy. Native browser popovers/dialogs and direct app-owned modality are prohibited; use the SDK host dialog API for dialogs. Renderer portal, geometry, scrolling and dismissal capability work remains separate from this primitive API.

Props

The reference is generated from the public component types. Native attributes, including accessible names and event handlers, are also accepted on parts that render elements.

RefObject<PopoverRootActions | null>

A ref to imperative actions.

unmount: Ends the closing phase of the popover after an externally controlled closing animation finishes. Call preventUnmountOnClose() in onOpenChange first, otherwise the popover completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.
close: Closes the popover imperatively when called.

ReactNode | PayloadChildRenderFunction<Payload>

Parts or a render function receiving the active trigger payload. Root renders no DOM element.

boolean

default:"false"

Whether the popover is initially open.To render a controlled popover, use the open prop instead.

string | null

ID of the trigger that the popover is associated with. This is useful in conjunction with the defaultOpen prop to create an initially open popover.

PopoverHandle<Payload>

Connects detached triggers and imperative open/close actions.

Determines if the popover enters a modal state when open.

true: user interaction is limited to the popover: document page scroll is locked, and pointer interactions on outside elements are disabled.
false: user interaction with the rest of the document is allowed.
'trap-focus': focus is trapped inside the popover, but document page scroll is not locked and pointer interactions outside of it remain enabled.

On touch devices, a true modal blocks outside taps but leaves the page scrollable unless the popup spans nearly the full viewport width, matching native iOS behavior.When modal is true, focus trapping is enabled only if <Popover.Close> is rendered inside <Popover.Popup>. It can be visually hidden with your own CSS if needed, such as Tailwind’s sr-only utility.When modal is 'trap-focus', render <Popover.Close> inside <Popover.Popup> so touch screen readers can escape the popup.

((open: boolean, eventDetails: PopoverRootChangeEventDetails) => void)

Receives the requested open state and Base UI event details, including reason, event, trigger, cancel() and preventUnmountOnClose().

((open: boolean) => void)

Event handler called after any animations complete when the popover is opened or closed.

boolean

Whether the popover is currently open.

string | null

ID of the trigger that the popover is associated with. This is useful in conjunction with the open prop to create a controlled popover. There’s no need to specify this prop when the popover is uncontrolled (that is, when the open prop is not set).

Popover.Trigger

string | ((state: PopoverTriggerState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

number

default:"0"

How long to wait before closing the popover that was opened on hover. Specified in milliseconds.Requires the openOnHover prop.

number

default:"300"

How long to wait before the popover may be opened on hover. Specified in milliseconds.Requires the openOnHover prop.

PopoverHandle<Payload>

A handle to associate the trigger with a popover.

string

ID of the trigger. In addition to being forwarded to the rendered element, it is also used to specify the active trigger for the popover in controlled mode (with the PopoverRoot triggerId prop).

boolean

default:"true"

Whether the component renders a native <button> element when replacing it via the render prop. Set to false if the rendered element is not a button (e.g. <div>).

boolean

default:"false"

Whether the popover should also open when the trigger is hovered.

Payload

A payload to pass to the popover when it is opened.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverTriggerState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverTriggerState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverPortalState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

When omitted, uses the scoped theme container, then the Base UI parent portal or document body. Explicit null delays rendering until a target is supplied. Explicit elements, ShadowRoots and refs are forwarded unchanged; their DOM scope supplies CSS tokens.

boolean

default:"false"

Whether to keep the portal mounted in the DOM while the popup is hidden.

Ref<HTMLDivElement>

Ref to the portal div. Native props, handlers and render target this element.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverPortalState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverPortalState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

"center" | "end" | "start"

default:"center"

How to align the popup relative to the specified side.

number | OffsetFunction

default:"0"

Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment.The function takes a data object parameter with the following properties:

data.anchor: the dimensions of the anchor element with properties width and height.
data.positioner: the dimensions of the positioner element with properties width and height.
data.side: which side of the anchor element the positioner is aligned against.
data.align: how the positioner is aligned relative to the specified side.

An element to position the popup against. By default, the popup will be positioned against the trigger.

number

default:"5"

Minimum distance to maintain between the arrow and the edges of the popup.Use it to prevent the arrow element from hanging out of the rounded corners of a popup.

string | ((state: PopoverPositionerState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

CollisionAvoidance

Determines how to handle collisions when positioning the popup.side controls overflow on the preferred placement axis (top/bottom or left/right):

'flip': keep the requested side when it fits; otherwise try the opposite side (top and bottom, or left and right).
'shift': never change side; keep the requested side and move the popup within the clipping boundary so it stays visible.
'none': do not correct side-axis overflow.

align controls overflow on the alignment axis (start/center/end):

'flip': keep side, but swap start and end when the requested alignment overflows.
'shift': keep side and requested alignment, then nudge the popup along the alignment axis to fit.
'none': do not correct alignment-axis overflow.

fallbackAxisSide controls fallback behavior on the perpendicular axis when the preferred axis cannot fit:

'start': allow perpendicular fallback and try the logical start side first (top before bottom, or left before right in LTR).
'end': allow perpendicular fallback and try the logical end side first (bottom before top, or right before left in LTR).
'none': do not fallback to the perpendicular axis.

When side is 'shift', explicitly setting align only supports 'shift' or 'none'. If align is omitted, it defaults to 'flip'.

Boundary

default:"clipping-ancestors"

An element or a rectangle that delimits the area that the popup is confined to.

Padding

default:"5"

Additional space to maintain from the edge of the collision boundary.

boolean

default:"false"

Whether to disable the popup from tracking any layout shift of its positioning anchor.

"absolute" | "fixed"

default:"absolute"

Determines which CSS position property to use.

Ref<HTMLDivElement>

Ref to the positioning div. Accepts the complete Base UI anchor, collision and positioning contract.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverPositionerState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

default:"bottom"

Which side of the anchor element to align the popup against. May automatically change to avoid collisions.

number | OffsetFunction

default:"8"

Distance from the anchor. Defaults to 8. Accepts a number or positioning function.

boolean

default:"false"

Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.

CSSProperties | ((state: PopoverPositionerState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Popup content. Compose Portal, Positioner and Arrow separately.

CSS class applied to the element, or a function that returns a class based on the component’s state.

Determines the element to focus when the popover is closed.

false: Do not move focus.
true: Move focus based on the default behavior (trigger or previously focused element).
RefObject: Move focus to the ref element.
function: Called with the interaction type (mouse, touch, pen, or keyboard). Return an element to focus, true to use the default behavior, null to fall back to the default behavior, or false/undefined to do nothing.

Determines the element to focus when the popover is opened. By default, focus moves to the first tabbable element inside the popup, except when the popover is opened by touch — then the popup itself is focused to avoid opening the virtual keyboard.

false: Do not move focus.
true: Move focus based on the default behavior (first tabbable element or popup).
RefObject: Move focus to the ref element.
function: Called with the interaction type (mouse, touch, pen, or keyboard). Return an element to focus, true to use the default behavior, null to fall back to the default behavior, or false/undefined to do nothing.

Ref to the popup div. Focus props, native attributes, handlers and render target this element.

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverArrowState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

Ref<HTMLDivElement>

Ref to the arrow div. Compose inside Popup.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverArrowState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverArrowState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverBackdropState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

Ref<HTMLDivElement>

Ref to the optional backdrop div. Compose inside Portal.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverBackdropState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverBackdropState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverTitleState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverTitleState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverTitleState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverDescriptionState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverDescriptionState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverDescriptionState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

string | ((state: PopoverCloseState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

boolean

default:"true"

Whether the component renders a native <button> element when replacing it via the render prop. Set to false if the rendered element is not a button (for example, <div>).

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverCloseState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverCloseState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

ReactNode

The content to render inside the transition container.

string | ((state: PopoverViewportState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

Ref<HTMLDivElement>

Ref to the content-transition div for changing trigger payloads.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverViewportState>

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.Accepts a ReactElement or a function that returns the element to render.

CSSProperties | ((state: PopoverViewportState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Overview

Apps

API

Self-Host

Contribute

UI Library

Usage

Uncontrolled state

Placement comparison

Anatomy

Controlled state

Compose with buttons

Placement and focus

Portal destinations and theme

Detached triggers and payloads

Migration

Props

Popover.Root

Popover.Trigger

Popover.Portal

Popover.Positioner

Popover.Arrow

Popover.Backdrop

Popover.Title

Popover.Description

Popover.Close

Popover.Viewport

​Usage

​Uncontrolled state

​Placement comparison

​Anatomy

​Controlled state

​Compose with buttons

​Placement and focus

​Portal destinations and theme

​Detached triggers and payloads

​Migration

​Props

​Popover.Root

​Popover.Trigger

​Popover.Portal

​Popover.Positioner

​Popover.Popup

​Popover.Arrow

​Popover.Backdrop

​Popover.Title

​Popover.Description

​Popover.Close

​Popover.Viewport

Usage

Uncontrolled state

Placement comparison

Anatomy

Controlled state

Compose with buttons

Placement and focus

Portal destinations and theme

Detached triggers and payloads

Migration

Props

Popover.Root

Popover.Trigger

Popover.Portal

Popover.Positioner

Popover.Popup

Popover.Arrow

Popover.Backdrop

Popover.Title

Popover.Description

Popover.Close

Popover.Viewport