WGShare.Client.Wx/miniprogram_npm/tdesign-miniprogram/count-down/README.md

3.7 KiB
Raw Permalink Blame History

title description spline isComponent
CountDown 倒计时 用于实时展示倒计时数值。 data true

CountDown 组件用于实时展示倒计时数值。 如果需要与站点演示一致的数字字体效果,推荐您到 数字字体章节,将 TCloudNumber 字体下载并将包含的 TCloudNumberVF.ttf 做为 TCloudNumber 字体资源引入到具体项目中使用。

引入

全局引入,在 miniprogram 根目录下的app.json中配置,局部引入,在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-count-down": "tdesign-miniprogram/count-down/count-down"
}

代码演示

在开发者工具中预览效果

Tips: 请确保开发者工具为打开状态。导入开发者工具后依次执行npm i > 构建npm包 > 勾选 "将JS编译成ES5"

基础倒计时

{{ base }}

调整尺寸

{{ size }}

API

CountDown Props

名称 类型 默认值 描述 必传
style Object - 样式 N
custom-style Object - 样式,一般用于开启虚拟化组件节点场景 N
auto-start Boolean true 是否自动开始倒计时 N
content String / Slot 'default' 最终倒计时的展示内容,值为'default'时使用默认的格式,否则使用自定义样式插槽。通用类型定义 N
format String HH:mm:ss 时间格式DD-日HH-时mm-分ss-秒SSS-毫秒 N
millisecond Boolean false 是否开启毫秒级渲染 N
size String 'medium' 0.5.1。倒计时尺寸。可选项small/medium/large N
split-with-unit Boolean false 0.5.1。使用时间单位分割 N
theme String 'default' 0.5.1。倒计时风格。可选项default/round/square N
time Number 0 必需。倒计时时长,单位毫秒 Y

CountDown Events

名称 参数 描述
change (time: TimeData) 时间变化时触发。详细类型定义
interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }
finish - 倒计时结束时触发

CountDown External Classes

类名 描述
t-class 根节点样式类
t-class-count 计数样式类
t-class-split 分隔线样式类

CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。

名称 默认值 描述
--td-countdown-bg-color @error-color-6 -
--td-countdown-default-color @font-gray-1 -
--td-countdown-round-border-radius @radius-circle -
--td-countdown-round-color @font-white-1 -
--td-countdown-square-border-radius @radius-small -