widget.js 33 KB

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