Back to Ant Design

Alert

components/alert/index.zh-CN.md

6.3.73.9 KB
Original Source

何时使用 {#when-to-use}

  • 当某个页面需要向用户显示警告的信息时。
  • 非浮层的静态展现形式,始终展现,不会自动消失,用户可以点击关闭。

代码演示 {#examples}

<!-- prettier-ignore -->

<code src="./demo/basic.tsx">基本</code> <code src="./demo/style.tsx">四种样式</code> <code src="./demo/closable.tsx">可关闭的警告提示</code> <code src="./demo/description.tsx">含有辅助性文字介绍</code> <code src="./demo/icon.tsx">图标</code> <code src="./demo/banner.tsx" iframe="250">顶部公告</code> <code src="./demo/loop-banner.tsx">轮播的公告</code> <code src="./demo/smooth-closed.tsx">平滑地卸载</code> <code src="./demo/error-boundary.tsx">React 错误处理</code> <code src="./demo/custom-icon.tsx" debug>自定义图标</code> <code src="./demo/action.tsx">操作</code> <code src="./demo/component-token.tsx" debug>组件 Token</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code>

API

通用属性参考:通用属性

参数说明类型默认值版本
action自定义操作项ReactNode-4.9.0
afterClose关闭动画结束后触发的回调函数,请使用 closable.afterClose 替换() => void-
banner是否用作顶部公告booleanfalse
classNames自定义组件内部各语义化结构的类名。支持对象或函数Record<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string>-
closable可关闭配置,>=5.15.0: 支持 aria-*boolean | ClosableType & React.AriaAttributesfalse
description警告提示的辅助性文字介绍ReactNode-
icon自定义图标,showIcon 为 true 时有效ReactNode-
message警告提示内容,请使用 title 替换ReactNode-
title警告提示内容ReactNode-
showIcon是否显示辅助图标booleanfalse,banner 模式下默认值为 true
styles自定义组件内部各语义化结构的内联样式。支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props }) => Record<SemanticDOM, CSSProperties>-
type指定警告提示的样式,有四种选择 successinfowarningerrorstringinfobanner 模式下默认值为 warning
onClose关闭时触发的回调函数,请使用 closable.onClose 替换(e: MouseEvent) => void-
closeIcon自定义关闭图标,请使用 closable.closeIcon 替代ReactNode--
closeText自定义关闭文案,请使用 closable.closeIcon 替代ReactNode--

ClosableType

参数说明类型默认值版本
afterClose关闭动画结束后触发的回调函数function--
closeIcon自定义关闭图标ReactNode--
onClose关闭时触发的回调函数(e: MouseEvent) => void--

Alert.ErrorBoundary

参数说明类型默认值版本
description自定义错误内容,如果未指定会展示报错堆栈ReactNode{{ error stack }}
message自定义错误标题,如果未指定会展示原生报错信息,请使用 title 替换ReactNode{{ error }}
title自定义错误标题,如果未指定会展示原生报错信息ReactNode{{ error }}

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

Design Token

<ComponentTokenTable component="Alert"></ComponentTokenTable>