Appearance
xtf-cell
组件说明
xtf-cell 是单元格,用于呈现设置项、详情值或可点击列表入口。当前实现通过 click 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-cell/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfCell title="账单详情" />
</view>
</template>
<script setup lang="uts">
import XtfCell from "@/uni_modules/xtf-linkuiunix/components/xtf-cell/xtf-cell.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfCell title="账单详情" :clickable="true" @click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfCell from "@/uni_modules/xtf-linkuiunix/components/xtf-cell/xtf-cell.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-cell:click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfCell title="账单详情" :disabled="state" />
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfCell from "@/uni_modules/xtf-linkuiunix/components/xtf-cell/xtf-cell.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", 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. 定制 thumb 插槽
使用源码真实声明的 thumb slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfCell title="账单详情">
<template #thumb><text class="doc-content-text">自定义 thumb 内容</text></template>
</XtfCell>
</view>
</template>
<script setup lang="uts">
import XtfCell from "@/uni_modules/xtf-linkuiunix/components/xtf-cell/xtf-cell.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 toggleSwitch()
调用该公开实例能力;签名为 toggleSwitch(): void。
vue
<template>
<view class="doc-method">
<XtfCell title="账单详情" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfCell from "@/uni_modules/xtf-linkuiunix/components/xtf-cell/xtf-cell.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.toggleSwitch(); console.log("调用 toggleSwitch") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
title | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15 | 需要提供业务文案或图标内容时设置。 |
eyebrow | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 14 | 需要覆盖组件默认业务值时设置。 |
eyebrowColor | string | "caption" | 设置对应区域的颜色;消费位置:template 行 14 | 需要调整布局或视觉表现时设置。 |
desc | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 18 | 需要覆盖组件默认业务值时设置。 |
descColor | string | "secondary" | 设置对应区域的颜色;消费位置:template 行 18 | 需要调整布局或视觉表现时设置。 |
value | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 43、template 行 21 | 需要覆盖组件默认业务值时设置。 |
valueColor | string | "secondary" | 设置对应区域的颜色;消费位置:template 行 21 | 需要调整布局或视觉表现时设置。 |
extra | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 43、template 行 22 | 需要覆盖组件默认业务值时设置。 |
extraColor | string | "secondary" | 设置对应区域的颜色;消费位置:template 行 22 | 需要调整布局或视觉表现时设置。 |
note | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 30 | 需要覆盖组件默认业务值时设置。 |
noteColor | string | "caption" | 设置对应区域的颜色;消费位置:template 行 30 | 需要调整布局或视觉表现时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 28、template 行 7 | 需要提供业务文案或图标内容时设置。 |
thumb | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 28、template 行 5 | 需要覆盖组件默认业务值时设置。 |
iconTheme | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 7 | 需要覆盖组件默认业务值时设置。 |
iconVariant | string | "soft" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 7 | 需要覆盖组件默认业务值时设置。 |
iconSize | string | "sm" | 设置对应元素尺寸;消费位置:template 行 7 | 需要调整布局或视觉表现时设置。 |
rightIcon | string | "" | 设置对应区域的图标名称;消费位置:script 行 29、script 行 43、template 行 27 | 需要提供业务文案或图标内容时设置。 |
rightText | string | "" | 设置对应区域的显示文案;消费位置:script 行 43、template 行 27 | 需要提供业务文案或图标内容时设置。 |
rightTextColor | string | "secondary" | 设置对应区域的颜色;消费位置:template 行 27 | 需要调整布局或视觉表现时设置。 |
badge | UTSJSONObject | null | null | 参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 36、script 行 37、script 行 38、script 行 39 | 需要覆盖组件默认业务值时设置。 |
badgeText | string | "" | 设置对应区域的显示文案;消费位置:script 行 36、script 行 38 | 需要提供业务文案或图标内容时设置。 |
valueTag | any | null | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 30、script 行 31 | 需要覆盖组件默认业务值时设置。 |
theme | string | "primary" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 32、template 行 7 | 需要调整布局或视觉表现时设置。 |
variant | string | "surface" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44 | 需要调整布局或视觉表现时设置。 |
size | string | "md" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44 | 需要覆盖组件默认业务值时设置。 |
valueBold | boolean | false | 提供当前受控状态;是否回写以事件表为准;消费位置:template 行 21 | 需要覆盖组件默认业务值时设置。 |
titleBold | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15 | 需要提供业务文案或图标内容时设置。 |
required | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15 | 需要控制显示、可用性或交互状态时设置。 |
selected | boolean | false | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 44 | 需要覆盖组件默认业务值时设置。 |
checked | boolean | false | 开关对应显示或交互行为;消费位置:script 行 52、template 行 26 | 需要覆盖组件默认业务值时设置。 |
switchable | boolean | false | 参与组件运行逻辑;源码在 9 处读取该值;消费位置:script 行 29、script 行 43、script 行 44、script 行 51 | 需要覆盖组件默认业务值时设置。 |
switchColor | string | "#2563eb" | 设置对应区域的颜色;消费位置:template 行 26 | 需要调整布局或视觉表现时设置。 |
arrow | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 29 | 需要覆盖组件默认业务值时设置。 |
arrowIcon | string | "chevron_right" | 设置对应区域的图标名称;消费位置:template 行 27 | 需要提供业务文案或图标内容时设置。 |
arrowTheme | string | "secondary" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 27 | 需要覆盖组件默认业务值时设置。 |
url | string | "" | 参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 29、script 行 44、script 行 53、script 行 54 | 需要覆盖组件默认业务值时设置。 |
openType | string | "navigateTo" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 53 | 需要覆盖组件默认业务值时设置。 |
clickable | boolean | false | 开关对应显示或交互行为;消费位置:script 行 44、script 行 54 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 44、script 行 51、script 行 52、script 行 54 | 需要控制显示、可用性或交互状态时设置。 |
center | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44 | 需要覆盖组件默认业务值时设置。 |
divider | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 32 | 需要覆盖组件默认业务值时设置。 |
inset | string | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 50 | 需要覆盖组件默认业务值时设置。 |
sideAlign | string | "center" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42 | 需要覆盖组件默认业务值时设置。 |
radius | string | number | 28 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46 | 需要覆盖组件默认业务值时设置。 |
paddingX | string | number | 24 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46 | 需要覆盖组件默认业务值时设置。 |
paddingY | string | number | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 46 | 需要覆盖组件默认业务值时设置。 |
titleWidth | string | number | "" | 设置对应区域宽度;消费位置:script 行 46、script 行 48 | 需要调整布局或视觉表现时设置。 |
tone | string | "" | 参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 32、script 行 44、script 行 45 | 需要覆盖组件默认业务值时设置。 |
accent | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44 | 需要覆盖组件默认业务值时设置。 |
accentColor | string | "" | 设置对应区域的颜色;消费位置:script 行 45 | 需要调整布局或视觉表现时设置。 |
thumbSize | string | number | 72 | 设置对应元素尺寸;消费位置:script 行 47 | 需要调整布局或视觉表现时设置。 |
thumbRadius | string | number | 20 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47 | 需要调整布局或视觉表现时设置。 |
thumbShape | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 47 | 需要覆盖组件默认业务值时设置。 |
thumbRing | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | handleClick 内触发(script 行 54);参数表达式:event;前置 guard:props.disabled || (!props.clickable && !props.switchable && props.url.length == 0) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
cell-click | handleClick 内触发(script 行 54);参数表达式:event;前置 guard:props.disabled || (!props.clickable && !props.switchable && props.url.length == 0) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | handleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchabletoggleSwitch 内触发(script 行 52);参数表达式:value;前置 guard:props.disabled || !props.switchable | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
switch-change | handleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchabletoggleSwitch 内触发(script 行 52);参数表达式:value;前置 guard:props.disabled || !props.switchable | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:checked | handleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchabletoggleSwitch 内触发(script 行 52);参数表达式:value;前置 guard:props.disabled || !props.switchable | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
thumb | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
icon | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
title | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
desc | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
value | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
extra | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
value-tag | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
badge | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
right | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
footer | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
toggleSwitch | toggleSwitch(): void | 调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-card-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-cell-accent):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-cell-title-width):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface-muted):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-popup-bg):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-shadow-card):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-shadow-glass):组件样式实际读取的主题变量,可在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。