widget.js 33 KB

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