mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
dda650cc7b
* docs: Update components cover #24629 * docs: Update components cover
1.5 KiB
1.5 KiB
category | type | title | cover |
---|---|---|---|
Components | Feedback | Alert | https://gw.alipayobjects.com/zos/alicdn/8emPa3fjl/Alert.svg |
Alert component for feedback.
When To Use
- When you need to show alert messages to users.
- When you need a persistent static container which is closable by user actions.
API
Property | Description | Type | Default |
---|---|---|---|
afterClose | Called when close animation is finished | () => void | - |
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 | - |
icon | Custom icon, effective when showIcon is true |
ReactNode | - |
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 |
onClose | Callback when Alert is closed | (e: MouseEvent) => void | - |
Alert.ErrorBoundary
Property | Description | Type | Default | Version |
---|---|---|---|---|
message | custom error message to show | ReactNode | {{ error }} |
|
description | custom error description to show | ReactNode | {{ error stack }} |