mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-01 23:29:30 +08:00
1.6 KiB
1.6 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 | Version |
---|---|---|---|---|
action | The action of Alert | ReactNode | - | 4.9.0 |
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 | ReactNode | - | |
closeIcon | Custom close icon | ReactNode | <CloseOutlined /> |
4.17.0 |
description | Additional content of Alert | ReactNode | - | |
icon | Custom icon, effective when showIcon is true |
ReactNode | - | |
message | Content of Alert | 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 |
---|---|---|---|---|
description | Custom error description to show | ReactNode | {{ error stack }} | |
message | Custom error message to show | ReactNode | {{ error }} |