-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
imageloadobserver.ts
74 lines (66 loc) · 2.11 KB
/
imageloadobserver.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
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module image/image/imageloadobserver
*/
import { Observer } from 'ckeditor5/src/engine.js';
/**
* Observes all new images added to the {@link module:engine/view/document~Document},
* fires {@link module:engine/view/document~Document#event:imageLoaded} and
* {@link module:engine/view/document~Document#event:layoutChanged} event every time when the new image
* has been loaded.
*
* **Note:** This event is not fired for images that has been added to the document and rendered as `complete` (already loaded).
*/
export default class ImageLoadObserver extends Observer {
/**
* @inheritDoc
*/
public observe( domRoot: HTMLElement ): void {
this.listenTo( domRoot, 'load', ( event, domEvent ) => {
const domElement = domEvent.target as HTMLElement;
if ( this.checkShouldIgnoreEventFromTarget( domElement ) ) {
return;
}
if ( domElement.tagName == 'IMG' ) {
this._fireEvents( domEvent );
}
// Use capture phase for better performance (#4504).
}, { useCapture: true } );
}
/**
* @inheritDoc
*/
public override stopObserving( domRoot: HTMLElement ): void {
this.stopListening( domRoot );
}
/**
* Fires {@link module:engine/view/document~Document#event:layoutChanged} and
* {@link module:engine/view/document~Document#event:imageLoaded}
* if observer {@link #isEnabled is enabled}.
*
* @param domEvent The DOM event.
*/
private _fireEvents( domEvent: Event ): void {
if ( this.isEnabled ) {
this.document.fire( 'layoutChanged' );
this.document.fire<ImageLoadedEvent>( 'imageLoaded', domEvent );
}
}
}
/**
* Fired when an <img/> DOM element has been loaded in the DOM root.
*
* Introduced by {@link module:image/image/imageloadobserver~ImageLoadObserver}.
*
* @see module:image/image/imageloadobserver~ImageLoadObserver
*
* @eventName module:engine/view/document~Document#imageLoaded
* @param data Event data.
*/
export type ImageLoadedEvent = {
name: 'imageLoaded';
args: [ Event ];
};