-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
resizeobserver.js
384 lines (336 loc) · 11 KB
/
resizeobserver.js
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module utils/dom/resizeobserver
*/
/* globals setTimeout, clearTimeout */
import mix from '../mix';
import global from './global';
import Rect from './rect';
import DomEmitterMixin from './emittermixin';
const RESIZE_CHECK_INTERVAL = 100;
/**
* A helper class which instances allow performing custom actions when native DOM elements are resized.
*
* const editableElement = editor.editing.view.getDomRoot();
*
* const observer = new ResizeObserver( editableElement, entry => {
* console.log( 'The editable element has been resized in DOM.' );
* console.log( entry.target ); // -> editableElement
* console.log( entry.contentRect.width ); // -> e.g. '423px'
* } );
*
* By default, it uses the [native DOM resize observer](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
* under the hood and in browsers that do not support the native API yet, a polyfilled observer is
* used instead.
*/
export default class ResizeObserver {
/**
* Creates an instance of the `ResizeObserver` class.
*
* @param {HTMLElement} element A DOM element that is to be observed for resizing. Note that
* the element must be visible (i.e. not detached from DOM) for the observer to work.
* @param {Function} callback A function called when the observed element was resized. It passes
* the [`ResizeObserverEntry`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry)
* object with information about the resize event.
*/
constructor( element, callback ) {
// **Note**: For the maximum performance, this class ensures only a single instance of the native
// (or polyfilled) observer is used no matter how many instances of this class were created.
if ( !ResizeObserver._observerInstance ) {
ResizeObserver._createObserver();
}
/**
* The element observer by this observer.
*
* @readonly
* @private
* @member {HTMLElement}
*/
this._element = element;
/**
* The callback executed each time {@link #_element} is resized.
*
* @readonly
* @private
* @member {Function}
*/
this._callback = callback;
ResizeObserver._addElementCallback( element, callback );
ResizeObserver._observerInstance.observe( element );
}
/**
* Destroys the observer which disables the `callback` passed to the {@link #constructor}.
*/
destroy() {
ResizeObserver._deleteElementCallback( this._element, this._callback );
}
/**
* Registers a new resize callback for the DOM element.
*
* @private
* @static
* @param {HTMLElement} element
* @param {Function} callback
*/
static _addElementCallback( element, callback ) {
if ( !ResizeObserver._elementCallbacks ) {
ResizeObserver._elementCallbacks = new Map();
}
let callbacks = ResizeObserver._elementCallbacks.get( element );
if ( !callbacks ) {
callbacks = new Set();
ResizeObserver._elementCallbacks.set( element, callbacks );
}
callbacks.add( callback );
}
/**
* Removes a resize callback from the DOM element. If no callbacks are left
* for the element, it removes the element from the native observer.
*
* @private
* @static
* @param {HTMLElement} element
* @param {Function} callback
*/
static _deleteElementCallback( element, callback ) {
const callbacks = ResizeObserver._getElementCallbacks( element );
// Remove the element callback. Check if exist first in case someone
// called destroy() twice.
if ( callbacks ) {
callbacks.delete( callback );
// If no callbacks left for the element, also remove the element.
if ( !callbacks.size ) {
ResizeObserver._elementCallbacks.delete( element );
ResizeObserver._observerInstance.unobserve( element );
}
}
if ( ResizeObserver._elementCallbacks && !ResizeObserver._elementCallbacks.size ) {
ResizeObserver._observerInstance = null;
ResizeObserver._elementCallbacks = null;
}
}
/**
* Returns are registered resize callbacks for the DOM element.
*
* @private
* @static
* @param {HTMLElement} element
* @returns {Set.<HTMLElement>|null}
*/
static _getElementCallbacks( element ) {
if ( !ResizeObserver._elementCallbacks ) {
return null;
}
return ResizeObserver._elementCallbacks.get( element );
}
/**
* Creates the single native observer shared across all `ResizeObserver` instances.
* If the browser does not support the native API, it creates a polyfill.
*
* @private
* @static
*/
static _createObserver() {
let ObserverConstructor;
// TODO: One day, the `ResizeObserver` API will be supported in all modern web browsers.
// When it happens, this module will no longer make sense and should be removed and
// the native implementation should be used across the project to save bytes.
// Check out https://caniuse.com/#feat=resizeobserver.
if ( typeof global.window.ResizeObserver === 'function' ) {
ObserverConstructor = global.window.ResizeObserver;
} else {
ObserverConstructor = ResizeObserverPolyfill;
}
ResizeObserver._observerInstance = new ObserverConstructor( entries => {
for ( const entry of entries ) {
// Do not execute callbacks for elements that are invisible.
// https://github.com/ckeditor/ckeditor5/issues/6570
if ( !entry.target.offsetParent ) {
continue;
}
const callbacks = ResizeObserver._getElementCallbacks( entry.target );
if ( callbacks ) {
for ( const callback of callbacks ) {
callback( entry );
}
}
}
} );
}
}
/**
* The single native observer instance (or polyfill in browsers that do not support the API)
* shared across all {@link module:utils/dom/resizeobserver~ResizeObserver} instances.
*
* @static
* @protected
* @readonly
* @property {Object|null} module:utils/dom/resizeobserver~ResizeObserver#_observerInstance
*/
ResizeObserver._observerInstance = null;
/**
* A mapping of native DOM elements and their callbacks shared across all
* {@link module:utils/dom/resizeobserver~ResizeObserver} instances.
*
* @static
* @private
* @readonly
* @property {Map.<HTMLElement,Set>|null} module:utils/dom/resizeobserver~ResizeObserver#_elementCallbacks
*/
ResizeObserver._elementCallbacks = null;
/**
* A polyfill class for the native [`ResizeObserver`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).
*
* @private
* @mixes module:utils/domemittermixin~DomEmitterMixin
*/
class ResizeObserverPolyfill {
/**
* Creates an instance of the {@link module:utils/dom/resizeobserver~ResizeObserverPolyfill} class.
*
* It synchronously reacts to resize of the window to check if observed elements' geometry changed.
*
* Additionally, the polyfilled observer uses a timeout to check if observed elements' geometry has changed
* in some other way (dynamic layouts, scrollbars showing up, etc.), so its response can also be asynchronous.
*
* @param {Function} callback A function called when any observed element was resized. Refer to the
* native [`ResizeObserver`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) API to
* learn more.
*/
constructor( callback ) {
/**
* A function called when any observed {@link #_elements element} was resized.
*
* @readonly
* @protected
* @member {Function}
*/
this._callback = callback;
/**
* DOM elements currently observed by the observer instance.
*
* @readonly
* @protected
* @member {Set}
*/
this._elements = new Set();
/**
* Cached DOM {@link #_elements elements} bounding rects to compare to upon the next check.
*
* @readonly
* @protected
* @member {Map.<HTMLElement,module:utils/dom/rect~Rect>}
*/
this._previousRects = new Map();
/**
* An UID of the current timeout upon which the observed elements rects
* will be compared to the {@link #_previousRects previous rects} from the past.
*
* @readonly
* @protected
* @member {Map.<HTMLElement,module:utils/dom/rect~Rect>}
*/
this._periodicCheckTimeout = null;
}
/**
* Starts observing a DOM element.
*
* Learn more in the
* [native method documentation](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver/observe).
*
* @param {HTMLElement} element
*/
observe( element ) {
this._elements.add( element );
this._checkElementRectsAndExecuteCallback();
if ( this._elements.size === 1 ) {
this._startPeriodicCheck();
}
}
/**
* Stops observing a DOM element.
*
* Learn more in the
* [native method documentation](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver/unobserve).
*
* @param {HTMLElement} element
*/
unobserve( element ) {
this._elements.delete( element );
this._previousRects.delete( element );
if ( !this._elements.size ) {
this._stopPeriodicCheck();
}
}
/**
* When called, the observer calls the {@link #_callback resize callback} for all observed
* {@link #_elements elements} but also starts checking periodically for changes in the elements' geometry.
* If some are detected, {@link #_callback resize callback} is called for relevant elements that were resized.
*
* @protected
*/
_startPeriodicCheck() {
const periodicCheck = () => {
this._checkElementRectsAndExecuteCallback();
this._periodicCheckTimeout = setTimeout( periodicCheck, RESIZE_CHECK_INTERVAL );
};
this.listenTo( global.window, 'resize', () => {
this._checkElementRectsAndExecuteCallback();
} );
this._periodicCheckTimeout = setTimeout( periodicCheck, RESIZE_CHECK_INTERVAL );
}
/**
* Stops checking for changes in all observed {@link #_elements elements} geometry.
*
* @protected
*/
_stopPeriodicCheck() {
clearTimeout( this._periodicCheckTimeout );
this.stopListening();
this._previousRects.clear();
}
/**
* Checks if the geometry of any of the {@link #_elements element} has changed. If so, executes
* the {@link #_callback resize callback} with element geometry data.
*
* @protected
*/
_checkElementRectsAndExecuteCallback() {
const entries = [];
for ( const element of this._elements ) {
if ( this._hasRectChanged( element ) ) {
entries.push( {
target: element,
contentRect: this._previousRects.get( element )
} );
}
}
if ( entries.length ) {
this._callback( entries );
}
}
/**
* Compares the DOM element geometry to the {@link #_previousRects cached geometry} from the past.
* Returns `true` if geometry has changed or the element is checked for the first time.
*
* @protected
* @param {HTMLElement} element
* @returns {Boolean}
*/
_hasRectChanged( element ) {
if ( !element.ownerDocument.body.contains( element ) ) {
return false;
}
const currentRect = new Rect( element );
const previousRect = this._previousRects.get( element );
// The first check should always yield true despite no Previous rect to compare to.
// The native ResizeObserver does that and... that makes sense. Sort of.
const hasChanged = !previousRect || !previousRect.isEqual( currentRect );
this._previousRects.set( element, currentRect );
return hasChanged;
}
}
mix( ResizeObserverPolyfill, DomEmitterMixin );