Prezentare generală
UtilizațiPopover pentru informații contextuale sau controale simple. Compuneți separat portalul, wrapperul de poziționare și fereastra pop-up. Folosiți Dropdown pentru meniuri, selectoare și panouri cu navigare de nivel superior.
Utilizare
Stare necontrolată
UtilizațidefaultOpen pentru a seta vizibilitatea inițială. Fereastra popover gestionează modificările ulterioare provenite de la declanșatorul său, controalele de închidere și interacțiunile de închidere.
defaultOpen are implicit valoarea false, astfel încât poate fi omis. Utilizați Title și Description pentru a identifica fereastra pop-up. Declanșatorul redă implicit un buton; render vă permite să furnizați un element compatibil.
Comparație de poziționare
Comparați laturile acceptate cu și fără săgeată. Aceste exemple deschise păstrează fiecare fereastră pop-up lângă declanșatorul său pentru inspecție; utilizați exemplul Display pentru a încerca să deschideți și să închideți un popover.Anatomie
Păstrați declanșatorul și fereastra pop-up înPopover.Root. Fereastra pop-up poate conține text, controale de formular și acțiuni.
Toate părțile redate acceptă atributele native Base UI instalate, gestionarele, ref-urile și compunerea
render de elemente/funcții. Componentele personalizate trebuie să redirecționeze proprietățile și ref-ul furnizate. Fiecare parte are un tip public Popover\<Part>Props și Popover\<Part>State. PopoverRootProps și PopoverTriggerProps păstrează genericele de payload. PopoverHandle, PopoverRootActions, PopoverRootChangeEventDetails și PopoverRootChangeEventReason sunt, de asemenea, exportate din twenty-ui/primitives/surfaces.
Stare controlată
Transmitețiopen și actualizați-l cu onOpenChange pentru a gestiona vizibilitatea aceleiași ferestre popover în starea React.
onOpenChange primește următoarea valoare booleană și detaliile evenimentului, inclusiv modificările solicitate de declanșator, controalele de închidere, Escape și interacțiunea din exterior.
Combinare cu butoane
Transmiteți unButton Twenty UI prin render pentru a-l utiliza ca declanșator sau control de închidere. Popoverul își păstrează starea deschisă, comportamentul tastaturii și gestionarea focalizării.
render combină comportamentul cu butonul furnizat. Componentele wrapper personalizate trebuie să transmită mai departe props și ref furnizate pentru a păstra acel comportament.
Poziționare și focalizare
Positioner are implicit side="bottom", align="center" și sideOffset={8}. Acceptă contractul Base UI instalat complet, inclusiv ancore de element/ref/funcție/virtuale, decalaje funcționale, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky și disableAnchorTracking. DirectionProvider controlează poziționarea logică și furnizează direcția DOM. Un dir explicit poate suprascrie atributul nativ; folosiți furnizorul pentru a schimba plasarea logică a laturii.
Popup.initialFocus și Popup.finalFocus acceptă țintele de focalizare și callback-urile upstream. Root.modal păstrează modurile implicit nemodal, modal și de blocare a focalizării din Base UI pentru utilizare independentă.
Destinațiile portalului și tema
Setațicontainer și keepMounted în Portal:
Destinația implicită cu scop delimitat își păstrează tokenurile CSS și schema de culori. O destinație explicită moștenește CSS-ul din scopul său DOM efectiv. Plasați-o în scopul temei intenționate sau furnizați acolo stilurile temei. Țintele ShadowRoot au nevoie de CSS-ul bibliotecii și de stilurile temei în acel arbore shadow. Contextul temei React și direcția de text furnizată rămân disponibile în portaluri. Acest API nu extinde destinațiile de portal permise ale rendererului.
Declanșatoare și payload-uri detașate
Popover.createHandle\<TPayload>() conectează declanșatoarele detașate la o rădăcină și expune open(triggerId), close() și isOpen. Popover.Handle este constructorul de handle upstream instalat. Funcția render a rădăcinii primește payload-ul activ. Apelați acțiunile imperative din gestionarele de evenimente sau efecte.
onOpenChange păstrează reason, event, trigger, cancel() și preventUnmountOnClose(). Rădăcinile controlate păstrează triggerId; rădăcinile necontrolate păstrează defaultTriggerId. actionsRef expune acțiunile upstream de închidere/demontare.
Migrare
Mutațicontainer și keepMounted din Popup în Portal. Mutați proprietățile de plasare, ancoră și coliziune în Positioner. Înlocuiți Popup.arrow cu un copil explicit Popover.Arrow. Proprietățile native, gestionarele, proprietățile de focalizare și ref-ul Popup continuă să vizeze elementul de conținut. Dropdown.Content își păstrează asamblarea convenabilă existentă.
În componentele front-end, folosiți compunerea nemodală în cadrul politicii existente pentru portaluri cu scop delimitat. Popoverele/dialogurile native ale browserului și modalitatea directă deținută de aplicație sunt interzise; folosiți API-ul de dialog al gazdei SDK pentru dialoguri. Lucrul privind capabilitățile rendererului pentru portal, geometrie, derulare și închidere rămâne separat de acest API primitiv.
Proprietăți
Referința este generată din tipurile de componente publice. Atributele native, inclusiv numele accesibile și gestionarii de evenimente, sunt acceptate și pe părțile care redau elemente.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
implicit:"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"
implicit:"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
implicit:"0"
How long to wait before closing the popover that was opened on hover.
Specified in milliseconds.Requires the
openOnHover prop.number
implicit:"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
implicit:"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
implicit:"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
implicit:"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"
implicit:"center"
How to align the popup relative to the specified side.
number | OffsetFunction
implicit:"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
implicit:"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
implicit:"clipping-ancestors"
An element or a rectangle that delimits the area that the popup is confined to.
Padding
implicit:"5"
Additional space to maintain from the edge of the collision boundary.
boolean
implicit:"false"
Whether to disable the popup from tracking any layout shift of its positioning anchor.
"absolute" | "fixed"
implicit:"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"
implicit:"bottom"
Which side of the anchor element to align the popup against.
May automatically change to avoid collisions.
number | OffsetFunction
implicit:"8"
Distance from the anchor. Defaults to 8. Accepts a number or positioning function.
boolean
implicit:"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
implicit:"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.