Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Apply VueUse composables in Vue 3/Nuxt projects to replace custom implementations with battle-tested utilities.
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
references/useNow.md
1---2category: Animation3---45# useNow67Reactive current Date instance.89## Usage1011```ts12import { useNow } from '@vueuse/core'1314const now = useNow()15```1617```ts18import { useNow } from '@vueuse/core'19// ---cut---20const { now, pause, resume } = useNow({ controls: true })21```2223## Component Usage2425```vue26<template>27<UseNow v-slot="{ now, pause, resume }">28Now: {{ now }}29<button @click="pause()">30Pause31</button>32<button @click="resume()">33Resume34</button>35</UseNow>36</template>37```3839## Type Declarations4041```ts42export interface UseNowOptions<43Controls extends boolean,44> extends ConfigurableScheduler {45/**46* Expose more controls47*48* @default false49*/50controls?: Controls51/**52* Start the clock immediately53*54* @deprecated Please use `scheduler` option instead55* @default true56*/57immediate?: boolean58/**59* Update interval in milliseconds, or use requestAnimationFrame60*61* @deprecated Please use `scheduler` option instead62* @default requestAnimationFrame63*/64interval?: "requestAnimationFrame" | number65}66export type UseNowReturn<Controls extends boolean> = Controls extends true67? {68now: Ref<Date>69} & Pausable70: Ref<Date>71/**72* Reactive current Date instance.73*74* @see https://vueuse.org/useNow75* @param options76*77* @__NO_SIDE_EFFECTS__78*/79export declare function useNow(options?: UseNowOptions<false>): Ref<Date>80export declare function useNow(options: UseNowOptions<true>): {81now: Ref<Date>82} & Pausable83```84