Skip to content
Influence Material UI's 2024 roadmap! Participate in the latest Developer Survey

Popover API

API reference docs for the React Popover component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import Popover from '@mui/material/Popover';
// or
import { Popover } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Modal component are also available.

NameTypeDefaultDescription
open*bool-

If true, the component is shown.

actionref-

A ref for imperative actions. It currently only supports updatePosition() action.

anchorElHTML element
| func		-

An HTML element, PopoverVirtualElement, or a function that returns either. It's used to set the position of the popover.

anchorOrigin{ horizontal: 'center'
| 'left'
| 'right'
| number, vertical: 'bottom'
| 'center'
| 'top'
| number }		{ vertical: 'top', horizontal: 'left', }

This is the point on the anchor where the popover's anchorEl will attach to. This is not used when the anchorReference is 'anchorPosition'.
Options: vertical: [top, center, bottom]; horizontal: [left, center, right].

anchorPosition{ left: number, top: number }-

This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.

anchorReference'anchorEl'
| 'anchorPosition'
| 'none'		'anchorEl'

This determines which anchor prop to refer to when setting the position of the popover.

childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

containerHTML element
| func		-

An HTML element, component instance, or function that returns either. The container will passed to the Modal component.
By default, it uses the body of the anchorEl's top-level document object, so it's simply document.body most of the time.

disableScrollLockboolfalse

Disable the scroll lock behavior.

elevationinteger8

The elevation of the popover.

marginThresholdnumber16

Specifies how close to the edge of the window the popover can appear. If null, the popover will not be constrained by the window.

onClosefunc-

Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

PaperProps{ component?: element type }{}

Props applied to the Paper element.
This prop is an alias for slotProps.paper and will be overriden by it if both are used.

slotProps{ paper?: func
| object, root?: func
| object }		{}

The extra props for the slot components. You can override the existing props or add new ones.

slots{ paper?: elementType, root?: elementType }{}

The components used for each slot inside.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

transformOrigin{ horizontal: 'center'
| 'left'
| 'right'
| number, vertical: 'bottom'
| 'center'
| 'top'
| number }		{ vertical: 'top', horizontal: 'left', }

This is the point on the popover which will attach to the anchor's origin.
Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)].

TransitionComponentelementTypeGrow

The component used for the transition. Follow this guide to learn more about the requirements for this component.

transitionDuration'auto'
| number
| { appear?: number, enter?: number, exit?: number }		'auto'

Set to 'auto' to automatically calculate transition time based on height.

TransitionPropsobject{}

Props applied to the transition element. By default, the element is based on this Transition component.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Modal component are also available in Popover. You can take advantage of this to target nested components.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiPopover-paperpaperStyles applied to the Paper component.
.MuiPopover-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options: