Popover

Resumen

Usa Popover para información contextual o controles ligeros. Componga su portal, contenedor de posicionamiento y ventana emergente por separado. Use Dropdown para menús, selectores y paneles con navegación de nivel superior.

”Uso”

Estado no controlado

Usa defaultOpen para establecer la visibilidad inicial. El popover gestiona los cambios posteriores de su disparador, controles de cierre e interacciones de descarte.

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 tiene como valor predeterminado false, por lo que se puede omitir. Usa Title y Description para identificar la ventana emergente. El activador muestra un botón de forma predeterminada; render te permite proporcionar un elemento compatible.

Comparación de posiciones

Compara los lados compatibles con y sin flecha. Estos ejemplos abiertos mantienen cada ventana emergente junto a su activador para su inspección; usa el ejemplo Display para intentar abrir y cerrar un popover.

Anatomía

Mantén el activador y la ventana emergente dentro de Popover.Root. La ventana emergente puede contener texto, controles de formulario y acciones.

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

Parte	Propósito y destino nativo
`Root`	Gestiona el estado, los activadores y las interacciones. No representa ningún elemento DOM.
`Disparador`	Abre la ventana emergente y proporciona su ancla predeterminada. Se dirige a un botón.
`Portal`	Elige el destino. Las props nativas, los controladores, `render` y la ref se dirigen a su div.
`Positioner`	Gestiona las anclas, la alineación, los desplazamientos y el manejo de colisiones. Se dirige a su div.
`Popup`	Representa contenido y gestiona el foco. Se dirige a su div.
`Arrow`	Flecha con estilo opcional dentro de Popup. Se dirige a su div.
`Backdrop`	Fondo opcional ascendente dentro de Portal. Se dirige a su div.
`Viewport`	Contenedor de transición opcional para contenido cambiante. Se dirige a su div.
`Título`	Proporciona un nombre accesible visible. Se dirige a un h2.
`Description`	Asocia texto explicativo. Se dirige a un párrafo.
`Cerrar`	Solicita el cierre. Se dirige a un botón.

Todas las partes representadas admiten los atributos nativos, controladores, refs y composición de render de elemento/función de Base UI instalados. Los componentes personalizados deben reenviar las props y la ref proporcionadas. Cada parte tiene un tipo público Popover\<Part>Props y Popover\<Part>State. PopoverRootProps y PopoverTriggerProps conservan los genéricos de carga útil. PopoverHandle, PopoverRootActions, PopoverRootChangeEventDetails y PopoverRootChangeEventReason también se exportan desde twenty-ui/primitives/surfaces.

Estado controlado

Pasa open y actualízalo con onOpenChange para gestionar la visibilidad del mismo popover en el estado de React.

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 recibe el siguiente valor booleano y los detalles del evento, incluidos los cambios solicitados por el disparador, los controles de cierre, Escape y la interacción externa.

Componer con botones

Pasa un Button de Twenty UI mediante render para usarlo como activador o control de cierre. La ventana emergente mantiene su estado abierto, comportamiento del teclado y gestión del foco.

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 compone el comportamiento en el botón proporcionado. Los componentes contenedores personalizados deben reenviar las props y la ref proporcionadas para conservar ese comportamiento.

Ubicación y foco

Positioner tiene como valores predeterminados side="bottom", align="center" y sideOffset={8}. Acepta el contrato completo de Base UI instalado, incluidas las anclas de elemento/ref/función/virtuales, los desplazamientos funcionales, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky y disableAnchorTracking. DirectionProvider controla el posicionamiento lógico y proporciona la dirección DOM. Un dir explícito puede anular el atributo nativo; use el proveedor para cambiar la ubicación del lado lógico.

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 cierra la ventana emergente y restaura el foco en su activador. La interacción externa la descarta de forma predeterminada. Popup.initialFocus y Popup.finalFocus aceptan los destinos de foco y las devoluciones de llamada ascendentes. Root.modal conserva los modos predeterminados no modales, modales y de captura de foco de Base UI para uso independiente.

Destinos del portal y tema

Establezca container y keepMounted en Portal:

Contenedor	Resolución
Omitido o `undefined`	Usa el contenedor ThemeProvider con ámbito más cercano. Sin uno, Base UI usa su portal principal o el cuerpo del documento.
`null`	Espera sin representar contenido del portal hasta que cambie el contenedor. No recurre al tema ni al cuerpo.
Elemento, ShadowRoot o ref	Pasa el destino proporcionado sin cambios a Base UI. Una ref sin resolver conserva el recurso alternativo de portal principal/cuerpo de Base UI; use null explícito cuando sea necesario esperar.

