Skip to content

xtf-tag ​

组件说明 ​

xtf-tag 是标签,用于展示分类、状态或可关闭筛选项。当前实现由 show 控制显示、通过 click 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-tag/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfTag label="保存" :show="true">
      <text class="doc-content-text">示例内容</text>
    </XtfTag>
  </view>
</template>

<script setup lang="uts">
import XtfTag from "@/uni_modules/xtf-linkuiunix/components/xtf-tag/xtf-tag.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">
    <XtfTag label="保存" :show="true" @click="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfTag>
  </view>
</template>

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

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

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

3. 动态 show 状态 ​

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

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

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

import { ref } from "vue"

const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", 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. 定制 prefix 插槽 ​

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

vue
<template>
  <view class="doc-slot">
    <XtfTag label="保存" :show="true">
      <template #prefix><text class="doc-content-text">自定义 prefix 内容</text></template>
    </XtfTag>
  </view>
</template>

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

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
textstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 37需要提供业务文案或图标内容时设置。
labelstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37需要提供业务文案或图标内容时设置。
presetstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 31需要覆盖组件默认业务值时设置。
variantstring"solid"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 33需要调整布局或视觉表现时设置。
shapestring"default"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 34需要覆盖组件默认业务值时设置。
sizestring"md"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42需要覆盖组件默认业务值时设置。
themestring"primary"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 32需要调整布局或视觉表现时设置。
colorstring""参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 43、script 行 49、script 行 60需要覆盖组件默认业务值时设置。
checkablebooleanfalse开关对应显示或交互行为;消费位置:script 行 36需要覆盖组件默认业务值时设置。
closablebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 10需要覆盖组件默认业务值时设置。
checkedboolean | string | numberfalse开关对应显示或交互行为;消费位置:script 行 23、script 行 24、script 行 26需要覆盖组件默认业务值时设置。
showboolean | string | numbertrue参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 25、script 行 27需要控制显示、可用性或交互状态时设置。
iconstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 35需要提供业务文案或图标内容时设置。
iconPositionstring"start"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 39需要覆盖组件默认业务值时设置。
iconSizestring | number""设置对应元素尺寸;消费位置:script 行 44需要调整布局或视觉表现时设置。
blockbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 45需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 45、script 行 63、script 行 64需要控制显示、可用性或交互状态时设置。
gradientbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 54需要覆盖组件默认业务值时设置。
glassbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 40需要覆盖组件默认业务值时设置。
hairlinebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 48需要覆盖组件默认业务值时设置。
ellipsisbooleanfalse参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 45、template 行 7需要覆盖组件默认业务值时设置。
bgColorstring""设置对应区域的颜色;消费位置:script 行 51、script 行 54需要调整布局或视觉表现时设置。
textColorstring""设置对应区域的颜色;消费位置:script 行 43需要调整布局或视觉表现时设置。
borderColorstring""设置对应区域的颜色;消费位置:script 行 49、script 行 52需要调整布局或视觉表现时设置。
softColorstring""设置对应区域的颜色;消费位置:script 行 50需要调整布局或视觉表现时设置。
gradientEndColorstring""设置对应区域的颜色;消费位置:script 行 54需要调整布局或视觉表现时设置。
glassColorstring""设置对应区域的颜色;消费位置:script 行 51需要调整布局或视觉表现时设置。
dotColorstring""设置对应区域的颜色;消费位置:script 行 59需要调整布局或视觉表现时设置。
closeBgColorstring""设置对应区域的颜色;消费位置:script 行 61需要调整布局或视觉表现时设置。
checkedVariantstring"solid"提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40需要覆盖组件默认业务值时设置。
uncheckedVariantstring"outlined"提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40需要覆盖组件默认业务值时设置。
maxWidthstring | number""设置对应区域宽度;消费位置:script 行 56需要调整布局或视觉表现时设置。
motionstring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 62、script 行 65需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 45需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 57需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
clickhandleTap 内触发(script 行 63);参数表达式:无回调参数;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
taphandleTap 内触发(script 行 63);参数表达式:无回调参数;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changehandleTap 内触发(script 行 63);参数表达式:next;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closehandleClose 内触发(script 行 64);参数表达式:无回调参数;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:checkedhandleTap 内触发(script 行 63);参数表达式:next;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:showhandleClose 内触发(script 行 64);参数表达式:false;前置 guard:props.disabled(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-button-):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-tag-bg):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-tag-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-tag-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-tag-soft):组件样式实际读取的主题变量,可在 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