converters.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/image/converters
  7. */
  8. import ModelPosition from '@ckeditor/ckeditor5-engine/src/model/position';
  9. import first from '@ckeditor/ckeditor5-utils/src/first';
  10. /**
  11. * Returns a function that converts the image view representation:
  12. *
  13. * <figure class="image"><img src="..." alt="..."></img></figure>
  14. *
  15. * to the model representation:
  16. *
  17. * <image src="..." alt="..."></image>
  18. *
  19. * The entire content of the `<figure>` element except the first `<img>` is being converted as children
  20. * of the `<image>` model element.
  21. *
  22. * @returns {Function}
  23. */
  24. export function viewFigureToModel() {
  25. return ( evt, data, conversionApi ) => {
  26. // Do not convert if this is not an "image figure".
  27. if ( !conversionApi.consumable.test( data.viewItem, { name: true, class: 'image' } ) ) {
  28. return;
  29. }
  30. // Find an image element inside the figure element.
  31. const viewImage = Array.from( data.viewItem.getChildren() ).find( viewChild => viewChild.is( 'img' ) );
  32. // Do not convert if image element is absent, is missing src attribute or was already converted.
  33. if ( !viewImage || !viewImage.hasAttribute( 'src' ) || !conversionApi.consumable.test( viewImage, { name: true } ) ) {
  34. return;
  35. }
  36. // Convert view image to model image.
  37. const conversionResult = conversionApi.convertItem( viewImage, data.modelCursor );
  38. // Get image element from conversion result.
  39. const modelImage = first( conversionResult.modelRange.getItems() );
  40. // When image was successfully converted.
  41. if ( modelImage ) {
  42. // Convert rest of the figure element's children as an image children.
  43. conversionApi.convertChildren( data.viewItem, ModelPosition.createAt( modelImage ) );
  44. }
  45. // Set image range as conversion result.
  46. data.modelRange = conversionResult.modelRange;
  47. // Continue conversion where image conversion ends.
  48. data.modelCursor = conversionResult.modelCursor;
  49. };
  50. }
  51. /**
  52. * Creates the image attribute converter for provided model conversion dispatchers.
  53. *
  54. * @param {Array.<module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher>} dispatchers
  55. * @param {String} attributeName
  56. * @param {Function} [converter] Custom converter for the attribute - default one converts attribute from model `image` element
  57. * to the same attribute in `img` in the view.
  58. */
  59. export function createImageAttributeConverter( dispatchers, attributeName, converter = modelToViewAttributeConverter ) {
  60. for ( const dispatcher of dispatchers ) {
  61. dispatcher.on( `attribute:${ attributeName }:image`, converter() );
  62. }
  63. }
  64. /**
  65. * Converter used to convert `srcset` model image's attribute to `srcset`, `sizes` and `width` attributes in the view.
  66. *
  67. * @return {Function}
  68. */
  69. export function srcsetAttributeConverter() {
  70. return ( evt, data, consumable, conversionApi ) => {
  71. const parts = evt.name.split( ':' );
  72. const consumableType = parts[ 0 ] + ':' + parts[ 1 ];
  73. const modelImage = data.item;
  74. if ( !consumable.consume( modelImage, consumableType ) ) {
  75. return;
  76. }
  77. const figure = conversionApi.mapper.toViewElement( modelImage );
  78. const img = figure.getChild( 0 );
  79. if ( data.attributeNewValue === null ) {
  80. const srcset = data.attributeOldValue;
  81. if ( srcset.data ) {
  82. img.removeAttribute( 'srcset' );
  83. img.removeAttribute( 'sizes' );
  84. if ( srcset.width ) {
  85. img.removeAttribute( 'width' );
  86. }
  87. }
  88. } else {
  89. const srcset = data.attributeNewValue;
  90. if ( srcset.data ) {
  91. img.setAttribute( 'srcset', srcset.data );
  92. // Always outputting `100vw`. See https://github.com/ckeditor/ckeditor5-image/issues/2.
  93. img.setAttribute( 'sizes', '100vw' );
  94. if ( srcset.width ) {
  95. img.setAttribute( 'width', srcset.width );
  96. }
  97. }
  98. }
  99. };
  100. }
  101. // Returns model to view image converter converting given attribute, and adding it to `img` element nested inside `figure` element.
  102. //
  103. // @private
  104. function modelToViewAttributeConverter() {
  105. return ( evt, data, consumable, conversionApi ) => {
  106. const parts = evt.name.split( ':' );
  107. const consumableType = parts[ 0 ] + ':' + parts[ 1 ];
  108. const modelImage = data.item;
  109. if ( !consumable.consume( modelImage, consumableType ) ) {
  110. return;
  111. }
  112. const figure = conversionApi.mapper.toViewElement( modelImage );
  113. const img = figure.getChild( 0 );
  114. if ( data.attributeNewValue !== null ) {
  115. img.setAttribute( data.attributeKey, data.attributeNewValue );
  116. } else {
  117. img.removeAttribute( data.attributeKey );
  118. }
  119. };
  120. }