- 组件总览
- 通用
- 布局
- 导航
- 数据录入
- 数据展示
- 反馈
- 其他
屏幕边缘滑出的浮层面板。
抽屉从父窗体边缘滑入,覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务,操作完成后,可以平滑地回到原任务。
通用属性参考:通用属性
🚨 注意: v5 使用 rootClassName
与 rootStyle
来配置最外层元素样式。原 v4 className
与 style
改至配置 Drawer 窗体样式以和 Modal 对齐。
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
autoFocus | 抽屉展开后是否将焦点切换至其 Dom 节点 | boolean | true | 4.17.0 |
afterOpenChange | 切换抽屉时动画结束后的回调 | function(open) | - | |
className | Drawer 容器外层 className 设置,如果需要设置最外层,请使用 rootClassName | string | - | |
classNames | 配置抽屉内置模块的 className | header?: string; body?: string; footer?: string; mask?: string; wrapper?: string; | - | |
styles | 配置抽屉内置模块的 style | header?: CSSProperties; body?: CSSProperties; footer?: CSSProperties; mask?: CSSProperties; wrapper?: CSSProperties; | - | 5.10.0 |
closeIcon | 自定义关闭图标。5.7.0:设置为 null 或 false 时隐藏关闭按钮 | boolean | ReactNode | <CloseOutlined /> | |
contentWrapperStyle | 可用于设置 Drawer 包裹内容部分的样式 | CSSProperties | - | |
destroyOnClose | 关闭时销毁 Drawer 里的子元素 | boolean | false | |
extra | 抽屉右上角的操作区域 | ReactNode | - | 4.17.0 |
footer | 抽屉的页脚 | ReactNode | - | |
forceRender | 预渲染 Drawer 内元素 | boolean | false | |
getContainer | 指定 Drawer 挂载的节点,并在容器内展现,false 为挂载在当前位置 | HTMLElement | () => HTMLElement | Selectors | false | body | |
height | 高度,在 placement 为 top 或 bottom 时使用 | string | number | 378 | |
keyboard | 是否支持键盘 esc 关闭 | boolean | true | |
mask | 是否展示遮罩 | boolean | true | |
maskClosable | 点击蒙层是否允许关闭 | boolean | true | |
placement | 抽屉的方向 | top | right | bottom | left | right | |
push | 用于设置多层 Drawer 的推动行为 | boolean | { distance: string | number } | { distance: 180 } | 4.5.0+ |
rootStyle | 可用于设置 Drawer 最外层容器的样式,和 style 的区别是作用节点包括 mask | CSSProperties | - | |
size | 预设抽屉宽度(或高度),default 378px 和 large 736px | 'default' | 'large' | 'default' | 4.17.0 |
style | 设计 Drawer 容器样式,如果你只需要设置内容部分请使用 bodyStyle | CSSProperties | - | |
title | 标题 | ReactNode | - | |
open | Drawer 是否可见 | boolean | - | |
width | 宽度 | string | number | 378 | |
zIndex | 设置 Drawer 的 z-index | number | 1000 | |
onClose | 点击遮罩层或左上角叉或取消按钮的回调 | function(e) | - |
Token 名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
footerPaddingBlock | 底部区域纵向内间距 | number | 8 |
footerPaddingInline | 底部区域横向内间距 | number | 16 |
zIndexPopup | 弹窗 z-index | number | 1000 |