widget-integration.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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 document */
  6. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  7. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  8. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  9. import LinkEditing from '@ckeditor/ckeditor5-link/src/linkediting';
  10. import Widget from '../src/widget';
  11. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  12. import { toWidget } from '../src/utils';
  13. import {
  14. setData as setModelData,
  15. getData as getModelData
  16. } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  17. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  18. import env from '@ckeditor/ckeditor5-utils/src/env';
  19. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  20. describe( 'Widget - integration', () => {
  21. let editor, model, view, viewDocument, editorElement;
  22. testUtils.createSinonSandbox();
  23. beforeEach( () => {
  24. testUtils.sinon.stub( env, 'isSafari' ).get( () => true );
  25. editorElement = document.createElement( 'div' );
  26. document.body.appendChild( editorElement );
  27. return ClassicEditor.create( editorElement, { plugins: [ Paragraph, Widget, Typing, LinkEditing ] } )
  28. .then( newEditor => {
  29. editor = newEditor;
  30. model = editor.model;
  31. view = editor.editing.view;
  32. viewDocument = view.document;
  33. model.schema.register( 'widget', {
  34. inheritAllFrom: '$block',
  35. isObject: true
  36. } );
  37. model.schema.register( 'nested', {
  38. allowIn: 'widget',
  39. isLimit: true
  40. } );
  41. model.schema.extend( '$text', {
  42. allowIn: [ 'nested', 'editable', 'inline-widget' ]
  43. } );
  44. model.schema.register( 'editable', {
  45. allowIn: [ 'widget', '$root' ]
  46. } );
  47. model.schema.register( 'inline-widget', {
  48. allowWhere: '$text',
  49. isObject: true,
  50. isInline: true
  51. } );
  52. model.schema.extend( '$block', {
  53. allowIn: 'nested'
  54. } );
  55. editor.conversion.for( 'downcast' )
  56. .elementToElement( { model: 'inline', view: 'figure' } )
  57. .elementToElement( { model: 'image', view: 'img' } )
  58. .elementToElement( {
  59. model: 'widget',
  60. view: ( modelItem, viewWriter ) => {
  61. const div = viewWriter.createContainerElement( 'div' );
  62. return toWidget( div, viewWriter, { label: 'element label' } );
  63. }
  64. } )
  65. .elementToElement( {
  66. model: 'inline-widget',
  67. view: ( modelItem, viewWriter ) => {
  68. const span = viewWriter.createContainerElement( 'span' );
  69. return toWidget( span, viewWriter );
  70. }
  71. } )
  72. .elementToElement( {
  73. model: 'nested',
  74. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  75. } )
  76. .elementToElement( {
  77. model: 'editable',
  78. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  79. } );
  80. } );
  81. } );
  82. afterEach( () => {
  83. editorElement.remove();
  84. return editor.destroy();
  85. } );
  86. it( 'should do nothing if clicked inside a nested editable', () => {
  87. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  88. const viewDiv = viewDocument.getRoot().getChild( 1 );
  89. const viewFigcaption = viewDiv.getChild( 0 );
  90. const preventDefault = sinon.spy();
  91. const domEventDataMock = new DomEventData( view, {
  92. target: view.domConverter.mapViewToDom( viewFigcaption ),
  93. preventDefault,
  94. detail: 1
  95. } );
  96. viewDocument.fire( 'mousedown', domEventDataMock );
  97. sinon.assert.notCalled( preventDefault );
  98. expect( getViewData( view ) ).to.equal(
  99. '<p>[]</p>' +
  100. '<div class="ck-widget" contenteditable="false">' +
  101. '<figcaption contenteditable="true">foo bar</figcaption>' +
  102. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  103. '</div>'
  104. );
  105. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  106. } );
  107. it( 'should select the entire nested editable if triple clicked', () => {
  108. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  109. const viewDiv = viewDocument.getRoot().getChild( 0 );
  110. const viewFigcaption = viewDiv.getChild( 0 );
  111. const preventDefault = sinon.spy();
  112. const domEventDataMock = new DomEventData( view, {
  113. target: view.domConverter.mapViewToDom( viewFigcaption ),
  114. preventDefault,
  115. detail: 3
  116. } );
  117. viewDocument.fire( 'mousedown', domEventDataMock );
  118. sinon.assert.called( preventDefault );
  119. expect( getViewData( view ) ).to.equal(
  120. '<div class="ck-widget" contenteditable="false">' +
  121. '<figcaption contenteditable="true">{foo bar}</figcaption>' +
  122. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  123. '</div>'
  124. );
  125. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  126. } );
  127. it( 'should select the entire nested editable if triple clicked on link', () => {
  128. setModelData( model, '[]<widget><nested>foo <$text linkHref="abc">bar</$text></nested></widget>' );
  129. const viewDiv = viewDocument.getRoot().getChild( 0 );
  130. const viewLink = viewDiv.getChild( 0 ).getChild( 1 );
  131. const preventDefault = sinon.spy();
  132. const domEventDataMock = new DomEventData( view, {
  133. target: view.domConverter.mapViewToDom( viewLink ),
  134. preventDefault,
  135. detail: 3
  136. } );
  137. viewDocument.fire( 'mousedown', domEventDataMock );
  138. sinon.assert.called( preventDefault );
  139. expect( getViewData( view ) ).to.equal(
  140. '<div class="ck-widget" contenteditable="false">' +
  141. '<figcaption contenteditable="true">{foo <a href="abc">bar</a>]</figcaption>' +
  142. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  143. '</div>'
  144. );
  145. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo <$text linkHref="abc">bar</$text>]</nested></widget>' );
  146. } );
  147. it( 'should select only clicked paragraph if triple clicked on link', () => {
  148. setModelData( model,
  149. '[]<widget>' +
  150. '<nested>' +
  151. '<paragraph>foo</paragraph>' +
  152. '<paragraph>foo <$text linkHref="abc">bar</$text></paragraph>' +
  153. '<paragraph>bar</paragraph>' +
  154. '</nested>' +
  155. '</widget>'
  156. );
  157. const viewDiv = viewDocument.getRoot().getChild( 0 );
  158. const viewLink = viewDiv.getChild( 0 ).getChild( 1 ).getChild( 1 );
  159. const preventDefault = sinon.spy();
  160. const domEventDataMock = new DomEventData( view, {
  161. target: view.domConverter.mapViewToDom( viewLink ),
  162. preventDefault,
  163. detail: 3
  164. } );
  165. viewDocument.fire( 'mousedown', domEventDataMock );
  166. sinon.assert.called( preventDefault );
  167. expect( getViewData( view ) ).to.equal(
  168. '<div class="ck-widget" contenteditable="false">' +
  169. '<figcaption contenteditable="true">' +
  170. '<p>foo</p>' +
  171. '<p>{foo <a href="abc">bar</a>]</p>' +
  172. '<p>bar</p>' +
  173. '</figcaption>' +
  174. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  175. '</div>'
  176. );
  177. expect( getModelData( model ) ).to.equal(
  178. '<widget>' +
  179. '<nested>' +
  180. '<paragraph>foo</paragraph>' +
  181. '<paragraph>[foo <$text linkHref="abc">bar</$text>]</paragraph>' +
  182. '<paragraph>bar</paragraph>' +
  183. '</nested>' +
  184. '</widget>'
  185. );
  186. } );
  187. it( 'should select proper nested editable if triple clicked', () => {
  188. setModelData( model, '[]<widget><nested>foo</nested><nested>bar</nested></widget>' );
  189. const viewDiv = viewDocument.getRoot().getChild( 0 );
  190. const secondViewFigcaption = viewDiv.getChild( 1 );
  191. const preventDefault = sinon.spy();
  192. const domEventDataMock = new DomEventData( view, {
  193. target: view.domConverter.mapViewToDom( secondViewFigcaption ),
  194. preventDefault,
  195. detail: 3
  196. } );
  197. viewDocument.fire( 'mousedown', domEventDataMock );
  198. sinon.assert.called( preventDefault );
  199. expect( getViewData( view ) ).to.equal(
  200. '<div class="ck-widget" contenteditable="false">' +
  201. '<figcaption contenteditable="true">foo</figcaption>' +
  202. '<figcaption contenteditable="true">{bar}</figcaption>' +
  203. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  204. '</div>'
  205. );
  206. expect( getModelData( model ) ).to.equal( '<widget><nested>foo</nested><nested>[bar]</nested></widget>' );
  207. } );
  208. it( 'should select the entire nested editable if quadra clicked', () => {
  209. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  210. const viewDiv = viewDocument.getRoot().getChild( 0 );
  211. const viewFigcaption = viewDiv.getChild( 0 );
  212. const preventDefault = sinon.spy();
  213. const domEventDataMock = new DomEventData( view, {
  214. target: view.domConverter.mapViewToDom( viewFigcaption ),
  215. preventDefault,
  216. detail: 4
  217. } );
  218. viewDocument.fire( 'mousedown', domEventDataMock );
  219. sinon.assert.called( preventDefault );
  220. expect( getViewData( view ) ).to.equal(
  221. '<div class="ck-widget" contenteditable="false">' +
  222. '<figcaption contenteditable="true">{foo bar}</figcaption>' +
  223. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  224. '</div>'
  225. );
  226. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  227. } );
  228. it( 'should select the inline widget if triple clicked', () => {
  229. setModelData( model, '<paragraph>Foo<inline-widget>foo bar</inline-widget>Bar</paragraph>' );
  230. const viewParagraph = viewDocument.getRoot().getChild( 0 );
  231. const viewInlineWidget = viewParagraph.getChild( 1 );
  232. const preventDefault = sinon.spy();
  233. const domEventDataMock = new DomEventData( view, {
  234. target: view.domConverter.mapViewToDom( viewInlineWidget ),
  235. preventDefault,
  236. detail: 3
  237. } );
  238. viewDocument.fire( 'mousedown', domEventDataMock );
  239. sinon.assert.called( preventDefault );
  240. expect( getViewData( view ) ).to.equal(
  241. '<p>Foo{<span class="ck-widget ck-widget_selected" contenteditable="false">foo bar</span>}Bar</p>'
  242. );
  243. expect( getModelData( model ) ).to.equal( '<paragraph>Foo[<inline-widget>foo bar</inline-widget>]Bar</paragraph>' );
  244. } );
  245. it( 'should do nothing for non-Safari and non-Gecko browser', () => {
  246. testUtils.sinon.stub( env, 'isSafari' ).get( () => false );
  247. testUtils.sinon.stub( env, 'isGecko' ).get( () => false );
  248. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  249. const viewDiv = viewDocument.getRoot().getChild( 1 );
  250. const viewFigcaption = viewDiv.getChild( 0 );
  251. const preventDefault = sinon.spy();
  252. const domEventDataMock = new DomEventData( view, {
  253. target: view.domConverter.mapViewToDom( viewFigcaption ),
  254. preventDefault,
  255. detail: 4
  256. } );
  257. viewDocument.fire( 'mousedown', domEventDataMock );
  258. sinon.assert.notCalled( preventDefault );
  259. expect( getViewData( view ) ).to.equal(
  260. '<p>[]</p>' +
  261. '<div class="ck-widget" contenteditable="false">' +
  262. '<figcaption contenteditable="true">foo bar</figcaption>' +
  263. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  264. '</div>'
  265. );
  266. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  267. } );
  268. } );