跳到内容跳到内容

PortalAPI

React Portal 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

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

阅读本指南,了解有关最小化 bundle size 的区别。



Portal 提供了一种一流的方式,将子元素渲染到父组件 DOM 层次结构之外的 DOM 节点中。

Props

名称类型默认值描述
children节点-

要渲染到 container 中的子元素。

containerHTML 元素
| 函数
-

一个 HTML 元素或返回 HTML 元素的函数。container 将会附加 portal 子元素。
您还可以提供一个回调函数,该函数在 React 布局 effect 中被调用。这允许您从 ref 设置 container,并使服务器端渲染成为可能。
默认情况下,它使用顶层文档对象的 body,因此大多数时候它只是 document.body

disablePortal布尔值false

子元素将位于父组件的 DOM 层次结构下。

该组件不能持有 ref。

源代码

如果您在此页面中没有找到所需信息,请考虑查看组件的实现以获取更多详细信息。