跳转到内容
编辑此页面

Popover API

想要学习更多组件属性和 CSS API，可以查阅 React Popover 组件的 API 文档。

演示项目

For examples and details on the usage of this React component, visit the component demo pages:

导入

import Popover from '@mui/material/Popover';
// 或
import { Popover } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

组件名称

在主题中，名称“MuiPopover”可用于提供默认属性（props），或者样式覆盖

属性

Modal 组件的属性也是可用的。

名称类型默认值描述
open*boolfalse
Control the popup` open state.
actionref
A ref for imperative actions. It currently only supports updatePosition() action.
anchorElHTML element
| func
A HTML element, or a function that returns it. It's used to set the position of the popover.
anchorOrigin{ horizontal: 'center'
| 'left'
| 'right'
| number, vertical: 'bottom'
| 'center'
| 'top'
| number }		{ vertical: 'top', horizontal: 'left', }
This is the point on the anchor where the popover's anchorEl will attach to. This is not used when the anchorReference is 'anchorPosition'.
Options: vertical: [top, center, bottom]; horizontal: [left, center, right].
anchorPosition{ left: number, top: number }
This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.
anchorReference'anchorEl'
| 'anchorPosition'
| 'none'		'anchorEl'
This determines which anchor prop to refer to to set the position of the popover.
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
containerHTML element
| func
A HTML element, component instance, or function that returns either. The container will passed to the Modal component.
By default, it uses the body of the anchorEl's top-level document object, so it's simply document.body most of the time.
elevationinteger8
The elevation of the popover.
marginThresholdnumber16
Specifies how close to the edge of the window the popover can appear.
onClosefunc
Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.
PaperProps{ component?: element type }{}
Props applied to the Paper element.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
transformOrigin{ horizontal: 'center'
| 'left'
| 'right'
| number, vertical: 'bottom'
| 'center'
| 'top'
| number }		{ vertical: 'top', horizontal: 'left', }
This is the point on the popover which will attach to the anchor's origin.
Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)].
TransitionComponentelementTypeGrow
The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDuration'auto'
| number
| { appear?: number, enter?: number, exit?: number }		'auto'
Set to 'auto' to automatically calculate transition time based on height.
TransitionPropsobject{}
Props applied to the transition element. By default, the element is based on this Transition component.

ref 则会被传递到根元素中。

继承

尽管上文没有明文记录， Modal 组件 的属性(props) 在组件Popover上同样是可用的。 你可以利用这一点来 指向嵌套组件

CSS

规则名称全局类名描述
root.MuiPopover-rootStyles applied to the root element.
paper.MuiPopover-paperStyles applied to the Paper component.

您可以使用组件自定义选项对组件进行个性化：