forked from vueuse/vueuse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.test.ts
230 lines (176 loc) · 6.42 KB
/
index.test.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
import type { Fn } from '@vueuse/shared'
import type { SpyInstance } from 'vitest'
import { noop } from '@vueuse/shared'
import { isVue2 } from 'vue-demi'
import type { Ref } from 'vue'
import { effectScope, nextTick, ref } from 'vue'
import { useEventListener } from '.'
describe('useEventListener', () => {
const options = { capture: true }
let stop: Fn
let target: HTMLDivElement
let removeSpy: SpyInstance
let addSpy: SpyInstance
beforeEach(() => {
target = document.createElement('div')
removeSpy = vitest.spyOn(target, 'removeEventListener')
addSpy = vitest.spyOn(target, 'addEventListener')
})
it('should be defined', () => {
expect(useEventListener).toBeDefined()
})
describe('given both none array', () => {
const listener = vitest.fn()
const event = 'click'
beforeEach(() => {
listener.mockReset()
stop = useEventListener(target, event, listener, options)
})
it('should add listener', () => {
expect(addSpy).toBeCalledTimes(1)
})
it('should trigger listener', () => {
expect(listener).not.toBeCalled()
target.dispatchEvent(new MouseEvent(event))
expect(listener).toBeCalledTimes(1)
})
it('should remove listener', () => {
expect(removeSpy).not.toBeCalled()
stop()
expect(removeSpy).toBeCalledTimes(1)
expect(removeSpy).toBeCalledWith(event, listener, options)
})
})
describe('given array of events but single listener', () => {
const listener = vitest.fn()
const events = ['click', 'scroll', 'blur', 'resize']
beforeEach(() => {
listener.mockReset()
stop = useEventListener(target, events, listener, options)
})
it('should add listener for all events', () => {
events.forEach(event => expect(addSpy).toBeCalledWith(event, listener, options))
})
it('should trigger listener with all events', () => {
expect(listener).not.toBeCalled()
events.forEach((event, index) => {
target.dispatchEvent(new Event(event))
expect(listener).toBeCalledTimes(index + 1)
})
})
it('should remove listener with all events', () => {
expect(removeSpy).not.toBeCalled()
stop()
expect(removeSpy).toBeCalledTimes(events.length)
events.forEach(event => expect(removeSpy).toBeCalledWith(event, listener, options))
})
})
describe('given single event but array of listeners', () => {
const listeners = [vitest.fn(), vitest.fn(), vitest.fn()]
const event = 'click'
beforeEach(() => {
listeners.forEach(listener => listener.mockReset())
stop = useEventListener(target, event, listeners, options)
})
it('should add all listeners', () => {
listeners.forEach(listener => expect(addSpy).toBeCalledWith(event, listener, options))
})
it('should call all listeners with single click event', () => {
listeners.forEach(listener => expect(listener).not.toBeCalled())
target.dispatchEvent(new Event(event))
listeners.forEach(listener => expect(listener).toBeCalledTimes(1))
})
it('should remove listeners', () => {
expect(removeSpy).not.toBeCalled()
stop()
expect(removeSpy).toBeCalledTimes(listeners.length)
listeners.forEach(listener => expect(removeSpy).toBeCalledWith(event, listener, options))
})
})
describe('given both array of events and listeners', () => {
const listeners = [vitest.fn(), vitest.fn(), vitest.fn()]
const events = ['click', 'scroll', 'blur', 'resize', 'custom-event']
beforeEach(() => {
listeners.forEach(listener => listener.mockReset())
stop = useEventListener(target, events, listeners, options)
})
it('should add all listeners for all events', () => {
listeners.forEach((listener) => {
events.forEach((event) => {
expect(addSpy).toBeCalledWith(event, listener, options)
})
})
})
it('should call all listeners with all events', () => {
events.forEach((event, index) => {
target.dispatchEvent(new Event(event))
listeners.forEach(listener => expect(listener).toBeCalledTimes(index + 1))
})
})
it('should remove all listeners with all events', () => {
stop()
listeners.forEach((listener) => {
events.forEach((event) => {
expect(removeSpy).toBeCalledWith(event, listener, options)
})
})
})
})
describe('multiple events', () => {
let target: Ref<HTMLDivElement | null>
let listener: () => any
beforeEach(() => {
target = ref(document.createElement('div'))
listener = vi.fn()
})
it('should not listen when target is invalid', async () => {
useEventListener(target, 'click', listener)
const el = target.value
target.value = null
await nextTick()
el?.dispatchEvent(new MouseEvent('click'))
await nextTick()
expect(listener).toHaveBeenCalledTimes(isVue2 ? 1 : 0)
expect(useEventListener(null, 'click', listener)).toBe(noop)
})
function getTargetName(useTarget: boolean) {
return useTarget ? 'element' : 'window'
}
function getArgs(useTarget: boolean) {
return (useTarget ? [target, 'click', listener] : ['click', listener])
}
function trigger(useTarget: boolean) {
(useTarget ? target.value : window)!.dispatchEvent(new MouseEvent('click'))
}
function testTarget(useTarget: boolean) {
it(`should ${getTargetName(useTarget)} listen event`, async () => {
// @ts-expect-error mock different args
const stop = useEventListener(...getArgs(useTarget))
trigger(useTarget)
await nextTick()
expect(listener).toHaveBeenCalledTimes(1)
})
it(`should ${getTargetName(useTarget)} manually stop listening event`, async () => {
// @ts-expect-error mock different args
const stop = useEventListener(...getArgs(useTarget))
stop()
trigger(useTarget)
await nextTick()
expect(listener).toHaveBeenCalledTimes(0)
})
it(`should ${getTargetName(useTarget)} auto stop listening event`, async () => {
const scope = effectScope()
await scope.run(async () => {
// @ts-expect-error mock different args
useEventListener(...getArgs(useTarget))
})
await scope.stop()
trigger(useTarget)
await nextTick()
expect(listener).toHaveBeenCalledTimes(isVue2 ? 1 : 0)
})
}
testTarget(false)
testTarget(true)
})
})