mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-12 15:19:58 +08:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
5fa55e291d
ant-design/components/alert/index.en-US.md
afc163 e027cbec1c
docs: format all markdown (#38629) 
* chore: add prettier-ignore in markdown demo

* docs: format markdown api table

* docs: format markdown api table
2022-11-17 17:31:26 +08:00

2.3 KiB
Raw Blame History

category title cover demo group
Components Alert https://gw.alipayobjects.com/zos/alicdn/8emPa3fjl/Alert.svg
cols
2
title order
Feedback 6

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.

Examples

Basic More types Closable Description Icon Customized Close Text Banner Loop Banner Smoothly Unmount ErrorBoundary Custom Icon Custom action

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.18.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 }}