ant-design/components/alert/index.en-US.md

28 lines
1.0 KiB
Markdown
Raw Normal View History

---
category: Components
type: Feedback
2016-09-21 11:28:38 +08:00
title: Alert
---
Alert component for feedback.
2016-09-10 13:43:30 +08:00
## When To Use
- When you need to show alert messages to users.
2016-11-29 17:13:24 +08:00
- When you need a persistent static container which is closable by user actions.
## API
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
2019-05-07 14:57:32 +08:00
| --- | --- | --- | --- |
2018-03-13 11:40:11 +08:00
| afterClose | Called when close animation is finished | () => void | - |
2017-10-25 10:25:44 +08:00
| banner | Whether to show as banner | boolean | false |
| closable | Whether Alert can be closed | boolean | - |
| closeText | Close text to show | string\|ReactNode | - |
| description | Additional content of Alert | string\|ReactNode | - |
2018-09-14 23:54:54 +08:00
| icon | Custom icon, effective when `showIcon` is `true` | ReactNode | - |
2017-10-25 10:25:44 +08:00
| message | Content of Alert | string\|ReactNode | - |
| showIcon | Whether to show icon | boolean | false, in `banner` mode default is true |
| type | Type of Alert styles, options: `success`, `info`, `warning`, `error` | string | `info`, in `banner` mode default is `warning` |
2018-03-13 11:40:11 +08:00
| onClose | Callback when Alert is closed | (e: MouseEvent) => void | - |