widget-integration.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  6. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  7. import Widget from '../src/widget';
  8. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  9. import { toWidget } from '../src/utils';
  10. import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  11. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  12. import env from '@ckeditor/ckeditor5-utils/src/env';
  13. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  14. /* global document */
  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. } );
  84. it( 'should do nothing if clicked inside nested editable', () => {
  85. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  86. const viewDiv = viewDocument.getRoot().getChild( 0 );
  87. const viewFigcaption = viewDiv.getChild( 0 );
  88. const preventDefault = sinon.spy();
  89. const domEventDataMock = new DomEventData( view, {
  90. target: view.domConverter.mapViewToDom( viewFigcaption ),
  91. preventDefault,
  92. detail: 1
  93. } );
  94. viewDocument.fire( 'mousedown', domEventDataMock );
  95. sinon.assert.notCalled( preventDefault );
  96. expect( getViewData( view ) ).to.equal(
  97. '[]<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></div>'
  98. );
  99. } );
  100. it( 'should select the entire nested editable if triple clicked', () => {
  101. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  102. const viewDiv = viewDocument.getRoot().getChild( 0 );
  103. const viewFigcaption = viewDiv.getChild( 0 );
  104. const preventDefault = sinon.spy();
  105. const domEventDataMock = new DomEventData( view, {
  106. target: view.domConverter.mapViewToDom( viewFigcaption ),
  107. preventDefault,
  108. detail: 3
  109. } );
  110. viewDocument.fire( 'mousedown', domEventDataMock );
  111. sinon.assert.called( preventDefault );
  112. expect( getViewData( view ) ).to.equal(
  113. '<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">[foo bar]</figcaption></div>'
  114. );
  115. } );
  116. it( 'should select proper nested editable if triple clicked', () => {
  117. setModelData( model, '[]<widget><nested>foo</nested><nested>bar</nested></widget>' );
  118. const viewDiv = viewDocument.getRoot().getChild( 0 );
  119. const secondViewFigcaption = viewDiv.getChild( 1 );
  120. const preventDefault = sinon.spy();
  121. const domEventDataMock = new DomEventData( view, {
  122. target: view.domConverter.mapViewToDom( secondViewFigcaption ),
  123. preventDefault,
  124. detail: 3
  125. } );
  126. viewDocument.fire( 'mousedown', domEventDataMock );
  127. sinon.assert.called( preventDefault );
  128. expect( getViewData( view ) ).to.equal(
  129. '<div class="ck-widget" contenteditable="false">' +
  130. '<figcaption contenteditable="true">foo</figcaption>' +
  131. '<figcaption contenteditable="true">[bar]</figcaption>' +
  132. '</div>'
  133. );
  134. } );
  135. it( 'should select the entire nested editable if quadra clicked', () => {
  136. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  137. const viewDiv = viewDocument.getRoot().getChild( 0 );
  138. const viewFigcaption = viewDiv.getChild( 0 );
  139. const preventDefault = sinon.spy();
  140. const domEventDataMock = new DomEventData( view, {
  141. target: view.domConverter.mapViewToDom( viewFigcaption ),
  142. preventDefault,
  143. detail: 4
  144. } );
  145. viewDocument.fire( 'mousedown', domEventDataMock );
  146. sinon.assert.called( preventDefault );
  147. expect( getViewData( view ) ).to.equal(
  148. '<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">[foo bar]</figcaption></div>'
  149. );
  150. } );
  151. it( 'should select the inline widget if triple clicked', () => {
  152. setModelData( model, '<paragraph>Foo<inline-widget>foo bar</inline-widget>Bar</paragraph>' );
  153. const viewParagraph = viewDocument.getRoot().getChild( 0 );
  154. const viewInlineWidget = viewParagraph.getChild( 1 );
  155. const preventDefault = sinon.spy();
  156. const domEventDataMock = new DomEventData( view, {
  157. target: view.domConverter.mapViewToDom( viewInlineWidget ),
  158. preventDefault,
  159. detail: 3
  160. } );
  161. viewDocument.fire( 'mousedown', domEventDataMock );
  162. sinon.assert.called( preventDefault );
  163. expect( getViewData( view ) ).to.equal(
  164. '<p>Foo{<span class="ck-widget ck-widget_selected" contenteditable="false">foo bar</span>}Bar</p>'
  165. );
  166. } );
  167. it( 'should does nothing for non-Safari browser', () => {
  168. testUtils.sinon.stub( env, 'isSafari' ).get( () => false );
  169. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  170. const viewDiv = viewDocument.getRoot().getChild( 0 );
  171. const viewFigcaption = viewDiv.getChild( 0 );
  172. const preventDefault = sinon.spy();
  173. const domEventDataMock = new DomEventData( view, {
  174. target: view.domConverter.mapViewToDom( viewFigcaption ),
  175. preventDefault,
  176. detail: 4
  177. } );
  178. viewDocument.fire( 'mousedown', domEventDataMock );
  179. sinon.assert.notCalled( preventDefault );
  180. expect( getViewData( view ) ).to.equal(
  181. '[]<div class="ck-widget" contenteditable="false"><figcaption contenteditable="true">foo bar</figcaption></div>'
  182. );
  183. } );
  184. } );