@ckeditor/ckeditor5-image
Version:
Image feature for CKEditor 5.
53 lines (52 loc) • 1.8 kB
JavaScript
/**
* @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
*/
observe(domRoot) {
this.listenTo(domRoot, 'load', (event, domEvent) => {
const domElement = domEvent.target;
if (this.checkShouldIgnoreEventFromTarget(domElement)) {
return;
}
if (domElement.tagName == 'IMG') {
this._fireEvents(domEvent);
}
// Use capture phase for better performance (#4504).
}, { useCapture: true });
}
/**
* @inheritDoc
*/
stopObserving(domRoot) {
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.
*/
_fireEvents(domEvent) {
if (this.isEnabled) {
this.document.fire('layoutChanged');
this.document.fire('imageLoaded', domEvent);
}
}
}