Skip to content

xtf-progress ​

组件说明 ​

xtf-progress 是线性进度,用于展示任务完成比例和状态文本。当前实现按源码声明的 props 渲染内容。

  • 实际 Demo 路由:#/pages/components/xtf-progress/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfProgress title="账单详情" />
  </view>
</template>

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

</script>

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

2. 核心数据与主要事件 ​

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

vue
<template>
  <view class="doc-core">
    <XtfProgress title="账单详情" :key="renderKey" />
    <button class="doc-action-button" @click="remountComponent">重新挂载组件</button>
  </view>
</template>

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

import { ref } from "vue"
const renderKey = ref(0)
function remountComponent(): void { renderKey.value += 1; console.log("xtf-progress 重新挂载", renderKey.value) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

3. 动态 showText 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfProgress title="账单详情" :show-text="state" />
    <button class="doc-action-button" @click="toggleState">切换 showText</button>
    <text class="doc-state-text">showText: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("showText", 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 默认值实际行为 / 范围适用范围
typestring"line"参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 48、script 行 49需要覆盖组件默认业务值时设置。
percentagestring | number0参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 45需要覆盖组件默认业务值时设置。
percentstring | numberundefined参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 45需要覆盖组件默认业务值时设置。
themestring"primary"参与组件运行逻辑;源码在 6 处读取该值;消费位置:script 行 77、script 行 82、script 行 83、script 行 84需要调整布局或视觉表现时设置。
variantstring"gradient"参与组件运行逻辑;源码在 9 处读取该值;消费位置:script 行 104、script 行 106、script 行 107、script 行 117需要调整布局或视觉表现时设置。
titlestring""参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 3、template 行 5需要提供业务文案或图标内容时设置。
descstring""参与组件运行逻辑;源码在 5 处读取该值;消费位置:template 行 3、template 行 6、template 行 12需要覆盖组件默认业务值时设置。
notestring""参与组件运行逻辑;源码在 5 处读取该值;消费位置:template 行 12、template 行 34需要覆盖组件默认业务值时设置。
showTextbooleantrue设置对应区域的显示文案;消费位置:script 行 76需要控制显示、可用性或交互状态时设置。
showInfostring | number | boolean""开关对应显示或交互行为;消费位置:script 行 76需要控制显示、可用性或交互状态时设置。
insideTextbooleanfalse设置对应区域的显示文案;消费位置:script 行 102、script 行 107、template 行 3、template 行 8需要提供业务文案或图标内容时设置。
stripedbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 25需要覆盖组件默认业务值时设置。
indeterminatebooleanfalse参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 19、template 行 23、template 行 29需要覆盖组件默认业务值时设置。
sizestring"md"参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 90、script 行 100、script 行 102需要覆盖组件默认业务值时设置。
strokeWidthstring | number""设置对应区域宽度;消费位置:script 行 91需要调整布局或视觉表现时设置。
trackColorstring""设置对应区域的颜色;消费位置:script 行 88需要调整布局或视觉表现时设置。
stepsstring | number0参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 46需要覆盖组件默认业务值时设置。
indicatorbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 19需要覆盖组件默认业务值时设置。
colorstring""参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 77、script 行 81需要覆盖组件默认业务值时设置。
activeColorstring""设置对应区域的颜色;消费位置:script 行 77、script 行 80需要调整布局或视觉表现时设置。
activebooleanfalse提供当前受控状态;是否回写以事件表为准;消费位置:script 行 51、script 行 58、script 行 71需要覆盖组件默认业务值时设置。
activeModestring"backwards"提供当前受控状态;是否回写以事件表为准;消费位置:script 行 59、script 行 72需要覆盖组件默认业务值时设置。
format(percentage: number) => stringundefined参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 101需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 102需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 103需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
-当前组件未调用 defineEmits。--

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-color-):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 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-progress-accent):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-progress-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-progress-stroke):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-progress-track):组件样式实际读取的主题变量,可在 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