mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-02 07:39:36 +08:00
Code Issues Actions 30 Packages Projects Releases Wiki Activity
5f2588ffd1
ant-design/components/alert/index.en-US.md
Tom Xu 5f2588ffd1
docs: improve api type docs (#27038)
2020-10-09 10:08:52 +08:00

1.5 KiB
Raw Blame History

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 ReactNode -
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
message Custom error message to show ReactNode {{ error }}
description Custom error description to show ReactNode {{ error stack }}