8
0

widget.js 34 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import Widget from '../src/widget';
  7. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  8. import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
  9. import { toWidget } from '../src/utils';
  10. import ViewContainer from '@ckeditor/ckeditor5-engine/src/view/containerelement';
  11. import ViewEditable from '@ckeditor/ckeditor5-engine/src/view/editableelement';
  12. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  13. import AttributeContainer from '@ckeditor/ckeditor5-engine/src/view/attributeelement';
  14. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  15. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  16. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  17. /* global document */
  18. describe( 'Widget', () => {
  19. let editor, model, doc, viewDocument;
  20. beforeEach( () => {
  21. return VirtualTestEditor.create( { plugins: [ Widget ] } )
  22. .then( newEditor => {
  23. editor = newEditor;
  24. model = editor.model;
  25. doc = model.document;
  26. viewDocument = editor.editing.view;
  27. model.schema.registerItem( 'widget', '$block' );
  28. model.schema.objects.add( 'widget' );
  29. model.schema.registerItem( 'paragraph', '$block' );
  30. model.schema.registerItem( 'inline', '$inline' );
  31. model.schema.objects.add( 'inline' );
  32. model.schema.registerItem( 'nested' );
  33. model.schema.limits.add( 'nested' );
  34. model.schema.allow( { name: '$inline', inside: 'nested' } );
  35. model.schema.allow( { name: 'nested', inside: 'widget' } );
  36. model.schema.registerItem( 'editable' );
  37. model.schema.allow( { name: '$inline', inside: 'editable' } );
  38. model.schema.allow( { name: 'editable', inside: 'widget' } );
  39. model.schema.allow( { name: 'editable', inside: '$root' } );
  40. // Image feature.
  41. model.schema.registerItem( 'image' );
  42. model.schema.allow( { name: 'image', inside: '$root' } );
  43. model.schema.objects.add( 'image' );
  44. // Block-quote feature.
  45. model.schema.registerItem( 'blockQuote' );
  46. model.schema.allow( { name: 'blockQuote', inside: '$root' } );
  47. model.schema.allow( { name: '$block', inside: 'blockQuote' } );
  48. // Div element which helps nesting elements.
  49. model.schema.registerItem( 'div' );
  50. model.schema.allow( { name: 'div', inside: 'blockQuote' } );
  51. model.schema.allow( { name: 'div', inside: 'div' } );
  52. model.schema.allow( { name: 'paragraph', inside: 'div' } );
  53. buildModelConverter().for( editor.editing.modelToView )
  54. .fromElement( 'paragraph' )
  55. .toElement( 'p' );
  56. buildModelConverter().for( editor.editing.modelToView )
  57. .fromElement( 'widget' )
  58. .toElement( () => {
  59. const b = new AttributeContainer( 'b' );
  60. const div = new ViewContainer( 'div', null, b );
  61. return toWidget( div, { label: 'element label' } );
  62. } );
  63. buildModelConverter().for( editor.editing.modelToView )
  64. .fromElement( 'inline' )
  65. .toElement( 'figure' );
  66. buildModelConverter().for( editor.editing.modelToView )
  67. .fromElement( 'nested' )
  68. .toElement( () => new ViewEditable( 'figcaption', { contenteditable: true } ) );
  69. buildModelConverter().for( editor.editing.modelToView )
  70. .fromElement( 'editable' )
  71. .toElement( () => new ViewEditable( 'figcaption', { contenteditable: true } ) );
  72. buildModelConverter().for( editor.editing.modelToView )
  73. .fromElement( 'image' )
  74. .toElement( 'img' );
  75. buildModelConverter().for( editor.editing.modelToView )
  76. .fromElement( 'blockQuote' )
  77. .toElement( 'blockquote' );
  78. buildModelConverter().for( editor.editing.modelToView )
  79. .fromElement( 'div' )
  80. .toElement( 'div' );
  81. } );
  82. } );
  83. it( 'should be loaded', () => {
  84. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  85. } );
  86. it( 'should add MouseObserver', () => {
  87. expect( editor.editing.view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  88. } );
  89. it( 'should create selection over clicked widget', () => {
  90. setModelData( model, '[]<widget></widget>' );
  91. const viewDiv = viewDocument.getRoot().getChild( 0 );
  92. const domEventDataMock = {
  93. target: viewDiv,
  94. preventDefault: sinon.spy()
  95. };
  96. viewDocument.fire( 'mousedown', domEventDataMock );
  97. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  98. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  99. } );
  100. it( 'should create selection when clicked in nested element', () => {
  101. setModelData( model, '[]<widget></widget>' );
  102. const viewDiv = viewDocument.getRoot().getChild( 0 );
  103. const viewB = viewDiv.getChild( 0 );
  104. const domEventDataMock = {
  105. target: viewB,
  106. preventDefault: sinon.spy()
  107. };
  108. viewDocument.fire( 'mousedown', domEventDataMock );
  109. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  110. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  111. } );
  112. it( 'should do nothing if clicked inside nested editable', () => {
  113. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  114. const viewDiv = viewDocument.getRoot().getChild( 0 );
  115. const viewFigcaption = viewDiv.getChild( 0 );
  116. const domEventDataMock = {
  117. target: viewFigcaption,
  118. preventDefault: sinon.spy()
  119. };
  120. viewDocument.fire( 'mousedown', domEventDataMock );
  121. sinon.assert.notCalled( domEventDataMock.preventDefault );
  122. } );
  123. it( 'should do nothing if clicked in non-widget element', () => {
  124. setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  125. const viewP = viewDocument.getRoot().getChild( 0 );
  126. const domEventDataMock = {
  127. target: viewP,
  128. preventDefault: sinon.spy()
  129. };
  130. viewDocument.focus();
  131. viewDocument.fire( 'mousedown', domEventDataMock );
  132. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  133. sinon.assert.notCalled( domEventDataMock.preventDefault );
  134. } );
  135. it( 'should not focus editable if already is focused', () => {
  136. setModelData( model, '<widget></widget>' );
  137. const widget = viewDocument.getRoot().getChild( 0 );
  138. const domEventDataMock = {
  139. target: widget,
  140. preventDefault: sinon.spy()
  141. };
  142. const focusSpy = sinon.spy( viewDocument, 'focus' );
  143. viewDocument.isFocused = true;
  144. viewDocument.fire( 'mousedown', domEventDataMock );
  145. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  146. sinon.assert.notCalled( focusSpy );
  147. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  148. } );
  149. it( 'should apply fake view selection if model selection is on widget element', () => {
  150. setModelData( model, '[<widget>foo bar</widget>]' );
  151. expect( getViewData( viewDocument ) ).to.equal(
  152. '[<div class="ck-widget ck-widget_selected" contenteditable="false">foo bar<b></b></div>]'
  153. );
  154. expect( viewDocument.selection.isFake ).to.be.true;
  155. } );
  156. it( 'should use element\'s label to set fake selection if one is provided', () => {
  157. setModelData( model, '[<widget>foo bar</widget>]' );
  158. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
  159. } );
  160. it( 'should add selected class when no only a widget is selected', () => {
  161. setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
  162. expect( viewDocument.selection.isFake ).to.be.false;
  163. expect( getViewData( viewDocument ) ).to.equal(
  164. '[' +
  165. '<p>foo</p>' +
  166. '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
  167. '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
  168. ']'
  169. );
  170. } );
  171. it( 'fake selection should be empty if widget is not selected', () => {
  172. setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
  173. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
  174. } );
  175. it( 'should toggle selected class', () => {
  176. setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
  177. expect( getViewData( viewDocument ) ).to.equal(
  178. '<p>foo</p>[<div class="ck-widget ck-widget_selected" contenteditable="false">foo<b></b></div>]'
  179. );
  180. model.change( () => {
  181. doc.selection.removeAllRanges();
  182. } );
  183. expect( getViewData( viewDocument ) ).to.equal(
  184. '<p>{}foo</p><div class="ck-widget" contenteditable="false">foo<b></b></div>'
  185. );
  186. } );
  187. it( 'should do nothing when selection is placed in other editable', () => {
  188. setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
  189. expect( getViewData( viewDocument ) ).to.equal(
  190. '<div class="ck-widget" contenteditable="false">' +
  191. '<figcaption contenteditable="true">foo bar</figcaption>' +
  192. '<b></b>' +
  193. '</div>' +
  194. '<figcaption contenteditable="true">{baz}</figcaption>'
  195. );
  196. } );
  197. describe( 'keys handling', () => {
  198. describe( 'delete and backspace', () => {
  199. test(
  200. 'should select widget when backspace is pressed',
  201. '<widget></widget><paragraph>[]foo</paragraph>',
  202. keyCodes.backspace,
  203. '[<widget></widget>]<paragraph>foo</paragraph>'
  204. );
  205. test(
  206. 'should remove empty element after selecting widget when backspace is pressed',
  207. '<widget></widget><paragraph>[]</paragraph>',
  208. keyCodes.backspace,
  209. '[<widget></widget>]'
  210. );
  211. test(
  212. 'should select widget when delete is pressed',
  213. '<paragraph>foo[]</paragraph><widget></widget>',
  214. keyCodes.delete,
  215. '<paragraph>foo</paragraph>[<widget></widget>]'
  216. );
  217. test(
  218. 'should remove empty element after selecting widget when delete is pressed',
  219. '<paragraph>[]</paragraph><widget></widget>',
  220. keyCodes.delete,
  221. '[<widget></widget>]'
  222. );
  223. test(
  224. 'should not respond to other keys',
  225. '<widget></widget><paragraph>[]foo</paragraph>',
  226. 65,
  227. '<widget></widget><paragraph>[]foo</paragraph>'
  228. );
  229. test(
  230. 'should do nothing on non-collapsed selection',
  231. '<widget></widget><paragraph>[f]oo</paragraph>',
  232. keyCodes.backspace,
  233. '<widget></widget><paragraph>[f]oo</paragraph>'
  234. );
  235. test(
  236. 'should do nothing on non-object elements',
  237. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  238. keyCodes.backspace,
  239. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  240. );
  241. test(
  242. 'should work correctly with modifier key: backspace + ctrl',
  243. '<widget></widget><paragraph>[]foo</paragraph>',
  244. { keyCode: keyCodes.backspace, ctrlKey: true },
  245. '[<widget></widget>]<paragraph>foo</paragraph>'
  246. );
  247. test(
  248. 'should work correctly with modifier key: backspace + alt',
  249. '<widget></widget><paragraph>[]foo</paragraph>',
  250. { keyCode: keyCodes.backspace, altKey: true },
  251. '[<widget></widget>]<paragraph>foo</paragraph>'
  252. );
  253. test(
  254. 'should work correctly with modifier key: backspace + shift',
  255. '<widget></widget><paragraph>[]foo</paragraph>',
  256. { keyCode: keyCodes.backspace, shiftKey: true },
  257. '[<widget></widget>]<paragraph>foo</paragraph>'
  258. );
  259. test(
  260. 'should work correctly with modifier key: delete + ctrl',
  261. '<paragraph>foo[]</paragraph><widget></widget>',
  262. { keyCode: keyCodes.delete, ctrlKey: true },
  263. '<paragraph>foo</paragraph>[<widget></widget>]'
  264. );
  265. test(
  266. 'should work correctly with modifier key: delete + alt',
  267. '<paragraph>foo[]</paragraph><widget></widget>',
  268. { keyCode: keyCodes.delete, altKey: true },
  269. '<paragraph>foo</paragraph>[<widget></widget>]'
  270. );
  271. test(
  272. 'should work correctly with modifier key: delete + shift',
  273. '<paragraph>foo[]</paragraph><widget></widget>',
  274. { keyCode: keyCodes.delete, shiftKey: true },
  275. '<paragraph>foo</paragraph>[<widget></widget>]'
  276. );
  277. test(
  278. 'should not modify backspace default behaviour in single paragraph boundaries',
  279. '<paragraph>[]foo</paragraph>',
  280. keyCodes.backspace,
  281. '<paragraph>[]foo</paragraph>'
  282. );
  283. test(
  284. 'should not modify delete default behaviour in single paragraph boundaries',
  285. '<paragraph>foo[]</paragraph>',
  286. keyCodes.delete,
  287. '<paragraph>foo[]</paragraph>'
  288. );
  289. test(
  290. 'should do nothing on selected widget preceded by a paragraph - backspace',
  291. '<paragraph>foo</paragraph>[<widget></widget>]',
  292. keyCodes.backspace,
  293. '<paragraph>foo</paragraph>[<widget></widget>]'
  294. );
  295. test(
  296. 'should do nothing on selected widget preceded by another widget - backspace',
  297. '<widget></widget>[<widget></widget>]',
  298. keyCodes.backspace,
  299. '<widget></widget>[<widget></widget>]'
  300. );
  301. test(
  302. 'should do nothing on selected widget before paragraph - backspace',
  303. '[<widget></widget>]<paragraph>foo</paragraph>',
  304. keyCodes.backspace,
  305. '[<widget></widget>]<paragraph>foo</paragraph>'
  306. );
  307. test(
  308. 'should do nothing on selected widget before another widget - backspace',
  309. '[<widget></widget>]<widget></widget>',
  310. keyCodes.backspace,
  311. '[<widget></widget>]<widget></widget>'
  312. );
  313. test(
  314. 'should do nothing on selected widget between paragraphs - backspace',
  315. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  316. keyCodes.backspace,
  317. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>'
  318. );
  319. test(
  320. 'should do nothing on selected widget between other widgets - backspace',
  321. '<widget></widget>[<widget></widget>]<widget></widget>',
  322. keyCodes.backspace,
  323. '<widget></widget>[<widget></widget>]<widget></widget>'
  324. );
  325. test(
  326. 'should do nothing on selected widget preceded by a paragraph - delete',
  327. '<paragraph>foo</paragraph>[<widget></widget>]',
  328. keyCodes.delete,
  329. '<paragraph>foo</paragraph>[<widget></widget>]'
  330. );
  331. test(
  332. 'should do nothing on selected widget preceded by another widget - delete',
  333. '<widget></widget>[<widget></widget>]',
  334. keyCodes.delete,
  335. '<widget></widget>[<widget></widget>]'
  336. );
  337. test(
  338. 'should do nothing on selected widget before paragraph - delete',
  339. '[<widget></widget>]<paragraph>foo</paragraph>',
  340. keyCodes.delete,
  341. '[<widget></widget>]<paragraph>foo</paragraph>'
  342. );
  343. test(
  344. 'should do nothing on selected widget before another widget - delete',
  345. '[<widget></widget>]<widget></widget>',
  346. keyCodes.delete,
  347. '[<widget></widget>]<widget></widget>'
  348. );
  349. test(
  350. 'should do nothing on selected widget between paragraphs - delete',
  351. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  352. keyCodes.delete,
  353. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>'
  354. );
  355. test(
  356. 'should do nothing on selected widget between other widgets - delete',
  357. '<widget></widget>[<widget></widget>]<widget></widget>',
  358. keyCodes.delete,
  359. '<widget></widget>[<widget></widget>]<widget></widget>'
  360. );
  361. test(
  362. 'should select inline objects - backspace',
  363. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  364. keyCodes.backspace,
  365. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  366. );
  367. test(
  368. 'should select inline objects - delete',
  369. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  370. keyCodes.delete,
  371. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  372. );
  373. test(
  374. 'should do nothing on selected inline objects - backspace',
  375. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  376. keyCodes.backspace,
  377. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  378. );
  379. test(
  380. 'should do nothing on selected inline objects - delete',
  381. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  382. keyCodes.delete,
  383. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  384. );
  385. test(
  386. 'should do nothing if selection is placed after first letter - backspace',
  387. '<paragraph>a[]</paragraph>',
  388. keyCodes.backspace,
  389. '<paragraph>a[]</paragraph>'
  390. );
  391. test(
  392. 'should do nothing if selection is placed before first letter - delete',
  393. '<paragraph>[]a</paragraph>',
  394. keyCodes.delete,
  395. '<paragraph>[]a</paragraph>'
  396. );
  397. it( 'should prevent default behaviour and stop event propagation', () => {
  398. const keydownHandler = sinon.spy();
  399. const domEventDataMock = {
  400. keyCode: keyCodes.delete,
  401. preventDefault: sinon.spy(),
  402. };
  403. setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
  404. viewDocument.on( 'keydown', keydownHandler );
  405. viewDocument.fire( 'keydown', domEventDataMock );
  406. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  407. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  408. sinon.assert.notCalled( keydownHandler );
  409. } );
  410. test(
  411. 'should remove the entire empty element if it is next to a widget',
  412. '<paragraph>foo</paragraph>' +
  413. '<image></image>' +
  414. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  415. '<paragraph>foo</paragraph>',
  416. keyCodes.backspace,
  417. '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
  418. );
  419. test(
  420. 'should remove the entire empty element (deeper structure) if it is next to a widget',
  421. '<paragraph>foo</paragraph>' +
  422. '<image></image>' +
  423. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  424. '<paragraph>foo</paragraph>',
  425. keyCodes.backspace,
  426. '<paragraph>foo</paragraph>' +
  427. '[<image></image>]' +
  428. '<paragraph>foo</paragraph>'
  429. );
  430. test(
  431. 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
  432. '<paragraph>foo</paragraph>' +
  433. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  434. '<image></image>' +
  435. '<paragraph>foo</paragraph>',
  436. keyCodes.delete,
  437. '<paragraph>foo</paragraph>' +
  438. '[<image></image>]' +
  439. '<paragraph>foo</paragraph>'
  440. );
  441. test(
  442. 'should not remove the entire element which is not empty and the element is next to a widget',
  443. '<paragraph>foo</paragraph>' +
  444. '<image></image>' +
  445. '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
  446. '<paragraph>foo</paragraph>',
  447. keyCodes.backspace,
  448. '<paragraph>foo</paragraph>' +
  449. '[<image></image>]' +
  450. '<blockQuote><paragraph></paragraph></blockQuote>' +
  451. '<paragraph>foo</paragraph>'
  452. );
  453. test(
  454. 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
  455. '<paragraph>foo</paragraph>' +
  456. '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
  457. '<image></image>' +
  458. '<paragraph>foo</paragraph>',
  459. keyCodes.delete,
  460. '<paragraph>foo</paragraph>' +
  461. '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
  462. '[<image></image>]' +
  463. '<paragraph>foo</paragraph>'
  464. );
  465. test(
  466. 'should not remove the entire element (deeper structure) which is not empty and the element is next to a widget',
  467. '<paragraph>foo</paragraph>' +
  468. '<image></image>' +
  469. '<blockQuote>' +
  470. '<div>' +
  471. '<div>' +
  472. '<paragraph>[]</paragraph>' +
  473. '</div>' +
  474. '</div>' +
  475. '<paragraph></paragraph>' +
  476. '</blockQuote>' +
  477. '<paragraph>foo</paragraph>',
  478. keyCodes.backspace,
  479. '<paragraph>foo</paragraph>' +
  480. '[<image></image>]' +
  481. '<blockQuote>' +
  482. '<paragraph></paragraph>' +
  483. '</blockQuote>' +
  484. '<paragraph>foo</paragraph>'
  485. );
  486. test(
  487. 'should do nothing if the nested element is not empty and the element is next to a widget',
  488. '<paragraph>foo</paragraph>' +
  489. '<image></image>' +
  490. '<blockQuote>' +
  491. '<div>' +
  492. '<div>' +
  493. '<paragraph>Foo[]</paragraph>' +
  494. '</div>' +
  495. '</div>' +
  496. '</blockQuote>' +
  497. '<paragraph>foo</paragraph>',
  498. keyCodes.backspace,
  499. '<paragraph>foo</paragraph>' +
  500. '<image></image>' +
  501. '<blockQuote>' +
  502. '<div>' +
  503. '<div>' +
  504. '<paragraph>Foo[]</paragraph>' +
  505. '</div>' +
  506. '</div>' +
  507. '</blockQuote>' +
  508. '<paragraph>foo</paragraph>'
  509. );
  510. it( 'does nothing when editor when read only mode is enabled (delete)', () => {
  511. setModelData( model,
  512. '<paragraph>foo</paragraph>' +
  513. '<image></image>' +
  514. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  515. '<paragraph>foo</paragraph>'
  516. );
  517. editor.isReadOnly = true;
  518. viewDocument.fire( 'keydown', new DomEventData(
  519. viewDocument,
  520. { target: document.createElement( 'div' ), preventDefault: () => {} },
  521. { keyCode: keyCodes.backspace }
  522. ) );
  523. expect( getModelData( model ) ).to.equal(
  524. '<paragraph>foo</paragraph>' +
  525. '<image></image>' +
  526. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  527. '<paragraph>foo</paragraph>'
  528. );
  529. } );
  530. it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
  531. setModelData( model,
  532. '<paragraph>foo</paragraph>' +
  533. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  534. '<image></image>' +
  535. '<paragraph>foo</paragraph>'
  536. );
  537. editor.isReadOnly = true;
  538. viewDocument.fire( 'keydown', new DomEventData(
  539. viewDocument,
  540. { target: document.createElement( 'div' ), preventDefault: () => {} },
  541. { keyCode: keyCodes.delete }
  542. ) );
  543. expect( getModelData( model ) ).to.equal(
  544. '<paragraph>foo</paragraph>' +
  545. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  546. '<image></image>' +
  547. '<paragraph>foo</paragraph>'
  548. );
  549. } );
  550. } );
  551. describe( 'arrows', () => {
  552. test(
  553. 'should move selection forward from selected object - right arrow',
  554. '[<widget></widget>]<paragraph>foo</paragraph>',
  555. keyCodes.arrowright,
  556. '<widget></widget><paragraph>[]foo</paragraph>'
  557. );
  558. test(
  559. 'should move selection forward from selected object - down arrow',
  560. '[<widget></widget>]<paragraph>foo</paragraph>',
  561. keyCodes.arrowdown,
  562. '<widget></widget><paragraph>[]foo</paragraph>'
  563. );
  564. test(
  565. 'should move selection backward from selected object - left arrow',
  566. '<paragraph>foo</paragraph>[<widget></widget>]',
  567. keyCodes.arrowleft,
  568. '<paragraph>foo[]</paragraph><widget></widget>'
  569. );
  570. test(
  571. 'should move selection backward from selected object - up arrow',
  572. '<paragraph>foo</paragraph>[<widget></widget>]',
  573. keyCodes.arrowup,
  574. '<paragraph>foo[]</paragraph><widget></widget>'
  575. );
  576. test(
  577. 'should move selection to next widget - right arrow',
  578. '[<widget></widget>]<widget></widget>',
  579. keyCodes.arrowright,
  580. '<widget></widget>[<widget></widget>]'
  581. );
  582. test(
  583. 'should move selection to next widget - down arrow',
  584. '[<widget></widget>]<widget></widget>',
  585. keyCodes.arrowdown,
  586. '<widget></widget>[<widget></widget>]'
  587. );
  588. test(
  589. 'should move selection to previous widget - left arrow',
  590. '<widget></widget>[<widget></widget>]',
  591. keyCodes.arrowleft,
  592. '[<widget></widget>]<widget></widget>'
  593. );
  594. test(
  595. 'should move selection to previous widget - up arrow',
  596. '<widget></widget>[<widget></widget>]',
  597. keyCodes.arrowup,
  598. '[<widget></widget>]<widget></widget>'
  599. );
  600. test(
  601. 'should do nothing on non-collapsed selection next to object - right arrow',
  602. '<paragraph>ba[r]</paragraph><widget></widget>',
  603. keyCodes.arrowright,
  604. '<paragraph>ba[r]</paragraph><widget></widget>'
  605. );
  606. test(
  607. 'should do nothing on non-collapsed selection next to object - down arrow',
  608. '<paragraph>ba[r]</paragraph><widget></widget>',
  609. keyCodes.arrowdown,
  610. '<paragraph>ba[r]</paragraph><widget></widget>'
  611. );
  612. test(
  613. 'should do nothing on non-collapsed selection next to object - left arrow',
  614. '<widget></widget><paragraph>[b]ar</paragraph>',
  615. keyCodes.arrowleft,
  616. '<widget></widget><paragraph>[b]ar</paragraph>'
  617. );
  618. test(
  619. 'should do nothing on non-collapsed selection next to object - up arrow',
  620. '<widget></widget><paragraph>[b]ar</paragraph>',
  621. keyCodes.arrowup,
  622. '<widget></widget><paragraph>[b]ar</paragraph>'
  623. );
  624. test(
  625. 'should not move selection if there is no correct location - right arrow',
  626. '<paragraph>foo</paragraph>[<widget></widget>]',
  627. keyCodes.arrowright,
  628. '<paragraph>foo</paragraph>[<widget></widget>]'
  629. );
  630. test(
  631. 'should not move selection if there is no correct location - down arrow',
  632. '<paragraph>foo</paragraph>[<widget></widget>]',
  633. keyCodes.arrowdown,
  634. '<paragraph>foo</paragraph>[<widget></widget>]'
  635. );
  636. test(
  637. 'should not move selection if there is no correct location - left arrow',
  638. '[<widget></widget>]<paragraph>foo</paragraph>',
  639. keyCodes.arrowleft,
  640. '[<widget></widget>]<paragraph>foo</paragraph>'
  641. );
  642. test(
  643. 'should not move selection if there is no correct location - up arrow',
  644. '[<widget></widget>]<paragraph>foo</paragraph>',
  645. keyCodes.arrowup,
  646. '[<widget></widget>]<paragraph>foo</paragraph>'
  647. );
  648. it( 'should prevent default behaviour when there is no correct location - document end', () => {
  649. const keydownHandler = sinon.spy();
  650. const domEventDataMock = {
  651. keyCode: keyCodes.arrowright,
  652. preventDefault: sinon.spy(),
  653. };
  654. setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
  655. viewDocument.on( 'keydown', keydownHandler );
  656. viewDocument.fire( 'keydown', domEventDataMock );
  657. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  658. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  659. sinon.assert.notCalled( keydownHandler );
  660. } );
  661. it( 'should prevent default behaviour when there is no correct location - document start', () => {
  662. const keydownHandler = sinon.spy();
  663. const domEventDataMock = {
  664. keyCode: keyCodes.arrowleft,
  665. preventDefault: sinon.spy(),
  666. };
  667. setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
  668. viewDocument.on( 'keydown', keydownHandler );
  669. viewDocument.fire( 'keydown', domEventDataMock );
  670. expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
  671. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  672. sinon.assert.notCalled( keydownHandler );
  673. } );
  674. test(
  675. 'should move selection to object element - right arrow',
  676. '<paragraph>foo[]</paragraph><widget></widget>',
  677. keyCodes.arrowright,
  678. '<paragraph>foo</paragraph>[<widget></widget>]'
  679. );
  680. test(
  681. 'should move selection to object element - down arrow',
  682. '<paragraph>foo[]</paragraph><widget></widget>',
  683. keyCodes.arrowdown,
  684. '<paragraph>foo</paragraph>[<widget></widget>]'
  685. );
  686. test(
  687. 'should move selection to object element - left arrow',
  688. '<widget></widget><paragraph>[]foo</paragraph>',
  689. keyCodes.arrowleft,
  690. '[<widget></widget>]<paragraph>foo</paragraph>'
  691. );
  692. test(
  693. 'should move selection to object element - up arrow',
  694. '<widget></widget><paragraph>[]foo</paragraph>',
  695. keyCodes.arrowup,
  696. '[<widget></widget>]<paragraph>foo</paragraph>'
  697. );
  698. test(
  699. 'do nothing on non objects - right arrow',
  700. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  701. keyCodes.arrowright,
  702. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  703. );
  704. test(
  705. 'do nothing on non objects - down arrow',
  706. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  707. keyCodes.arrowdown,
  708. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  709. );
  710. test(
  711. 'do nothing on non objects - left arrow',
  712. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  713. keyCodes.arrowleft,
  714. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  715. );
  716. test(
  717. 'do nothing on non objects - up arrow',
  718. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  719. keyCodes.arrowup,
  720. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  721. );
  722. test(
  723. 'should work correctly with modifier key: right arrow + ctrl',
  724. '[<widget></widget>]<paragraph>foo</paragraph>',
  725. { keyCode: keyCodes.arrowright, ctrlKey: true },
  726. '<widget></widget><paragraph>[]foo</paragraph>'
  727. );
  728. test(
  729. 'should work correctly with modifier key: right arrow + alt',
  730. '[<widget></widget>]<paragraph>foo</paragraph>',
  731. { keyCode: keyCodes.arrowright, altKey: true },
  732. '<widget></widget><paragraph>[]foo</paragraph>'
  733. );
  734. test(
  735. 'should work correctly with modifier key: right arrow + shift',
  736. '[<widget></widget>]<paragraph>foo</paragraph>',
  737. { keyCode: keyCodes.arrowright, shiftKey: true },
  738. '<widget></widget><paragraph>[]foo</paragraph>'
  739. );
  740. test(
  741. 'should work correctly with modifier key: down arrow + ctrl',
  742. '[<widget></widget>]<paragraph>foo</paragraph>',
  743. { keyCode: keyCodes.arrowdown, ctrlKey: true },
  744. '<widget></widget><paragraph>[]foo</paragraph>'
  745. );
  746. test(
  747. 'should work correctly with modifier key: down arrow + alt',
  748. '[<widget></widget>]<paragraph>foo</paragraph>',
  749. { keyCode: keyCodes.arrowdown, altKey: true },
  750. '<widget></widget><paragraph>[]foo</paragraph>'
  751. );
  752. test(
  753. 'should work correctly with modifier key: down arrow + shift',
  754. '[<widget></widget>]<paragraph>foo</paragraph>',
  755. { keyCode: keyCodes.arrowdown, shiftKey: true },
  756. '<widget></widget><paragraph>[]foo</paragraph>'
  757. );
  758. test(
  759. 'should work correctly with modifier key: left arrow + ctrl',
  760. '<paragraph>foo</paragraph>[<widget></widget>]',
  761. { keyCode: keyCodes.arrowleft, ctrlKey: true },
  762. '<paragraph>foo[]</paragraph><widget></widget>'
  763. );
  764. test(
  765. 'should work correctly with modifier key: left arrow + alt',
  766. '<paragraph>foo</paragraph>[<widget></widget>]',
  767. { keyCode: keyCodes.arrowleft, altKey: true },
  768. '<paragraph>foo[]</paragraph><widget></widget>'
  769. );
  770. test(
  771. 'should work correctly with modifier key: left arrow + shift',
  772. '<paragraph>foo</paragraph>[<widget></widget>]',
  773. { keyCode: keyCodes.arrowleft, shiftKey: true },
  774. '<paragraph>foo[]</paragraph><widget></widget>'
  775. );
  776. test(
  777. 'should work correctly with modifier key: up arrow + ctrl',
  778. '<paragraph>foo</paragraph>[<widget></widget>]',
  779. { keyCode: keyCodes.arrowup, ctrlKey: true },
  780. '<paragraph>foo[]</paragraph><widget></widget>'
  781. );
  782. test(
  783. 'should work correctly with modifier key: up arrow + alt',
  784. '<paragraph>foo</paragraph>[<widget></widget>]',
  785. { keyCode: keyCodes.arrowup, altKey: true },
  786. '<paragraph>foo[]</paragraph><widget></widget>'
  787. );
  788. test(
  789. 'should work correctly with modifier key: up arrow + shift',
  790. '<paragraph>foo</paragraph>[<widget></widget>]',
  791. { keyCode: keyCodes.arrowup, shiftKey: true },
  792. '<paragraph>foo[]</paragraph><widget></widget>'
  793. );
  794. test(
  795. 'should do nothing if there is more than one selection in model',
  796. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
  797. keyCodes.arrowright,
  798. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
  799. );
  800. test(
  801. 'should work if selection is in nested element (left arrow)',
  802. '<paragraph>foo</paragraph>' +
  803. '<image></image>' +
  804. '<blockQuote>' +
  805. '<div>' +
  806. '<div>' +
  807. '<paragraph>[]</paragraph>' +
  808. '</div>' +
  809. '</div>' +
  810. '</blockQuote>' +
  811. '<paragraph>foo</paragraph>',
  812. keyCodes.arrowleft,
  813. '<paragraph>foo</paragraph>' +
  814. '[<image></image>]' +
  815. '<blockQuote>' +
  816. '<div>' +
  817. '<div>' +
  818. '<paragraph></paragraph>' +
  819. '</div>' +
  820. '</div>' +
  821. '</blockQuote>' +
  822. '<paragraph>foo</paragraph>'
  823. );
  824. test(
  825. 'should work if selection is in nested element (up arrow)',
  826. '<paragraph>foo</paragraph>' +
  827. '<image></image>' +
  828. '<blockQuote>' +
  829. '<div>' +
  830. '<div>' +
  831. '<paragraph>[]</paragraph>' +
  832. '</div>' +
  833. '</div>' +
  834. '</blockQuote>' +
  835. '<paragraph>foo</paragraph>',
  836. keyCodes.arrowup,
  837. '<paragraph>foo</paragraph>' +
  838. '[<image></image>]' +
  839. '<blockQuote>' +
  840. '<div>' +
  841. '<div>' +
  842. '<paragraph></paragraph>' +
  843. '</div>' +
  844. '</div>' +
  845. '</blockQuote>' +
  846. '<paragraph>foo</paragraph>'
  847. );
  848. test(
  849. 'should work if selection is in nested element (right arrow)',
  850. '<paragraph>foo</paragraph>' +
  851. '<blockQuote>' +
  852. '<div>' +
  853. '<div>' +
  854. '<paragraph>[]</paragraph>' +
  855. '</div>' +
  856. '</div>' +
  857. '</blockQuote>' +
  858. '<image></image>' +
  859. '<paragraph>foo</paragraph>',
  860. keyCodes.arrowright,
  861. '<paragraph>foo</paragraph>' +
  862. '<blockQuote>' +
  863. '<div>' +
  864. '<div>' +
  865. '<paragraph></paragraph>' +
  866. '</div>' +
  867. '</div>' +
  868. '</blockQuote>' +
  869. '[<image></image>]' +
  870. '<paragraph>foo</paragraph>'
  871. );
  872. test(
  873. 'should work if selection is in nested element (down arrow)',
  874. '<paragraph>foo</paragraph>' +
  875. '<blockQuote>' +
  876. '<div>' +
  877. '<div>' +
  878. '<paragraph>[]</paragraph>' +
  879. '</div>' +
  880. '</div>' +
  881. '</blockQuote>' +
  882. '<image></image>' +
  883. '<paragraph>foo</paragraph>',
  884. keyCodes.arrowdown,
  885. '<paragraph>foo</paragraph>' +
  886. '<blockQuote>' +
  887. '<div>' +
  888. '<div>' +
  889. '<paragraph></paragraph>' +
  890. '</div>' +
  891. '</div>' +
  892. '</blockQuote>' +
  893. '[<image></image>]' +
  894. '<paragraph>foo</paragraph>'
  895. );
  896. } );
  897. describe( 'Ctrl+A', () => {
  898. test(
  899. 'should select the entire content of the nested editable',
  900. '<widget><nested>foo[]</nested></widget><paragraph>bar</paragraph>',
  901. { keyCode: keyCodes.a, ctrlKey: true },
  902. '<widget><nested>[foo]</nested></widget><paragraph>bar</paragraph>'
  903. );
  904. test(
  905. 'should not change the selection if outside of the nested editable',
  906. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>',
  907. { keyCode: keyCodes.a, ctrlKey: true },
  908. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>'
  909. );
  910. test(
  911. 'should selected whole content when widget is selected',
  912. '<paragraph>foo</paragraph>[<widget></widget>]<paragraph>bar</paragraph>',
  913. { keyCode: keyCodes.a, ctrlKey: true },
  914. '[<paragraph>foo</paragraph><widget></widget><paragraph>bar</paragraph>]',
  915. '[<p>foo</p><div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div><p>bar</p>]'
  916. );
  917. } );
  918. function test( name, data, keyCodeOrMock, expected, expectedView ) {
  919. it( name, () => {
  920. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  921. keyCode: keyCodeOrMock
  922. };
  923. setModelData( model, data );
  924. viewDocument.fire( 'keydown', new DomEventData(
  925. viewDocument,
  926. { target: document.createElement( 'div' ), preventDefault: () => {} },
  927. domEventDataMock
  928. ) );
  929. expect( getModelData( model ) ).to.equal( expected );
  930. if ( expectedView ) {
  931. expect( getViewData( viewDocument ) ).to.equal( expectedView );
  932. }
  933. } );
  934. }
  935. } );
  936. } );