8
0

widget-integration.js 8.6 KB

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