xtf-steps

组件说明

xtf-steps 是步骤条，用于展示流程阶段与当前进度。当前实现读取 items 数据、通过 click 等事件反馈交互。

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

---

基础用法

1. 最小可用

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

<template>
  <view class="doc-minimum">
    <XtfSteps :items="fixture" />
  </view>
</template>

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

const fixture = [{ title: '填写' }, { title: '确认' }, { title: '完成' }] as Array<any>
</script>

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

2. 核心数据与主要事件

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

<template>
  <view class="doc-core">
    <XtfSteps :items="fixture" :clickable="true" @click="onPrimaryEvent" />
  </view>
</template>

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

const fixture = [{ title: '填写' }, { title: '确认' }, { title: '完成' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-steps:click", payload) }
</script>

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

3. 动态 clickable 状态

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

<template>
  <view class="doc-dynamic">
    <XtfSteps :items="fixture" :clickable="state" />
    <button class="doc-action-button" @click="toggleState">切换 clickable</button>
    <text class="doc-state-text">clickable: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"
const fixture = [{ title: '填写' }, { title: '确认' }, { title: '完成' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("clickable", 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. 定制 icon 插槽

使用源码真实声明的 icon slot 替换对应内容。

<template>
  <view class="doc-slot">
    <XtfSteps :items="fixture">
      <template #icon="scope"><text class="doc-content-text">自定义 icon 内容：{{ scope.item }}</text></template>
    </XtfSteps>
  </view>
</template>

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

const fixture = [{ title: '填写' }, { title: '确认' }, { title: '完成' }] as Array<any>
</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
items	any[]	() => [] as any[]	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 14、script 行 20	数据驱动或选项渲染场景。
current	string | number	0	提供当前受控状态；是否回写以事件表为准；消费位置：script 行 14	需要覆盖组件默认业务值时设置。
direction	string	"horizontal"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 19	需要覆盖组件默认业务值时设置。
mode	string	"number"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 21	需要覆盖组件默认业务值时设置。
nodeSize	string | number	44	设置对应元素尺寸；消费位置：script 行 27	需要调整布局或视觉表现时设置。
lineThickness	string | number	4	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 27	需要覆盖组件默认业务值时设置。
clickable	boolean	false	开关对应显示或交互行为；消费位置：script 行 24、script 行 28	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 26	需要调整布局或视觉表现时设置。
customStyle	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 27	需要调整布局或视觉表现时设置。

---

事件

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

---

插槽

插槽	Scope 参数	实际渲染位置
icon	{ item, index }	仅在模板对应 <slot> 渲染位置生效。
title	{ item, index }	仅在模板对应 <slot> 渲染位置生效。
desc	{ item, index }	仅在模板对应 <slot> 渲染位置生效。

---

方法

实例方法

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

公开状态

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

---

主题说明

• var(--xtf-color-border)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-danger)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-danger-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)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-color-text-secondary)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-opacity-disabled)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-error-border)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-finish-border)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-finish-line)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-line-thickness)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-node-size)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-process-border)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-process-glow)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
• var(--xtf-steps-process-line)：组件样式实际读取的主题变量，可在 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。