widget-integration.js 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  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( 'paragraph', {
  36. inheritAllFrom: '$block',
  37. allowIn: '$root'
  38. } );
  39. model.schema.register( 'nested', {
  40. allowIn: 'widget',
  41. isLimit: true
  42. } );
  43. model.schema.extend( '$text', {
  44. allowIn: [ 'nested', 'editable', 'inline-widget' ]
  45. } );
  46. model.schema.register( 'editable', {
  47. allowIn: [ 'widget', '$root' ]
  48. } );
  49. model.schema.register( 'inline-widget', {
  50. allowWhere: '$text',
  51. isObject: true,
  52. isInline: true
  53. } );
  54. editor.conversion.for( 'downcast' )
  55. .elementToElement( { model: 'paragraph', view: 'p' } )
  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><div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></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"><figcaption contenteditable="true">{foo bar}</figcaption></div>'
  117. );
  118. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  119. } );
  120. it( 'should select proper nested editable if triple clicked', () => {
  121. setModelData( model, '[]<widget><nested>foo</nested><nested>bar</nested></widget>' );
  122. const viewDiv = viewDocument.getRoot().getChild( 0 );
  123. const secondViewFigcaption = viewDiv.getChild( 1 );
  124. const preventDefault = sinon.spy();
  125. const domEventDataMock = new DomEventData( view, {
  126. target: view.domConverter.mapViewToDom( secondViewFigcaption ),
  127. preventDefault,
  128. detail: 3
  129. } );
  130. viewDocument.fire( 'mousedown', domEventDataMock );
  131. sinon.assert.called( preventDefault );
  132. expect( getViewData( view ) ).to.equal(
  133. '<div class="ck-widget" contenteditable="false">' +
  134. '<figcaption contenteditable="true">foo</figcaption>' +
  135. '<figcaption contenteditable="true">{bar}</figcaption>' +
  136. '</div>'
  137. );
  138. expect( getModelData( model ) ).to.equal( '<widget><nested>foo</nested><nested>[bar]</nested></widget>' );
  139. } );
  140. it( 'should select the entire nested editable if quadra clicked', () => {
  141. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  142. const viewDiv = viewDocument.getRoot().getChild( 0 );
  143. const viewFigcaption = viewDiv.getChild( 0 );
  144. const preventDefault = sinon.spy();
  145. const domEventDataMock = new DomEventData( view, {
  146. target: view.domConverter.mapViewToDom( viewFigcaption ),
  147. preventDefault,
  148. detail: 4
  149. } );
  150. viewDocument.fire( 'mousedown', domEventDataMock );
  151. sinon.assert.called( preventDefault );
  152. expect( getViewData( view ) ).to.equal(
  153. '<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">{foo bar}</figcaption></div>'
  154. );
  155. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  156. } );
  157. it( 'should select the inline widget if triple clicked', () => {
  158. setModelData( model, '<paragraph>Foo<inline-widget>foo bar</inline-widget>Bar</paragraph>' );
  159. const viewParagraph = viewDocument.getRoot().getChild( 0 );
  160. const viewInlineWidget = viewParagraph.getChild( 1 );
  161. const preventDefault = sinon.spy();
  162. const domEventDataMock = new DomEventData( view, {
  163. target: view.domConverter.mapViewToDom( viewInlineWidget ),
  164. preventDefault,
  165. detail: 3
  166. } );
  167. viewDocument.fire( 'mousedown', domEventDataMock );
  168. sinon.assert.called( preventDefault );
  169. expect( getViewData( view ) ).to.equal(
  170. '<p>Foo{<span class="ck-widget ck-widget_selected" contenteditable="false">foo bar</span>}Bar</p>'
  171. );
  172. expect( getModelData( model ) ).to.equal( '<paragraph>Foo[<inline-widget>foo bar</inline-widget>]Bar</paragraph>' );
  173. } );
  174. it( 'should does nothing for non-Safari browser', () => {
  175. testUtils.sinon.stub( env, 'isSafari' ).get( () => false );
  176. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  177. const viewDiv = viewDocument.getRoot().getChild( 1 );
  178. const viewFigcaption = viewDiv.getChild( 0 );
  179. const preventDefault = sinon.spy();
  180. const domEventDataMock = new DomEventData( view, {
  181. target: view.domConverter.mapViewToDom( viewFigcaption ),
  182. preventDefault,
  183. detail: 4
  184. } );
  185. viewDocument.fire( 'mousedown', domEventDataMock );
  186. sinon.assert.notCalled( preventDefault );
  187. expect( getViewData( view ) ).to.equal(
  188. '<p>[]</p><div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></div>'
  189. );
  190. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  191. } );
  192. } );