跳到内容跳到内容
🚀 影响 Material UI 2025 年的路线图！参与最新的开发者调查

DrawerAPI

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

演示

导入

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

通过阅读关于最小化 bundle 大小的指南，了解它们之间的区别。



当设置 variant="temporary" 时，Modal 组件的 props 可用。

Props

原生组件的 Props 也可用。

名称类型默认描述
anchor'bottom'
| 'left'
| 'right'
| 'top'		'left'

抽屉将从哪一侧出现。

childrennode-

组件的内容。

classesobject-

覆盖或扩展应用于组件的样式。

有关更多详细信息，请参见下方的 CSS 类 API。

elevationinteger16

抽屉的海拔。

hideBackdropboolfalse

如果为 true，则不渲染背景幕。

ModalPropsobject{}

应用于 Modal 元素的 Props。

onClosefunc-

当组件请求关闭时触发的回调。 reason 参数可以选择性地用于控制对 onClose 的响应。

签名:function(event: object, reason: string) => void
  • event 回调的事件源。
  • reason 可以是: "escapeKeyDown", "backdropClick"。
openboolfalse

如果 true，则显示组件。

PaperPropsobject{}

应用于 Paper 元素的 Props。

SlidePropsobject-

应用于 Slide 元素的 Props。

slotProps{ backdrop?: func
| object, docked?: func
| object, paper?: func
| object, root?: func
| object, transition?: func
| object }		{}

用于每个插槽内部的 props。

slots{ backdrop?: elementType, docked?: elementType, paper?: elementType, root?: elementType, transition?: elementType }{}

用于每个插槽内部的组件。

sxArray<func
| object
| bool>
| func
| object		-

允许定义系统覆盖以及其他 CSS 样式的系统 prop。

有关更多详细信息，请参见 `sx` 页面。

transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }		{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }

过渡的持续时间，以毫秒为单位。 您可以为所有过渡指定单个超时，也可以使用对象单独指定。

variant'permanent'
| 'persistent'
| 'temporary'		'temporary'

要使用的变体。

ref 被转发到根元素。

主题默认 props

您可以使用 MuiDrawer 通过主题 更改此组件的默认 props。

插槽

插槽名称类名默认组件描述
root.MuiDrawer-rootModal当 variant 为 temporary 时，用于根的组件。
backdropBackdrop用于 Modal 背景幕的组件。
docked.MuiDrawer-dockeddiv当 variant 为 permanent 或 persistent 时，用于根元素的组件。
paper.MuiDrawer-paperPaper用于 paper 的组件。
transitionSlide用于过渡的组件。 请遵循本指南 以了解有关此组件要求的更多信息。

CSS 类

这些类名对于使用 CSS 设置样式很有用。 当触发特定状态时，它们将应用于组件的插槽。

类名规则名称描述
.MuiDrawer-anchorBottomanchorBottom如果 anchor="bottom"，则应用于根元素的样式。
.MuiDrawer-anchorLeftanchorLeft如果 anchor="left"，则应用于根元素的样式。
.MuiDrawer-anchorRightanchorRight如果 anchor="right"，则应用于根元素的样式。
.MuiDrawer-anchorTopanchorTop如果 anchor="top"，则应用于根元素的样式。
.MuiDrawer-modalmodal应用于 Modal 组件的样式。
.MuiDrawer-paperAnchorBottompaperAnchorBottom如果 anchor="bottom"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorDockedBottompaperAnchorDockedBottom如果 anchor="bottom" 且 variant 不是 "temporary"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorDockedLeftpaperAnchorDockedLeft如果 anchor="left" 且 variant 不是 "temporary"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorDockedRightpaperAnchorDockedRight如果 anchor="right" 且 variant 不是 "temporary"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorDockedToppaperAnchorDockedTop如果 anchor="top" 且 variant 不是 "temporary"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorLeftpaperAnchorLeft如果 anchor="left"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorRightpaperAnchorRight如果 anchor="right"，则应用于 Paper 组件的样式。
.MuiDrawer-paperAnchorToppaperAnchorTop如果 anchor="top"，则应用于 Paper 组件的样式。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

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