倒计时 Countdown
倒计时组件用于实时展示倒计时数值,精度支持毫秒
使用
API安装使用
import { TiCountdown } from '@titian-design/mobile-vue'
用法示例
基础用法
<template>
<TiCountdown autoplay :time="time" />
</template>
<script lang="ts" setup>
import { TiCountdown } from '@titian-design/mobile-vue';
</script>
格式化时间
<template>
<TiCountdown format="HH:mm:ss SSS" />
<TiCountdown format="DD天HH时mm分ss SSS" />
<TiCountdown format="D天H时m分s SSS" />
</template>
<script lang="ts" setup>
import { TiCountdown } from '@titian-design/mobile-vue';
</script>
风格
<template>
<TiCountdown variant="pure" format="DD天HH:mm:ss SSS" />
<TiCountdown variant="block" format="DD天HH时mm分ss SSS" />
<TiCountdown variant="mixture" format="D天H时m分s SSS" />
</template>
<script lang="ts" setup>
import { TiCountdown } from '@titian-design/mobile-vue';
</script>
尺寸
在variant设为block
或者mixture
下生效,对应块状尺寸分别为32px
40px
44px
48px
<template>
<TiCountdown variant="block" size="small" />
<TiCountdown variant="block" size="medium" />
<TiCountdown variant="block" size="big" />
<TiCountdown variant="block" size="large" />
</template>
<script lang="ts" setup>
import { TiCountdown } from '@titian-design/mobile-vue';
</script>
启动、暂停、重置
<template>
<TiCountdown ref="countdownRef" time="118888666" />
</template>
<script lang="ts" setup>
import { ref } from 'vue';
import { TiCountdown } from '@titian-design/mobile-vue';
const countdownRef = ref();
const onStart = () => ref.value.$el.start()
const onPause = () => ref.value.$el.pause()
const onReset = () => ref.value.$el.reset()
</script>
自定义内容
<template>
<TiCountdown time="118888666" use-slot @change="onChange">
<div class="time">{{time.day}}</div>
<div class="tag">天</div>
<div class="time">{{time.hour}}</div>
<div class="tag">:</div>
<div class="time">{{time.minute}}</div>
<div class="tag">:</div>
<div class="time">{{time.second}}</div>
<div class="tag">:</div>
<div class="time">{{time.millisecond}}</div>
</TiCountdown>
</template>
<script lang="ts" setup>
import { TiCountdown } from '@titian-design/mobile-vue';
</script>
TiCountdown API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
variant | string | 否 | pure | 倒计时的风格,可选值:pure block mixture | - |
size | string | 否 | medium | 倒计时的尺寸,在variant设为block 或者mixture 下生效,可选值:small medium big large ,对应块状尺寸分别为32px 40px 44px 48px | - |
time | number | 否 | 1200 | 倒计时时长,单位毫秒 | - |
format | string | 否 | HH:mm:ss | 时间格式,DD-日,HH-时,mm-分,ss-秒,SSS-毫秒 | - |
autoplay | boolean | 否 | false | 是否自动开始倒计时 | - |
use-slot | boolean | 否 | false | 是否使用自定义样式插槽 | - |
ext-style | string | 否 | - | 根节点样式 | - |
事件 Events
名称 | 参数列表 | 描述 | 备注 |
---|---|---|---|
finish | (e: CustomEvent) => void | 倒计时结束时触发 | - |
change | (e: CustomEvent<{day: number, hour: number, minute: number, second: number, millisecond: number}>) => void | 时间变化时触发 | - |
插槽 Slots
名称 | 说明 | 备注 |
---|---|---|
default | 默认插槽 | - |
外部样式类 External Classes
名称 | 说明 | 备注 |
---|---|---|
ext-class | 根节点样式类 | - |
CSS 变量 CSS Variable
变量 | 默认值 | 说明 | 备注 |
---|---|---|---|
--countdown-color | #757575 | 倒计时文字颜色,块状风格下默认值为#ff2e2e | - |
--countdown-font-size | 28px | 倒计时文字字号 | - |
--countdown-line-height | 34px | 倒计时文字行高 | - |
--countdown-border-radius | 8px | 块状风格下,圆角 | - |
--countdown-background | #fff2f2 | 块状风格下,背景色 | - |
--countdown-font-family | wemo | 块状风格下,文字字体 | - |
--countdown-font-weight | 600 | 块状风格下,文字字重 | - |
--countdown-day-color | 600 | 块状风格下,天数文字颜色 | - |
--countdown-day-font-size | 24px | 块状风格下,天数文字大小 | - |
--countdown-day-margin | - | 块状风格下,天数区域的间距 | - |
--countdown-dot-color | #212121 | 块状风格下,图标冒号颜色 | - |
--countdown-dot-size | 20 | 块状风格下,图标冒号大小 | - |
--countdown-size | - | 块状风格下,方块的大小 | - |
--countdown-millisecond-width | 52px | 块状风格下,毫秒区域的宽度 | - |