Skip to contents
1.0.0-beta.3GitHub

Popover

An accessible popup anchored to a button.

View as Markdown

Anatomy

Import the component and assemble its parts:

Anatomy

API reference

Root

Groups all parts of the popover. Doesn’t render its own HTML element.

defaultOpen

boolean

(default:

false

)
Name
defaultOpen
Description

Whether the popover is initially open.

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

Type
boolean | undefined
Default

false

open

boolean

Name
open
Description

Whether the popover is currently open.

Type
boolean | undefined
onOpenChange

function

Name
onOpenChange
Description

Event handler called when the popover is opened or closed.

Type
| ((
    open: boolean,
    eventDetails: Popover.Root.ChangeEventDetails,
  ) => void)
| undefined
actionsRef

RefObject<Popover.Root.Actions>

Name
actionsRef
Description

A ref to imperative actions.

  • unmount: When specified, the popover will not be unmounted when closed. Instead, the unmount function must be called to unmount the popover manually. Useful when the popover's animation is controlled by an external library.
Type
React.RefObject<Popover.Root.Actions> | undefined
modal

boolean | 'trap-focus'

(default:

false

)
Name
modal
Description

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.
Type
boolean | 'trap-focus' | undefined
Default

false

onOpenChangeComplete

function

Name
onOpenChangeComplete
Description

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

Type
((open: boolean) => void) | undefined
openOnHover

boolean

(default:

false

)
Name
openOnHover
Description

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

Type
boolean | undefined
Default

false

delay

number

(default:

300

)
Name
delay
Description

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

Requires the openOnHover prop.

Type
number | undefined
Default

300

closeDelay

number

(default:

0

)
Name
closeDelay
Description

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

Requires the openOnHover prop.

Type
number | undefined
Default

0

children

ReactNode

Name
children
Type
React.ReactNode

Trigger

A button that opens the popover. Renders a <button> element.

nativeButton

boolean

(default:

true

)
Name
nativeButton
Description

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>).

Type
boolean | undefined
Default

true

className

string | function

Name
className
Description

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

Type
string | ((state: Popover.Trigger.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Trigger.State,
  ) => ReactElement)
data-popup-open

Present when the corresponding popover is open.

data-pressed

Present when the trigger is pressed.

Backdrop

An overlay displayed beneath the popover. Renders a <div> element.

className

string | function

Name
className
Description

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

Type
| string
| ((state: Popover.Backdrop.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Backdrop.State,
  ) => ReactElement)
data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-starting-style

Present when the popup is animating in.

data-ending-style

Present when the popup is animating out.

Portal

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>.

container

Union

Name
container
Description

A parent element to render the portal element into.

Type
| HTMLElement
| ShadowRoot
| React.RefObject<HTMLElement | ShadowRoot | null>
| null
| undefined
children

ReactNode

Name
children
Type
React.ReactNode
keepMounted

boolean

(default:

false

)
Name
keepMounted
Description

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

Type
boolean | undefined
Default

false

Positioner

Positions the popover against the trigger. Renders a <div> element.

collisionAvoidance

CollisionAvoidance

Name
collisionAvoidance
Description

Determines how to handle collisions when positioning the popup.

