Appearance
xtf-empty
组件说明
xtf-empty 是空状态,用于在无数据或异常场景展示说明与操作入口。当前实现通过 action 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-empty/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfEmpty title="账单详情" />
</view>
</template>
<script setup lang="uts">
import XtfEmpty from "@/uni_modules/xtf-linkuiunix/components/xtf-empty/xtf-empty.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfEmpty title="账单详情" @action="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfEmpty from "@/uni_modules/xtf-linkuiunix/components/xtf-empty/xtf-empty.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-empty:action", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 compact 状态
运行时切换 compact,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfEmpty title="账单详情" :compact="state" />
<button class="doc-action-button" @click="toggleState">切换 compact</button>
<text class="doc-state-text">compact: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfEmpty from "@/uni_modules/xtf-linkuiunix/components/xtf-empty/xtf-empty.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("compact", 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. 定制 image 插槽
使用源码真实声明的 image slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfEmpty title="账单详情">
<template #image><text class="doc-content-text">自定义 image 内容</text></template>
</XtfEmpty>
</view>
</template>
<script setup lang="uts">
import XtfEmpty from "@/uni_modules/xtf-linkuiunix/components/xtf-empty/xtf-empty.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
locale | XtfLocale | "" | "" | 参与组件运行逻辑;源码在 2 处读取该值;可选值:"";消费位置:script 行 80 | 需要覆盖组件默认业务值时设置。 |
type | string | "default" | 参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 85、script 行 88、script 行 90、script 行 91 | 需要覆盖组件默认业务值时设置。 |
image | string | "" | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 40、script 行 55、template 行 5 | 需要覆盖组件默认业务值时设置。 |
title | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 86 | 需要提供业务文案或图标内容时设置。 |
desc | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 87 | 需要覆盖组件默认业务值时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 88 | 需要提供业务文案或图标内容时设置。 |
iconSize | string | number | "xl" | 设置对应元素尺寸;消费位置:template 行 9 | 需要调整布局或视觉表现时设置。 |
imageSize | string | number | "" | 设置对应元素尺寸;消费位置:script 行 93 | 需要调整布局或视觉表现时设置。 |
theme | string | "primary" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 9、template 行 19 | 需要调整布局或视觉表现时设置。 |
actionText | string | "" | 设置对应区域的显示文案;消费位置:template 行 17、template 行 19 | 需要提供业务文案或图标内容时设置。 |
compact | boolean | false | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 89、template 行 13、template 行 17 | 需要覆盖组件默认业务值时设置。 |
float | boolean | true | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 40、script 行 55、script 行 89、script 行 90 | 需要覆盖组件默认业务值时设置。 |
animated | boolean | true | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 32、script 行 55 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 89 | 需要调整布局或视觉表现时设置。 |
customStyle | string | UTSJSONObject | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 92 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
action | handleAction 内触发(script 行 94);参数表达式:event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
click | handleAction 内触发(script 行 94);参数表达式:event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
image | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
action | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger-soft):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-warning-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。