widget.js 33 KB

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