ant-design/components/drawer/index.zh-CN.md

35 lines
1.5 KiB
Markdown
Raw Normal View History

2018-05-23 10:56:37 +08:00
---
type: Feedback
category: Components
subtitle: 抽屉
title: Drawer
---
2018-06-26 16:51:51 +08:00
抽屉从父窗体边缘滑入,覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务,操作完成后,可以平滑地回到到原任务。
2018-05-23 10:56:37 +08:00
## 何时使用
2018-06-06 22:55:29 +08:00
2018-06-26 16:51:51 +08:00
* 当需要一个附加的面板来控制父窗体内容,这个面板在需要时呼出。比如,控制界面展示样式,往界面中添加内容。
* 当需要在当前任务流中插入临时任务,创建或预览附加内容。比如展示协议条款,创建子对象。
2018-05-23 10:56:37 +08:00
## API
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| closable | 是否显示右上角的关闭按钮 | boolean | true |
| destroyOnClose | 关闭时销毁 Drawer 里的子元素 | boolean | false |
2018-06-21 11:21:42 +08:00
| getContainer | 指定 Drawer 挂载的 HTML 节点 | HTMLElement \| `() => HTMLElement` \| selectors  | 'body' |
2018-05-23 10:56:37 +08:00
| maskClosable | 点击蒙层是否允许关闭 | boolean | true |
| mask | 是否展示遮罩 | Boolean | true |
| maskStyle | 遮罩样式 | object | {} |
| style | 可用于设置 Drawer 的样式,调整浮层位置等 | object | - |
2018-06-07 16:59:04 +08:00
| title | 标题 | string \| ReactNode | - |
| visible | Drawer 是否可见 | boolean | - |
2018-05-27 00:00:07 +08:00
| width | 宽度 | string \| number | 256 |
2018-05-23 10:56:37 +08:00
| wrapClassName | 对话框外层容器的类名 | string | - |
| zIndex | 设置 Drawer 的 `z-index` | Number | 1000 |
2018-06-06 22:55:29 +08:00
| placement | 抽屉的方向 | 'left' \| 'right' | 'right'
2018-05-23 10:56:37 +08:00
| onClose | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | 无 |