widget.js 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from 'tests/core/_utils/virtualtesteditor.js';
  6. import Widget from 'ckeditor5/image/widget/widget.js';
  7. import MouseObserver from 'ckeditor5/engine/view/observer/mouseobserver.js';
  8. import buildModelConverter from 'ckeditor5/engine/conversion/buildmodelconverter.js';
  9. import { widgetize } from 'ckeditor5/image/widget/utils.js';
  10. import ViewContainer from 'ckeditor5/engine/view/containerelement.js';
  11. import AttributeContainer from 'ckeditor5/engine/view/attributeelement.js';
  12. import { setData as setModelData, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
  13. import { keyCodes } from 'ckeditor5/utils/keyboard.js';
  14. describe( 'Widget', () => {
  15. let editor, document, viewDocument;
  16. beforeEach( () => {
  17. return VirtualTestEditor.create( {
  18. plugins: [ Widget ]
  19. } )
  20. .then( newEditor => {
  21. editor = newEditor;
  22. document = editor.document;
  23. viewDocument = editor.editing.view;
  24. document.schema.registerItem( 'widget', '$block' );
  25. document.schema.objects.add( 'widget' );
  26. document.schema.registerItem( 'paragraph', '$block' );
  27. buildModelConverter().for( editor.editing.modelToView )
  28. .fromElement( 'paragraph' )
  29. .toElement( 'p' );
  30. buildModelConverter().for( editor.editing.modelToView )
  31. .fromElement( 'widget' )
  32. .toElement( () => {
  33. const b = new AttributeContainer( 'b' );
  34. const div = new ViewContainer( 'div', null, b );
  35. return widgetize( div );
  36. } );
  37. } );
  38. } );
  39. it( 'should be loaded', () => {
  40. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  41. } );
  42. it( 'should add MouseObserver', () => {
  43. expect( editor.editing.view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  44. } );
  45. it( 'should create selection over clicked widget', () => {
  46. setModelData( document, '[]<widget></widget>' );
  47. const viewDiv = viewDocument.getRoot().getChild( 0 );
  48. const domEventDataMock = {
  49. target: viewDiv,
  50. preventDefault: sinon.spy()
  51. };
  52. viewDocument.fire( 'mousedown', domEventDataMock );
  53. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  54. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  55. } );
  56. it( 'should create selection when clicked in nested element', () => {
  57. setModelData( document, '[]<widget></widget>' );
  58. const viewDiv = viewDocument.getRoot().getChild( 0 );
  59. const viewB = viewDiv.getChild( 0 );
  60. const domEventDataMock = {
  61. target: viewB,
  62. preventDefault: sinon.spy()
  63. };
  64. viewDocument.fire( 'mousedown', domEventDataMock );
  65. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  66. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  67. } );
  68. it( 'should do nothing if clicked in non-widget element', () => {
  69. setModelData( document, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  70. const viewP = viewDocument.getRoot().getChild( 0 );
  71. const domEventDataMock = {
  72. target: viewP,
  73. preventDefault: sinon.spy()
  74. };
  75. viewDocument.focus();
  76. viewDocument.fire( 'mousedown', domEventDataMock );
  77. expect( getModelData( document ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  78. sinon.assert.notCalled( domEventDataMock.preventDefault );
  79. } );
  80. it( 'should not focus editable if already is focused', () => {
  81. setModelData( document, '<widget></widget>' );
  82. const widget = viewDocument.getRoot().getChild( 0 );
  83. const domEventDataMock = {
  84. target: widget,
  85. preventDefault: sinon.spy()
  86. };
  87. const focusSpy = sinon.spy( viewDocument, 'focus' );
  88. viewDocument.isFocused = true;
  89. viewDocument.fire( 'mousedown', domEventDataMock );
  90. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  91. sinon.assert.notCalled( focusSpy );
  92. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  93. } );
  94. describe( 'delete and backspace handling', () => {
  95. test(
  96. 'should select widget when backspace is pressed',
  97. '<widget></widget><paragraph>[]foo</paragraph>',
  98. keyCodes.backspace,
  99. '[<widget></widget>]<paragraph>foo</paragraph>'
  100. );
  101. test(
  102. 'should remove empty element after selecting widget when backspace is pressed',
  103. '<widget></widget><paragraph>[]</paragraph>',
  104. keyCodes.backspace,
  105. '[<widget></widget>]'
  106. );
  107. test(
  108. 'should select widget when delete is pressed',
  109. '<paragraph>foo[]</paragraph><widget></widget>',
  110. keyCodes.delete,
  111. '<paragraph>foo</paragraph>[<widget></widget>]'
  112. );
  113. test(
  114. 'should remove empty element after selecting widget when delete is pressed',
  115. '<paragraph>[]</paragraph><widget></widget>',
  116. keyCodes.delete,
  117. '[<widget></widget>]'
  118. );
  119. test(
  120. 'should not respond to other keys',
  121. '<widget></widget><paragraph>[]foo</paragraph>',
  122. 65,
  123. '<widget></widget><paragraph>[]foo</paragraph>'
  124. );
  125. test(
  126. 'should do nothing on non-collapsed selection',
  127. '<widget></widget><paragraph>[f]oo</paragraph>',
  128. keyCodes.backspace,
  129. '<widget></widget><paragraph>[f]oo</paragraph>'
  130. );
  131. test(
  132. 'should od nothing when entering non-object elements',
  133. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  134. keyCodes.backspace,
  135. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  136. );
  137. test(
  138. 'should work correctly with modifier key: backspace + ctrl',
  139. '<widget></widget><paragraph>[]foo</paragraph>',
  140. { keyCode: keyCodes.backspace, ctrlKey: true, preventDefault: () => {} },
  141. '[<widget></widget>]<paragraph>foo</paragraph>'
  142. );
  143. test(
  144. 'should work correctly with modifier key: backspace + alt',
  145. '<widget></widget><paragraph>[]foo</paragraph>',
  146. { keyCode: keyCodes.backspace, altKey: true, preventDefault: () => {} },
  147. '[<widget></widget>]<paragraph>foo</paragraph>'
  148. );
  149. test(
  150. 'should work correctly with modifier key: backspace + shift',
  151. '<widget></widget><paragraph>[]foo</paragraph>',
  152. { keyCode: keyCodes.backspace, shiftKey: true, preventDefault: () => {} },
  153. '[<widget></widget>]<paragraph>foo</paragraph>'
  154. );
  155. test(
  156. 'should work correctly with modifier key: delete + ctrl',
  157. '<paragraph>foo[]</paragraph><widget></widget>',
  158. { keyCode: keyCodes.delete, ctrlKey: true, preventDefault: () => {} },
  159. '<paragraph>foo</paragraph>[<widget></widget>]'
  160. );
  161. test(
  162. 'should work correctly with modifier key: delete + alt',
  163. '<paragraph>foo[]</paragraph><widget></widget>',
  164. { keyCode: keyCodes.delete, altKey: true, preventDefault: () => {} },
  165. '<paragraph>foo</paragraph>[<widget></widget>]'
  166. );
  167. test(
  168. 'should work correctly with modifier key: delete + shift',
  169. '<paragraph>foo[]</paragraph><widget></widget>',
  170. { keyCode: keyCodes.delete, shiftKey: true, preventDefault: () => {} },
  171. '<paragraph>foo</paragraph>[<widget></widget>]'
  172. );
  173. it( 'should prevent default behaviour and stop event propagation', () => {
  174. const keydownHandler = sinon.spy();
  175. const domEventDataMock = {
  176. keyCode: keyCodes.delete,
  177. preventDefault: sinon.spy()
  178. };
  179. setModelData( document, '<paragraph>foo[]</paragraph><widget></widget>' );
  180. viewDocument.on( 'keydown', keydownHandler );
  181. viewDocument.fire( 'keydown', domEventDataMock );
  182. expect( getModelData( document ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  183. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  184. sinon.assert.notCalled( keydownHandler );
  185. } );
  186. function test( name, data, keyCodeOrMock, expected ) {
  187. it( name, () => {
  188. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  189. keyCode: keyCodeOrMock,
  190. preventDefault: () => {}
  191. };
  192. setModelData( document, data );
  193. viewDocument.fire( 'keydown', domEventDataMock );
  194. expect( getModelData( document ) ).to.equal( expected );
  195. } );
  196. }
  197. } );
  198. } );