2016-03-31 14:17:09 +08:00
|
|
|
---
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
subtitle: 全局提示
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Feedback
|
2016-03-31 14:17:09 +08:00
|
|
|
noinstant: true
|
2016-09-21 11:28:38 +08:00
|
|
|
title: Message
|
2016-03-31 14:17:09 +08:00
|
|
|
---
|
2015-06-15 22:01:39 +08:00
|
|
|
|
2015-06-26 14:42:30 +08:00
|
|
|
全局展示操作反馈信息。
|
2015-06-17 20:24:42 +08:00
|
|
|
|
2015-06-26 14:42:30 +08:00
|
|
|
## 何时使用
|
2015-06-17 20:24:42 +08:00
|
|
|
|
2015-06-26 14:42:30 +08:00
|
|
|
- 可提供成功、警告和错误等反馈信息。
|
|
|
|
- 顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。
|
2015-07-11 18:00:58 +08:00
|
|
|
|
|
|
|
## API
|
|
|
|
|
2017-03-19 14:16:39 +08:00
|
|
|
组件提供了一些静态方法,使用方式和参数如下:
|
|
|
|
|
2017-10-14 14:28:57 +08:00
|
|
|
- `message.success(content, [duration], onClose)`
|
|
|
|
- `message.error(content, [duration], onClose)`
|
|
|
|
- `message.info(content, [duration], onClose)`
|
|
|
|
- `message.warning(content, [duration], onClose)`
|
|
|
|
- `message.warn(content, [duration], onClose)` // alias of warning
|
|
|
|
- `message.loading(content, [duration], onClose)`
|
2015-07-11 18:00:58 +08:00
|
|
|
|
2017-10-25 10:25:44 +08:00
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
| content | 提示内容 | string\|ReactNode | - |
|
2018-04-03 13:41:44 +08:00
|
|
|
| duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭。 | number | 3 |
|
2017-10-25 10:25:44 +08:00
|
|
|
| onClose | 关闭时触发的回调函数 | Function | - |
|
2015-07-30 11:47:46 +08:00
|
|
|
|
2016-01-21 14:13:28 +08:00
|
|
|
还提供了全局配置和全局销毁方法:
|
2015-07-30 11:47:46 +08:00
|
|
|
|
|
|
|
- `message.config(options)`
|
2016-01-21 14:13:28 +08:00
|
|
|
- `message.destroy()`
|
2015-07-30 11:47:46 +08:00
|
|
|
|
2018-05-25 20:41:07 +08:00
|
|
|
组件同时提供 promise 接口
|
|
|
|
|
|
|
|
- `message[level](content, [duration]).then(afterClose)`
|
|
|
|
- `message[level](content, [duration], onClose).then(afterClose)`
|
|
|
|
|
|
|
|
其中`message[level]` 是组件已经提供的静态方法。`then` 接口返回值是 Promise 。
|
|
|
|
|
2017-03-19 02:07:39 +08:00
|
|
|
### message.config
|
|
|
|
|
2015-07-30 11:47:46 +08:00
|
|
|
```js
|
|
|
|
message.config({
|
2016-03-09 21:55:46 +08:00
|
|
|
top: 100,
|
|
|
|
duration: 2,
|
2018-04-20 15:40:43 +08:00
|
|
|
maxCount: 3,
|
2015-07-30 11:47:46 +08:00
|
|
|
});
|
|
|
|
```
|
|
|
|
|
2017-10-25 10:25:44 +08:00
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
| duration | 默认自动关闭延时,单位秒 | number | 3 |
|
2017-03-19 02:07:39 +08:00
|
|
|
| getContainer | 配置渲染节点的输出位置 | () => HTMLElement | () => document.body |
|
2018-04-20 15:40:43 +08:00
|
|
|
| maxCount | 最大显示数, 超过限制时,最早的消息会被自动关闭 | number | - |
|
2018-06-24 17:09:18 +08:00
|
|
|
| top | 消息距离顶部的位置 | number | 24 |
|