ant-design/components/badge/index.zh-CN.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

1.1 KiB

category subtitle type title
Components 徽标数 Data Display Badge

图标右上角的圆形徽标数字。

何时使用

一般出现在通知图标或头像的右上角,用于显示需要处理的消息条数,通过醒目视觉形式吸引用户处理。

API

<Badge count={5}>
  <a href="#" className="head-example" />
</Badge>
<Badge count={5} />
参数 说明 类型 可选值 默认值
count 展示的数字,大于 overflowCount 时显示为 ${overflowCount}+,为 0 时隐藏 number
overflowCount 展示封顶的数字值 number 99
dot 不展示数字,只有一个小红点 boolean false
status 设置 Badge 为状态点 Enum 'success'、'processing'、'default'、'error'、'warning' ''
text 在设置了 status 的前提下有效,设置状态点的文本 string ''