ballooneditor.js 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals document */
  6. import BalloonEditorUI from '../src/ballooneditorui';
  7. import BalloonEditorUIView from '../src/ballooneditoruiview';
  8. import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
  9. import BalloonEditor from '../src/ballooneditor';
  10. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  11. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  12. import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
  13. import BalloonToolbar from '@ckeditor/ckeditor5-ui/src/toolbar/balloon/balloontoolbar';
  14. import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
  15. import ElementApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin';
  16. import RootElement from '@ckeditor/ckeditor5-engine/src/model/rootelement';
  17. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  18. import log from '@ckeditor/ckeditor5-utils/src/log';
  19. import ArticlePluginSet from '@ckeditor/ckeditor5-core/tests/_utils/articlepluginset';
  20. import { describeMemoryUsage, testMemoryUsage } from '@ckeditor/ckeditor5-core/tests/_utils/memory';
  21. describe( 'BalloonEditor', () => {
  22. let editor, editorElement;
  23. testUtils.createSinonSandbox();
  24. beforeEach( () => {
  25. editorElement = document.createElement( 'div' );
  26. editorElement.innerHTML = '<p><strong>foo</strong> bar</p>';
  27. document.body.appendChild( editorElement );
  28. testUtils.sinon.stub( log, 'warn' ).callsFake( () => {} );
  29. } );
  30. afterEach( () => {
  31. editorElement.remove();
  32. } );
  33. describe( 'constructor()', () => {
  34. beforeEach( () => {
  35. editor = new BalloonEditor( editorElement, {
  36. plugins: [ BalloonToolbar, Bold ],
  37. toolbar: [ 'Bold' ]
  38. } );
  39. } );
  40. it( 'pushes BalloonToolbar to the list of plugins', () => {
  41. expect( editor.config.get( 'plugins' ) ).to.include( BalloonToolbar );
  42. } );
  43. it( 'pipes config#toolbar to config#balloonToolbar', () => {
  44. expect( editor.config.get( 'balloonToolbar' ) ).to.have.members( [ 'Bold' ] );
  45. } );
  46. it( 'uses HTMLDataProcessor', () => {
  47. expect( editor.data.processor ).to.be.instanceof( HtmlDataProcessor );
  48. } );
  49. it( 'has a Data Interface', () => {
  50. testUtils.isMixed( BalloonEditor, DataApiMixin );
  51. } );
  52. it( 'has a Element Interface', () => {
  53. testUtils.isMixed( BalloonEditor, ElementApiMixin );
  54. } );
  55. it( 'creates main root element', () => {
  56. expect( editor.model.document.getRoot( 'main' ) ).to.instanceof( RootElement );
  57. } );
  58. it( 'should have undefined the #sourceElement if editor was initialized with data', () => {
  59. return BalloonEditor
  60. .create( '<p>Foo.</p>', {
  61. plugins: [ Paragraph, Bold ]
  62. } )
  63. .then( newEditor => {
  64. expect( newEditor.sourceElement ).to.be.undefined;
  65. return newEditor.destroy();
  66. } );
  67. } );
  68. } );
  69. describe( 'create()', () => {
  70. beforeEach( function() {
  71. return BalloonEditor
  72. .create( editorElement, {
  73. plugins: [ Paragraph, Bold ]
  74. } )
  75. .then( newEditor => {
  76. editor = newEditor;
  77. } );
  78. } );
  79. afterEach( () => {
  80. return editor.destroy();
  81. } );
  82. it( 'creates an instance which inherits from the BalloonEditor', () => {
  83. expect( editor ).to.be.instanceof( BalloonEditor );
  84. } );
  85. it( 'creates element–less UI view', () => {
  86. expect( editor.ui.view.element ).to.be.null;
  87. } );
  88. it( 'attaches editable UI as view\'s DOM root', () => {
  89. const domRoot = editor.editing.view.getDomRoot();
  90. expect( domRoot ).to.equal( editor.ui.view.editable.element );
  91. } );
  92. it( 'creates the UI using BalloonEditorUI classes', () => {
  93. expect( editor.ui ).to.be.instanceof( BalloonEditorUI );
  94. expect( editor.ui.view ).to.be.instanceof( BalloonEditorUIView );
  95. } );
  96. it( 'loads data from the editor element', () => {
  97. expect( editor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  98. } );
  99. it( 'should not require config object', () => {
  100. // Just being safe with `builtinPlugins` static property.
  101. class CustomBalloonEditor extends BalloonEditor {}
  102. CustomBalloonEditor.builtinPlugins = [ Paragraph, Bold ];
  103. return CustomBalloonEditor.create( editorElement )
  104. .then( newEditor => {
  105. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  106. return newEditor.destroy();
  107. } );
  108. } );
  109. it( 'allows to pass data to the constructor', () => {
  110. return BalloonEditor.create( '<p>Hello world!</p>', {
  111. plugins: [ Paragraph ]
  112. } ).then( editor => {
  113. expect( editor.getData() ).to.equal( '<p>Hello world!</p>' );
  114. editor.destroy();
  115. } );
  116. } );
  117. it( 'initializes with config.initialData', () => {
  118. return BalloonEditor.create( editorElement, {
  119. initialData: '<p>Hello world!</p>',
  120. plugins: [ Paragraph ]
  121. } ).then( editor => {
  122. expect( editor.getData() ).to.equal( '<p>Hello world!</p>' );
  123. editor.destroy();
  124. } );
  125. } );
  126. it( 'throws if initial data is passed in Editor#create and config.initialData is also used', done => {
  127. BalloonEditor.create( '<p>Hello world!</p>', {
  128. initialData: '<p>I am evil!</p>',
  129. plugins: [ Paragraph ]
  130. } )
  131. .then(
  132. () => {
  133. expect.fail( 'Balloon editor should throw an error when both initial data are passed' );
  134. },
  135. err => {
  136. expect( err ).to.be.an( 'error' ).with.property( 'message' ).and
  137. // eslint-disable-next-line max-len
  138. .match( /^editor-create-initial-data: The config\.initialData option cannot be used together with initial data passed in Editor\.create\(\)\./ );
  139. }
  140. )
  141. .then( done )
  142. .catch( done );
  143. } );
  144. // ckeditor/ckeditor5-editor-classic#53
  145. it( 'creates an instance of a BalloonEditor child class', () => {
  146. // Fun fact: Remove the next 3 lines and you'll get a lovely inf loop due to two
  147. // editor being initialized on one element.
  148. const editorElement = document.createElement( 'div' );
  149. editorElement.innerHTML = '<p><strong>foo</strong> bar</p>';
  150. document.body.appendChild( editorElement );
  151. class CustomBalloonEditor extends BalloonEditor {}
  152. return CustomBalloonEditor
  153. .create( editorElement, {
  154. plugins: [ Paragraph, Bold ]
  155. } )
  156. .then( newEditor => {
  157. expect( newEditor ).to.be.instanceof( CustomBalloonEditor );
  158. expect( newEditor ).to.be.instanceof( BalloonEditor );
  159. expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
  160. editorElement.remove();
  161. return newEditor.destroy();
  162. } );
  163. } );
  164. it( 'throws an error when is initialized in textarea', done => {
  165. BalloonEditor.create( document.createElement( 'textarea' ) )
  166. .then(
  167. () => {
  168. expect.fail( 'Balloon editor should throw an error when is initialized in textarea.' );
  169. },
  170. err => {
  171. expect( err ).to.be.an( 'error' ).with.property( 'message' ).and
  172. .match( /^editor-wrong-element: This type of editor cannot be initialized inside <textarea> element\./ );
  173. }
  174. )
  175. .then( done )
  176. .catch( done );
  177. } );
  178. } );
  179. describe( 'create - events', () => {
  180. afterEach( () => {
  181. return editor.destroy();
  182. } );
  183. it( 'fires all events in the right order', () => {
  184. const fired = [];
  185. function spy( evt ) {
  186. fired.push( `${ evt.name }-${ evt.source.constructor.name.toLowerCase() }` );
  187. }
  188. class EventWatcher extends Plugin {
  189. init() {
  190. this.editor.ui.on( 'ready', spy );
  191. this.editor.data.on( 'ready', spy );
  192. this.editor.on( 'ready', spy );
  193. }
  194. }
  195. return BalloonEditor
  196. .create( editorElement, {
  197. plugins: [ EventWatcher ]
  198. } )
  199. .then( newEditor => {
  200. expect( fired ).to.deep.equal(
  201. [ 'ready-ballooneditorui', 'ready-datacontroller', 'ready-ballooneditor' ] );
  202. editor = newEditor;
  203. } );
  204. } );
  205. it( 'fires ready once UI is ready', () => {
  206. let isRendered;
  207. class EventWatcher extends Plugin {
  208. init() {
  209. this.editor.ui.on( 'ready', () => {
  210. isRendered = this.editor.ui.view.isRendered;
  211. } );
  212. }
  213. }
  214. return BalloonEditor
  215. .create( editorElement, {
  216. plugins: [ EventWatcher ]
  217. } )
  218. .then( newEditor => {
  219. expect( isRendered ).to.be.true;
  220. editor = newEditor;
  221. } );
  222. } );
  223. } );
  224. describe( 'destroy()', () => {
  225. beforeEach( function() {
  226. return BalloonEditor
  227. .create( editorElement, { plugins: [ Paragraph ] } )
  228. .then( newEditor => {
  229. editor = newEditor;
  230. const schema = editor.model.schema;
  231. schema.register( 'heading' );
  232. schema.extend( 'heading', { allowIn: '$root' } );
  233. schema.extend( '$text', { allowIn: 'heading' } );
  234. editor.conversion.for( 'upcast' ).elementToElement( { model: 'heading', view: 'heading' } );
  235. editor.conversion.for( 'dataDowncast' ).elementToElement( { model: 'heading', view: 'heading' } );
  236. editor.conversion.for( 'editingDowncast' ).elementToElement( {
  237. model: 'heading',
  238. view: 'heading-editing-representation'
  239. } );
  240. } );
  241. } );
  242. it( 'sets the data back to the editor element', () => {
  243. editor.setData( '<p>a</p><heading>b</heading>' );
  244. return editor.destroy()
  245. .then( () => {
  246. expect( editorElement.innerHTML )
  247. .to.equal( '<p>a</p><heading>b</heading>' );
  248. } );
  249. } );
  250. it( 'should not throw an error if editor was initialized with the data', () => {
  251. return BalloonEditor
  252. .create( '<p>Foo.</p>', {
  253. plugins: [ Paragraph, Bold ]
  254. } )
  255. .then( newEditor => newEditor.destroy() );
  256. } );
  257. } );
  258. describeMemoryUsage( () => {
  259. testMemoryUsage(
  260. 'should not grow on multiple create/destroy',
  261. () => BalloonEditor
  262. .create( document.querySelector( '#mem-editor' ), {
  263. plugins: [ ArticlePluginSet ],
  264. toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
  265. image: {
  266. toolbar: [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
  267. }
  268. } ) );
  269. } );
  270. } );