lifecycle.js
8.15 KB
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
import Popper from '../../src/index.js';
import makePopperFactory from '../utils/makePopperFactory';
import makeConnectedElement from '@popperjs/test-utils/utils/makeConnectedElement';
import makeConnectedScrollElement from '@popperjs/test-utils/utils/makeConnectedScrollElement';
import makeElement from '@popperjs/test-utils/utils/makeElement';
import '@popperjs/test-utils/setup';
describe('[lifecycle]', () => {
const makePopper = makePopperFactory();
describe('on creation', () => {
it('adds a resize event listener', () => {
spyOn(window, 'addEventListener');
const { state } = makePopper(
makeConnectedElement(),
makeConnectedElement()
);
expect(window.addEventListener.calls.argsFor(0)).toEqual([
'resize',
state.updateBound,
{ passive: true },
]);
});
it('adds a scroll event listener to window when boundariesElement is viewport', () => {
spyOn(window, 'addEventListener');
const {
state,
} = makePopper(makeConnectedElement(), makeConnectedElement(), {
boundariesElement: 'viewport',
});
expect(window.addEventListener.calls.argsFor(1)).toEqual([
'scroll',
state.updateBound,
{ passive: true },
]);
});
it('adds a scroll event listener to the closest scroll ancestor of reference when boundariesElement is an element', () => {
const boundariesElement = makeConnectedElement();
const scrollAncestor = document.createElement('div');
const reference = document.createElement('div');
const popper = document.createElement('div');
boundariesElement.appendChild(scrollAncestor);
scrollAncestor.appendChild(reference);
scrollAncestor.appendChild(popper);
scrollAncestor.style.overflow = 'scroll';
spyOn(scrollAncestor, 'addEventListener');
const { state } = makePopper(reference, popper, {
boundariesElement: boundariesElement,
});
expect(scrollAncestor.addEventListener.calls.allArgs()).toEqual([
['scroll', state.updateBound, { passive: true }],
]);
});
it('should not add resize/scroll event if eventsEnabled option is set to false', () => {
const {
state,
} = makePopper(makeConnectedElement(), makeConnectedElement(), {
eventsEnabled: false,
});
expect(state.eventsEnabled).toBe(false);
expect(state.updateBound).toBeUndefined();
expect(state.scrollElement).toBeUndefined();
});
});
describe('on update', () => {
it('should call update callback', done => {
const popperElement = makeConnectedElement();
let isOnCreateCalled = false;
new Popper(makeConnectedElement(), popperElement, {
onCreate: data => {
isOnCreateCalled = true;
data.instance.scheduleUpdate();
},
onUpdate: () => {
// makes sure it's executed after `onCreate`
expect(isOnCreateCalled).toBe(true);
// makes sure it's executed
done();
},
});
});
});
describe('on destroy', () => {
it('removes the resize event listener from window', () => {
spyOn(window, 'removeEventListener');
const instance = new Popper(
makeConnectedElement(),
makeConnectedElement()
);
const { updateBound } = instance.state;
instance.destroy();
expect(window.removeEventListener.calls.argsFor(0)).toEqual([
'resize',
updateBound,
]);
});
it('removes the scroll event listener from window', () => {
spyOn(window, 'removeEventListener');
const instance = new Popper(
makeConnectedElement(),
makeConnectedElement()
);
const { updateBound } = instance.state;
instance.destroy();
expect(window.removeEventListener.calls.argsFor(1)).toEqual([
'scroll',
updateBound,
]);
});
it('should clean up the popper element\'s styles if modifiers.applyStyle is enabled', () => {
const popperElement = makeConnectedElement();
popperElement.style.top = '100px';
const instance = new Popper(makeConnectedElement(), popperElement, {
modifiers: { applyStyle: { enabled: true } },
});
instance.destroy();
expect(popperElement.style.top).toBe('');
});
it('should not modify the popper element\'s styles if modifiers.applyStyle is disabled', () => {
const popperElement = makeConnectedElement();
popperElement.style.top = '100px';
const instance = new Popper(makeConnectedElement(), popperElement, {
modifiers: { applyStyle: { enabled: false } },
});
instance.destroy();
expect(popperElement.style.top).toBe('100px');
});
it('should not call update after destroy', () => {
let isUpdateCalled = false;
const popperElement = makeConnectedElement();
const instance = new Popper(makeConnectedElement(), popperElement, {
onUpdate: () => {
isUpdateCalled = true;
},
});
instance.update();
instance.destroy();
expect(isUpdateCalled).toBe(false);
});
describe('when boundariesElement is not `window` and the scroll parent is not `window`', () => {
it('removes the scroll event listener from the scroll parent', () => {
const boundariesElement = makeConnectedScrollElement();
const reference = boundariesElement.appendChild(makeElement());
const popper = boundariesElement.appendChild(makeElement());
spyOn(boundariesElement, 'removeEventListener');
const instance = new Popper(reference, popper, {
boundariesElement: boundariesElement,
});
const { updateBound } = instance.state;
instance.destroy();
expect(boundariesElement.removeEventListener.calls.allArgs()).toEqual([
['scroll', updateBound],
]);
});
describe('when the reference is disconnected from the DOM', () => {
it('removes the scroll event listener from the scroll parent when the reference is disconnected from the DOM', () => {
const boundariesElement = makeConnectedScrollElement();
const reference = boundariesElement.appendChild(makeElement());
const popper = boundariesElement.appendChild(makeElement());
spyOn(boundariesElement, 'removeEventListener');
const instance = new Popper(reference, popper, {
boundariesElement: boundariesElement,
});
const { updateBound } = instance.state;
boundariesElement.removeChild(reference);
instance.destroy();
expect(
boundariesElement.removeEventListener.calls.allArgs()
).toEqual([['scroll', updateBound]]);
});
});
});
});
describe('methods: enableEventListeners/disableEventListeners', () => {
it('enableEventListeners', () => {
spyOn(window, 'addEventListener');
const instance = makePopper(
makeConnectedElement(),
makeConnectedElement(),
{ eventsEnabled: false }
);
instance.enableEventListeners();
expect(window.addEventListener.calls.count()).toEqual(2);
expect(window.addEventListener.calls.argsFor(0)).toEqual([
'resize',
instance.state.updateBound,
{ passive: true },
]);
expect(window.addEventListener.calls.argsFor(1)).toEqual([
'scroll',
instance.state.updateBound,
{ passive: true },
]);
expect(instance.state.eventsEnabled).toBe(true);
});
it('disableEventListeners', () => {
spyOn(window, 'removeEventListener');
const instance = makePopper(
makeConnectedElement(),
makeConnectedElement()
);
const { updateBound } = instance.state;
instance.disableEventListeners();
expect(window.removeEventListener.calls.argsFor(0)).toEqual([
'resize',
updateBound,
]);
expect(window.removeEventListener.calls.argsFor(1)).toEqual([
'scroll',
updateBound,
]);
expect(instance.state.eventsEnabled).toBe(false);
expect(instance.state.updateBound).toBe(null);
expect(instance.state.scrollElement).toBe(null);
});
});
});