ant-design/components/alert/index.en-US.md
二货爱吃白萝卜 20561d6f9d
docs: Fix component doc alignment & support import usage ()
* docs: init ref

* docs all support

* docs: fix link show
2024-03-22 14:22:42 +08:00

2.6 KiB
Raw Blame History

category title description cover coverDark demo group
Components Alert Display warning messages that require attention. https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*QsvtS41m45UAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*gOTISoMFZV0AAAAAAAAAAAAADrJ8AQ/original
cols
2
title order
Feedback 6

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 Banner Loop Banner Smoothly Unmount ErrorBoundary Custom Icon Custom action Component Token

API

Common props refCommon props

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 The config of closable, >=5.15.0: support aria-* boolean | ({ closeIcon?: React.ReactNode } & React.AriaAttributes) false
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 }}

Design Token