widget-integration.js 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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. editor.conversion.for( 'downcast' )
  53. .elementToElement( { model: 'inline', view: 'figure' } )
  54. .elementToElement( { model: 'image', view: 'img' } )
  55. .elementToElement( {
  56. model: 'widget',
  57. view: ( modelItem, viewWriter ) => {
  58. const div = viewWriter.createContainerElement( 'div' );
  59. return toWidget( div, viewWriter, { label: 'element label' } );
  60. }
  61. } )
  62. .elementToElement( {
  63. model: 'inline-widget',
  64. view: ( modelItem, viewWriter ) => {
  65. const span = viewWriter.createContainerElement( 'span' );
  66. return toWidget( span, viewWriter );
  67. }
  68. } )
  69. .elementToElement( {
  70. model: 'nested',
  71. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  72. } )
  73. .elementToElement( {
  74. model: 'editable',
  75. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  76. } );
  77. } );
  78. } );
  79. afterEach( () => {
  80. editorElement.remove();
  81. return editor.destroy();
  82. } );
  83. it( 'should do nothing if clicked inside a nested editable', () => {
  84. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  85. const viewDiv = viewDocument.getRoot().getChild( 1 );
  86. const viewFigcaption = viewDiv.getChild( 0 );
  87. const preventDefault = sinon.spy();
  88. const domEventDataMock = new DomEventData( view, {
  89. target: view.domConverter.mapViewToDom( viewFigcaption ),
  90. preventDefault,
  91. detail: 1
  92. } );
  93. viewDocument.fire( 'mousedown', domEventDataMock );
  94. sinon.assert.notCalled( preventDefault );
  95. expect( getViewData( view ) ).to.equal(
  96. '<p>[]</p>' +
  97. '<div class="ck-widget" contenteditable="false">' +
  98. '<figcaption contenteditable="true">foo bar</figcaption>' +
  99. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  100. '</div>'
  101. );
  102. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  103. } );
  104. it( 'should select the entire nested editable if triple clicked', () => {
  105. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  106. const viewDiv = viewDocument.getRoot().getChild( 0 );
  107. const viewFigcaption = viewDiv.getChild( 0 );
  108. const preventDefault = sinon.spy();
  109. const domEventDataMock = new DomEventData( view, {
  110. target: view.domConverter.mapViewToDom( viewFigcaption ),
  111. preventDefault,
  112. detail: 3
  113. } );
  114. viewDocument.fire( 'mousedown', domEventDataMock );
  115. sinon.assert.called( preventDefault );
  116. expect( getViewData( view ) ).to.equal(
  117. '<div class="ck-widget" contenteditable="false">' +
  118. '<figcaption contenteditable="true">{foo bar}</figcaption>' +
  119. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  120. '</div>'
  121. );
  122. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  123. } );
  124. it( 'should select the entire nested editable if triple clicked on link', () => {
  125. setModelData( model, '[]<widget><nested>foo <$text linkHref="abc">bar</$text></nested></widget>' );
  126. const viewDiv = viewDocument.getRoot().getChild( 0 );
  127. const viewLink = viewDiv.getChild( 0 ).getChild( 1 );
  128. const preventDefault = sinon.spy();
  129. const domEventDataMock = new DomEventData( view, {
  130. target: view.domConverter.mapViewToDom( viewLink ),
  131. preventDefault,
  132. detail: 3
  133. } );
  134. viewDocument.fire( 'mousedown', domEventDataMock );
  135. sinon.assert.called( preventDefault );
  136. expect( getViewData( view ) ).to.equal(
  137. '<div class="ck-widget" contenteditable="false">' +
  138. '<figcaption contenteditable="true">{foo <a href="abc">bar</a>]</figcaption>' +
  139. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  140. '</div>'
  141. );
  142. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo <$text linkHref="abc">bar</$text>]</nested></widget>' );
  143. } );
  144. it( 'should select proper nested editable if triple clicked', () => {
  145. setModelData( model, '[]<widget><nested>foo</nested><nested>bar</nested></widget>' );
  146. const viewDiv = viewDocument.getRoot().getChild( 0 );
  147. const secondViewFigcaption = viewDiv.getChild( 1 );
  148. const preventDefault = sinon.spy();
  149. const domEventDataMock = new DomEventData( view, {
  150. target: view.domConverter.mapViewToDom( secondViewFigcaption ),
  151. preventDefault,
  152. detail: 3
  153. } );
  154. viewDocument.fire( 'mousedown', domEventDataMock );
  155. sinon.assert.called( preventDefault );
  156. expect( getViewData( view ) ).to.equal(
  157. '<div class="ck-widget" contenteditable="false">' +
  158. '<figcaption contenteditable="true">foo</figcaption>' +
  159. '<figcaption contenteditable="true">{bar}</figcaption>' +
  160. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  161. '</div>'
  162. );
  163. expect( getModelData( model ) ).to.equal( '<widget><nested>foo</nested><nested>[bar]</nested></widget>' );
  164. } );
  165. it( 'should select the entire nested editable if quadra clicked', () => {
  166. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  167. const viewDiv = viewDocument.getRoot().getChild( 0 );
  168. const viewFigcaption = viewDiv.getChild( 0 );
  169. const preventDefault = sinon.spy();
  170. const domEventDataMock = new DomEventData( view, {
  171. target: view.domConverter.mapViewToDom( viewFigcaption ),
  172. preventDefault,
  173. detail: 4
  174. } );
  175. viewDocument.fire( 'mousedown', domEventDataMock );
  176. sinon.assert.called( preventDefault );
  177. expect( getViewData( view ) ).to.equal(
  178. '<div class="ck-widget" contenteditable="false">' +
  179. '<figcaption contenteditable="true">{foo bar}</figcaption>' +
  180. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  181. '</div>'
  182. );
  183. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  184. } );
  185. it( 'should select the inline widget if triple clicked', () => {
  186. setModelData( model, '<paragraph>Foo<inline-widget>foo bar</inline-widget>Bar</paragraph>' );
  187. const viewParagraph = viewDocument.getRoot().getChild( 0 );
  188. const viewInlineWidget = viewParagraph.getChild( 1 );
  189. const preventDefault = sinon.spy();
  190. const domEventDataMock = new DomEventData( view, {
  191. target: view.domConverter.mapViewToDom( viewInlineWidget ),
  192. preventDefault,
  193. detail: 3
  194. } );
  195. viewDocument.fire( 'mousedown', domEventDataMock );
  196. sinon.assert.called( preventDefault );
  197. expect( getViewData( view ) ).to.equal(
  198. '<p>Foo{<span class="ck-widget ck-widget_selected" contenteditable="false">foo bar</span>}Bar</p>'
  199. );
  200. expect( getModelData( model ) ).to.equal( '<paragraph>Foo[<inline-widget>foo bar</inline-widget>]Bar</paragraph>' );
  201. } );
  202. it( 'should do nothing for non-Safari browser', () => {
  203. testUtils.sinon.stub( env, 'isSafari' ).get( () => false );
  204. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  205. const viewDiv = viewDocument.getRoot().getChild( 1 );
  206. const viewFigcaption = viewDiv.getChild( 0 );
  207. const preventDefault = sinon.spy();
  208. const domEventDataMock = new DomEventData( view, {
  209. target: view.domConverter.mapViewToDom( viewFigcaption ),
  210. preventDefault,
  211. detail: 4
  212. } );
  213. viewDocument.fire( 'mousedown', domEventDataMock );
  214. sinon.assert.notCalled( preventDefault );
  215. expect( getViewData( view ) ).to.equal(
  216. '<p>[]</p>' +
  217. '<div class="ck-widget" contenteditable="false">' +
  218. '<figcaption contenteditable="true">foo bar</figcaption>' +
  219. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  220. '</div>'
  221. );
  222. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  223. } );
  224. } );