inline-widget.js 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global console, window */
  6. import { getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  7. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  8. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  9. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  10. import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
  11. import Enter from '@ckeditor/ckeditor5-enter/src/enter';
  12. import Heading from '@ckeditor/ckeditor5-heading/src/heading';
  13. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  14. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  15. import Undo from '@ckeditor/ckeditor5-undo/src/undo';
  16. import Widget from '../../src/widget';
  17. import { toWidget, viewToModelPositionOutsideModelElement } from '../../src/utils';
  18. import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
  19. import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
  20. import ShiftEnter from '@ckeditor/ckeditor5-enter/src/shiftenter';
  21. import Table from '@ckeditor/ckeditor5-table/src/table';
  22. class InlineWidget extends Plugin {
  23. constructor( editor ) {
  24. super( editor );
  25. editor.model.schema.register( 'placeholder', {
  26. allowWhere: '$text',
  27. isObject: true,
  28. isInline: true,
  29. allowAttributes: [ 'type' ]
  30. } );
  31. editor.conversion.for( 'editingDowncast' ).elementToElement( {
  32. model: 'placeholder',
  33. view: ( modelItem, conversionApi ) => {
  34. const widgetElement = createPlaceholderView( modelItem, conversionApi );
  35. return toWidget( widgetElement, conversionApi.writer );
  36. }
  37. } );
  38. editor.conversion.for( 'dataDowncast' ).elementToElement( {
  39. model: 'placeholder',
  40. view: createPlaceholderView
  41. } );
  42. editor.conversion.for( 'upcast' ).elementToElement( {
  43. view: 'placeholder',
  44. model: ( viewElement, modelWriter ) => {
  45. let type = 'general';
  46. if ( viewElement.childCount ) {
  47. const text = viewElement.getChild( 0 );
  48. if ( text.is( '$text' ) ) {
  49. type = text.data.slice( 1, -1 );
  50. }
  51. }
  52. return modelWriter.createElement( 'placeholder', { type } );
  53. }
  54. } );
  55. editor.editing.mapper.on(
  56. 'viewToModelPosition',
  57. viewToModelPositionOutsideModelElement( editor.model, viewElement => viewElement.name == 'placeholder' )
  58. );
  59. this._createToolbarButton();
  60. function createPlaceholderView( modelItem, { writer } ) {
  61. const widgetElement = writer.createContainerElement( 'placeholder' );
  62. const viewText = writer.createText( '{' + modelItem.getAttribute( 'type' ) + '}' );
  63. writer.insert( writer.createPositionAt( widgetElement, 0 ), viewText );
  64. return widgetElement;
  65. }
  66. }
  67. _createToolbarButton() {
  68. const editor = this.editor;
  69. const t = editor.t;
  70. editor.ui.componentFactory.add( 'placeholder', locale => {
  71. const buttonView = new ButtonView( locale );
  72. buttonView.set( {
  73. label: t( 'Insert placeholder' ),
  74. tooltip: true,
  75. withText: true
  76. } );
  77. this.listenTo( buttonView, 'execute', () => {
  78. const model = editor.model;
  79. model.change( writer => {
  80. const placeholder = writer.createElement( 'placeholder', { type: 'placeholder' } );
  81. model.insertContent( placeholder );
  82. writer.setSelection( placeholder, 'on' );
  83. } );
  84. } );
  85. return buttonView;
  86. } );
  87. }
  88. }
  89. ClassicEditor
  90. .create( global.document.querySelector( '#editor' ), {
  91. plugins: [ Enter, Typing, Paragraph, Heading, Bold, Undo, Clipboard, Widget, ShiftEnter, InlineWidget, Table ],
  92. toolbar: [ 'heading', '|', 'bold', '|', 'placeholder', '|', 'insertTable', '|', 'undo', 'redo' ]
  93. } )
  94. .then( editor => {
  95. window.editor = editor;
  96. editor.model.document.on( 'change', () => {
  97. printModelContents( editor );
  98. } );
  99. printModelContents( editor );
  100. } )
  101. .catch( err => {
  102. console.error( err.stack );
  103. } );
  104. const modelDiv = global.document.querySelector( '#model' );
  105. function printModelContents( editor ) {
  106. modelDiv.innerText = formatData( getData( editor.model ) );
  107. }
  108. function formatData( data ) {
  109. return data
  110. .replace( /<(paragraph|\/tableRow|tableCell|table|heading[0-5])>/g, '\n<$1>' )
  111. .replace( /(<tableCell>)\n(<paragraph>)/g, '$1$2' )
  112. .replace( /\n(<tableCell>)/g, '\n\t$1' );
  113. }