Appearance
xtf-countdown
组件说明
xtf-countdown 是倒计时,用于按指定格式展示剩余时间。当前实现通过 change 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-countdown/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfCountdown :time="60000" />
</view>
</template>
<script setup lang="uts">
import XtfCountdown from "@/uni_modules/xtf-linkuiunix/components/xtf-countdown/xtf-countdown.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfCountdown :time="60000" @change="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfCountdown from "@/uni_modules/xtf-linkuiunix/components/xtf-countdown/xtf-countdown.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-countdown:change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 autoStart 状态
运行时切换 autoStart,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfCountdown :time="60000" :auto-start="state" />
<button class="doc-action-button" @click="toggleState">切换 autoStart</button>
<text class="doc-state-text">autoStart: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfCountdown from "@/uni_modules/xtf-linkuiunix/components/xtf-countdown/xtf-countdown.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("autoStart", 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(): void。
vue
<template>
<view class="doc-method">
<XtfCountdown :time="60000" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">开始执行</button>
</view>
</template>
<script setup lang="uts">
import XtfCountdown from "@/uni_modules/xtf-linkuiunix/components/xtf-countdown/xtf-countdown.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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
time | number | 0 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 13、script 行 70、script 行 84 | 需要覆盖组件默认业务值时设置。 |
format | string | "HH:MM:SS" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 24、script 行 79 | 需要覆盖组件默认业务值时设置。 |
autoStart | boolean | true | 开关对应显示或交互行为;消费位置:script 行 84、script 行 92 | 需要覆盖组件默认业务值时设置。 |
millisecond | boolean | false | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 22、script 行 46、script 行 85 | 需要覆盖组件默认业务值时设置。 |
mode | string | "block" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 80、script 行 81、script 行 82、script 行 83 | 需要覆盖组件默认业务值时设置。 |
separator | string | ":" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 9 | 需要覆盖组件默认业务值时设置。 |
showLabels | boolean | false | 开关对应显示或交互行为;消费位置:template 行 7 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 80 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
change | syncRemaining 内触发(script 行 40);参数表达式:parts(remaining.value)reset 内触发(script 行 77);参数表达式:parts(remaining.value) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
finish | syncRemaining 内触发(script 行 42);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
start | start(): void | 开始执行;通过组件 ref 调用,参数和返回值按签名处理。 |
pause | pause(): void | 暂停执行;通过组件 ref 调用,参数和返回值按签名处理。 |
resume | resume(): void | 继续执行;通过组件 ref 调用,参数和返回值按签名处理。 |
reset | reset(nextTime: number = props.time): void | 恢复初始状态;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-countdown-block-bg):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-countdown-block-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-countdown-split-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。