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

26 lines
962 B
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 for users.
2016-11-29 17:13:24 +08:00
- When you need a persistent static container which is closable by user actions.
## API
| Property | Description | Type | Default |
|----------- |--------------------------------------------------------- | ---------- |-------|
| type | Type of Alert styles, options:`success`, `info`, `warning`, `error` | string | `info` |
| closable | Whether Alert can be closed | boolean | - |
| closeText | Close text to show | string\|ReactNode | - |
| message | Content of Alert | string\|ReactNode | - |
| description | Additional content of Alert | string\|ReactNode | - |
| onClose | Callback when close Alert | Function | - |
| showIcon | Whether to show icon | boolean | false |
| banner | Whether to show as banner | boolean | false |