8
0

widget-integration.js 8.4 KB

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