widget-integration.js 7.5 KB

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