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

Popper

The Popper component lets you create tooltips and popovers that display information about an element on the page.

Component demosComponents API

Popper API

Import

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
open*bool-

If true, the component is shown.

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

childrennode
| func		-

Popper render function or node.

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

direction'ltr'
| 'rtl'		'ltr'

Direction of the text.

disablePortalboolfalse

The children will be under the DOM hierarchy of the parent component.

keepMountedboolfalse

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.

modifiersArray<{ 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.

popperRefref-

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.

See Slots API below for more details.

transitionboolfalse

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 nameDescription
.base-Popper-rootClass name applied to the root element.