readme.md



Badge 数字角标


组件名：uni-badge
代码块： uBadge


数字角标一般和其它控件（列表、9宫格等）配合使用，用于进行数量提示，默认为实心灰色背景，


安装方式

本组件符合easycom规范，HBuilderX 2.5.5起，只需将本组件导入项目，在页面template中即可直接使用，无需在页面中import和注册components。

如需通过npm方式使用uni-ui组件，另见文档：https://ext.dcloud.net.cn/plugin?id=55


基本用法

在 template 中使用组件

<uni-badge size="small" :text="100" absolute="rightBottom" type="primary">
    <button type="default">右上</button>
</uni-badge>
<uni-badge text="1"></uni-badge>
<uni-badge text="2" type="purple" @click="bindClick"></uni-badge>
<uni-badge text="3" type="primary" :inverted="true"></uni-badge>


API


Badge Props


属性名
类型
默认值
说明


text
String
-
角标内容


type
String
default
颜色类型，可选值：default（灰色）、primary（蓝色）、success（绿色）、warning(黄色)、error(红色)


size
String
normal
Badge 大小，可取值：normal、small


is-dot
Boolean
false
不展示数字，只有一个小点


max-num
String/Numbuer
99
展示封顶的数字值，超过 99 显示99+


custom-style
Object
{}
自定义 Badge 样式, 样式对象语法


inverted
Boolean
false
是否无需背景颜色，为 true 时，背景颜色将变为文字的字体颜色


absolute
String
rightTop
开启绝对定位, 角标将定位到其包裹的标签的四个角上，可选值： rightTop(右上角)、rightBottom（右下角）、leftBottom（左下角）    、leftTop（左上角）


offset
Array[number]
[0, 0]
距定位角中心点的偏移量，[-10, -10] 表示向 absolute 指定的方向偏移 10px，[10, 10] 表示向 absolute 指定的反方向偏移 10px，只有存在 absolute 属性时有效，与absolute 的值一一对应（例如：值为rightTop， 对应 offset 为 [right, Top]）


Badge Events


事件名
事件说明
返回参数


@click
点击 Badge 触发事件
-


组件示例

点击查看：https://hellouniapp.dcloud.net.cn/pages/extUI/badge/badge