57 lines
3.6 KiB
Markdown
57 lines
3.6 KiB
Markdown
---
|
||
title: Badge 徽标
|
||
description: 用于告知用户，该区域的状态变化或者待处理任务的数量。
|
||
spline: data
|
||
isComponent: true
|
||
---
|
||
|
||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-100%25-blue" /></span>
|
||
## 引入
|
||
|
||
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"t-badge": "tdesign-miniprogram/badge/badge"
|
||
}
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
### 普通徽标
|
||
|
||
<img src="https://tdesign.gtimg.com/miniprogram/readme/badge-1.png" width="375px" height="50%">
|
||
|
||
{{ base }}
|
||
|
||
### 按钮徽标
|
||
|
||
{{ button }}
|
||
|
||
### 单行徽标
|
||
|
||
{{ cell }}
|
||
|
||
### 标签栏徽标
|
||
|
||
<img src="https://tdesign.gtimg.com/miniprogram/readme/badge-3.png" width="375px" height="50%">
|
||
|
||
{{ tab-item }}
|
||
|
||
## API
|
||
|
||
### Badge Props
|
||
|
||
| 名称 | 类型 | 默认值 | 说明 | 必传 |
|
||
| ---------------- | ---------------------- | ------ | ----------------------------------------------------------------------------------------------------------------- | -------- |
|
||
| color | String | - | 颜色 | N |
|
||
| content | String | - | 徽标内容，示例：`content='自定义内容'`。也可以使用默认插槽定义 | N |
|
||
| count | String / Number / Slot | 0 | 徽标右上角内容。可以是数字，也可以是文字。如：'new'/3/99+。特殊：值为空表示使用插槽渲染 | N |
|
||
| dot | Boolean | false | 是否为红点 | N |
|
||
| external-classes | Array | - | 组件类名，分别用于设置外层元素、默认内容、右上角内容等元素类名。`['t-class', 't-class-content', 't-class-count']` | N |
|
||
| max-count | Number | 99 | 封顶的数字值 | N |
|
||
| offset | Array | - | 设置状态点的位置偏移，示例：[-10, 20] 或 ['10em', '8rem']。TS 类型：`Array<string | number>` | N |
|
||
| shape | String | circle | 形状。可选项：circle/square/round/ribbon | N |
|
||
| show-zero | Boolean | false | 当数值为 0 时，是否展示徽标 | N |
|
||
| size | String | medium | 尺寸。可选项：small/medium | N |
|