Skip to content
Edit this page

Popover API

The API documentation of the Popover React component. Learn more about the props and the CSS customization points.

import { Popover } from '@material-ui/core';

Props

Name Type Default Description
action func This is callback prop. It's called by the component on mount. This is useful when you want to trigger an action programmatically. It currently only supports updatePosition() action.

Signature:
function(actions: object) => void
actions: This object contains all possible actions that can be triggered programmatically.
anchorEl object
| func		 This is the DOM element, or a function that returns the DOM element, that may be used to set the position of the popover.
anchorOrigin { horizontal: number
| 'left'
| 'center'
| 'right', vertical: number
| 'top'
| 'center'
| 'bottom' }		 { 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'
children node The content of the component.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
container object
| func		 A node, 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.
elevation number 8 The elevation of the popover.
getContentAnchorEl func This 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.
marginThreshold number 16 Specifies how close to the edge of the window the popover can appear.
ModalClasses object classes prop applied to the Modal element.
onClose func Callback fired when the component requests to be closed.

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be:"escapeKeyDown", "backdropClick"
onEnter func Callback fired before the component is entering.
onEntered func Callback fired when the component has entered.
onEntering func Callback fired when the component is entering.
onExit func Callback fired before the component is exiting.
onExited func Callback fired when the component has exited.
onExiting func Callback fired when the component is exiting.
open * bool If true, the popover is visible.
PaperProps { component?: element type } {} Props applied to the Paper element.
transformOrigin { horizontal: number
| 'left'
| 'center'
| 'right', vertical: number
| 'top'
| 'center'
| 'bottom' }		 { 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)].
TransitionComponent elementType Grow The component used for the transition.
transitionDuration number
| { enter?: number, exit?: number }
| 'auto'		 'auto' Set to 'auto' to automatically calculate transition time based on height.
TransitionProps object {} Props applied to the Transition element.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Modal).

CSS

  • Style sheet name: MuiPopover.
  • Style sheet details:
Rule name Global class Description
paper MuiPopover-paper Styles applied to the Paper component.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Modal component are also available. You can take advantage of this behavior to target nested components.

Notes

The component can cause issues in StrictMode.

Demos