Popper API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Popper from '@mui/material/Popper';
// or
import { Popper } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
open*	bool	-	If `true`, the component is shown.
anchorEl	HTML element \| object \| func	-	An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.
children	node \| func	-	Popper render function or node.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
components	{ Root?: elementType }	{}	The components used for each slot inside the Popper. Either a string to use a HTML element or a component. Deprecated－use the `slots` prop instead. This prop will be removed in v7. How to migrate.
componentsProps	{ root?: func \| object }	{}	The props used for each slot inside the Popper. Deprecated－use the `slotProps` prop instead. This prop will be removed in v7. How to migrate.
container	HTML element \| func	-	An HTML element or function that returns one. The `container` will have the portal children appended to it. You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible. By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time.
disablePortal	bool	false	The `children` will be under the DOM hierarchy of the parent component.
keepMounted	bool	false	Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.
modifiers	Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain' \| 'afterRead' \| 'afterWrite' \| 'beforeMain' \| 'beforeRead' \| 'beforeWrite' \| 'main' \| 'read' \| 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>	-	Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers". A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.
placement	'auto-end' \| 'auto-start' \| 'auto' \| 'bottom-end' \| 'bottom-start' \| 'bottom' \| 'left-end' \| 'left-start' \| 'left' \| 'right-end' \| 'right-start' \| 'right' \| 'top-end' \| 'top-start' \| 'top'	'bottom'	Popper placement.
popperOptions	{ modifiers?: array, onFirstUpdate?: func, placement?: 'auto-end' \| 'auto-start' \| 'auto' \| 'bottom-end' \| 'bottom-start' \| 'bottom' \| 'left-end' \| 'left-start' \| 'left' \| 'right-end' \| 'right-start' \| 'right' \| 'top-end' \| 'top-start' \| 'top', strategy?: 'absolute' \| 'fixed' }	{}	Options provided to the `Popper.js` instance.
popperRef	ref	-	A ref that points to the used popper instance.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside the Popper.
slots	{ root?: elementType }	{}	The components used for each slot inside the Popper. Either a string to use a HTML element or a component.
sx	Array<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.
transition	bool	false	Help supporting a react-transition-group/Transition component.

The ref is forwarded to the root element.

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 name	Rule name	Description
.MuiPopper-root	root	Class name applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.