ant-design/components/drawer/index.zh-CN.md
2019-05-07 14:57:32 +08:00

1.9 KiB

type category subtitle title
反馈 Components 抽屉 Drawer

屏幕边缘滑出的浮层面板。

何时使用

抽屉从父窗体边缘滑入,覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务,操作完成后,可以平滑地回到到原任务。

  • 当需要一个附加的面板来控制父窗体内容,这个面板在需要时呼出。比如,控制界面展示样式,往界面中添加内容。
  • 当需要在当前任务流中插入临时任务,创建或预览附加内容。比如展示协议条款,创建子对象。

API

参数 说明 类型 默认值
closable 是否显示右上角的关闭按钮 boolean true
destroyOnClose 关闭时销毁 Drawer 里的子元素 boolean false
getContainer 指定 Drawer 挂载的 HTML 节点 HTMLElement | () => HTMLElement | Selectors 'body'
maskClosable 点击蒙层是否允许关闭 boolean true
mask 是否展示遮罩 Boolean true
maskStyle 遮罩样式 object {}
style 可用于设置 Drawer 最外层容器的样式 object -
bodyStyle 可用于设置 Drawer 的样式,调整浮层位置等 object -
title 标题 string | ReactNode -
visible Drawer 是否可见 boolean -
width 宽度 string | number 256
height 高度, 在 placementtopbottom 时使用 string | number 256
className 对话框外层容器的类名 string -
zIndex 设置 Drawer 的 z-index Number 1000
placement 抽屉的方向 'top' | 'right' | 'bottom' | 'left' 'right'
onClose 点击遮罩层或右上角叉或取消按钮的回调 function(e)
afterVisibleChange 切换抽屉时动画结束后的回调 function(visible)