Type
| {
    side?: 'none' | 'flip'
    align?: 'shift' | 'none' | 'flip'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| {
    side?: 'shift' | 'none'
    align?: 'shift' | 'none'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| undefined
Example
align

Align

(default:

'center'

)
Name
align
Description

How to align the popup relative to the specified side.

Type
'center' | 'start' | 'end' | undefined
Default

'center'

alignOffset

number | OffsetFunction

(default:

0

)
Name
alignOffset
Description

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.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default

0

Example
side

Side

(default:

'bottom'

)
Name
side
Description

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

Type
| 'top'
| 'bottom'
| 'left'
| 'right'
| 'inline-end'
| 'inline-start'
| undefined
Default

'bottom'

sideOffset

number | OffsetFunction

(default:

0

)
Name
sideOffset
Description

Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance 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.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default

0

Example
arrowPadding

number

(default:

5

)
Name
arrowPadding
Description

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.

Type
number | undefined
Default

5

anchor

Union

Name
anchor
Description

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

Type
| Element
| React.RefObject<Element | null>
| VirtualElement
| (() => Element | VirtualElement | null)
| null
| undefined
collisionBoundary

Boundary

(default:

'clipping-ancestors'

)
Name
collisionBoundary
Description

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

Type
| Element
| 'clipping-ancestors'
| Element[]
| Rect
| undefined
Default

'clipping-ancestors'

collisionPadding

Padding

(default:

5

)
Name
collisionPadding
Description

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

Type
| {
    top?: number
    right?: number
    bottom?: number
    left?: number
  }
| number
| undefined
Default

5

sticky

boolean

(default:

false

)
Name
sticky
Description

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

Type
boolean | undefined
Default

false

positionMethod

'fixed' | 'absolute'

(default:

'absolute'

)
Name
positionMethod
Description

Determines which CSS position property to use.

Type
'fixed' | 'absolute' | undefined
Default

'absolute'

trackAnchor

boolean

(default:

true

)
Name
trackAnchor
Description

Whether the popup tracks any layout shift of its positioning anchor.

Type
boolean | undefined
Default

true

className

string | function

Name
className
Description

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

Type
| string
| ((state: Popover.Positioner.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Positioner.State,
  ) => ReactElement)
data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

--anchor-height

The anchor's height.

--anchor-width

The anchor's width.

--available-height

The available height between the trigger and the edge of the viewport.

--available-width

The available width between the trigger and the edge of the viewport.

--transform-origin

The coordinates that this element is anchored to. Used for animations and transitions.

Popup

A container for the popover contents. Renders a <div> element.

initialFocus

Union

Name
initialFocus
Description

Determines the element to focus when the popover is opened.

  • 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, or false/undefined to do nothing.
Type
| boolean
| React.RefObject<HTMLElement | null>
| ((
    openType: InteractionType,
  ) => boolean | void | HTMLElement | null)
| undefined
finalFocus

Union

Name
finalFocus
Description

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, or false/undefined to do nothing.
Type
| boolean
| React.RefObject<HTMLElement | null>
| ((
    closeType: InteractionType,
  ) => boolean | void | HTMLElement | null)
| undefined
className

string | function

Name
className
Description

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

Type
string | ((state: Popover.Popup.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Popup.State,
  ) => ReactElement)
data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-align

Indicates how the popup is aligned relative to specified side.

data-instant

Present if animations should be instant.

data-side

Indicates which side the popup is positioned relative to the trigger.

data-starting-style

Present when the popup is animating in.

data-ending-style

Present when the popup is animating out.

Arrow

Displays an element positioned against the popover anchor. Renders a <div> element.

className

string | function

Name
className
Description

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

Type
string | ((state: Popover.Arrow.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Arrow.State,
  ) => ReactElement)
data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-uncentered

Present when the popover arrow is uncentered.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

Title

A heading that labels the popover. Renders an <h2> element.

className

string | function

Name
className
Description

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

Type
string | ((state: Popover.Title.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Title.State,
  ) => ReactElement)

Description

A paragraph with additional information about the popover. Renders a <p> element.

className

string | function

Name
className
Description

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

Type
| string
| ((state: Popover.Description.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Description.State,
  ) => ReactElement)

Close

A button that closes the popover. Renders a <button> element.

nativeButton

boolean

(default:

true

)
Name
nativeButton
Description

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>).

Type
boolean | undefined
Default

true

className

string | function

Name
className
Description

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

Type
string | ((state: Popover.Close.State) => string)
render

ReactElement | function

Name
render
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Popover.Close.State,
  ) => ReactElement)