amis2/docs/zh-CN/components/alert.md
RUNZE LU 87dce84ec8
feat: Alert提示组件对齐4.0 (#3010)
Co-authored-by: lurunze1226 <lurunze@baidu.com>
2021-11-24 21:44:38 +08:00

4.9 KiB
Executable File

title description type group menuName icon order
Alert 提示 0 ⚙ 组件 Alert 提示 27

用来做文字特殊提示,分为四类:提示类、成功类、警告类和危险类。

基本使用

level属性支持 4 种预设样式:info, success, warning, danger

[
  {
    "type": "alert",
    "body": "提示类文案",
    "level": "info",
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "提示类标题",
    "body": "提示类文案",
    "level": "info",
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "成功类文案",
    "level": "success",
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "成功类标题",
    "body": "成功类文案",
    "level": "success",
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "警告类文案",
    "level": "warning",
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "警告类标题",
    "body": "警告类文案",
    "level": "warning",
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "危险类文案",
    "level": "danger",
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "危险类标题",
    "body": "危险类文案",
    "level": "danger",
  },
]

图标

配置"showIcon": true后展示图标让信息更加醒目。可以通过icon属性自定义设置 icon 内容,如果icon属性为空,则根据level值添加默认 icon。

[
  {
    "type": "alert",
    "body": "提示类文案",
    "level": "info",
    "showIcon": true,
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "提示类标题",
    "body": "提示类文案",
    "level": "info",
    "showIcon": true,
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "成功类文案",
    "level": "success",
    "showIcon": true,
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "成功类标题",
    "body": "成功类文案",
    "level": "success",
    "showIcon": true,
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "警告类文案",
    "level": "warning",
    "showIcon": true,
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "警告类标题",
    "body": "警告类文案",
    "level": "warning",
    "showIcon": true,
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "危险类文案",
    "level": "danger",
    "showIcon": true,
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "危险类标题",
    "body": "危险类文案",
    "level": "danger",
    "showIcon": true,
    "className": "mb-3"
  },
  {
    "type": "alert",
    "body": "自定义ICON文案",
    "showIcon": true,
    "icon": "warning",
    "className": "mb-1"
  },
  {
    "type": "alert",
    "title": "自定义ICON标题",
    "body": "自定义ICON文案",
    "showIcon": true,
    "icon": "warning"
  },
]

显示关闭按钮

配置"showCloseButton": true实现显示关闭按钮。

[
  {
    "type": "alert",
    "body": "显示关闭按钮的提示",
    "level": "info",
    "showCloseButton": true,
    "showIcon": true,
    "className": "mb-2"
  },
  {
    "type": "alert",
    "title": "可关闭提示",
    "body": "显示关闭按钮的提示",
    "level": "success",
    "showCloseButton": true,
    "showIcon": true
  }
]

属性表

属性名 类型 默认值 说明
type string "alert" 指定为 alert 渲染器
className string 外层 Dom 的类名
level string info 级别,可以是:infosuccesswarning 或者 danger
body SchemaNode 显示内容
showCloseButton boolean false 是否显示关闭按钮
closeButtonClassName string 关闭按钮的 CSS 类名
showIcon boolean false 是否显示 icon
icon string 自定义 icon
iconClassName string icon 的 CSS 类名