imageengine.js 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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 { viewFigureToModel, createImageAttributeConverter } from './converters';
  12. import { toImageWidget } from './utils';
  13. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  14. import ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement';
  15. import ViewEmptyElement from '@ckeditor/ckeditor5-engine/src/view/emptyelement';
  16. /**
  17. * The image engine plugin.
  18. * Registers `image` as a block element in document's schema and allows it to have two attributes: `src` and `alt`.
  19. * Registers converters for editing and data pipelines.
  20. *
  21. * @extends module:core/plugin~Plugin
  22. */
  23. export default class ImageEngine extends Plugin {
  24. /**
  25. * @inheritDoc
  26. */
  27. init() {
  28. const editor = this.editor;
  29. const doc = editor.document;
  30. const schema = doc.schema;
  31. const data = editor.data;
  32. const editing = editor.editing;
  33. const t = editor.t;
  34. // Configure schema.
  35. schema.registerItem( 'image' );
  36. schema.requireAttributes( 'image', [ 'src' ] );
  37. schema.allow( { name: 'image', attributes: [ 'alt', 'src' ], inside: '$root' } );
  38. schema.objects.add( 'image' );
  39. // Build converter from model to view for data pipeline.
  40. buildModelConverter().for( data.modelToView )
  41. .fromElement( 'image' )
  42. .toElement( () => createImageViewElement() );
  43. // Build converter from model to view for editing pipeline.
  44. buildModelConverter().for( editing.modelToView )
  45. .fromElement( 'image' )
  46. .toElement( () => toImageWidget( createImageViewElement(), t( 'image widget' ) ) );
  47. createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'src' );
  48. createImageAttributeConverter( [ editing.modelToView, data.modelToView ], 'alt' );
  49. // Build converter for view img element to model image element.
  50. buildViewConverter().for( data.viewToModel )
  51. .from( { name: 'img', attribute: { src: /./ } } )
  52. .toElement( ( viewImage ) => new ModelElement( 'image', { src: viewImage.getAttribute( 'src' ) } ) );
  53. // Build converter for alt attribute.
  54. buildViewConverter().for( data.viewToModel )
  55. .from( { name: 'img', attribute: { alt: /./ } } )
  56. .consuming( { attribute: [ 'alt' ] } )
  57. .toAttribute( ( viewImage ) => ( { key: 'alt', value: viewImage.getAttribute( 'alt' ) } ) );
  58. // Converter for figure element from view to model.
  59. data.viewToModel.on( 'element:figure', viewFigureToModel() );
  60. }
  61. }
  62. // Creates view element representing the image.
  63. //
  64. // <figure class="image"><img></img></figure>
  65. //
  66. // Note that `alt` and `src` attributes are converted separately, so they're not included.
  67. //
  68. // @private
  69. // @return {module:engine/view/containerelement~ContainerElement}
  70. export function createImageViewElement() {
  71. return new ViewContainerElement( 'figure', { class: 'image' }, new ViewEmptyElement( 'img' ) );
  72. }