-
Notifications
You must be signed in to change notification settings - Fork 0
/
DomMustationObserver.js
418 lines (363 loc) · 14.3 KB
/
DomMustationObserver.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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
(function (root, YDomMutationObserver) {
if (typeof define === 'function' && define.amd) {
/**
* AMD. Register as an anonymous module unless amdModuleId is set
*/
define(["jquery"], function (a0) {
return (YDomMutationObserver(a0));
});
} else if (typeof module !== 'undefined' && typeof module.exports !== 'undefined') {
/**
* Pass this to node modules when this is the server
*
* @type {DomMutationObserver}
*/
module.exports = YDomMutationObserver(require("jquery"));
} else {
/**
* Pass this if window is defined
*
* @type {DomMutationObserver}
*/
window.YDomMutationObserver = YDomMutationObserver(window.jQuery);
}
}(this, function (jQuery) {
"use strict";
/**
* @typedef {Object} DomMutationObserver
* This component needs to handle dom changes and listen to dom changes without killing browser performance
* if this not supported we fall back to simple setInterval action
*/
/**
* Construct a new DomMutationObserver
*
* @class DomMutationObserver
* @classdesc Wrapper over MutationObserver.
* simple event listener for dom changes or the attached dom
*
* @namespace DomMutationObserver
* @constructor
*/
var DomMutationObserver = function () {
var self = this;
/**
* Node for which observing DOM mutation.
*
* @name DomMutationObserver#node
* @type Node
*/
var node;
/**
* DOM mutations observer.
*
* @name DomMutationObserver#mutationObserver
* @type MutationObserver
*/
var mutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver;
/**
* observer.
*
* @name DomMutationObserver#observer
* @type MutationObserver
*/
var observer;
/**
* setInterval when the MutationObserver not available
*
* @name DomMutationObserver#intervalHandle
* @type setInterval
*/
var intervalHandle;
/**
* events handlers
*
* @name DomMutationObserver#handlers
* @type Object
*/
var handlers = {};
/**
* events handlers Name
*
* @name DomMutationObserver#handlersName
* @type Array
*/
var handlersName = [];
for (var i in DomMutationObserver.EVENTS) {
handlersName.push(DomMutationObserver.EVENTS[i]);
}
/**
* @description
* These options the default for 'mutationObserver' not using all of them, you can pass one of them on init method
* @options
* @param {boolean} childList
* @param {boolean} attributes
* @param {boolean} characterData
* @param {boolean} subtree
* @param {boolean} attributeOldValue
* @param {boolean} characterDataOldValue
* @param {Array} attributeFilter
*/
var options = {
attributes: true,
characterData: true,
childList: true,
subtree: true,
attributeOldValue: true,
characterDataOldValue: true
};
/**
* private function to handle changes on dom
*
* @memberof DomMutationObserver#
* @method defaultCallback
* @param {Array} records
*/
var defaultCallback = function (records) {
if (records && Array.isArray(records)) {
var triggeredEvents = {};
records.forEach(function (record) {
if (
record &&
record.type
) {
triggeredEvents[record.type] = triggeredEvents[record.type] || [];
triggeredEvents[record.type].push(record);
}
});
Object.keys(triggeredEvents).forEach(function (record) {
switch (record) {
case 'attributes':
if (handlers[DomMutationObserver.EVENTS.ON_ATTRIBUTES_CHANGED]) {
self.trigger('on-attributes-changed', triggeredEvents[record]);
}
break;
case 'characterData':
if (handlers[DomMutationObserver.EVENTS.ON_CHARACTER_DATA_CHANGED]) {
self.trigger('on-character-data-changed', triggeredEvents[record]);
}
break;
case 'childList':
if (handlers[DomMutationObserver.EVENTS.ON_CHILD_LIST_CHANGED]) {
self.trigger('on-child-list-changed', triggeredEvents[record]);
}
break;
case 'subtree':
if (handlers[DomMutationObserver.EVENTS.ON_SUBTREE_CHANGED]) {
self.trigger('on-subtree-changed', triggeredEvents[record]);
}
break;
case 'attributeOldValue':
if (handlers[DomMutationObserver.EVENTS.ON_ATTRIBUTE_OLD_VALUE]) {
self.trigger('on-attribute-old-value', triggeredEvents[record]);
}
break;
case 'characterDataOldValue':
if (handlers[DomMutationObserver.EVENTS.ON_CHARACTER_DATA_OLD_VALUE]) {
self.trigger('on-character-data-old-value', triggeredEvents[record]);
}
break;
}
});
} else {
self.trigger('on-change', []);
}
};
/**
* Call startListening when you are ready to start handler events
*
* Note: At the very least, childList or attributes or characterData must be set to true.
* Otherwise, "An invalid or illegal string was specified" error is thrown.
*
* @memberof DomMutationObserver#
* @method startListening
* @param {Node, jQuery} attachedNode - the node you need to listen to dom changes
* @param {Object} passedOptions - these options for the mutationObserver for now these not working when the mutationObserver not defined
*/
self.init = function (attachedNode, passedOptions) {
if (!attachedNode) {
throw new Error('No javascript dom element send to watch changes', Date.now());
}
if (attachedNode instanceof jQuery) {
attachedNode = attachedNode[0];
}
if (passedOptions) {
options = jQuery.extend({}, options, passedOptions);
}
node = attachedNode;
if (!mutationObserver) {
observer = {
id: 'IS_INTERVAL',
callback: defaultCallback
};
} else {
observer = new mutationObserver(defaultCallback);
}
};
/**
* Events attached when listen to dom changes
* on-change event trigger when the browser dose't support the mutationObserver
* @memberof DomMutationObserver#
* @method on
* @param {String} type
* @param {Function[]} handler
*/
self.on = function (type, handler) {
if (handlersName.indexOf(type) === -1) {
throw new Error('Type must be one of these ' + JSON.stringify(handlersName), Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_ATTRIBUTES_CHANGED && !options['attributes']) {
throw new Error('You can\'t use on-attributes-changed event when attributes listener as false' , Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_CHARACTER_DATA_CHANGED && !options['characterData']) {
throw new Error('You can\'t use on-character-data-changed event when characterData listener as false' , Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_CHILD_LIST_CHANGED && !options['childList']) {
throw new Error('You can\'t use on-child-list-changed event when childList listener as false' , Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_SUBTREE_CHANGED && !options['subtree']) {
throw new Error('You can\'t use on-subtree-changed event when subtree listener as false' , Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_ATTRIBUTE_OLD_VALUE && !options['attributeOldValue']) {
throw new Error('You can\'t use on-attribute-old-value event when attributeOldValue listener as false' , Date.now());
}
if (type === DomMutationObserver.EVENTS.ON_CHARACTER_DATA_OLD_VALUE && !options['characterDataOldValue']) {
throw new Error('You can\'t use on-character-data-old-value event when characterDataOldValue listener as false' , Date.now());
}
handlers[type] = handlers[type] || [];
handlers[type].push(handler);
return handlers[type];
};
/**
* async trigger any event attached to this dom but this manual trigger not a browser trigger
* the first params will always be an empty array or array of Mutation Records
*
* @memberof DomMutationObserver#
* @method trigger
* @param {String} type
*/
self.trigger = function (type) {
if (!type || handlersName.indexOf(type) === -1) {
throw new Error('This event not valid' , Date.now());
}
// get params from function as infinite params fix
var params = Array.from(arguments);
params.splice(0, 1);
// push an empty array if the first params not MutationRecord
if (
!Array.isArray(params[0]) || (Array.isArray(params[0]) && !params[0][0] instanceof MutationRecord)
) {
params.unshift([]);
}
/**
* trigger the events with new params
*
* @param {function} handler
*/
handlers[type].forEach(function (handler) {
setTimeout(function () {
/**
* @type function
*/
handler.apply(null, params);
}, 1);
});
};
/**
* sync trigger any event attached to this dom but this manual trigger not a browser trigger
*
* @memberof DomMutationObserver#
* @method trigger
* @param {String} type
*/
self.syncTrigger = function (type) {
if (!type || handlersName.indexOf(type) === -1) {
throw new Error('This event not valid' , Date.now());
}
// get params from function as infinite params fix
var params = Array.from(arguments);
params.splice(0, 1);
// push an empty array if the first params not MutationRecord
if (
!Array.isArray(params[0]) || (Array.isArray(params[0]) && !params[0][0] instanceof MutationRecord)
) {
params.unshift([]);
}
/**
* trigger the events with new params
*
* @param {function} handler
*/
handlers[type].forEach(function (handler) {
/**
* @type function
*/
handler.apply(null, params);
});
};
/**
* Call startListening when you are ready to start handler events
*
* @memberof DomMutationObserver#
* @method startListening
* @param {Number} interval
*/
self.startListening = function (interval) {
if (!handlers[DomMutationObserver.EVENTS.ON_CHANGE]) {
throw new Error('On Change event for this component is a required handler', Date.now());
}
if (!mutationObserver) {
intervalHandle = setInterval(observer.callback, (typeof (interval) === 'undefined') ? 500 : interval);
} else {
observer.observe(node, options);
}
};
/**
* get the node attached as simple Dom object
*
* @memberof DomMutationObserver#
* @method getNode
*/
self.getNode = function () {
return node;
};
/**
* destroy
*
* @memberof DomMutationObserver#
* @method destroy
*/
self.destroy = function () {
// stop observing
if (mutationObserver) {
clearInterval(intervalHandle);
} else {
observer.disconnect();
}
options = {
attributes: true,
childList: true,
characterData: true,
subtree: true
};
observer = null;
node = null;
};
};
/**
* Define events for this component
* @type {Object}
*/
DomMutationObserver.EVENTS = {};
DomMutationObserver.EVENTS.ON_ATTRIBUTES_CHANGED = 'on-attributes-changed';
DomMutationObserver.EVENTS.ON_CHARACTER_DATA_CHANGED = 'on-character-data-changed';
DomMutationObserver.EVENTS.ON_CHILD_LIST_CHANGED = 'on-child-list-changed';
DomMutationObserver.EVENTS.ON_SUBTREE_CHANGED = 'on-subtree-changed';
DomMutationObserver.EVENTS.ON_ATTRIBUTE_OLD_VALUE = 'on-attribute-old-value';
DomMutationObserver.EVENTS.ON_CHARACTER_DATA_OLD_VALUE = 'on-character-data-old-value';
DomMutationObserver.EVENTS.ON_CHANGE = 'on-change';
/**
* Pass this object to node server if defined or pass to window to use it on client side
* @type {DomMutationObserver}
*/
return DomMutationObserver;
}));