Panoramica
UsaPopover per informazioni contestuali o controlli leggeri. Componi separatamente il relativo portale, wrapper di posizionamento e popup. Usa Dropdown per menu, selettori e pannelli con navigazione di livello superiore.
Utilizzo
Stato non controllato
UsadefaultOpen per impostare la visibilità iniziale. Il popover gestisce le modifiche successive provenienti dal relativo trigger, dai controlli di chiusura e dalle interazioni di chiusura.
defaultOpen è impostato su false per impostazione predefinita, quindi può essere omesso. Usa Title e Description per identificare il popup. Per impostazione predefinita, il trigger esegue il rendering di un pulsante; render consente di fornire un elemento compatibile.
Confronto del posizionamento
Confronta i lati supportati con e senza freccia. Questi esempi aperti mantengono ogni popup accanto al relativo trigger per l’ispezione; usa l’esempio Display per provare ad aprire e chiudere un popover.Anatomia
Mantieni l’attivatore e il popup all’interno diPopover.Root. Il popup può contenere testo, controlli del modulo e azioni.
Tutte le parti sottoposte a rendering supportano gli attributi nativi, gli handler, i ref e la composizione
render di elementi/funzioni di Base UI installata. I componenti personalizzati devono inoltrare le props e il ref forniti. Ogni parte ha un tipo pubblico Popover\<Part>Props e Popover\<Part>State. PopoverRootProps e PopoverTriggerProps mantengono i generici del payload. Anche PopoverHandle, PopoverRootActions, PopoverRootChangeEventDetails e PopoverRootChangeEventReason vengono esportati da twenty-ui/primitives/surfaces.
Stato controllato
Passaopen e aggiornalo con onOpenChange per gestire la visibilità dello stesso popover nello stato di React.
onOpenChange riceve il valore booleano successivo e i dettagli dell’evento, incluse le modifiche richieste dal trigger, dai controlli di chiusura, da Escape e dall’interazione esterna.
Componi con i pulsanti
Passa unButton di Twenty UI tramite render per utilizzarlo come attivatore o controllo di chiusura. Il popover mantiene il proprio stato di apertura, il comportamento della tastiera e la gestione del focus.
render compone il comportamento sul pulsante fornito. I componenti wrapper personalizzati devono inoltrare le props e il ref forniti per preservare tale comportamento.
Posizionamento e focus
Per impostazione predefinita,Positioner usa side="bottom", align="center" e sideOffset={8}. Accetta il contratto completo di Base UI installata, inclusi ancoraggi elemento/ref/funzione/virtuali, offset funzionali, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky e disableAnchorTracking. DirectionProvider controlla il posizionamento logico e fornisce la direzione DOM. Un dir esplicito può sovrascrivere l’attributo nativo; usa il provider per modificare il posizionamento logico laterale.
Popup.initialFocus e Popup.finalFocus accettano le destinazioni dello stato attivo e i callback upstream. Root.modal mantiene le modalità predefinita non modale, modale e di intrappolamento dello stato attivo di Base UI per l’uso autonomo.
Destinazioni del portale e tema
Impostacontainer e keepMounted su Portal:
La destinazione con ambito predefinita conserva i relativi token CSS e schema di colori. Una destinazione esplicita eredita il CSS dal relativo ambito DOM effettivo. Inseriscila nell’ambito del tema previsto oppure fornisci lì gli stili del tema. Le destinazioni ShadowRoot richiedono il CSS della libreria e gli stili del tema in tale albero shadow. Il contesto del tema React e la direzione del testo fornita restano disponibili attraverso i portali. Questa API non estende le destinazioni del portale consentite dal renderer.
Trigger e payload separati
Popover.createHandle\<TPayload>() collega trigger separati a una root ed espone open(triggerId), close() e isOpen. Popover.Handle è il costruttore di handle upstream installato. La funzione di rendering della root riceve il payload attivo. Chiama le azioni imperative dagli handler di eventi o dagli effetti.
onOpenChange mantiene reason, event, trigger, cancel() e preventUnmountOnClose(). Le root controllate mantengono triggerId; le root non controllate mantengono defaultTriggerId. actionsRef espone le azioni upstream di chiusura/smontaggio.
Migrazione
Spostacontainer e keepMounted da Popup a Portal. Sposta le props di posizionamento, ancoraggio e collisione in Positioner. Sostituisci Popup.arrow con un elemento figlio Popover.Arrow esplicito. Le props native, gli handler, le props dello stato attivo e il ref di Popup continuano ad avere come destinazione l’elemento contenuto. Dropdown.Content mantiene il relativo pratico assemblaggio esistente.
All’interno dei componenti front, usa una composizione non modale nell’ambito della policy dei portali esistente. I popover/dialog nativi del browser e la modalità gestita direttamente dall’app sono vietati; usa l’API delle finestre di dialogo dell’host SDK per le finestre di dialogo. Il lavoro sulle funzionalità del renderer per portale, geometria, scorrimento e chiusura rimane separato da questa API primitiva.
Props
Il riferimento viene generato dai tipi di componenti pubblici. Gli attributi nativi, inclusi i nomi accessibili e i gestori di eventi, sono accettati anche nelle parti che eseguono il rendering di elementi.Popover.Root
RefObject<PopoverRootActions | null>
A ref to imperative actions.
unmount: Ends the closing phase of the popover after an externally controlled closing animation finishes. CallpreventUnmountOnClose()inonOpenChangefirst, otherwise the popover completes closing on its own. Whether it leaves the DOM is decided bykeepMountedon 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
predefinito:"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.
boolean | "trap-focus"
predefinito:"false"
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.
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
predefinito:"0"
How long to wait before closing the popover that was opened on hover.
Specified in milliseconds.Requires the
openOnHover prop.number
predefinito:"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
predefinito:"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
predefinito:"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.
Popover.Portal
string | ((state: PopoverPortalState) => string | undefined)
CSS class applied to the element, or a function that
returns a class based on the component’s state.
HTMLElement | ShadowRoot | RefObject<HTMLElement | ShadowRoot | null> | null
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
predefinito:"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.
Popover.Positioner
"center" | "end" | "start"
predefinito:"center"
How to align the popup relative to the specified side.
number | OffsetFunction
predefinito:"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 propertieswidthandheight.data.positioner: the dimensions of the positioner element with propertieswidthandheight.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.
Element | VirtualElement | RefObject<Element | null> | (() => Element | VirtualElement | null) | null
An element to position the popup against.
By default, the popup will be positioned against the trigger.
number
predefinito:"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 (topandbottom, orleftandright).'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 swapstartandendwhen 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 (topbeforebottom, orleftbeforerightin LTR).'end': allow perpendicular fallback and try the logical end side first (bottombeforetop, orrightbeforeleftin LTR).'none': do not fallback to the perpendicular axis.
side is 'shift', explicitly setting align only supports 'shift' or 'none'.
If align is omitted, it defaults to 'flip'.Boundary
predefinito:"clipping-ancestors"
An element or a rectangle that delimits the area that the popup is confined to.
Padding
predefinito:"5"
Additional space to maintain from the edge of the collision boundary.
boolean
predefinito:"false"
Whether to disable the popup from tracking any layout shift of its positioning anchor.
"absolute" | "fixed"
predefinito:"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."bottom" | "inline-end" | "inline-start" | "left" | "right" | "top"
predefinito:"bottom"
Which side of the anchor element to align the popup against.
May automatically change to avoid collisions.
number | OffsetFunction
predefinito:"8"
Distance from the anchor. Defaults to 8. Accepts a number or positioning function.
boolean
predefinito:"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.
Popover.Popup
ReactNode
Popup content. Compose Portal, Positioner and Arrow separately.
string | ((state: PopoverPopupState) => string | undefined)
CSS class applied to the element, or a function that
returns a class based on the component’s state.
boolean | RefObject<HTMLElement | null> | ((closeType: InteractionType) => boolean | void | HTMLElement | null)
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, orkeyboard). Return an element to focus,trueto use the default behavior,nullto fall back to the default behavior, orfalse/undefinedto do nothing.
boolean | RefObject<HTMLElement | null> | ((openType: InteractionType) => boolean | void | HTMLElement | null)
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, orkeyboard). Return an element to focus,trueto use the default behavior,nullto fall back to the default behavior, orfalse/undefinedto do nothing.
Ref<HTMLDivElement>
Ref to the popup div. Focus props, native attributes, handlers and render target this element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, PopoverPopupState>
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: PopoverPopupState) => CSSProperties | undefined)
Style applied to the element, or a function that
returns a style object based on the component’s state.
Popover.Arrow
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.
Popover.Backdrop
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.
Popover.Title
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.
Popover.Description
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.
Popover.Close
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
predefinito:"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.
Popover.Viewport
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.