zk-desktop-ui/docs/components/badge.md

ZKTeco UI Components

## Badge 标记

出现在按钮、图标旁的数字或状态标记。

### 基础用法
展示新消息数量。

demo 定义`value`属性，它接受`Number`或者`String`。

```html
<zk-badge :value="12" class="item">
  <zk-button size="small">评论</zk-button>
</zk-badge>
<zk-badge :value="3" class="item">
  <zk-button size="small">回复</zk-button>
</zk-badge>

<zk-dropdown trigger="click">
  <span class="zk-dropdown-link">
    点我查看<i class="zk-icon-caret-bottom zk-icon--right"></i>
  </span>
  <zk-dropdown-menu slot="dropdown">
    <zk-dropdown-item class="clearfix">
      评论
      <zk-badge class="mark" :value="12" />
    </zk-dropdown-item>
    <zk-dropdown-item class="clearfix">
      回复
      <zk-badge class="mark" :value="3" />
    </zk-dropdown-item>
  </zk-dropdown-menu>
</zk-dropdown>

<style>
.item {
  margin-top: 10px;
  margin-right: 40px;
}
</style>
```


### 最大值
可自定义最大值。

demo 由`max`属性定义，它接受一个`Number`，需要注意的是，只有当`value`为`Number`时，它才会生效。

```html
<zk-badge :value="200" :max="99" class="item">
  <zk-button size="small">评论</zk-button>
</zk-badge>
<zk-badge :value="100" :max="10" class="item">
  <zk-button size="small">回复</zk-button>
</zk-badge>

<style>
.item {
  margin-top: 10px;
  margin-right: 40px;
}
</style>
```


### 自定义内容
可以显示数字以外的文本内容。

demo 定义`value`为`String`类型是时可以用于显示自定义文本。

```html
<zk-badge value="new" class="item">
  <zk-button size="small">评论</zk-button>
</zk-badge>
<zk-badge value="hot" class="item">
  <zk-button size="small">回复</zk-button>
</zk-badge>

<style>
.item {
  margin-top: 10px;
  margin-right: 40px;
}
</style>
```


### 小红点
以红点的形式标注需要关注的内容。

demo 除了数字外，设置`is-dot`属性，它接受一个`Boolean`。

```html
<zk-badge is-dot class="item">数据查询</zk-badge>
<zk-badge is-dot class="item">
  <zk-button class="share-button" icon="share" type="primary"></zk-button>
</zk-badge>

<style>
.item {
  margin-top: 10px;
  margin-right: 40px;
}
</style>
```

### Attributes
| 参数          | 说明            | 类型            | 可选值                 | 默认值   |
|-------------  |---------------- |---------------- |---------------------- |-------- |
| value          | 显示值      | string, number          |          —             |    —     |
| max          |  最大值，超过最大值会显示 '{max}+'，要求 value 是 Number 类型    | number  |         —              |     —    |
| is-dot       | 小圆点    | boolean  |  —  |  false |