press-pix/common/hooks/use-count-down/type.ts

基于 PixUI 的 Press 组件库

export interface CountDownProps {
  /**
   * 是否自动开始倒计时
   * @default true
   */
  autoStart?: boolean;
  /**
   * 时间格式，DD-日，HH-时，mm-分，ss-秒，SSS-毫秒
   * @default HH:mm:ss
   */
  format?: string;
  /**
   * 是否开启毫秒级渲染
   * @default false
   */
  millisecond?: boolean;
  /**
   * 倒计时尺寸
   * @default 'medium'
   */
  size?: 'small' | 'medium' | 'large';
  /**
   * 使用时间单位分割
   * @default false
   */
  splitWithUnit?: boolean;
  /**
   * 倒计时风格
   * @default 'default'
   */
  theme?: 'default' | 'round' | 'square';
  /**
   * 倒计时时长，单位毫秒
   * @default 0
   */
  time: number;
  /**
   * 时间变化时触发
   */
  onChange?: (time: TimeData) => void;
  /**
   * 倒计时结束时触发
   */
  onFinish?: () => void;
  /**
   * 是否增长显示，比如匹配时长
   * @default false
   */
  ascending?: boolean;
}

export interface TimeData {
  days: number;
  hours: number;
  minutes: number;
  seconds: number;
  milliseconds: number;
}