2016-07-04 10:49:26 +08:00
|
|
|
|
---
|
|
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
|
subtitle: 警告提示
|
2018-11-04 16:20:35 +08:00
|
|
|
|
type: 反馈
|
2016-09-21 11:28:38 +08:00
|
|
|
|
title: Alert
|
2016-07-04 10:49:26 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
警告提示，展现需要关注的信息。
|
|
|
|
|
|
|
|
|
|
|
|
## 何时使用
|
|
|
|
|
|
|
|
|
|
|
|
- 当某个页面需要向用户显示警告的信息时。
|
|
|
|
|
|
- 非浮层的静态展现形式，始终展现，不会自动消失，用户可以点击关闭。
|
|
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
2019-11-20 17:46:50 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
|
| afterClose | 关闭动画结束后触发的回调函数 | () => void | - |
|
|
|
|
|
|
| banner | 是否用作顶部公告 | boolean | false |
|
|
|
|
|
|
| closable | 默认不显示关闭按钮 | boolean | 无 |
|
|
|
|
|
|
| closeText | 自定义关闭按钮 | string\|ReactNode | 无 |
|
|
|
|
|
|
| description | 警告提示的辅助性文字介绍 | string\|ReactNode | 无 |
|
|
|
|
|
|
| icon | 自定义图标，`showIcon` 为 `true` 时有效 | ReactNode | - |
|
|
|
|
|
|
| message | 警告提示内容 | string\|ReactNode | 无 |
|
|
|
|
|
|
| showIcon | 是否显示辅助图标 | boolean | false，`banner` 模式下默认值为 true |
|
|
|
|
|
|
| type | 指定警告提示的样式，有四种选择 `success`、`info`、`warning`、`error` | string | `info`，`banner` 模式下默认值为 `warning` |
|
|
|
|
|
|
| onClose | 关闭时触发的回调函数 | (e: MouseEvent) => void | 无 |
|
2019-12-11 14:15:45 +08:00
|
|
|
|
|
|
|
|
|
|
### Alert.ErrorBoundary
|
|
|
|
|
|
|
|
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
|
| message | 自定义错误标题，如果未指定会展示原生报错信息 | ReactNode | `{{ error }}` | |
|
|
|
|
|
|
| description | 自定义错误内容，如果未指定会展示报错堆栈 | ReactNode | `{{ error stack }}` | |
|
