mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 17:59:57 +08:00
2.7 KiB
2.7 KiB
type | category | subtitle | title | cover |
---|---|---|---|---|
反馈 | Components | 抽屉 | Drawer | https://gw.alipayobjects.com/zos/alicdn/7z8NJQhFb/Drawer.svg |
屏幕边缘滑出的浮层面板。
何时使用
抽屉从父窗体边缘滑入,覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务,操作完成后,可以平滑地回到原任务。
- 当需要一个附加的面板来控制父窗体内容,这个面板在需要时呼出。比如,控制界面展示样式,往界面中添加内容。
- 当需要在当前任务流中插入临时任务,创建或预览附加内容。比如展示协议条款,创建子对象。
API
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
afterVisibleChange | 切换抽屉时动画结束后的回调 | function(visible) | - | |
bodyStyle | 可用于设置 Drawer 内容部分的样式 | CSSProperties | - | |
className | 对话框外层容器的类名 | string | - | |
closable | 是否显示右上角的关闭按钮 | boolean | true | |
closeIcon | 自定义关闭图标 | ReactNode | <CloseOutlined /> | |
contentWrapperStyle | 可用于设置 Drawer 包裹内容部分的样式 | CSSProperties | - | |
destroyOnClose | 关闭时销毁 Drawer 里的子元素 | boolean | false | |
drawerStyle | 用于设置 Drawer 弹出层的样式 | CSSProperties | - | |
footer | 抽屉的页脚 | ReactNode | - | |
footerStyle | 抽屉页脚部件的样式 | CSSProperties | - | |
forceRender | 预渲染 Drawer 内元素 | boolean | false | |
getContainer | 指定 Drawer 挂载的 HTML 节点, false 为挂载在当前 dom | HTMLElement | () => HTMLElement | Selectors | false | body | |
headerStyle | 用于设置 Drawer 头部的样式 | CSSProperties | - | |
height | 高度, 在 placement 为 top 或 bottom 时使用 |
string | number | 256 | |
keyboard | 是否支持键盘 esc 关闭 | boolean | true | |
mask | 是否展示遮罩 | boolean | true | |
maskClosable | 点击蒙层是否允许关闭 | boolean | true | |
maskStyle | 遮罩样式 | CSSProperties | {} | |
placement | 抽屉的方向 | top | right | bottom | left |
right |
|
push | 用于设置多层 Drawer 的推动行为 | boolean | { distance: string | number } | { distance: 180 } | 4.5.0+ |
style | 可用于设置 Drawer 最外层容器的样式,和 drawerStyle 的区别是作用节点包括 mask |
CSSProperties | - | |
title | 标题 | ReactNode | - | |
visible | Drawer 是否可见 | boolean | - | |
width | 宽度 | string | number | 256 | |
zIndex | 设置 Drawer 的 z-index |
number | 1000 | |
onClose | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | - |