Appearance
xtf-description-item
组件说明
xtf-description-item 是描述列表子项,用于在 Descriptions 上下文中展示标签、值并控制跨列宽度。当前实现按源码声明的 props 渲染内容。
- 实际 Demo 路由:
#/pages/components/xtf-descriptions/index - Demo 源码
基础用法
1. 标签与值
DescriptionItem 必须放在 Descriptions 中,父组件提供列数、间距和视觉 context。
vue
<template>
<view class="doc-description-basic">
<XtfDescriptions :columns="2"><XtfDescriptionItem label="订单号" value="SO-20261029" /><XtfDescriptionItem label="状态" value="待发货" /></XtfDescriptions>
</view>
</template>
<script setup lang="uts">
import XtfDescriptions from "@/uni_modules/xtf-linkuiunix/components/xtf-descriptions/xtf-descriptions.uvue"
import XtfDescriptionItem from "@/uni_modules/xtf-linkuiunix/components/xtf-description-item/xtf-description-item.uvue"
console.log("description values ready")
</script>
<style>
.doc-description-basic { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 跨列内容
span 会限制在父 columns 范围内,并按百分比计算当前项宽度。
vue
<template>
<view class="doc-description-span">
<XtfDescriptions :columns="2" bordered><XtfDescriptionItem label="客户" value="星海商贸" /><XtfDescriptionItem label="配送地址" value="深圳市南山区科技园" :span="2" /></XtfDescriptions>
</view>
</template>
<script setup lang="uts">
import XtfDescriptions from "@/uni_modules/xtf-linkuiunix/components/xtf-descriptions/xtf-descriptions.uvue"
import XtfDescriptionItem from "@/uni_modules/xtf-linkuiunix/components/xtf-description-item/xtf-description-item.uvue"
console.log("description span", 2)
</script>
<style>
.doc-description-span { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 标签与默认插槽
label slot 替换标签区域,default slot 替换值区域。
vue
<template>
<view class="doc-description-slots">
<XtfDescriptions :columns="1" layout="vertical"><XtfDescriptionItem><template #label><text class="doc-content-text">订单备注</text></template><template #default><text class="doc-content-text">请在工作日配送</text></template></XtfDescriptionItem></XtfDescriptions>
</view>
</template>
<script setup lang="uts">
import XtfDescriptions from "@/uni_modules/xtf-linkuiunix/components/xtf-descriptions/xtf-descriptions.uvue"
import XtfDescriptionItem from "@/uni_modules/xtf-linkuiunix/components/xtf-description-item/xtf-description-item.uvue"
console.log("description slots ready")
</script>
<style>
.doc-description-slots { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
label | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 4 | 需要提供业务文案或图标内容时设置。 |
value | any | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 5 | 需要覆盖组件默认业务值时设置。 |
span | number | 1 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 37 | 需要覆盖组件默认业务值时设置。 |
layout | "" | "horizontal" | "vertical" | "" | 参与组件运行逻辑;源码在 2 处读取该值;可选值:"" / horizontal / vertical;消费位置:script 行 38 | 需要调整布局或视觉表现时设置。 |
labelWidth | string | number | "" | 设置对应区域宽度;消费位置:script 行 39 | 需要调整布局或视觉表现时设置。 |
labelClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 43 | 需要调整布局或视觉表现时设置。 |
valueClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 44、template 行 5 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | string | UTSJSONObject | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 47 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
| - | 当前组件未调用 defineEmits。 | - | - |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
default | (props: {}) | 仅在模板对应 <slot> 渲染位置生效。 |
label | (props: {}) | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在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。