Appearance
xtf-tag-group
组件说明
xtf-tag-group 是标签组，用于管理一组标签的选择和删除。当前实现读取 options 数据、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-tag-group/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfTagGroup :options="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfTagGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-tag-group/xtf-tag-group.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel' }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfTagGroup :options="fixture" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfTagGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-tag-group/xtf-tag-group.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-tag-group:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 multiple 状态
运行时切换 multiple，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfTagGroup :options="fixture" :multiple="state" />
<button class="doc-action-button" @click="toggleState">切换 multiple</button>
<text class="doc-state-text">multiple: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfTagGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-tag-group/xtf-tag-group.uvue"
import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("multiple", state.value) }
</script>
<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.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">
<XtfTagGroup :options="fixture">
<template #default><text class="doc-content-text">自定义 default 内容</text></template>
</XtfTagGroup>
</view>
</template>
<script setup lang="uts">
import XtfTagGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-tag-group/xtf-tag-group.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel' }] as Array<any>
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 getTags()
调用该公开实例能力；签名为 getTags(): Array<any>。
vue
<template>
<view class="doc-method">
<XtfTagGroup :options="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfTagGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-tag-group/xtf-tag-group.uvue"
import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'travel' }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.getTags(); console.log("调用 getTags") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
options | Array<any> | undefined | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 37、script 行 38 | 数据驱动或选项渲染场景。 |
items | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 37、script 行 38 | 数据驱动或选项渲染场景。 |
modelValue | any | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 25 | 需要覆盖组件默认业务值时设置。 |
active | any | undefined | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 25 | 需要覆盖组件默认业务值时设置。 |
value | any | undefined | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 25 | 需要覆盖组件默认业务值时设置。 |
multiple | boolean | true | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 76、script 行 90、script 行 91 | 需要控制显示、可用性或交互状态时设置。 |
min | number | string | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 85 | 需要覆盖组件默认业务值时设置。 |
max | number | string | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 85 | 需要覆盖组件默认业务值时设置。 |
checkable | boolean | true | 开关对应显示或交互行为；消费位置：script 行 56 | 需要覆盖组件默认业务值时设置。 |
closable | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 57 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 56、script 行 57、script 行 71、script 行 97 | 需要控制显示、可用性或交互状态时设置。 |
layoutMode | string | "flow" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 27 | 需要覆盖组件默认业务值时设置。 |
layout | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 27 | 需要调整布局或视觉表现时设置。 |
direction | string | "row" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 28 | 需要覆盖组件默认业务值时设置。 |
wrap | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 28 | 需要覆盖组件默认业务值时设置。 |
gap | string | number | 16 | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 29 | 需要覆盖组件默认业务值时设置。 |
valueKey | string | "value" | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 33、script 行 37、script 行 68 | 需要覆盖组件默认业务值时设置。 |
labelKey | string | "label" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 37、script 行 51、script 行 68 | 需要提供业务文案或图标内容时设置。 |
theme | string | "primary" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
variant | string | "outlined" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
shape | string | "round" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
size | string | "md" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
color | string | "" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 28 | 需要调整布局或视觉表现时设置。 |
customStyle | any | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 29 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | emitSelection 内触发（script 行 79）；参数表达式：output | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:active | emitSelection 内触发（script 行 79）；参数表达式：output | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | emitSelection 内触发（script 行 79）；参数表达式：output | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:options | remove 内触发（script 行 110）；参数表达式：allTags；前置 guard：!itemClosable(item) || index < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | emitSelection 内触发（script 行 79）；参数表达式：payload | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
selection-change | emitSelection 内触发（script 行 79）；参数表达式：payload | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
selection-limit | toggle 内触发（script 行 87）；参数表达式：{ type: "min", min, tag: serialize(item, index), selectedValues: values, allTags: getTags() }；前置 guard：!itemCheckable(item)、min > 0 && values.length <= mintoggle 内触发（script 行 90）；参数表达式：{ type: "max", max, tag: serialize(item, index), selectedValues: values, allTags: getTags() }；前置 guard：!itemCheckable(item)、min > 0 && values.length <= min、props.multiple && max > 0 && values.length >= max | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
tag-click | handleTap 内触发（script 行 99）；参数表达式：payload；前置 guard：props.disabled || item.disabled == true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
item-click | handleTap 内触发（script 行 99）；参数表达式：payload；前置 guard：props.disabled || item.disabled == true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
delete | remove 内触发（script 行 110）；参数表达式：payload；前置 guard：!itemClosable(item) || index < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
remove | remove 内触发（script 行 110）；参数表达式：payload；前置 guard：!itemClosable(item) || index < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
close | remove 内触发（script 行 110）；参数表达式：payload；前置 guard：!itemClosable(item) || index < 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
getTags | getTags(): Array<any> | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
getSelectedValues | getSelectedValues(): Array<any> | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
getSelectedTags | getSelectedTags(): Array<any> | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
- 当前组件 CSS 未读取
var(--xtf-*)主题变量；颜色或尺寸可能来自 props、固定样式或父级上下文。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 当前仅兼容接收、未发现运行消费的 props：
theme、variant、shape、size、color。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。