Appearance
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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
text | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 37 | 需要提供业务文案或图标内容时设置。 |
label | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 37 | 需要提供业务文案或图标内容时设置。 |
preset | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 31 | 需要覆盖组件默认业务值时设置。 |
variant | string | "solid" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 33 | 需要调整布局或视觉表现时设置。 |
shape | string | "default" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 34 | 需要覆盖组件默认业务值时设置。 |
size | string | "md" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42 | 需要覆盖组件默认业务值时设置。 |
theme | string | "primary" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 32 | 需要调整布局或视觉表现时设置。 |
color | string | "" | 参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 43、script 行 49、script 行 60 | 需要覆盖组件默认业务值时设置。 |
checkable | boolean | false | 开关对应显示或交互行为;消费位置:script 行 36 | 需要覆盖组件默认业务值时设置。 |
closable | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 10 | 需要覆盖组件默认业务值时设置。 |
checked | boolean | string | number | false | 开关对应显示或交互行为;消费位置:script 行 23、script 行 24、script 行 26 | 需要覆盖组件默认业务值时设置。 |
show | boolean | string | number | true | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 25、script 行 27 | 需要控制显示、可用性或交互状态时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 35 | 需要提供业务文案或图标内容时设置。 |
iconPosition | string | "start" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 39 | 需要覆盖组件默认业务值时设置。 |
iconSize | string | number | "" | 设置对应元素尺寸;消费位置:script 行 44 | 需要调整布局或视觉表现时设置。 |
block | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 45 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 45、script 行 63、script 行 64 | 需要控制显示、可用性或交互状态时设置。 |
gradient | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 54 | 需要覆盖组件默认业务值时设置。 |
glass | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
hairline | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 48 | 需要覆盖组件默认业务值时设置。 |
ellipsis | boolean | false | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 45、template 行 7 | 需要覆盖组件默认业务值时设置。 |
bgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 51、script 行 54 | 需要调整布局或视觉表现时设置。 |
textColor | string | "" | 设置对应区域的颜色;消费位置:script 行 43 | 需要调整布局或视觉表现时设置。 |
borderColor | string | "" | 设置对应区域的颜色;消费位置:script 行 49、script 行 52 | 需要调整布局或视觉表现时设置。 |
softColor | string | "" | 设置对应区域的颜色;消费位置:script 行 50 | 需要调整布局或视觉表现时设置。 |
gradientEndColor | string | "" | 设置对应区域的颜色;消费位置:script 行 54 | 需要调整布局或视觉表现时设置。 |
glassColor | string | "" | 设置对应区域的颜色;消费位置:script 行 51 | 需要调整布局或视觉表现时设置。 |
dotColor | string | "" | 设置对应区域的颜色;消费位置:script 行 59 | 需要调整布局或视觉表现时设置。 |
closeBgColor | string | "" | 设置对应区域的颜色;消费位置:script 行 61 | 需要调整布局或视觉表现时设置。 |
checkedVariant | string | "solid" | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
uncheckedVariant | string | "outlined" | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
maxWidth | string | number | "" | 设置对应区域宽度;消费位置:script 行 56 | 需要调整布局或视觉表现时设置。 |
motion | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 62、script 行 65 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 45 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 57 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | handleTap 内触发(script 行 63);参数表达式:无回调参数;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
tap | handleTap 内触发(script 行 63);参数表达式:无回调参数;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | handleTap 内触发(script 行 63);参数表达式:next;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
close | handleClose 内触发(script 行 64);参数表达式:无回调参数;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:checked | handleTap 内触发(script 行 63);参数表达式:next;前置 guard:props.disabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:show | handleClose 内触发(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。