Skip to content
Edit this page

Portal API

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

Import

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

Portals provide a first-class way to render children into a DOM node that exists outside the DOM hierarchy of the parent component.

Props

NameTypeDefaultDescription
childrennode
The children to render into the container.
containerHTML element
| func
An HTML element or function that returns one. The container will have the portal children appended to it.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time.
disablePortalboolfalse
The children will be under the DOM hierarchy of the parent component.

The component cannot hold a ref.

Demos