El destino con ámbito predeterminado conserva sus tokens CSS y su esquema de color. Un destino explícito hereda CSS de su ámbito DOM real. Colóquelo dentro del ámbito de tema previsto o proporcione allí los estilos del tema. Los destinos ShadowRoot necesitan el CSS y los estilos del tema de la biblioteca en ese árbol de sombra. El contexto de tema de React y la dirección de texto proporcionada permanecen disponibles a través de los portales. Esta API no amplía los destinos de portal permitidos por el renderizador.

Activadores y cargas útiles desacoplados

Popover.createHandle\<TPayload>() conecta activadores desacoplados a una raíz y expone open(triggerId), close() e isOpen. Popover.Handle es el constructor de identificadores ascendente instalado. La función de renderizado de Root recibe la carga útil activa. Llame a las acciones imperativas desde los controladores de eventos o los efectos.

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 conserva reason, event, trigger, cancel() y preventUnmountOnClose(). Las raíces controladas conservan triggerId; las raíces no controladas conservan defaultTriggerId. actionsRef expone las acciones ascendentes de cierre/desmontaje.

Migración

Mueva container y keepMounted de Popup a Portal. Mueva las props de ubicación, ancla y colisión a Positioner. Sustituya Popup.arrow por un elemento secundario explícito Popover.Arrow. Las props nativas, los controladores, las props de foco y la ref de Popup siguen dirigiéndose al elemento de contenido. Dropdown.Content conserva su ensamblaje práctico existente. Dentro de los componentes frontales, use una composición no modal dentro de la política de portal con ámbito existente. Se prohíben las ventanas emergentes/cuadros de diálogo nativos del navegador y la modalidad directa propiedad de la aplicación; use la API de diálogo del host del SDK para los cuadros de diálogo. El trabajo de capacidad del portal del renderizador, geometría, desplazamiento y descarte permanece separado de esta API primitiva.

”Props”

La referencia se genera a partir de los tipos de componentes públicos. Los atributos nativos, incluidos los nombres accesibles y los controladores de eventos, también se aceptan en las partes que renderizan elementos.

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

predeterminado:"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

predeterminado:"0"

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

number

predeterminado:"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

predeterminado:"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

predeterminado:"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

predeterminado:"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"

predeterminado:"center"

How to align the popup relative to the specified side.

number | OffsetFunction

predeterminado:"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

predeterminado:"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

predeterminado:"clipping-ancestors"

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

Padding

predeterminado:"5"

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

boolean

predeterminado:"false"

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

"absolute" | "fixed"

predeterminado:"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.

predeterminado:"bottom"

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

number | OffsetFunction

predeterminado:"8"

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

boolean

predeterminado:"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

predeterminado:"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.

Desarrolladores

Aplicaciones

API

Autoalojamiento

Contribuir

Biblioteca de IU

Resumen

”Uso”

Estado no controlado

Comparación de posiciones

Anatomía

Estado controlado

Componer con botones

Ubicación y foco

Destinos del portal y tema

Activadores y cargas útiles desacoplados

Migración

”Props”

Popover.Root

Popover.Trigger

Popover.Portal

Popover.Positioner

Popover.Arrow

Popover.Backdrop

Popover.Title

Popover.Description

Popover.Close

Popover.Viewport

​Resumen

​”Uso”

​Estado no controlado

​Comparación de posiciones

​Anatomía

​Estado controlado

​Componer con botones

​Ubicación y foco

​Destinos del portal y tema

​Activadores y cargas útiles desacoplados

​Migración

​”Props”

​Popover.Root

​Popover.Trigger

​Popover.Portal

​Popover.Positioner

​Popover.Popup

​Popover.Arrow

​Popover.Backdrop

​Popover.Title

​Popover.Description

​Popover.Close

​Popover.Viewport

Resumen

”Uso”

Estado no controlado

Comparación de posiciones

Anatomía

Estado controlado

Componer con botones

Ubicación y foco

Destinos del portal y tema

Activadores y cargas útiles desacoplados

Migración

”Props”

Popover.Root

Popover.Trigger

Popover.Portal

Popover.Positioner

Popover.Popup

Popover.Arrow

Popover.Backdrop

Popover.Title

Popover.Description

Popover.Close

Popover.Viewport