ant-design/components/modal/index.md

61 lines
2.4 KiB
Markdown
Raw Normal View History

2015-05-27 15:43:29 +08:00
# Modal
2015-08-22 20:16:24 +08:00
- type: 展示
2015-06-02 12:11:49 +08:00
- category: Components
2015-05-27 15:43:29 +08:00
- chinese: 对话框
---
2015-06-05 10:39:30 +08:00
模态对话框。
## 何时使用
需要用户处理事务,又不希望跳转页面以致打断工作流程时,可以使用 `Modal` 在当前页面正中打开一个浮层,承载相应的操作。
2015-09-07 11:48:57 +08:00
另外当需要一个简洁的确认框询问用户时,可以使用精心封装好的 `ant.Modal.confirm()` 等方法。
2015-06-12 19:41:30 +08:00
2015-06-05 10:39:30 +08:00
## API
2015-05-27 15:43:29 +08:00
2015-06-10 16:43:35 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|------------|----------------|------------------|--------------|
| visible | 对话框是否可见 | Boolean | 无 |
| confirmLoading | 确定按钮 loading | Boolean | 无 |
2015-06-10 16:43:35 +08:00
| title | 标题 | React.Element | 无 |
2016-01-06 10:21:02 +08:00
| closable | 是否显示右上角的关闭按钮 | Boolean | true |
| onOk | 点击确定回调 | function | 无 |
2016-02-02 14:54:34 +08:00
| onCancel | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | 无 |
2015-08-25 16:56:08 +08:00
| width | 宽度 | String or Number | 520 |
2015-06-10 16:43:35 +08:00
| footer | 底部内容 | React.Element | 确定取消按钮 |
| okText | 确认按钮文字 | String | 确定 |
| cancelText | 取消按钮文字 | String | 取消 |
2016-03-06 00:10:36 +08:00
| maskClosable | 点击蒙层是否允许关闭 | Boolean | true |
2015-06-12 19:41:30 +08:00
2015-09-07 11:48:57 +08:00
### Modal.xxx()
2015-06-12 19:41:30 +08:00
2015-09-07 11:48:57 +08:00
包括:
- `Modal.info`
- `Modal.success`
- `Modal.error`
- `Modal.confirm`
以上均为一个函数,参数为 object具体属性如下
2015-06-12 19:41:30 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|------------|----------------|------------------|--------------|
| title | 标题 | React.Element or String | 无 |
2015-06-25 15:29:56 +08:00
| onOk | 点击确定回调,参数为关闭函数,返回 promise 时 resolve 后自动关闭 | function | 无 |
| onCancel | 取消回调,参数为关闭函数,返回 promise 时 resolve 后自动关闭 | function | 无 |
2015-09-07 11:48:57 +08:00
| width | 宽度 | String or Number | 416 |
| iconClassName | 图标 Icon 类型 | String | question-circle |
| okText | 确认按钮文字 | String | 确定 |
| cancelText | 取消按钮文字 | String | 取消 |
2015-09-07 11:48:57 +08:00
<style>
.code-box-demo .ant-btn {
margin-right: 8px;
}
</style>