Skip to content

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 默认值实际行为 / 范围适用范围
titlestring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15需要提供业务文案或图标内容时设置。
eyebrowstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 14需要覆盖组件默认业务值时设置。
eyebrowColorstring"caption"设置对应区域的颜色;消费位置:template 行 14需要调整布局或视觉表现时设置。
descstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 18需要覆盖组件默认业务值时设置。
descColorstring"secondary"设置对应区域的颜色;消费位置:template 行 18需要调整布局或视觉表现时设置。
valuestring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 43、template 行 21需要覆盖组件默认业务值时设置。
valueColorstring"secondary"设置对应区域的颜色;消费位置:template 行 21需要调整布局或视觉表现时设置。
extrastring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 43、template 行 22需要覆盖组件默认业务值时设置。
extraColorstring"secondary"设置对应区域的颜色;消费位置:template 行 22需要调整布局或视觉表现时设置。
notestring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 30需要覆盖组件默认业务值时设置。
noteColorstring"caption"设置对应区域的颜色;消费位置:template 行 30需要调整布局或视觉表现时设置。
iconstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 28、template 行 7需要提供业务文案或图标内容时设置。
thumbstring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 28、template 行 5需要覆盖组件默认业务值时设置。
iconThemestring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 7需要覆盖组件默认业务值时设置。
iconVariantstring"soft"参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 7需要覆盖组件默认业务值时设置。
iconSizestring"sm"设置对应元素尺寸;消费位置:template 行 7需要调整布局或视觉表现时设置。
rightIconstring""设置对应区域的图标名称;消费位置:script 行 29、script 行 43、template 行 27需要提供业务文案或图标内容时设置。
rightTextstring""设置对应区域的显示文案;消费位置:script 行 43、template 行 27需要提供业务文案或图标内容时设置。
rightTextColorstring"secondary"设置对应区域的颜色;消费位置:template 行 27需要调整布局或视觉表现时设置。
badgeUTSJSONObject | nullnull参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 36、script 行 37、script 行 38、script 行 39需要覆盖组件默认业务值时设置。
badgeTextstring""设置对应区域的显示文案;消费位置:script 行 36、script 行 38需要提供业务文案或图标内容时设置。
valueTaganynull提供当前受控状态;是否回写以事件表为准;消费位置:script 行 30、script 行 31需要覆盖组件默认业务值时设置。
themestring"primary"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 32、template 行 7需要调整布局或视觉表现时设置。
variantstring"surface"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44需要调整布局或视觉表现时设置。
sizestring"md"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44需要覆盖组件默认业务值时设置。
valueBoldbooleanfalse提供当前受控状态;是否回写以事件表为准;消费位置:template 行 21需要覆盖组件默认业务值时设置。
titleBoldbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15需要提供业务文案或图标内容时设置。
requiredbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 15需要控制显示、可用性或交互状态时设置。
selectedbooleanfalse提供当前受控状态;是否回写以事件表为准;消费位置:script 行 44需要覆盖组件默认业务值时设置。
checkedbooleanfalse开关对应显示或交互行为;消费位置:script 行 52、template 行 26需要覆盖组件默认业务值时设置。
switchablebooleanfalse参与组件运行逻辑;源码在 9 处读取该值;消费位置:script 行 29、script 行 43、script 行 44、script 行 51需要覆盖组件默认业务值时设置。
switchColorstring"#2563eb"设置对应区域的颜色;消费位置:template 行 26需要调整布局或视觉表现时设置。
arrowbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 29需要覆盖组件默认业务值时设置。
arrowIconstring"chevron_right"设置对应区域的图标名称;消费位置:template 行 27需要提供业务文案或图标内容时设置。
arrowThemestring"secondary"参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 27需要覆盖组件默认业务值时设置。
urlstring""参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 29、script 行 44、script 行 53、script 行 54需要覆盖组件默认业务值时设置。
openTypestring"navigateTo"参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 53需要覆盖组件默认业务值时设置。
clickablebooleanfalse开关对应显示或交互行为;消费位置:script 行 44、script 行 54需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 44、script 行 51、script 行 52、script 行 54需要控制显示、可用性或交互状态时设置。
centerbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44需要覆盖组件默认业务值时设置。
dividerbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 32需要覆盖组件默认业务值时设置。
insetstring | number0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 50需要覆盖组件默认业务值时设置。
sideAlignstring"center"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42需要覆盖组件默认业务值时设置。
radiusstring | number28参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46需要覆盖组件默认业务值时设置。
paddingXstring | number24参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46需要覆盖组件默认业务值时设置。
paddingYstring | number""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 46需要覆盖组件默认业务值时设置。
titleWidthstring | number""设置对应区域宽度;消费位置:script 行 46、script 行 48需要调整布局或视觉表现时设置。
tonestring""参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 32、script 行 44、script 行 45需要覆盖组件默认业务值时设置。
accentbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44需要覆盖组件默认业务值时设置。
accentColorstring""设置对应区域的颜色;消费位置:script 行 45需要调整布局或视觉表现时设置。
thumbSizestring | number72设置对应元素尺寸;消费位置:script 行 47需要调整布局或视觉表现时设置。
thumbRadiusstring | number20参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47需要调整布局或视觉表现时设置。
thumbShapestring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 47需要覆盖组件默认业务值时设置。
thumbRingbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 44需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
clickhandleClick 内触发(script 行 54);参数表达式:event;前置 guard:props.disabled || (!props.clickable && !props.switchable && props.url.length == 0)(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
cell-clickhandleClick 内触发(script 行 54);参数表达式:event;前置 guard:props.disabled || (!props.clickable && !props.switchable && props.url.length == 0)(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changehandleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchable
toggleSwitch 内触发(script 行 52);参数表达式:value;前置 guard:props.disabled || !props.switchable
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
switch-changehandleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchable
toggleSwitch 内触发(script 行 52);参数表达式:value;前置 guard:props.disabled || !props.switchable
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:checkedhandleSwitchChange 内触发(script 行 51);参数表达式:value;前置 guard:props.disabled || !props.switchable
toggleSwitch 内触发(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> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
toggleSwitchtoggleSwitch(): 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。

MIT Licensed