Parcourir la source

Feature: Introduced ImageLoadObserver.

Oskar Wróbel il y a 7 ans
Parent
commit
8ab568499c

+ 101 - 0
packages/ckeditor5-image/src/image/imageloadobserver.js

@@ -0,0 +1,101 @@
+/**
+ * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/**
+ * @module image/image/imageloadobserver
+ */
+
+import DomEventObserver from '@ckeditor/ckeditor5-engine/src/view/observer/domeventobserver';
+import DOMEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
+
+/**
+ * Observes all images added to the {@link module:engine/view/document~Document},
+ * fires {@link module:engine/view/document~Document#event:imageLoad}` event and
+ * {@link module:engine/view/view~View#render renders} the View every time when new image
+ * has been loaded.
+ *
+ * **Note:** This event is not fired for images that has been added to the document as `complete` (already loaded).
+ *
+ * @extends module:engine/view/observer/domeventobserver~DomEventObserver
+ */
+export default class ImageLoadObserver extends DomEventObserver {
+	constructor( view ) {
+		super( view );
+
+		/**
+		 * List of img DOM elements that are observed by this observer.
+		 *
+		 * @private
+		 * @type {Set.<HTMLElement>}
+		 */
+		this._observedElements = new Set();
+
+		/**
+		 * DOM emitter used for listening images `load` event.
+		 *
+		 * @private
+		 * @type {module:utils/dom/emittermixin~DomEmitterMixin}
+		 */
+		this._domEmitter = Object.create( DOMEmitterMixin );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	observe( domRoot, name ) {
+		const viewRoot = this.document.getRoot( name );
+
+		viewRoot.on( 'change:children', ( evt, node ) => {
+			this.view.once( 'render', () => {
+				if ( !node.is( 'element' ) || node.is( 'attributeElement' ) ) {
+					return;
+				}
+
+				const domNode = this.view.domConverter.mapViewToDom( node );
+
+				for ( const domElement of domNode.querySelectorAll( 'img' ) ) {
+					if ( !this._observedElements.has( domElement ) ) {
+						this._domEmitter.listenTo( domElement, 'load', ( evt, domEvt ) => this.onDomEvent( domEvt ) );
+						this._observedElements.add( domElement );
+					}
+				}
+
+				// Clean up the list of observed elements from elements that has been removed from the root.
+				for ( const domElement of this._observedElements ) {
+					if ( !domRoot.contains( domElement ) ) {
+						this._domEmitter.stopListening( domElement );
+						this._observedElements.delete( domElement );
+					}
+				}
+			} );
+		} );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	onDomEvent( domEvent ) {
+		this.view.render();
+		this.fire( 'imageLoad', domEvent );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	destroy() {
+		this._domEmitter.stopListening();
+		super.destroy();
+	}
+}
+
+/**
+ * Fired when img element has been loaded in one of the editable.
+ *
+ * Introduced by {@link module:image/image/imageloadobserver~ImageLoadObserver}.
+ *
+ * @see image/image/imageloadobserver~ImageLoadObserver
+ * @event module:engine/view/document~Document#event:imageLoad
+ * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
+ */

+ 96 - 0
packages/ckeditor5-image/tests/image/imageloadobserver.js

@@ -0,0 +1,96 @@
+/**
+ * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* globals document, Event */
+
+import ImageLoadObserver from '../../src/image/imageloadobserver';
+import View from '@ckeditor/ckeditor5-engine/src/view/view';
+import Position from '@ckeditor/ckeditor5-engine/src/view/position';
+import Range from '@ckeditor/ckeditor5-engine/src/view/range';
+import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
+import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
+
+describe( 'ClickObserver', () => {
+	let view, viewDocument, observer, domRoot, viewRoot;
+
+	beforeEach( () => {
+		view = new View();
+		viewDocument = view.document;
+		observer = view.addObserver( ImageLoadObserver );
+
+		viewRoot = createViewRoot( viewDocument );
+		domRoot = document.createElement( 'div' );
+		view.attachDomRoot( domRoot );
+	} );
+
+	afterEach( () => {
+		view.destroy();
+	} );
+
+	it( 'should fire `loadImage` event for images in the document that are loaded with a delay', () => {
+		const spy = sinon.spy();
+
+		viewDocument.on( 'imageLoad', spy );
+
+		setData( view, '<img src="foo.png" />' );
+
+		sinon.assert.notCalled( spy );
+
+		domRoot.querySelector( 'img' ).dispatchEvent( new Event( 'load' ) );
+
+		sinon.assert.calledOnce( spy );
+	} );
+
+	it( 'should not fire `loadImage` event for images removed from document', () => {
+		const spy = sinon.spy();
+
+		viewDocument.on( 'imageLoad', spy );
+
+		setData( view, '<img src="foo.png" />' );
+
+		sinon.assert.notCalled( spy );
+
+		const img = domRoot.querySelector( 'img' );
+
+		setData( view, '' );
+
+		img.dispatchEvent( new Event( 'load' ) );
+
+		sinon.assert.notCalled( spy );
+	} );
+
+	it( 'should do nothing with an image when changes are in the other parent', () => {
+		setData( view, '<container:p><attribute:b>foo</attribute:b></container:p><container:div><img src="foo.png" /></container:div>' );
+
+		const viewP = viewRoot.getChild( 0 );
+		const viewDiv = viewRoot.getChild( 1 );
+
+		const mapSpy = sinon.spy( view.domConverter, 'mapViewToDom' );
+
+		// Change only the paragraph.
+		view.change( writer => {
+			const text = writer.createText( 'foo', { b: true } );
+
+			writer.insert( Position.createAt( viewRoot.getChild( 0 ).getChild( 0 ) ), text );
+			writer.wrap( Range.createOn( text ), writer.createAttributeElement( 'b' ) );
+		} );
+
+		sinon.assert.calledWith( mapSpy, viewP );
+		sinon.assert.neverCalledWith( mapSpy, viewDiv );
+	} );
+
+	it( 'should call `view#render` along with `imageLoad` event', () => {
+		const renderSpy = sinon.spy();
+		const imageLoadSpy = sinon.spy();
+
+		view.on( 'render', renderSpy );
+		view.document.on( 'imageLoad', imageLoadSpy );
+
+		observer.onDomEvent( {} );
+
+		sinon.assert.calledOnce( renderSpy );
+		sinon.assert.calledOnce( imageLoadSpy );
+	} );
+} );