Vant3 useCountDown

介紹

提供倒計(jì)時(shí)管理能力。

代碼演示

基本用法

<span>總時(shí)間：{{ current.total }}</span>
<span>剩余天數(shù)：{{ current.days }}</span>
<span>剩余小時(shí)：{{ current.hours }}</span>
<span>剩余分鐘：{{ current.minutes }}</span>
<span>剩余秒數(shù)：{{ current.seconds }}</span>
<span>剩余毫秒：{{ current.milliseconds }}</span>

import { useCountDown } from '@vant/use';

export default {
  setup() {
    const countDown = useCountDown({
      // 倒計(jì)時(shí) 24 小時(shí)
      time: 24 * 60 * 60 * 1000,
    });

    // 開(kāi)始倒計(jì)時(shí)
    countDown.start();

    return {
      current: countDown.current,
    };
  },
};

毫秒級(jí)渲染

倒計(jì)時(shí)默認(rèn)每秒渲染一次，設(shè)置 millisecond 選項(xiàng)可以開(kāi)啟毫秒級(jí)渲染。

import { useCountDown } from '@vant/use';

export default {
  setup() {
    const countDown = useCountDown({
      time: 24 * 60 * 60 * 1000,
      millisecond: true,
    });
    countDown.start();

    return {
      current: countDown.current,
    };
  },
};

API

類型定義

type CurrentTime = {
  days: number;
  hours: number;
  total: number;
  minutes: number;
  seconds: number;
  milliseconds: number;
};

type CountDown = {
  start: () => void;
  pause: () => void;
  reset: (totalTime: number) => void;
  current: ComputedRef<CurrentTime>;
};

type UseCountDownOptions = {
  time: number;
  millisecond?: boolean;
  onChange?: (current: CurrentTime) => void;
  onFinish?: () => void;
};

function useCountDown(options: UseCountDownOptions): CountDown;

參數(shù)

返回值

CurrentTime 格式