Appearance
xtf-count-to
组件说明
xtf-count-to 是数字滚动,用于从起始值动画递增或递减到目标值。当前实现通过 mounted 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-count-to/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfCountTo end="1280" />
</view>
</template>
<script setup lang="uts">
import XtfCountTo from "@/uni_modules/xtf-linkuiunix/components/xtf-count-to/xtf-count-to.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfCountTo end="1280" @mounted="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfCountTo from "@/uni_modules/xtf-linkuiunix/components/xtf-count-to/xtf-count-to.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-count-to:mounted", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 autoplay 状态
运行时切换 autoplay,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfCountTo end="1280" :autoplay="state" />
<button class="doc-action-button" @click="toggleState">切换 autoplay</button>
<text class="doc-state-text">autoplay: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfCountTo from "@/uni_modules/xtf-linkuiunix/components/xtf-count-to/xtf-count-to.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("autoplay", 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. 调用 start()
开始执行;签名为 start(target: number = props.end): void。
vue
<template>
<view class="doc-method">
<XtfCountTo end="1280" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">开始执行</button>
</view>
</template>
<script setup lang="uts">
import XtfCountTo from "@/uni_modules/xtf-linkuiunix/components/xtf-count-to/xtf-count-to.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.start(); console.log("调用 start") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
end | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 34、script 行 73 | 需要覆盖组件默认业务值时设置。 |
start | number | 0 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 7、script 行 61 | 需要覆盖组件默认业务值时设置。 |
duration | string | number | 2000 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 40 | 需要覆盖组件默认业务值时设置。 |
decimals | number | 0 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 18 | 需要覆盖组件默认业务值时设置。 |
separator | string | "," | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 24 | 需要覆盖组件默认业务值时设置。 |
decimal | string | "." | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 27 | 需要覆盖组件默认业务值时设置。 |
prefix | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 3 | 需要覆盖组件默认业务值时设置。 |
suffix | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 5 | 需要覆盖组件默认业务值时设置。 |
autoplay | boolean | true | 开关对应显示或交互行为;消费位置:script 行 74 | 需要覆盖组件默认业务值时设置。 |
useEasing | boolean | true | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 15 | 需要覆盖组件默认业务值时设置。 |
easing | string | "easeOutExpo" | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 15 | 需要覆盖组件默认业务值时设置。 |
color | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 68 | 需要覆盖组件默认业务值时设置。 |
size | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 69 | 需要覆盖组件默认业务值时设置。 |
bold | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 67 | 需要覆盖组件默认业务值时设置。 |
align | string | "left" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 64 | 需要调整布局或视觉表现时设置。 |
lineHeight | string | number | "" | 设置对应区域高度;消费位置:script 行 70 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 64 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 65 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
mounted | setup 内触发(script 行 74);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
finished | start 内触发(script 行 44);参数表达式:end;前置 guard:disposed、duration == 0 || from == endsetup 内触发(script 行 58);参数表达式:end;前置 guard:disposed || activeRun != run | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | start 内触发(script 行 43);参数表达式:end;前置 guard:disposed、duration == 0 || from == endsetup 内触发(script 行 56);参数表达式:current.value;前置 guard:disposed || activeRun != runreset 内触发(script 行 61);参数表达式:current.value;前置 guard:disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
start | start(target: number = props.end): void | 开始执行;通过组件 ref 调用,参数和返回值按签名处理。 |
stop | stop(): void | 停止执行;通过组件 ref 调用,参数和返回值按签名处理。 |
reset | reset(): void | 恢复初始状态;通过组件 ref 调用,参数和返回值按签名处理。 |
update | update(value: number): void | 调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-text):组件样式实际读取的主题变量,可在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。