imageengine.js 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/image/imageengine
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
  10. import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
  11. import {
  12. viewFigureToModel,
  13. createImageAttributeConverter,
  14. convertHoistableImage,
  15. hoistImageThroughElement,
  16. srcsetAttributeConverter
  17. } from './converters';
  18. import { toImageWidget } from './utils';
  19. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  20. import ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement';
  21. import ViewEmptyElement from '@ckeditor/ckeditor5-engine/src/view/emptyelement';
  22. /**
  23. * The image engine plugin.
  24. * Registers `<image>` as a block element in the document schema, and allows `alt`, `src` and `srcset` attributes.
  25. * Registers converters for editing and data pipelines.
  26. *
  27. * @extends module:core/plugin~Plugin
  28. */
  29. export default class ImageEngine extends Plugin {
  30. /**
  31. * @inheritDoc
  32. */
  33. init() {
  34. const editor = this.editor;
  35. const schema = editor.model.schema;
  36. const data = editor.data;
  37. const editing = editor.editing;
  38. const t = editor.t;
  39. // Configure schema.
  40. schema.register( 'image', {
  41. isObject: true,
  42. isBlock: true,
  43. allowWhere: '$block',
  44. allowAttributes: [ 'alt', 'src', 'srcset' ]
  45. } );
  46. // Build converter from model to view for data pipeline.
  47. buildModelConverter().for( data.modelToView )
  48. .fromElement( 'image' )
  49. .toElement( () => createImageViewElement() );
  50. // Build converter from model to view for editing pipeline.
  51. buildModelConverter().for( editing.modelToView )
  52. .fromElement( 'image' )
  53. .toElement( () => toImageWidget( createImageViewElement(), t( 'image widget' ) ) );
  54. createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'src' );
  55. createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'alt' );
  56. // Convert `srcset` attribute changes and add or remove `sizes` attribute when necessary.
  57. createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'srcset', srcsetAttributeConverter );
  58. // Build converter for view img element to model image element.
  59. buildViewConverter().for( data.viewToModel )
  60. .from( { name: 'img', attribute: { src: /./ } } )
  61. .toElement( viewImage => new ModelElement( 'image', { src: viewImage.getAttribute( 'src' ) } ) );
  62. data.viewToModel.on( 'element:img', convertHoistableImage, { priority: 'low' } );
  63. data.viewToModel.on( 'element', hoistImageThroughElement, { priority: 'low' } );
  64. // Build converter for alt attribute.
  65. // Note that by default attribute converters are added with `low` priority.
  66. // This converter will be thus fired after `convertHoistableImage` converter.
  67. buildViewConverter().for( data.viewToModel )
  68. .from( { name: 'img', attribute: { alt: /./ } } )
  69. .consuming( { attribute: [ 'alt' ] } )
  70. .toAttribute( viewImage => ( { key: 'alt', value: viewImage.getAttribute( 'alt' ) } ) );
  71. // Build converter for srcset attribute.
  72. buildViewConverter().for( data.viewToModel )
  73. .from( { name: 'img', attribute: { srcset: /./ } } )
  74. .consuming( { attribute: [ 'srcset' ] } )
  75. .toAttribute( viewImage => {
  76. const value = {
  77. data: viewImage.getAttribute( 'srcset' )
  78. };
  79. if ( viewImage.hasAttribute( 'width' ) ) {
  80. value.width = viewImage.getAttribute( 'width' );
  81. }
  82. return {
  83. key: 'srcset',
  84. value
  85. };
  86. } );
  87. // Converter for figure element from view to model.
  88. data.viewToModel.on( 'element:figure', viewFigureToModel() );
  89. }
  90. }
  91. // Creates a view element representing the image.
  92. //
  93. // <figure class="image"><img></img></figure>
  94. //
  95. // Note that `alt` and `src` attributes are converted separately, so they are not included.
  96. //
  97. // @private
  98. // @return {module:engine/view/containerelement~ContainerElement}
  99. export function createImageViewElement() {
  100. return new ViewContainerElement( 'figure', { class: 'image' }, new ViewEmptyElement( 'img' ) );
  101. }