| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module image/image/imageengine
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
- import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
- import {
- viewFigureToModel,
- createImageAttributeConverter,
- convertHoistableImage,
- hoistImageThroughElement,
- srcsetAttributeConverter
- } from './converters';
- import { toImageWidget } from './utils';
- import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
- import ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement';
- import ViewEmptyElement from '@ckeditor/ckeditor5-engine/src/view/emptyelement';
- /**
- * The image engine plugin.
- * Registers `<image>` as a block element in the document schema, and allows `alt`, `src` and `srcset` attributes.
- * Registers converters for editing and data pipelines.
- *
- * @extends module:core/plugin~Plugin
- */
- export default class ImageEngine extends Plugin {
- /**
- * @inheritDoc
- */
- init() {
- const editor = this.editor;
- const schema = editor.model.schema;
- const data = editor.data;
- const editing = editor.editing;
- const t = editor.t;
- // Configure schema.
- schema.register( 'image', {
- isObject: true,
- isBlock: true,
- allowWhere: '$block',
- allowAttributes: [ 'alt', 'src', 'srcset' ]
- } );
- // Build converter from model to view for data pipeline.
- buildModelConverter().for( data.modelToView )
- .fromElement( 'image' )
- .toElement( () => createImageViewElement() );
- // Build converter from model to view for editing pipeline.
- buildModelConverter().for( editing.modelToView )
- .fromElement( 'image' )
- .toElement( () => toImageWidget( createImageViewElement(), t( 'image widget' ) ) );
- createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'src' );
- createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'alt' );
- // Convert `srcset` attribute changes and add or remove `sizes` attribute when necessary.
- createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'srcset', srcsetAttributeConverter );
- // Build converter for view img element to model image element.
- buildViewConverter().for( data.viewToModel )
- .from( { name: 'img', attribute: { src: /./ } } )
- .toElement( viewImage => new ModelElement( 'image', { src: viewImage.getAttribute( 'src' ) } ) );
- data.viewToModel.on( 'element:img', convertHoistableImage, { priority: 'low' } );
- data.viewToModel.on( 'element', hoistImageThroughElement, { priority: 'low' } );
- // Build converter for alt attribute.
- // Note that by default attribute converters are added with `low` priority.
- // This converter will be thus fired after `convertHoistableImage` converter.
- buildViewConverter().for( data.viewToModel )
- .from( { name: 'img', attribute: { alt: /./ } } )
- .consuming( { attribute: [ 'alt' ] } )
- .toAttribute( viewImage => ( { key: 'alt', value: viewImage.getAttribute( 'alt' ) } ) );
- // Build converter for srcset attribute.
- buildViewConverter().for( data.viewToModel )
- .from( { name: 'img', attribute: { srcset: /./ } } )
- .consuming( { attribute: [ 'srcset' ] } )
- .toAttribute( viewImage => {
- const value = {
- data: viewImage.getAttribute( 'srcset' )
- };
- if ( viewImage.hasAttribute( 'width' ) ) {
- value.width = viewImage.getAttribute( 'width' );
- }
- return {
- key: 'srcset',
- value
- };
- } );
- // Converter for figure element from view to model.
- data.viewToModel.on( 'element:figure', viewFigureToModel() );
- }
- }
- // Creates a view element representing the image.
- //
- // <figure class="image"><img></img></figure>
- //
- // Note that `alt` and `src` attributes are converted separately, so they are not included.
- //
- // @private
- // @return {module:engine/view/containerelement~ContainerElement}
- export function createImageViewElement() {
- return new ViewContainerElement( 'figure', { class: 'image' }, new ViewEmptyElement( 'img' ) );
- }
|