8
0

widget.js 36 KB

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