useTimestamp

分类

动画

导出大小

709 B

上次更改

8 个月前

响应式当前时间戳

演示

源码演练场 (beta)

时间戳: 1761202149484

用法

import { useTimestamp
 } from '@vueuse/core'

const timestamp
 = useTimestamp
({ offset
: 0 })

const { timestamp
, pause
, resume
 } = useTimestamp
({ controls
: true })

组件用法

此函数还通过 @vueuse/components 包提供了一个无渲染组件版本。了解更多用法。

vue

<template>
  <UseTimestamp v-slot="{ timestamp
, pause
, resume
 }">
    Current Time: {{ timestamp
 }}
    <button
 @click
="pause
()">
      Pause
    </button
>
    <button
 @click
="resume
()">
      Resume
    </button
>
  </UseTimestamp>
</template>

类型声明

export interface UseTimestampOptions
<Controls
 extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls
?: Controls

  /**
   * Offset value adding to the value
   *
   * @default 0
   */
  offset
?: number
  /**
   * Update the timestamp immediately
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * Update interval, or use requestAnimationFrame
   *
   * @default requestAnimationFrame
   */
  interval
?: "requestAnimationFrame" | number
  /**
   * Callback on each update
   */
  callback
?: (timestamp
: number) => void
}
/**
 * Reactive current timestamp.
 *
 * @see https://vueuse.org.cn/useTimestamp
 * @param options
 */
export declare function useTimestamp
(
  options
?: UseTimestampOptions
<false>,
): ShallowRef
<number>
export declare function useTimestamp
(options
: UseTimestampOptions
<true>): {
  timestamp
: ShallowRef
<number>
} & Pausable

export type UseTimestampReturn
 = ReturnType
<typeof useTimestamp
>