widget.js 36 KB

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