xtf-icon

组件说明

xtf-icon 是图标，用于通过内置字体映射展示图形、徽标和动效。当前实现通过 click 等事件反馈交互。

• 实际 Demo 路由：#/pages/components/xtf-icon/index
• Demo 源码

---

基础用法

1. 最小可用

提供能够直接看到或操作组件的最少业务内容。

<template>
  <view class="doc-minimum">
    <XtfIcon name="home" />
  </view>
</template>

<script setup lang="uts">
import XtfIcon from "@/uni_modules/xtf-linkuiunix/components/xtf-icon/xtf-icon.uvue"

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件

使用组件真实数据入口，并记录当前源码声明的主要事件。

<template>
  <view class="doc-core">
    <XtfIcon name="home" :clickable="true" @click="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfIcon from "@/uni_modules/xtf-linkuiunix/components/xtf-icon/xtf-icon.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-icon:click", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 filled 状态

运行时切换 filled，观察组件对应状态变化。

<template>
  <view class="doc-dynamic">
    <XtfIcon name="home" :filled="state" />
    <button class="doc-action-button" @click="toggleState">切换 filled</button>
    <text class="doc-state-text">filled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfIcon from "@/uni_modules/xtf-linkuiunix/components/xtf-icon/xtf-icon.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("filled", 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>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
name	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 144	需要覆盖组件默认业务值时设置。
size	XtfIconSize | number | string	"md"	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 150、script 行 156	需要覆盖组件默认业务值时设置。
color	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 165	需要覆盖组件默认业务值时设置。
theme	XtfIconTheme	"primary"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 150	需要调整布局或视觉表现时设置。
variant	"plain" | "soft"	"plain"	参与组件运行逻辑；源码在 1 处读取该值；可选值：plain / soft；消费位置：script 行 147	需要调整布局或视觉表现时设置。
bg	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 166	需要覆盖组件默认业务值时设置。
filled	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 139	需要覆盖组件默认业务值时设置。
weight	number | string	300	兼容接收，当前实现未消费/不产生行为	仅用于兼容现有调用；当前版本不应依赖其效果。
grad	number | string	0	兼容接收，当前实现未消费/不产生行为	仅用于兼容现有调用；当前版本不应依赖其效果。
opsz	number | string	24	兼容接收，当前实现未消费/不产生行为	仅用于兼容现有调用；当前版本不应依赖其效果。
padding	number | string	0	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 167	需要覆盖组件默认业务值时设置。
radius	number | string	0	参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 168	需要覆盖组件默认业务值时设置。
round	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 148	需要覆盖组件默认业务值时设置。
clickable	boolean	false	开关对应显示或交互行为；消费位置：script 行 149、script 行 181	需要覆盖组件默认业务值时设置。
spin	boolean	false	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 74、script 行 89、script 行 153	需要覆盖组件默认业务值时设置。
pulse	boolean	false	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 73、script 行 89、script 行 153	需要覆盖组件默认业务值时设置。
dot	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 4	需要覆盖组件默认业务值时设置。
badge	string | number	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 173、script 行 175	需要覆盖组件默认业务值时设置。
badgeMax	number	99	参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 176	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 150	需要调整布局或视觉表现时设置。
customStyle	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
click	handleClick 内触发（script 行 181）；参数表达式：event	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

插槽	Scope 参数	实际渲染位置
-	-	当前模板没有公开 slot。

---

方法

实例方法

方法	签名 / 返回值	调用边界
-	-	当前组件没有公开实例方法。

公开状态

状态	类型 / 包装	读取边界
-	-	当前组件没有公开状态。

---

主题说明

• var(--xtf-color-danger)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-danger-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-info)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-info-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-primary)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-primary-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-success)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-success-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-surface-muted)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-text-disabled)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-text-secondary)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-warning)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-warning-soft)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-bg)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-color)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-padding)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-radius)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-size)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-icon-soft-bg)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-radius-full)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。

---

平台与实现边界

• 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
• Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
• 本文按当前源码生成，不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
• 当前仅兼容接收、未发现运行消费的 props：weight、grad、opsz。
• 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。