/
index.ts
81 lines (68 loc) · 1.85 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
import { ref } from 'vue-demi'
import type { Pausable } from '@vueuse/shared'
import { tryOnScopeDispose } from '@vueuse/shared'
import type { ConfigurableWindow } from '../_configurable'
import { defaultWindow } from '../_configurable'
interface RafFnCallbackArguments {
/**
* Time elapsed between this and the last frame.
*/
delta: number
/**
* Time elapsed since the creation of the web page. See {@link https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#the_time_origin Time origin}.
*/
timestamp: DOMHighResTimeStamp
}
export interface UseRafFnOptions extends ConfigurableWindow {
/**
* Start the requestAnimationFrame loop immediately on creation
*
* @default true
*/
immediate?: boolean
}
/**
* Call function on every `requestAnimationFrame`. With controls of pausing and resuming.
*
* @see https://vueuse.org/useRafFn
* @param fn
* @param options
*/
export function useRafFn(fn: (args: RafFnCallbackArguments) => void, options: UseRafFnOptions = {}): Pausable {
const {
immediate = true,
window = defaultWindow,
} = options
const isActive = ref(false)
let previousFrameTimestamp = 0
let rafId: null | number = null
function loop(timestamp: DOMHighResTimeStamp) {
if (!isActive.value || !window)
return
const delta = timestamp - previousFrameTimestamp
fn({ delta, timestamp })
previousFrameTimestamp = timestamp
rafId = window.requestAnimationFrame(loop)
}
function resume() {
if (!isActive.value && window) {
isActive.value = true
rafId = window.requestAnimationFrame(loop)
}
}
function pause() {
isActive.value = false
if (rafId != null && window) {
window.cancelAnimationFrame(rafId)
rafId = null
}
}
if (immediate)
resume()
tryOnScopeDispose(pause)
return {
isActive,
pause,
resume,
}
}