@activelylearn/material-ui
Version:
Material-UI's workspace package
28 lines (18 loc) • 1.25 kB
Markdown
---
filename: /packages/material-ui/src/Portal/Portal.js
---
<!--- This documentation is automatically generated, do not try to edit it. -->
# Portal
This component shares many concepts with
[react-overlays](https://react-bootstrap.github.io/react-overlays/#portals)
But has been forked in order to fix some bugs, reduce the number of dependencies
and take the control of our destiny.
## 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: object |<br> 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">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)