Skip to content

Popover API

API documentation for the React Popover component. Learn about the available props, and the CSS API.

Import

import Popover from '@material-ui/core/Popover';
// or
import { Popover } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiPopover can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
actionrefA ref for imperative actions. It currently only supports updatePosition() action.
anchorElHTML element
| func
An HTML element, or a function that returns one. 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.
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS 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.
elevationnumber8The elevation of the popover.
getContentAnchorElfuncThis function is called in order to retrieve the content anchor element. It's the opposite of the anchorEl prop. The content anchor element should be an element inside the popover. It's used to correctly scroll and set the position of the popover. The positioning strategy tries to make the content anchor element just above the anchor element.
marginThresholdnumber16Specifies how close to the edge of the window the popover can appear.
onClosefuncCallback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.
open*boolfalseIf true, the component is shown.
PaperProps{ component?: element type }{}Props applied to the Paper element.
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)].
TransitionComponentelementTypeGrowThe 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.
Any other props supplied will be provided to the root element (Modal).

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiPopover-rootStyles applied to the root element.
paper.MuiPopover-paperStyles applied to the Paper component.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos