8
0

htmlembedediting.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806
  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, document, HTMLTextAreaElement, HTMLDivElement, Event */
  6. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  7. import HtmlEmbedEditing from '../src/htmlembedediting';
  8. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  9. import UpdateHtmlEmbedCommand from '../src/updatehtmlembedcommand';
  10. import InsertHtmlEmbedCommand from '../src/inserthtmlembedcommand';
  11. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  12. import { isWidget } from '@ckeditor/ckeditor5-widget/src/utils';
  13. describe( 'HtmlEmbedEditing', () => {
  14. let element, editor, model, view, viewDocument;
  15. testUtils.createSinonSandbox();
  16. beforeEach( () => {
  17. element = document.createElement( 'div' );
  18. document.body.appendChild( element );
  19. return ClassicTestEditor
  20. .create( element, {
  21. plugins: [ HtmlEmbedEditing ]
  22. } )
  23. .then( newEditor => {
  24. editor = newEditor;
  25. model = editor.model;
  26. view = editor.editing.view;
  27. viewDocument = view.document;
  28. } );
  29. } );
  30. afterEach( () => {
  31. return editor.destroy()
  32. .then( () => {
  33. element.remove();
  34. } );
  35. } );
  36. it( 'should have pluginName', () => {
  37. expect( HtmlEmbedEditing.pluginName ).to.equal( 'HtmlEmbedEditing' );
  38. } );
  39. it( 'should be loaded', () => {
  40. expect( editor.plugins.get( HtmlEmbedEditing ) ).to.be.instanceOf( HtmlEmbedEditing );
  41. } );
  42. it( 'should set proper schema rules', () => {
  43. expect( model.schema.checkChild( [ '$root' ], 'rawHtml' ) ).to.be.true;
  44. expect( model.schema.checkAttribute( [ '$root', 'rawHtml' ], 'value' ) ).to.be.true;
  45. expect( model.schema.isObject( 'rawHtml' ) ).to.be.true;
  46. expect( model.schema.checkChild( [ '$root', 'rawHtml' ], '$text' ) ).to.be.false;
  47. expect( model.schema.checkChild( [ '$root', '$block' ], 'rawHtml' ) ).to.be.false;
  48. } );
  49. describe( 'commands', () => {
  50. it( 'should register updateHtmlEmbed command', () => {
  51. expect( editor.commands.get( 'updateHtmlEmbed' ) ).to.be.instanceOf( UpdateHtmlEmbedCommand );
  52. } );
  53. it( 'should register insertHtmlEmbed command', () => {
  54. expect( editor.commands.get( 'insertHtmlEmbed' ) ).to.be.instanceOf( InsertHtmlEmbedCommand );
  55. } );
  56. } );
  57. describe( 'config', () => {
  58. let htmlEmbed;
  59. beforeEach( () => {
  60. htmlEmbed = editor.config.get( 'htmlEmbed' );
  61. } );
  62. describe( 'htmlEmbed.showPreviews', () => {
  63. it( 'should be set to `false` by default', () => {
  64. expect( htmlEmbed.showPreviews ).to.equal( false );
  65. } );
  66. } );
  67. describe( 'htmlEmbed.sanitizeHtml', () => {
  68. beforeEach( () => {
  69. sinon.stub( console, 'warn' );
  70. } );
  71. it( 'should return an object with cleaned html and a note whether something has changed', () => {
  72. expect( htmlEmbed.sanitizeHtml( 'foo' ) ).to.deep.equal( {
  73. html: 'foo',
  74. hasChanged: false
  75. } );
  76. } );
  77. it( 'should return an input string (without any modifications)', () => {
  78. const unsafeHtml = '<img src="data:/xxx,<script>void</script>" onload="void;">';
  79. expect( htmlEmbed.sanitizeHtml( unsafeHtml ).html ).to.deep.equal( unsafeHtml );
  80. } );
  81. it( 'should display a warning when using the default sanitizer', () => {
  82. htmlEmbed.sanitizeHtml( 'foo' );
  83. expect( console.warn.callCount ).to.equal( 1 );
  84. expect( console.warn.firstCall.args[ 0 ] ).to.equal( 'html-embed-provide-sanitize-function' );
  85. } );
  86. } );
  87. } );
  88. describe( 'conversion in the data pipeline', () => {
  89. describe( 'model to view', () => {
  90. it( 'should convert an empty `rawHtml` element', () => {
  91. setModelData( model, '[<rawHtml></rawHtml>]' );
  92. expect( editor.getData() ).to.equal( '<div class="raw-html-embed"></div>' );
  93. } );
  94. it( 'should put the HTML from the `value` attribute (in `rawHtml`) into the data', () => {
  95. setModelData( model, '[<rawHtml></rawHtml>]' );
  96. model.change( writer => {
  97. writer.setAttribute( 'value', '<b>Foo.</b>', model.document.getRoot().getChild( 0 ) );
  98. } );
  99. expect( editor.getData() ).to.equal(
  100. '<div class="raw-html-embed">' +
  101. '<b>Foo.</b>' +
  102. '</div>'
  103. );
  104. } );
  105. } );
  106. describe( 'view to model', () => {
  107. it( 'should convert innerHTML (single element) of div.raw-html-embed', () => {
  108. editor.setData(
  109. '<div class="raw-html-embed">' +
  110. '<b>Foo.</b>' +
  111. '</div>'
  112. );
  113. const rawHtml = model.document.getRoot().getChild( 0 );
  114. expect( rawHtml.getAttribute( 'value' ) ).to.equal( '<b>Foo.</b>' );
  115. } );
  116. it( 'should convert innerHTML (single element with children) of div.raw-html-embed', () => {
  117. editor.setData(
  118. '<div class="raw-html-embed">' +
  119. '<p>' +
  120. '<b>Foo B.</b>' +
  121. '<i>Foo I.</i>' +
  122. '</p>' +
  123. '</div>'
  124. );
  125. const rawHtml = model.document.getRoot().getChild( 0 );
  126. expect( rawHtml.getAttribute( 'value' ) ).to.equal(
  127. '<p>' +
  128. '<b>Foo B.</b>' +
  129. '<i>Foo I.</i>' +
  130. '</p>'
  131. );
  132. } );
  133. it( 'should convert innerHTML (few elements) of div.raw-html-embed', () => {
  134. editor.setData(
  135. '<div class="raw-html-embed">' +
  136. '<b>Foo B.</b>' +
  137. '<i>Foo I.</i>' +
  138. '<u>Foo U.</u>' +
  139. '</div>'
  140. );
  141. const rawHtml = model.document.getRoot().getChild( 0 );
  142. expect( rawHtml.getAttribute( 'value' ) ).to.equal(
  143. '<b>Foo B.</b>' +
  144. '<i>Foo I.</i>' +
  145. '<u>Foo U.</u>'
  146. );
  147. } );
  148. it( 'should not convert in wrong context', () => {
  149. model.schema.register( 'div', { inheritAllFrom: '$block' } );
  150. model.schema.addChildCheck( ( ctx, childDef ) => {
  151. if ( ctx.endsWith( '$root' ) && childDef.name == 'rawHtml' ) {
  152. return false;
  153. }
  154. } );
  155. editor.conversion.elementToElement( { model: 'div', view: 'div' } );
  156. editor.setData(
  157. '<div>' +
  158. '<div class="raw-html-embed">' +
  159. '<b>Foo.</b>' +
  160. '</div>' +
  161. '</div>'
  162. );
  163. expect( getModelData( model, { withoutSelection: true } ) )
  164. .to.equal( '<div></div>' );
  165. } );
  166. it( 'should not convert inner `div.raw-html-embed` that is a child of outer div.raw-html-embed', () => {
  167. editor.setData(
  168. '<div class="raw-html-embed">' +
  169. '<div class="raw-html-embed">' +
  170. '<b>Foo B.</b>' +
  171. '<i>Foo I.</i>' +
  172. '<u>Foo U.</u>' +
  173. '</div>' +
  174. '</div>'
  175. );
  176. const rawHtml = model.document.getRoot().getChild( 0 );
  177. expect( rawHtml.getAttribute( 'value' ) ).to.equal(
  178. '<div class="raw-html-embed">' +
  179. '<b>Foo B.</b>' +
  180. '<i>Foo I.</i>' +
  181. '<u>Foo U.</u>' +
  182. '</div>'
  183. );
  184. } );
  185. } );
  186. } );
  187. describe( 'conversion in the editing pipeline (model to view)', () => {
  188. describe( 'without previews (htmlEmbed.showPreviews=false)', () => {
  189. it( 'converted element should be widgetized', () => {
  190. setModelData( model, '<rawHtml></rawHtml>' );
  191. const widget = viewDocument.getRoot().getChild( 0 );
  192. expect( widget.name ).to.equal( 'div' );
  193. expect( isRawHtmlWidget( widget ) ).to.be.true;
  194. const contentWrapper = widget.getChild( 1 );
  195. expect( contentWrapper.hasClass( 'raw-html-embed__content-wrapper' ) );
  196. } );
  197. it( 'renders a disabled textarea as a preview', () => {
  198. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  199. const widget = viewDocument.getRoot().getChild( 0 );
  200. const contentWrapper = widget.getChild( 1 );
  201. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  202. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).value ).to.equal( 'foo' );
  203. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).disabled ).to.be.true;
  204. } );
  205. it( 'updates the textarea preview once the model changes', () => {
  206. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  207. editor.model.change( writer => writer.setAttribute( 'value', 'bar', editor.model.document.getRoot().getChild( 0 ) ) );
  208. const widget = viewDocument.getRoot().getChild( 0 );
  209. const contentWrapper = widget.getChild( 1 );
  210. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  211. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).value ).to.equal( 'bar' );
  212. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).disabled ).to.be.true;
  213. } );
  214. it( 'renders the "edit" button', () => {
  215. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  216. const widget = viewDocument.getRoot().getChild( 0 );
  217. const contentWrapper = widget.getChild( 1 );
  218. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  219. // There's exactly this button, and nothing else.
  220. expect( domContentWrapper.querySelectorAll( 'button' ) ).to.have.lengthOf( 1 );
  221. expect( domContentWrapper.querySelectorAll( '.raw-html-embed__edit-button' ) ).to.have.lengthOf( 1 );
  222. } );
  223. it( 'the main element should expose rawHtmlApi custom property', () => {
  224. setModelData( model, '<rawHtml></rawHtml>' );
  225. const widget = viewDocument.getRoot().getChild( 0 );
  226. expect( widget.getCustomProperty( 'rawHtmlApi' ) ).has.keys( [ 'makeEditable', 'save', 'cancel' ] );
  227. } );
  228. describe( 'rawHtmlApi.makeEditable()', () => {
  229. it( 'makes the textarea editable', () => {
  230. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  231. const widget = viewDocument.getRoot().getChild( 0 );
  232. const contentWrapper = widget.getChild( 1 );
  233. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  234. widget.getCustomProperty( 'rawHtmlApi' ).makeEditable();
  235. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).value ).to.equal( 'foo' );
  236. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).disabled ).to.be.false;
  237. } );
  238. } );
  239. describe( 'rawHtmlApi.save()', () => {
  240. it( 'saves the new value to the model', () => {
  241. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  242. const widget = viewDocument.getRoot().getChild( 0 );
  243. widget.getCustomProperty( 'rawHtmlApi' ).makeEditable();
  244. widget.getCustomProperty( 'rawHtmlApi' ).save( 'bar' );
  245. expect( getModelData( model ) ).to.equal( '[<rawHtml value="bar"></rawHtml>]' );
  246. } );
  247. it( 'turns back to the non-editable mode and updates the textarea value', () => {
  248. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  249. const widget = viewDocument.getRoot().getChild( 0 );
  250. widget.getCustomProperty( 'rawHtmlApi' ).makeEditable();
  251. widget.getCustomProperty( 'rawHtmlApi' ).save( 'bar' );
  252. const newWidget = viewDocument.getRoot().getChild( 0 );
  253. const contentWrapper = newWidget.getChild( 1 );
  254. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  255. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).value ).to.equal( 'bar' );
  256. expect( domContentWrapper.querySelector( 'textarea.raw-html-embed__source' ).disabled ).to.be.true;
  257. } );
  258. } );
  259. } );
  260. describe( 'with previews (htmlEmbed.showPreviews=true)', () => {
  261. let element, editor, model, view, viewDocument, sanitizeHtml;
  262. testUtils.createSinonSandbox();
  263. beforeEach( () => {
  264. element = document.createElement( 'div' );
  265. document.body.appendChild( element );
  266. // The default sanitize function without `console.warn`.
  267. sanitizeHtml = input => ( { html: input, hasChanged: false } );
  268. return ClassicTestEditor
  269. .create( element, {
  270. plugins: [ HtmlEmbedEditing ],
  271. htmlEmbed: {
  272. showPreviews: true,
  273. sanitizeHtml
  274. }
  275. } )
  276. .then( newEditor => {
  277. editor = newEditor;
  278. model = editor.model;
  279. view = editor.editing.view;
  280. viewDocument = view.document;
  281. } );
  282. } );
  283. afterEach( () => {
  284. return editor.destroy()
  285. .then( () => {
  286. element.remove();
  287. } );
  288. } );
  289. it( 'renders a div with a preview', () => {
  290. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  291. const widget = viewDocument.getRoot().getChild( 0 );
  292. const contentWrapper = widget.getChild( 1 );
  293. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  294. expect( domContentWrapper.querySelector( 'div.raw-html-embed__preview' ).innerHTML ).to.equal( 'foo' );
  295. } );
  296. it( 'updates the preview once the model changes', () => {
  297. setModelData( model, '<rawHtml value="foo"></rawHtml>' );
  298. editor.model.change( writer => writer.setAttribute( 'value', 'bar', editor.model.document.getRoot().getChild( 0 ) ) );
  299. const widget = viewDocument.getRoot().getChild( 0 );
  300. const contentWrapper = widget.getChild( 1 );
  301. const domContentWrapper = editor.editing.view.domConverter.mapViewToDom( contentWrapper );
  302. expect( domContentWrapper.querySelector( 'div.raw-html-embed__preview' ).innerHTML ).to.equal( 'bar' );
  303. } );
  304. } );
  305. } );
  306. describe.skip( 'conversion in editing pipeline (model to view)', () => {
  307. describe( 'without previews (htmlEmbed.showPreviews=false)', () => {
  308. it( 'converted element should be widgetized', () => {
  309. setModelData( model, '<rawHtml></rawHtml>' );
  310. const widget = viewDocument.getRoot().getChild( 0 );
  311. expect( widget.name ).to.equal( 'div' );
  312. expect( isRawHtmlWidget( widget ) ).to.be.true;
  313. const rawHtmlContainer = widget.getChild( 1 );
  314. expect( rawHtmlContainer ).to.not.be.undefined;
  315. } );
  316. it( 'widget should not contain a class that informs about available preview mode', () => {
  317. setModelData( model, '<rawHtml></rawHtml>' );
  318. const widget = viewDocument.getRoot().getChild( 0 );
  319. expect( widget.hasClass( 'raw-html_preview_enabled' ) ).to.equal( false );
  320. } );
  321. it( 'should render the toggle button and edit source elements', () => {
  322. setModelData( model, '<rawHtml></rawHtml>' );
  323. const widget = viewDocument.getRoot().getChild( 0 );
  324. const viewHtmlContainer = widget.getChild( 1 );
  325. // Expecting two children: toggle button and editable textarea.
  326. expect( viewHtmlContainer.childCount ).to.equal( 2 );
  327. const toggleWrapperElement = viewHtmlContainer.getChild( 0 );
  328. expect( toggleWrapperElement.is( 'uiElement' ) ).to.equal( true );
  329. expect( toggleWrapperElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLDivElement );
  330. const sourceElement = viewHtmlContainer.getChild( 1 );
  331. expect( sourceElement.is( 'uiElement' ) ).to.equal( true );
  332. expect( sourceElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLTextAreaElement );
  333. } );
  334. it( 'source element should have a placeholder', () => {
  335. setModelData( model, '<rawHtml></rawHtml>' );
  336. const widget = viewDocument.getRoot().getChild( 0 );
  337. const viewHtmlContainer = widget.getChild( 1 );
  338. const sourceElement = viewHtmlContainer.getChild( 1 );
  339. expect( sourceElement.getAttribute( 'placeholder' ) ).to.equal( 'Paste raw HTML here...' );
  340. } );
  341. it( 'should update the edit source element when the `value` attribute has changed', () => {
  342. setModelData( model, '<rawHtml></rawHtml>' );
  343. model.change( writer => {
  344. writer.setAttribute( 'value', '<b>Foo.</b>', model.document.getRoot().getChild( 0 ) );
  345. } );
  346. const widget = viewDocument.getRoot().getChild( 0 );
  347. const viewHtmlContainer = widget.getChild( 1 );
  348. const sourceElement = viewHtmlContainer.getChild( 1 );
  349. expect( sourceElement.getCustomProperty( 'domElement' ).value ).to.equal( '<b>Foo.</b>' );
  350. } );
  351. it( 'should update the `value` attribute after applying changes in the edit source element', () => {
  352. setModelData( model, '<rawHtml></rawHtml>' );
  353. const widget = viewDocument.getRoot().getChild( 0 );
  354. const viewHtmlContainer = widget.getChild( 1 );
  355. const sourceElement = viewHtmlContainer.getChild( 1 );
  356. const textarea = sourceElement.getCustomProperty( 'domElement' );
  357. textarea.value = '<b>Foo.</b>';
  358. textarea.dispatchEvent( new Event( 'input' ) );
  359. expect( model.document.getRoot().getChild( 0 ).getAttribute( 'value' ) ).to.equal( '<b>Foo.</b>' );
  360. } );
  361. it( 'should show the HTML in the preview mode by default (source element should be disabled)', () => {
  362. setModelData( model, '<rawHtml value="Foo"></rawHtml>' );
  363. const widget = viewDocument.getRoot().getChild( 0 );
  364. const viewHtmlContainer = widget.getChild( 1 );
  365. const sourceElement = viewHtmlContainer.getChild( 1 );
  366. const textarea = sourceElement.getCustomProperty( 'domElement' );
  367. expect( textarea.disabled ).to.equal( true );
  368. expect( textarea.value ).to.equal( 'Foo' );
  369. } );
  370. it( 'should allows modifying the source after clicking the toggle button', () => {
  371. setModelData( model, '<rawHtml></rawHtml>' );
  372. const widget = viewDocument.getRoot().getChild( 0 );
  373. const viewHtmlContainer = widget.getChild( 1 );
  374. const toggleButtonElement = viewHtmlContainer.getChild( 0 );
  375. toggleButtonElement.getCustomProperty( 'domElement' ).click();
  376. const sourceElement = viewHtmlContainer.getChild( 1 );
  377. expect( sourceElement.getCustomProperty( 'domElement' ).disabled ).to.equal( false );
  378. } );
  379. it( 'should update the toggle button icon after switching to "edit source mode"', () => {
  380. setModelData( model, '<rawHtml></rawHtml>' );
  381. const widget = viewDocument.getRoot().getChild( 0 );
  382. const viewHtmlContainer = widget.getChild( 1 );
  383. const toggleButtonElement = viewHtmlContainer.getChild( 0 );
  384. const toggleButton = toggleButtonElement.getCustomProperty( 'domElement' );
  385. const toggleIconBeforeClick = toggleButton.innerHTML;
  386. toggleButton.click();
  387. // Check whether the icon has been updated.
  388. expect( toggleButton.innerHTML ).to.not.equal( toggleIconBeforeClick );
  389. } );
  390. it( 'should disable the source element after clicking the toggle button when edit source mode is enabled', () => {
  391. setModelData( model, '<rawHtml></rawHtml>' );
  392. const widget = viewDocument.getRoot().getChild( 0 );
  393. const viewHtmlContainer = widget.getChild( 1 );
  394. const toggleIconElement = viewHtmlContainer.getChild( 0 );
  395. const toggleButton = toggleIconElement.getCustomProperty( 'domElement' );
  396. // Switch to edit source mode.
  397. toggleButton.click();
  398. // Switch to preview mode.
  399. toggleButton.click();
  400. expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).disabled ).to.equal( true );
  401. } );
  402. it( 'should restore the toggle button icon after leaving the "edit source" mode', () => {
  403. setModelData( model, '<rawHtml></rawHtml>' );
  404. const widget = viewDocument.getRoot().getChild( 0 );
  405. const viewHtmlContainer = widget.getChild( 1 );
  406. const toggleButtonElement = viewHtmlContainer.getChild( 0 );
  407. const toggleButton = toggleButtonElement.getCustomProperty( 'domElement' );
  408. // The icon before switching mode.
  409. const toggleIconBeforeClick = toggleButton.innerHTML;
  410. // Switch to edit source mode.
  411. toggleButton.click();
  412. // The icon for edit source mode.
  413. const toggleIconAfterFirstClick = toggleButton.innerHTML;
  414. // Switch to preview mode.
  415. toggleButton.click();
  416. // The first click: the icon has been changed.
  417. expect( toggleButton.innerHTML ).to.equal( toggleIconBeforeClick );
  418. // The second click: the icon has been restored.
  419. expect( toggleButton.innerHTML ).to.not.equal( toggleIconAfterFirstClick );
  420. } );
  421. it( 'should add the "readonly" attribute if updated content of the editor in read-only mode', () => {
  422. editor.isReadOnly = true;
  423. setModelData( model, '<rawHtml></rawHtml>' );
  424. const widget = viewDocument.getRoot().getChild( 0 );
  425. const viewHtmlContainer = widget.getChild( 1 );
  426. expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).readOnly ).to.equal( true );
  427. } );
  428. it( 'should add the "readonly" attribute if editor switches itself to read-only mode', () => {
  429. setModelData( model, '<rawHtml></rawHtml>' );
  430. const widget = viewDocument.getRoot().getChild( 0 );
  431. const viewHtmlContainer = widget.getChild( 1 );
  432. editor.isReadOnly = true;
  433. expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).readOnly ).to.equal( true );
  434. } );
  435. it( 'should remove the "readonly" attribute if editor switches itself to edit mode', () => {
  436. editor.isReadOnly = true;
  437. setModelData( model, '<rawHtml></rawHtml>' );
  438. const widget = viewDocument.getRoot().getChild( 0 );
  439. const viewHtmlContainer = widget.getChild( 1 );
  440. editor.isReadOnly = false;
  441. expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).readOnly ).to.equal( false );
  442. } );
  443. it( 'should select the proper model element when editing source', () => {
  444. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  445. editor.conversion.elementToElement( { model: 'paragraph', view: 'p' } );
  446. setModelData( model, '<paragraph>Foo.[]</paragraph><rawHtml value="1"></rawHtml><rawHtml value="2"></rawHtml>' );
  447. const secondHtmlContainer = viewDocument.getRoot().getChild( 2 ).getChild( 1 );
  448. // Switch to edit mode.
  449. secondHtmlContainer.getChild( 0 ).getCustomProperty( 'domElement' ).click();
  450. const sourceElement = secondHtmlContainer.getChild( 1 );
  451. const textarea = sourceElement.getCustomProperty( 'domElement' );
  452. textarea.dispatchEvent( new Event( 'focus' ) );
  453. expect( getModelData( model ) ).to.equal(
  454. '<paragraph>Foo.</paragraph><rawHtml value="1"></rawHtml>[<rawHtml value="2"></rawHtml>]'
  455. );
  456. } );
  457. } );
  458. describe( 'with previews (htmlEmbed.showPreviews=true)', () => {
  459. let element, editor, model, view, viewDocument, sanitizeHtml;
  460. testUtils.createSinonSandbox();
  461. beforeEach( () => {
  462. element = document.createElement( 'div' );
  463. document.body.appendChild( element );
  464. // The default sanitize function without `console.warn`.
  465. sanitizeHtml = input => ( { html: input, hasChanged: false } );
  466. return ClassicTestEditor
  467. .create( element, {
  468. plugins: [ HtmlEmbedEditing ],
  469. htmlEmbed: {
  470. showPreviews: true,
  471. sanitizeHtml
  472. }
  473. } )
  474. .then( newEditor => {
  475. editor = newEditor;
  476. model = editor.model;
  477. view = editor.editing.view;
  478. viewDocument = view.document;
  479. } );
  480. } );
  481. afterEach( () => {
  482. return editor.destroy()
  483. .then( () => {
  484. element.remove();
  485. } );
  486. } );
  487. it( 'widget should contain a class that informs about available preview mode', () => {
  488. setModelData( model, '<rawHtml></rawHtml>' );
  489. const widget = viewDocument.getRoot().getChild( 0 );
  490. expect( widget.hasClass( 'raw-html-embed_preview_enabled' ) ).to.equal( true );
  491. } );
  492. it( 'should render the toggle button, edit source and preview container elements', () => {
  493. setModelData( model, '<rawHtml></rawHtml>' );
  494. const widget = viewDocument.getRoot().getChild( 0 );
  495. const viewHtmlContainer = widget.getChild( 1 );
  496. // Expecting three children: toggle button, editable textarea, and the preview container.
  497. expect( viewHtmlContainer.childCount ).to.equal( 3 );
  498. const toggleWrapperElement = viewHtmlContainer.getChild( 0 );
  499. expect( toggleWrapperElement.is( 'uiElement' ) ).to.equal( true );
  500. expect( toggleWrapperElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLDivElement );
  501. const sourceElement = viewHtmlContainer.getChild( 1 );
  502. expect( sourceElement.is( 'uiElement' ) ).to.equal( true );
  503. expect( sourceElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLTextAreaElement );
  504. const previewElement = viewHtmlContainer.getChild( 2 );
  505. expect( previewElement.is( 'rawElement' ) ).to.equal( true );
  506. expect( previewElement.getCustomProperty( 'domElement' ) ).to.be.an.instanceOf( HTMLDivElement );
  507. } );
  508. it( 'should update the source and preview elements when the `value` attribute has changed', () => {
  509. setModelData( model, '<rawHtml></rawHtml>' );
  510. const widget = viewDocument.getRoot().getChild( 0 );
  511. const viewHtmlContainer = widget.getChild( 1 );
  512. const sourceElement = viewHtmlContainer.getChild( 1 );
  513. const previewElement = viewHtmlContainer.getChild( 2 );
  514. // The preview container should be empty.
  515. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '' );
  516. model.change( writer => {
  517. writer.setAttribute( 'value', '<b>Foo.</b>', model.document.getRoot().getChild( 0 ) );
  518. } );
  519. expect( sourceElement.getCustomProperty( 'domElement' ).value ).to.equal( '<b>Foo.</b>' );
  520. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '<b>Foo.</b>' );
  521. } );
  522. it( 'should render the HTML in the preview element by default', () => {
  523. setModelData( model, '<rawHtml value="Foo"></rawHtml>' );
  524. const widget = viewDocument.getRoot().getChild( 0 );
  525. expect( widget.hasClass( 'raw-html-embed_preview_visible' ) ).to.equal( true );
  526. const viewHtmlContainer = widget.getChild( 1 );
  527. const sourceElement = viewHtmlContainer.getChild( 1 );
  528. const textarea = sourceElement.getCustomProperty( 'domElement' );
  529. expect( textarea.disabled ).to.equal( true );
  530. expect( textarea.value ).to.equal( 'Foo' );
  531. const previewElement = viewHtmlContainer.getChild( 2 ).getCustomProperty( 'domElement' );
  532. expect( previewElement.innerHTML ).to.equal( 'Foo' );
  533. } );
  534. it( 'should re-render the preview element after applying changes in the edit source element', () => {
  535. setModelData( model, '<rawHtml></rawHtml>' );
  536. const event = new Event( 'input' );
  537. const widget = viewDocument.getRoot().getChild( 0 );
  538. const viewHtmlContainer = widget.getChild( 1 );
  539. const sourceElement = viewHtmlContainer.getChild( 1 );
  540. const previewElement = viewHtmlContainer.getChild( 2 );
  541. // The preview container should be empty.
  542. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '' );
  543. const textarea = sourceElement.getCustomProperty( 'domElement' );
  544. textarea.value = '<b>Foo.</b>';
  545. textarea.dispatchEvent( event );
  546. expect( previewElement.getCustomProperty( 'domElement' ).innerHTML ).to.equal( '<b>Foo.</b>' );
  547. } );
  548. it( 'should pass an empty string if the `value` attribute is empty', () => {
  549. setModelData( model, '<rawHtml value="Foo"></rawHtml>' );
  550. model.change( writer => {
  551. writer.setAttribute( 'value', '', model.document.getRoot().getChild( 0 ) );
  552. } );
  553. const widget = viewDocument.getRoot().getChild( 0 );
  554. const viewHtmlContainer = widget.getChild( 1 );
  555. const previewElement = viewHtmlContainer.getChild( 2 ).getCustomProperty( 'domElement' );
  556. expect( previewElement.innerHTML ).to.equal( '' );
  557. } );
  558. it( 'should pass an empty string if the `value` attribute was removed', () => {
  559. setModelData( model, '<rawHtml value="Foo"></rawHtml>' );
  560. model.change( writer => {
  561. writer.removeAttribute( 'value', model.document.getRoot().getChild( 0 ) );
  562. } );
  563. const widget = viewDocument.getRoot().getChild( 0 );
  564. const viewHtmlContainer = widget.getChild( 1 );
  565. const previewElement = viewHtmlContainer.getChild( 2 ).getCustomProperty( 'domElement' );
  566. expect( previewElement.innerHTML ).to.equal( '' );
  567. } );
  568. it( 'should allows modifying the source after clicking the toggle button', () => {
  569. setModelData( model, '<rawHtml></rawHtml>' );
  570. const widget = viewDocument.getRoot().getChild( 0 );
  571. const viewHtmlContainer = widget.getChild( 1 );
  572. const toggleIconElement = viewHtmlContainer.getChild( 0 );
  573. toggleIconElement.getCustomProperty( 'domElement' ).click();
  574. const sourceElement = viewHtmlContainer.getChild( 1 );
  575. expect( sourceElement.getCustomProperty( 'domElement' ).disabled ).to.equal( false );
  576. expect( widget.hasClass( 'raw-html_preview_visible' ) ).to.equal( false );
  577. } );
  578. it( 'should display preview element after clicking the toggle button when displaying edit source mode', () => {
  579. setModelData( model, '<rawHtml></rawHtml>' );
  580. const widget = viewDocument.getRoot().getChild( 0 );
  581. const viewHtmlContainer = widget.getChild( 1 );
  582. const toggleIconElement = viewHtmlContainer.getChild( 0 );
  583. const toggleButton = toggleIconElement.getCustomProperty( 'domElement' );
  584. // Switch to edit source mode.
  585. toggleButton.click();
  586. // Switch to preview mode.
  587. toggleButton.click();
  588. expect( widget.hasClass( 'raw-html-embed_preview_visible' ) ).to.equal( true );
  589. expect( viewHtmlContainer.getChild( 1 ).getCustomProperty( 'domElement' ).disabled ).to.equal( true );
  590. } );
  591. } );
  592. } );
  593. } );
  594. function isRawHtmlWidget( viewElement ) {
  595. return !!viewElement.getCustomProperty( 'rawHtml' ) && isWidget( viewElement );
  596. }