widget-integration.js 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  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. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  23. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  24. testUtils.sinon.stub( env, 'isSafari' ).get( () => true );
  25. editorElement = document.createElement( 'div' );
  26. document.body.appendChild( editorElement );
  27. return ClassicEditor.create( editorElement, { plugins: [ Widget, Typing ] } )
  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( 'paragraph', {
  38. inheritAllFrom: '$block',
  39. allowIn: '$root'
  40. } );
  41. model.schema.register( 'nested', {
  42. allowIn: 'widget',
  43. isLimit: true
  44. } );
  45. model.schema.extend( '$text', {
  46. allowIn: [ 'nested', 'editable', 'inline-widget' ]
  47. } );
  48. model.schema.register( 'editable', {
  49. allowIn: [ 'widget', '$root' ]
  50. } );
  51. model.schema.register( 'inline-widget', {
  52. allowWhere: '$text',
  53. isObject: true,
  54. isInline: true
  55. } );
  56. editor.conversion.for( 'downcast' )
  57. .elementToElement( { model: 'paragraph', view: 'p' } )
  58. .elementToElement( { model: 'inline', view: 'figure' } )
  59. .elementToElement( { model: 'image', view: 'img' } )
  60. .elementToElement( {
  61. model: 'widget',
  62. view: ( modelItem, viewWriter ) => {
  63. const div = viewWriter.createContainerElement( 'div' );
  64. return toWidget( div, viewWriter, { label: 'element label' } );
  65. }
  66. } )
  67. .elementToElement( {
  68. model: 'inline-widget',
  69. view: ( modelItem, viewWriter ) => {
  70. const span = viewWriter.createContainerElement( 'span' );
  71. return toWidget( span, viewWriter );
  72. }
  73. } )
  74. .elementToElement( {
  75. model: 'nested',
  76. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  77. } )
  78. .elementToElement( {
  79. model: 'editable',
  80. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  81. } );
  82. } );
  83. } );
  84. afterEach( () => {
  85. editorElement.remove();
  86. return editor.destroy();
  87. } );
  88. it( 'should do nothing if clicked inside a nested editable', () => {
  89. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  90. const viewDiv = viewDocument.getRoot().getChild( 1 );
  91. const viewFigcaption = viewDiv.getChild( 0 );
  92. const preventDefault = sinon.spy();
  93. const domEventDataMock = new DomEventData( view, {
  94. target: view.domConverter.mapViewToDom( viewFigcaption ),
  95. preventDefault,
  96. detail: 1
  97. } );
  98. viewDocument.fire( 'mousedown', domEventDataMock );
  99. sinon.assert.notCalled( preventDefault );
  100. expect( getViewData( view ) ).to.equal(
  101. '<p>[]</p><div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></div>'
  102. );
  103. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  104. } );
  105. it( 'should select the entire nested editable if triple clicked', () => {
  106. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  107. const viewDiv = viewDocument.getRoot().getChild( 0 );
  108. const viewFigcaption = viewDiv.getChild( 0 );
  109. const preventDefault = sinon.spy();
  110. const domEventDataMock = new DomEventData( view, {
  111. target: view.domConverter.mapViewToDom( viewFigcaption ),
  112. preventDefault,
  113. detail: 3
  114. } );
  115. viewDocument.fire( 'mousedown', domEventDataMock );
  116. sinon.assert.called( preventDefault );
  117. expect( getViewData( view ) ).to.equal(
  118. '<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">{foo bar}</figcaption></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" contenteditable="false">' +
  136. '<figcaption contenteditable="true">foo</figcaption>' +
  137. '<figcaption contenteditable="true">{bar}</figcaption>' +
  138. '</div>'
  139. );
  140. expect( getModelData( model ) ).to.equal( '<widget><nested>foo</nested><nested>[bar]</nested></widget>' );
  141. } );
  142. it( 'should select the entire nested editable if quadra clicked', () => {
  143. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  144. const viewDiv = viewDocument.getRoot().getChild( 0 );
  145. const viewFigcaption = viewDiv.getChild( 0 );
  146. const preventDefault = sinon.spy();
  147. const domEventDataMock = new DomEventData( view, {
  148. target: view.domConverter.mapViewToDom( viewFigcaption ),
  149. preventDefault,
  150. detail: 4
  151. } );
  152. viewDocument.fire( 'mousedown', domEventDataMock );
  153. sinon.assert.called( preventDefault );
  154. expect( getViewData( view ) ).to.equal(
  155. '<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">{foo bar}</figcaption></div>'
  156. );
  157. expect( getModelData( model ) ).to.equal( '<widget><nested>[foo bar]</nested></widget>' );
  158. } );
  159. it( 'should select the inline widget if triple clicked', () => {
  160. setModelData( model, '<paragraph>Foo<inline-widget>foo bar</inline-widget>Bar</paragraph>' );
  161. const viewParagraph = viewDocument.getRoot().getChild( 0 );
  162. const viewInlineWidget = viewParagraph.getChild( 1 );
  163. const preventDefault = sinon.spy();
  164. const domEventDataMock = new DomEventData( view, {
  165. target: view.domConverter.mapViewToDom( viewInlineWidget ),
  166. preventDefault,
  167. detail: 3
  168. } );
  169. viewDocument.fire( 'mousedown', domEventDataMock );
  170. sinon.assert.called( preventDefault );
  171. expect( getViewData( view ) ).to.equal(
  172. '<p>Foo{<span class="ck-widget ck-widget_selected" contenteditable="false">foo bar</span>}Bar</p>'
  173. );
  174. expect( getModelData( model ) ).to.equal( '<paragraph>Foo[<inline-widget>foo bar</inline-widget>]Bar</paragraph>' );
  175. } );
  176. it( 'should does nothing for non-Safari browser', () => {
  177. testUtils.sinon.stub( env, 'isSafari' ).get( () => false );
  178. setModelData( model, '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  179. const viewDiv = viewDocument.getRoot().getChild( 1 );
  180. const viewFigcaption = viewDiv.getChild( 0 );
  181. const preventDefault = sinon.spy();
  182. const domEventDataMock = new DomEventData( view, {
  183. target: view.domConverter.mapViewToDom( viewFigcaption ),
  184. preventDefault,
  185. detail: 4
  186. } );
  187. viewDocument.fire( 'mousedown', domEventDataMock );
  188. sinon.assert.notCalled( preventDefault );
  189. expect( getViewData( view ) ).to.equal(
  190. '<p>[]</p><div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></div>'
  191. );
  192. expect( getModelData( model ) ).to.equal( '<paragraph>[]</paragraph><widget><nested>foo bar</nested></widget>' );
  193. } );
  194. } );