materialuiupgraded/pages/api/portal.md

Material-UI's workspace package

---
filename: /packages/material-ui/src/Portal/Portal.js
title: Portal API
---

<!--- This documentation is automatically generated, do not try to edit it. -->

# Portal

<p class="description">The API documentation of the Portal React component. Learn more about the properties and the CSS customization points.</p>

```js
import Portal from '@material-ui/core/Portal';
```

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

## Props

| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| <span class="prop-name required">children *</span> | <span class="prop-type">node |   | The children to render into the `container`. |
| <span class="prop-name">container</span> | <span class="prop-type">union:&nbsp;object&nbsp;&#124;<br>&nbsp;func<br> |   | A node, component instance, or function that returns either. 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. |
| <span class="prop-name">disablePortal</span> | <span class="prop-type">bool | <span class="prop-default">false</span> | Disable the portal behavior. The children stay within it's parent DOM hierarchy. |
| <span class="prop-name">onRendered</span> | <span class="prop-type">func |   | Callback fired once the children has been mounted into the `container`. |

Any other properties supplied will be spread to the root element (native element).

## Demos

- [Portal](/utils/portal/)