xtf-linkuiunix

Appearance

xtf-badge ​

组件说明 ​

xtf-badge 是徽标，用于在内容旁展示计数、圆点或状态标记。当前实现通过 click 等事件反馈交互。

  • 实际 Demo 路由：#/pages/components/xtf-badge/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

提供能够直接看到或操作组件的最少业务内容。

vue
<template>
  <view class="doc-minimum">
    <XtfBadge text="示例内容">
      <text class="doc-content-text">示例内容</text>
    </XtfBadge>
  </view>
</template>

<script setup lang="uts">
import XtfBadge from "@/uni_modules/xtf-linkuiunix/components/xtf-badge/xtf-badge.uvue"

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口，并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfBadge text="示例内容" :clickable="true" @click="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfBadge>
  </view>
</template>

<script setup lang="uts">
import XtfBadge from "@/uni_modules/xtf-linkuiunix/components/xtf-badge/xtf-badge.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-badge:click", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

3. 动态 dot 状态 ​

运行时切换 dot，观察组件对应状态变化。

vue
<template>
  <view class="doc-dynamic">
    <XtfBadge text="示例内容" :dot="state">
      <text class="doc-content-text">示例内容</text>
    </XtfBadge>
    <button class="doc-action-button" @click="toggleState">切换 dot</button>
    <text class="doc-state-text">dot: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfBadge from "@/uni_modules/xtf-linkuiunix/components/xtf-badge/xtf-badge.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("dot", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 定制 default 插槽 ​

使用源码真实声明的 default slot 替换对应内容。

vue
<template>
  <view class="doc-slot">
    <XtfBadge text="示例内容">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfBadge>
  </view>
</template>

<script setup lang="uts">
import XtfBadge from "@/uni_modules/xtf-linkuiunix/components/xtf-badge/xtf-badge.uvue"

</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
valuestring | number""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 91需要覆盖组件默认业务值时设置。
textstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 90需要提供业务文案或图标内容时设置。
iconstring""参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 100、script 行 140、script 行 164、script 行 165需要提供业务文案或图标内容时设置。
iconPosition"start" | "end""start"参与组件运行逻辑；源码在 2 处读取该值；可选值：start / end；消费位置：script 行 164、script 行 165需要覆盖组件默认业务值时设置。
iconSizeXtfComponentSize""设置对应元素尺寸；消费位置：script 行 140、script 行 166需要调整布局或视觉表现时设置。
dotbooleanfalse参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 90、script 行 100、script 行 140、script 行 164需要覆盖组件默认业务值时设置。
showZerobooleanfalse开关对应显示或交互行为；消费位置：script 行 95需要控制显示、可用性或交互状态时设置。
maxstring | number99参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 85需要覆盖组件默认业务值时设置。
sizeXtfBadgeSize""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 79需要覆盖组件默认业务值时设置。
themeXtfBadgeTheme"primary"参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 184、template 行 5需要调整布局或视觉表现时设置。
colorstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 213需要覆盖组件默认业务值时设置。
softColorstring""设置对应区域的颜色；消费位置：script 行 214需要调整布局或视觉表现时设置。
textColorstring""设置对应区域的颜色；消费位置：script 行 167、script 行 216需要调整布局或视觉表现时设置。
borderColorstring""设置对应区域的颜色；消费位置：script 行 217需要调整布局或视觉表现时设置。
bubbleEndColorstring""设置对应区域的颜色；消费位置：script 行 215需要调整布局或视觉表现时设置。
variantXtfBadgeVariant"solid"参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 167、script 行 184需要调整布局或视觉表现时设置。
shapeXtfBadgeShape"pill"参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 184、template 行 5需要覆盖组件默认业务值时设置。
positionXtfBadgePosition"top-right"参与组件运行逻辑；源码在 13 处读取该值；消费位置：script 行 187、script 行 191、script 行 193、script 行 198需要覆盖组件默认业务值时设置。
motion"" | "pulse" | "bounce" | "wave"""参与组件运行逻辑；源码在 6 处读取该值；可选值："" / pulse / bounce / wave；消费位置：script 行 118、script 行 119、script 行 120、script 行 140需要覆盖组件默认业务值时设置。
standalonebooleanfalse参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 175、script 行 187、script 行 190需要覆盖组件默认业务值时设置。
insetbooleanfalse参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 182需要覆盖组件默认业务值时设置。
offsetXstring | number0参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 192、script 行 194、script 行 196需要覆盖组件默认业务值时设置。
offsetYstring | number0参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 199、script 行 201、script 行 203需要覆盖组件默认业务值时设置。
clickablebooleanfalse开关对应显示或交互行为；消费位置：script 行 176、script 行 224需要覆盖组件默认业务值时设置。
ringColorstring""设置对应区域的颜色；消费位置：script 行 218需要调整布局或视觉表现时设置。
showBorderbooleantrue开关对应显示或交互行为；消费位置：script 行 219需要控制显示、可用性或交互状态时设置。
customClassstring""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 177需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
clickhandleClick 内触发（script 行 224）；参数表达式：event(...args: any[])表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
default无 scope 参数仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

状态类型 / 包装读取边界
--当前组件没有公开状态。

主题说明 ​

  • var(--xtf-badge-border-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-badge-bubble-end-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-badge-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-badge-soft-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-badge-text-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface-muted)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-radius-full)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。

平台与实现边界 ​

  • 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
  • Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
  • 本文按当前源码生成，不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
  • 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

MIT Licensed

Copyright © 2026 xtf-linkuiunix