widget.js 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global document */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import Enter from '@ckeditor/ckeditor5-enter/src/enter';
  8. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  9. import Widget from '../src/widget';
  10. import WidgetTypeAround from '../src/widgettypearound/widgettypearound';
  11. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  12. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  13. import { toWidget } from '../src/utils';
  14. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  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. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  19. describe( 'Widget', () => {
  20. let element, editor, model, view, viewDocument;
  21. testUtils.createSinonSandbox();
  22. beforeEach( () => {
  23. element = document.createElement( 'div' );
  24. document.body.appendChild( element );
  25. return ClassicTestEditor
  26. .create( element, {
  27. plugins: [ Paragraph, Widget, Typing, Enter ]
  28. } )
  29. .then( newEditor => {
  30. editor = newEditor;
  31. model = editor.model;
  32. view = editor.editing.view;
  33. viewDocument = view.document;
  34. model.schema.register( 'widget', {
  35. inheritAllFrom: '$block',
  36. isObject: true
  37. } );
  38. model.schema.extend( 'paragraph', {
  39. allowIn: 'div'
  40. } );
  41. model.schema.register( 'inline', {
  42. allowWhere: '$text',
  43. isObject: true
  44. } );
  45. model.schema.register( 'nested', {
  46. allowIn: 'widget',
  47. isLimit: true
  48. } );
  49. model.schema.extend( '$text', {
  50. allowIn: [ 'nested', 'editable' ]
  51. } );
  52. model.schema.register( 'editable', {
  53. allowIn: [ 'widget', '$root' ]
  54. } );
  55. model.schema.register( 'inline-widget', {
  56. allowWhere: '$text',
  57. isObject: true,
  58. isInline: true
  59. } );
  60. // Image feature.
  61. model.schema.register( 'image', {
  62. allowIn: '$root',
  63. isObject: true,
  64. isBlock: true
  65. } );
  66. // Block-quote feature.
  67. model.schema.register( 'blockQuote', {
  68. allowIn: '$root'
  69. } );
  70. model.schema.extend( '$block', { allowIn: 'blockQuote' } );
  71. // Div element which helps nesting elements.
  72. model.schema.register( 'div', {
  73. allowIn: [ 'blockQuote', 'div' ]
  74. } );
  75. editor.conversion.for( 'downcast' )
  76. .elementToElement( { model: 'inline', view: 'figure' } )
  77. .elementToElement( { model: 'image', view: 'img' } )
  78. .elementToElement( { model: 'blockQuote', view: 'blockquote' } )
  79. .elementToElement( { model: 'div', view: 'div' } )
  80. .elementToElement( {
  81. model: 'widget',
  82. view: ( modelItem, viewWriter ) => {
  83. const b = viewWriter.createAttributeElement( 'b' );
  84. const div = viewWriter.createContainerElement( 'div' );
  85. viewWriter.insert( viewWriter.createPositionAt( div, 0 ), b );
  86. return toWidget( div, viewWriter, { label: 'element label' } );
  87. }
  88. } )
  89. .elementToElement( {
  90. model: 'inline-widget',
  91. view: ( modelItem, viewWriter ) => {
  92. const span = viewWriter.createContainerElement( 'span' );
  93. return toWidget( span, viewWriter );
  94. }
  95. } )
  96. .elementToElement( {
  97. model: 'nested',
  98. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  99. } )
  100. .elementToElement( {
  101. model: 'editable',
  102. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  103. } );
  104. } );
  105. } );
  106. afterEach( () => {
  107. element.remove();
  108. return editor.destroy();
  109. } );
  110. it( 'should be loaded', () => {
  111. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  112. } );
  113. it( 'should add MouseObserver', () => {
  114. expect( view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  115. } );
  116. it( 'should require the WidgetTypeAround plugin', () => {
  117. expect( Widget.requires ).to.have.members( [ WidgetTypeAround ] );
  118. } );
  119. it( 'should create selection over clicked widget', () => {
  120. setModelData( model, '[]<widget></widget>' );
  121. const viewDiv = viewDocument.getRoot().getChild( 0 );
  122. const domEventDataMock = new DomEventData( view, {
  123. target: view.domConverter.mapViewToDom( viewDiv ),
  124. preventDefault: sinon.spy()
  125. } );
  126. viewDocument.fire( 'mousedown', domEventDataMock );
  127. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  128. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  129. } );
  130. it( 'should create selection when clicked in nested element', () => {
  131. setModelData( model, '[]<widget></widget>' );
  132. const viewDiv = viewDocument.getRoot().getChild( 0 );
  133. const viewB = viewDiv.getChild( 0 );
  134. const domEventDataMock = new DomEventData( view, {
  135. target: view.domConverter.mapViewToDom( viewB ),
  136. preventDefault: sinon.spy()
  137. } );
  138. viewDocument.fire( 'mousedown', domEventDataMock );
  139. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  140. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  141. } );
  142. it( 'should do nothing if clicked in non-widget element', () => {
  143. setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  144. const viewP = viewDocument.getRoot().getChild( 0 );
  145. const domEventDataMock = new DomEventData( view, {
  146. target: view.domConverter.mapViewToDom( viewP ),
  147. preventDefault: sinon.spy()
  148. } );
  149. view.focus();
  150. viewDocument.fire( 'mousedown', domEventDataMock );
  151. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  152. sinon.assert.notCalled( domEventDataMock.domEvent.preventDefault );
  153. } );
  154. it( 'should not focus editable if already is focused', () => {
  155. setModelData( model, '<widget></widget>' );
  156. const widget = viewDocument.getRoot().getChild( 0 );
  157. const domEventDataMock = new DomEventData( view, {
  158. target: view.domConverter.mapViewToDom( widget ),
  159. preventDefault: sinon.spy()
  160. } );
  161. const focusSpy = sinon.spy( view, 'focus' );
  162. viewDocument.isFocused = true;
  163. viewDocument.fire( 'mousedown', domEventDataMock );
  164. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  165. sinon.assert.notCalled( focusSpy );
  166. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  167. } );
  168. it( 'should apply fake view selection if model selection is on widget element', () => {
  169. setModelData( model, '[<widget>foo bar</widget>]' );
  170. expect( getViewData( view ) ).to.equal(
  171. '[<div class="ck-widget ck-widget_selected" ' +
  172. 'contenteditable="false">' +
  173. 'foo bar' +
  174. '<b></b>' +
  175. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  176. '</div>]'
  177. );
  178. expect( viewDocument.selection.isFake ).to.be.true;
  179. } );
  180. it( 'should use element\'s label to set fake selection if one is provided', () => {
  181. setModelData( model, '[<widget>foo bar</widget>]' );
  182. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
  183. } );
  184. it( 'should add selected class when other content is selected with widget', () => {
  185. setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
  186. expect( viewDocument.selection.isFake ).to.be.false;
  187. expect( getViewData( view ) ).to.equal(
  188. '<p>{foo</p>' +
  189. '<div class="ck-widget ck-widget_selected" contenteditable="false">' +
  190. '<b></b>' +
  191. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  192. '</div>' +
  193. '<div class="ck-widget ck-widget_selected" ' +
  194. 'contenteditable="false">' +
  195. '<b></b>' +
  196. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  197. '</div>]'
  198. );
  199. } );
  200. it( 'fake selection should be empty if widget is not selected', () => {
  201. setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
  202. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
  203. } );
  204. it( 'should toggle selected class', () => {
  205. setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
  206. expect( getViewData( view ) ).to.equal(
  207. '<p>foo</p>' +
  208. '[<div class="ck-widget ck-widget_selected" contenteditable="false">' +
  209. 'foo' +
  210. '<b></b>' +
  211. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  212. '</div>]'
  213. );
  214. model.change( writer => {
  215. writer.setSelection( null );
  216. } );
  217. expect( getViewData( view ) ).to.equal(
  218. '<p>{}foo</p>' +
  219. '<div class="ck-widget" contenteditable="false">' +
  220. 'foo' +
  221. '<b></b>' +
  222. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  223. '</div>'
  224. );
  225. } );
  226. it( 'should do nothing when selection is placed in other editable', () => {
  227. setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
  228. expect( getViewData( view ) ).to.equal(
  229. '<div class="ck-widget" contenteditable="false">' +
  230. '<figcaption contenteditable="true">foo bar</figcaption>' +
  231. '<b></b>' +
  232. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  233. '</div>' +
  234. '<figcaption contenteditable="true">{baz}</figcaption>'
  235. );
  236. } );
  237. describe( 'keys handling', () => {
  238. describe( 'arrows', () => {
  239. test(
  240. 'should move selection forward from selected object - right arrow',
  241. '[<widget></widget>]<paragraph>foo</paragraph>',
  242. // Note: The first step is handled by the WidgetTypeAround plugin.
  243. [ keyCodes.arrowright, keyCodes.arrowright ],
  244. '<widget></widget><paragraph>[]foo</paragraph>'
  245. );
  246. test(
  247. 'should move selection forward from selected object - down arrow',
  248. '[<widget></widget>]<paragraph>foo</paragraph>',
  249. // Note: The first step is handled by the WidgetTypeAround plugin.
  250. [ keyCodes.arrowdown, keyCodes.arrowdown ],
  251. '<widget></widget><paragraph>[]foo</paragraph>'
  252. );
  253. test(
  254. 'should move selection backward from selected object - left arrow',
  255. '<paragraph>foo</paragraph>[<widget></widget>]',
  256. // Note: The first step is handled by the WidgetTypeAround plugin.
  257. [ keyCodes.arrowleft, keyCodes.arrowleft ],
  258. '<paragraph>foo[]</paragraph><widget></widget>'
  259. );
  260. test(
  261. 'should move selection backward from selected object - up arrow',
  262. '<paragraph>foo</paragraph>[<widget></widget>]',
  263. // Note: The first step is handled by the WidgetTypeAround plugin.
  264. [ keyCodes.arrowup, keyCodes.arrowup ],
  265. '<paragraph>foo[]</paragraph><widget></widget>'
  266. );
  267. test(
  268. 'should move selection to next widget - right arrow',
  269. '[<widget></widget>]<widget></widget>',
  270. // Note: The first step is handled by the WidgetTypeAround plugin.
  271. [ keyCodes.arrowright, keyCodes.arrowright ],
  272. '<widget></widget>[<widget></widget>]'
  273. );
  274. test(
  275. 'should move selection to next widget - down arrow',
  276. '[<widget></widget>]<widget></widget>',
  277. // Note: The first step is handled by the WidgetTypeAround plugin.
  278. [ keyCodes.arrowdown, keyCodes.arrowdown ],
  279. '<widget></widget>[<widget></widget>]'
  280. );
  281. test(
  282. 'should move selection to previous widget - left arrow',
  283. '<widget></widget>[<widget></widget>]',
  284. // Note: The first step is handled by the WidgetTypeAround plugin.
  285. [ keyCodes.arrowleft, keyCodes.arrowleft ],
  286. '[<widget></widget>]<widget></widget>'
  287. );
  288. test(
  289. 'should move selection to previous widget - up arrow',
  290. '<widget></widget>[<widget></widget>]',
  291. // Note: The first step is handled by the WidgetTypeAround plugin.
  292. [ keyCodes.arrowup, keyCodes.arrowup ],
  293. '[<widget></widget>]<widget></widget>'
  294. );
  295. // Note: Testing an inline widget only because block widgets are handled and tested by the WidgetTypeAround plugin.
  296. test(
  297. 'should do nothing on non-collapsed selection next to an inline widget - right arrow',
  298. '<paragraph>ba[r]<inline-widget></inline-widget></paragraph>',
  299. keyCodes.arrowright,
  300. '<paragraph>ba[r]<inline-widget></inline-widget></paragraph>'
  301. );
  302. // Note: Testing an inline widget only because block widgets are handled and tested by the WidgetTypeAround plugin.
  303. test(
  304. 'should do nothing on non-collapsed selection next to an inline widget - down arrow',
  305. '<paragraph>ba[r]<inline-widget></inline-widget></paragraph>',
  306. keyCodes.arrowdown,
  307. '<paragraph>ba[r]<inline-widget></inline-widget></paragraph>'
  308. );
  309. // Note: Testing an inline widget only because block widgets are handled and tested by the WidgetTypeAround plugin.
  310. test(
  311. 'should do nothing on non-collapsed selection next to an inline widget - left arrow',
  312. '<paragraph><inline-widget></inline-widget>[b]ar</paragraph>',
  313. keyCodes.arrowleft,
  314. '<paragraph><inline-widget></inline-widget>[b]ar</paragraph>'
  315. );
  316. // Note: Testing an inline widget only because block widgets are handled and tested by the WidgetTypeAround plugin.
  317. test(
  318. 'should do nothing on non-collapsed selection next to an inline widget - up arrow',
  319. '<paragraph><inline-widget></inline-widget>[b]ar</paragraph>',
  320. keyCodes.arrowup,
  321. '<paragraph><inline-widget></inline-widget>[b]ar</paragraph>'
  322. );
  323. test(
  324. 'should not move selection if there is no correct location - right arrow',
  325. '<paragraph>foo</paragraph>[<widget></widget>]',
  326. // Note: The first step is handled by the WidgetTypeAround plugin.
  327. [ keyCodes.arrowright, keyCodes.arrowright ],
  328. '<paragraph>foo</paragraph>[<widget></widget>]'
  329. );
  330. test(
  331. 'should not move selection if there is no correct location - down arrow',
  332. '<paragraph>foo</paragraph>[<widget></widget>]',
  333. // Note: The first step is handled by the WidgetTypeAround plugin.
  334. [ keyCodes.arrowdown, keyCodes.arrowdown ],
  335. '<paragraph>foo</paragraph>[<widget></widget>]'
  336. );
  337. test(
  338. 'should not move selection if there is no correct location - left arrow',
  339. '[<widget></widget>]<paragraph>foo</paragraph>',
  340. // Note: The first step is handled by the WidgetTypeAround plugin.
  341. [ keyCodes.arrowleft, keyCodes.arrowleft ],
  342. '[<widget></widget>]<paragraph>foo</paragraph>'
  343. );
  344. test(
  345. 'should not move selection if there is no correct location - up arrow',
  346. '[<widget></widget>]<paragraph>foo</paragraph>',
  347. // Note: The first step is handled by the WidgetTypeAround plugin.
  348. [ keyCodes.arrowup, keyCodes.arrowup ],
  349. '[<widget></widget>]<paragraph>foo</paragraph>'
  350. );
  351. test(
  352. 'should do nothing if other key is pressed',
  353. '[<widget></widget>]<paragraph>foo</paragraph>',
  354. // Use a safe key (alt) to not trigger the Input features "unsafe keys" handler.
  355. 18,
  356. '[<widget></widget>]<paragraph>foo</paragraph>'
  357. );
  358. it( 'should prevent default behaviour when there is no correct location - document end', () => {
  359. const keydownHandler = sinon.spy();
  360. const domEventDataMock = {
  361. keyCode: keyCodes.arrowright,
  362. preventDefault: sinon.spy()
  363. };
  364. setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
  365. viewDocument.on( 'keydown', keydownHandler );
  366. // Note: The first step is handled by the WidgetTypeAround plugin.
  367. viewDocument.fire( 'keydown', domEventDataMock );
  368. viewDocument.fire( 'keydown', domEventDataMock );
  369. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  370. sinon.assert.calledTwice( domEventDataMock.preventDefault );
  371. sinon.assert.notCalled( keydownHandler );
  372. } );
  373. it( 'should prevent default behaviour when there is no correct location - document start', () => {
  374. const keydownHandler = sinon.spy();
  375. const domEventDataMock = {
  376. keyCode: keyCodes.arrowleft,
  377. preventDefault: sinon.spy()
  378. };
  379. setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
  380. viewDocument.on( 'keydown', keydownHandler );
  381. // Note: The first step is handled by the WidgetTypeAround plugin.
  382. viewDocument.fire( 'keydown', domEventDataMock );
  383. viewDocument.fire( 'keydown', domEventDataMock );
  384. expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
  385. sinon.assert.calledTwice( domEventDataMock.preventDefault );
  386. sinon.assert.notCalled( keydownHandler );
  387. } );
  388. test(
  389. 'should move selection to object element - right arrow',
  390. '<paragraph>foo[]</paragraph><widget></widget>',
  391. keyCodes.arrowright,
  392. '<paragraph>foo</paragraph>[<widget></widget>]'
  393. );
  394. test(
  395. 'should move selection to object element - down arrow',
  396. '<paragraph>foo[]</paragraph><widget></widget>',
  397. keyCodes.arrowdown,
  398. '<paragraph>foo</paragraph>[<widget></widget>]'
  399. );
  400. test(
  401. 'should move selection to object element - left arrow',
  402. '<widget></widget><paragraph>[]foo</paragraph>',
  403. keyCodes.arrowleft,
  404. '[<widget></widget>]<paragraph>foo</paragraph>'
  405. );
  406. test(
  407. 'should move selection to object element - up arrow',
  408. '<widget></widget><paragraph>[]foo</paragraph>',
  409. keyCodes.arrowup,
  410. '[<widget></widget>]<paragraph>foo</paragraph>'
  411. );
  412. test(
  413. 'do nothing on non objects - right arrow',
  414. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  415. keyCodes.arrowright,
  416. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  417. );
  418. test(
  419. 'do nothing on non objects - down arrow',
  420. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  421. keyCodes.arrowdown,
  422. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  423. );
  424. test(
  425. 'do nothing on non objects - left arrow',
  426. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  427. keyCodes.arrowleft,
  428. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  429. );
  430. test(
  431. 'do nothing on non objects - up arrow',
  432. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  433. keyCodes.arrowup,
  434. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  435. );
  436. test(
  437. 'should work correctly with modifier key: right arrow + ctrl',
  438. '[<widget></widget>]<paragraph>foo</paragraph>',
  439. // Note: The first step is handled by the WidgetTypeAround plugin.
  440. [
  441. { keyCode: keyCodes.arrowright, ctrlKey: true },
  442. { keyCode: keyCodes.arrowright, ctrlKey: true }
  443. ],
  444. '<widget></widget><paragraph>[]foo</paragraph>'
  445. );
  446. test(
  447. 'should work correctly with modifier key: right arrow + alt',
  448. '[<widget></widget>]<paragraph>foo</paragraph>',
  449. // Note: The first step is handled by the WidgetTypeAround plugin.
  450. [
  451. { keyCode: keyCodes.arrowright, altKey: true },
  452. { keyCode: keyCodes.arrowright, altKey: true }
  453. ],
  454. '<widget></widget><paragraph>[]foo</paragraph>'
  455. );
  456. test(
  457. 'should work correctly with modifier key: right arrow + shift',
  458. '[<widget></widget>]<paragraph>foo</paragraph>',
  459. // Note: The first step is handled by the WidgetTypeAround plugin.
  460. [
  461. { keyCode: keyCodes.arrowright, shiftKey: true },
  462. { keyCode: keyCodes.arrowright, shiftKey: true }
  463. ],
  464. '<widget></widget><paragraph>[]foo</paragraph>'
  465. );
  466. test(
  467. 'should work correctly with modifier key: down arrow + ctrl',
  468. '[<widget></widget>]<paragraph>foo</paragraph>',
  469. // Note: The first step is handled by the WidgetTypeAround plugin.
  470. [
  471. { keyCode: keyCodes.arrowdown, ctrlKey: true },
  472. { keyCode: keyCodes.arrowdown, ctrlKey: true }
  473. ],
  474. '<widget></widget><paragraph>[]foo</paragraph>'
  475. );
  476. test(
  477. 'should work correctly with modifier key: down arrow + alt',
  478. '[<widget></widget>]<paragraph>foo</paragraph>',
  479. // Note: The first step is handled by the WidgetTypeAround plugin.
  480. [
  481. { keyCode: keyCodes.arrowdown, altKey: true },
  482. { keyCode: keyCodes.arrowdown, altKey: true }
  483. ],
  484. '<widget></widget><paragraph>[]foo</paragraph>'
  485. );
  486. test(
  487. 'should work correctly with modifier key: down arrow + shift',
  488. '[<widget></widget>]<paragraph>foo</paragraph>',
  489. // Note: The first step is handled by the WidgetTypeAround plugin.
  490. [
  491. { keyCode: keyCodes.arrowdown, shiftKey: true },
  492. { keyCode: keyCodes.arrowdown, shiftKey: true }
  493. ],
  494. '<widget></widget><paragraph>[]foo</paragraph>'
  495. );
  496. test(
  497. 'should work correctly with modifier key: left arrow + ctrl',
  498. '<paragraph>foo</paragraph>[<widget></widget>]',
  499. // Note: The first step is handled by the WidgetTypeAround plugin.
  500. [
  501. { keyCode: keyCodes.arrowleft, ctrlKey: true },
  502. { keyCode: keyCodes.arrowleft, ctrlKey: true }
  503. ],
  504. '<paragraph>foo[]</paragraph><widget></widget>'
  505. );
  506. test(
  507. 'should work correctly with modifier key: left arrow + alt',
  508. '<paragraph>foo</paragraph>[<widget></widget>]',
  509. // Note: The first step is handled by the WidgetTypeAround plugin.
  510. [
  511. { keyCode: keyCodes.arrowleft, altKey: true },
  512. { keyCode: keyCodes.arrowleft, altKey: true }
  513. ],
  514. '<paragraph>foo[]</paragraph><widget></widget>'
  515. );
  516. test(
  517. 'should work correctly with modifier key: left arrow + shift',
  518. '<paragraph>foo</paragraph>[<widget></widget>]',
  519. // Note: The first step is handled by the WidgetTypeAround plugin.
  520. [
  521. { keyCode: keyCodes.arrowleft, shiftKey: true },
  522. { keyCode: keyCodes.arrowleft, shiftKey: true }
  523. ],
  524. '<paragraph>foo[]</paragraph><widget></widget>'
  525. );
  526. test(
  527. 'should work correctly with modifier key: up arrow + ctrl',
  528. '<paragraph>foo</paragraph>[<widget></widget>]',
  529. // Note: The first step is handled by the WidgetTypeAround plugin.
  530. [
  531. { keyCode: keyCodes.arrowup, ctrlKey: true },
  532. { keyCode: keyCodes.arrowup, ctrlKey: true }
  533. ],
  534. '<paragraph>foo[]</paragraph><widget></widget>'
  535. );
  536. test(
  537. 'should work correctly with modifier key: up arrow + alt',
  538. '<paragraph>foo</paragraph>[<widget></widget>]',
  539. // Note: The first step is handled by the WidgetTypeAround plugin.
  540. [
  541. { keyCode: keyCodes.arrowup, altKey: true },
  542. { keyCode: keyCodes.arrowup, altKey: true }
  543. ],
  544. '<paragraph>foo[]</paragraph><widget></widget>'
  545. );
  546. test(
  547. 'should work correctly with modifier key: up arrow + shift',
  548. '<paragraph>foo</paragraph>[<widget></widget>]',
  549. // Note: The first step is handled by the WidgetTypeAround plugin.
  550. [
  551. { keyCode: keyCodes.arrowup, shiftKey: true },
  552. { keyCode: keyCodes.arrowup, shiftKey: true }
  553. ],
  554. '<paragraph>foo[]</paragraph><widget></widget>'
  555. );
  556. test(
  557. 'should do nothing if there is more than one selection in model',
  558. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
  559. keyCodes.arrowright,
  560. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
  561. );
  562. test(
  563. 'should work if selection is in nested element (left arrow)',
  564. '<paragraph>foo</paragraph>' +
  565. '<image></image>' +
  566. '<blockQuote>' +
  567. '<div>' +
  568. '<div>' +
  569. '<paragraph>[]</paragraph>' +
  570. '</div>' +
  571. '</div>' +
  572. '</blockQuote>' +
  573. '<paragraph>foo</paragraph>',
  574. keyCodes.arrowleft,
  575. '<paragraph>foo</paragraph>' +
  576. '[<image></image>]' +
  577. '<blockQuote>' +
  578. '<div>' +
  579. '<div>' +
  580. '<paragraph></paragraph>' +
  581. '</div>' +
  582. '</div>' +
  583. '</blockQuote>' +
  584. '<paragraph>foo</paragraph>'
  585. );
  586. test(
  587. 'should work if selection is in nested element (up arrow)',
  588. '<paragraph>foo</paragraph>' +
  589. '<image></image>' +
  590. '<blockQuote>' +
  591. '<div>' +
  592. '<div>' +
  593. '<paragraph>[]</paragraph>' +
  594. '</div>' +
  595. '</div>' +
  596. '</blockQuote>' +
  597. '<paragraph>foo</paragraph>',
  598. keyCodes.arrowup,
  599. '<paragraph>foo</paragraph>' +
  600. '[<image></image>]' +
  601. '<blockQuote>' +
  602. '<div>' +
  603. '<div>' +
  604. '<paragraph></paragraph>' +
  605. '</div>' +
  606. '</div>' +
  607. '</blockQuote>' +
  608. '<paragraph>foo</paragraph>'
  609. );
  610. test(
  611. 'should work if selection is in nested element (right arrow)',
  612. '<paragraph>foo</paragraph>' +
  613. '<blockQuote>' +
  614. '<div>' +
  615. '<div>' +
  616. '<paragraph>[]</paragraph>' +
  617. '</div>' +
  618. '</div>' +
  619. '</blockQuote>' +
  620. '<image></image>' +
  621. '<paragraph>foo</paragraph>',
  622. keyCodes.arrowright,
  623. '<paragraph>foo</paragraph>' +
  624. '<blockQuote>' +
  625. '<div>' +
  626. '<div>' +
  627. '<paragraph></paragraph>' +
  628. '</div>' +
  629. '</div>' +
  630. '</blockQuote>' +
  631. '[<image></image>]' +
  632. '<paragraph>foo</paragraph>'
  633. );
  634. test(
  635. 'should work if selection is in nested element (down arrow)',
  636. '<paragraph>foo</paragraph>' +
  637. '<blockQuote>' +
  638. '<div>' +
  639. '<div>' +
  640. '<paragraph>[]</paragraph>' +
  641. '</div>' +
  642. '</div>' +
  643. '</blockQuote>' +
  644. '<image></image>' +
  645. '<paragraph>foo</paragraph>',
  646. keyCodes.arrowdown,
  647. '<paragraph>foo</paragraph>' +
  648. '<blockQuote>' +
  649. '<div>' +
  650. '<div>' +
  651. '<paragraph></paragraph>' +
  652. '</div>' +
  653. '</div>' +
  654. '</blockQuote>' +
  655. '[<image></image>]' +
  656. '<paragraph>foo</paragraph>'
  657. );
  658. describe( 'RTL (right-to-left) content', () => {
  659. test(
  660. 'should move selection forward from selected object - left arrow',
  661. '[<widget></widget>]<paragraph>foo</paragraph>',
  662. // Note: The first step is handled by the WidgetTypeAround plugin.
  663. [ keyCodes.arrowleft, keyCodes.arrowleft ],
  664. '<widget></widget><paragraph>[]foo</paragraph>',
  665. null,
  666. 'rtl'
  667. );
  668. test(
  669. 'should move selection backward from selected object - right arrow',
  670. '<paragraph>foo</paragraph>[<widget></widget>]',
  671. // Note: The first step is handled by the WidgetTypeAround plugin.
  672. [ keyCodes.arrowright, keyCodes.arrowright ],
  673. '<paragraph>foo[]</paragraph><widget></widget>',
  674. null,
  675. 'rtl'
  676. );
  677. test(
  678. 'should move selection to next widget - left arrow',
  679. '[<widget></widget>]<widget></widget>',
  680. // Note: The first step is handled by the WidgetTypeAround plugin.
  681. [ keyCodes.arrowleft, keyCodes.arrowleft ],
  682. '<widget></widget>[<widget></widget>]',
  683. null,
  684. 'rtl'
  685. );
  686. test(
  687. 'should move selection to previous widget - right arrow',
  688. '<widget></widget>[<widget></widget>]',
  689. // Note: The first step is handled by the WidgetTypeAround plugin.
  690. [ keyCodes.arrowright, keyCodes.arrowright ],
  691. '[<widget></widget>]<widget></widget>',
  692. null,
  693. 'rtl'
  694. );
  695. } );
  696. } );
  697. function test( name, data, actions, expected, expectedView, contentLanguageDirection = 'ltr' ) {
  698. it( name, () => {
  699. testUtils.sinon.stub( editor.locale, 'contentLanguageDirection' ).value( contentLanguageDirection );
  700. if ( !Array.isArray( actions ) ) {
  701. actions = [ actions ];
  702. }
  703. actions = actions.map( action => {
  704. if ( typeof action === 'object' ) {
  705. return action;
  706. }
  707. return {
  708. keyCode: action
  709. };
  710. } );
  711. setModelData( model, data );
  712. for ( const action of actions ) {
  713. viewDocument.fire( 'keydown', new DomEventData(
  714. viewDocument,
  715. { target: document.createElement( 'div' ), preventDefault() {} },
  716. action
  717. ) );
  718. }
  719. expect( getModelData( model ) ).to.equal( expected );
  720. if ( expectedView ) {
  721. expect( getViewData( view ) ).to.equal( expectedView );
  722. }
  723. } );
  724. }
  725. } );
  726. describe( 'delete integration', () => {
  727. function test( name, input, direction, expected ) {
  728. it( name, () => {
  729. setModelData( model, input );
  730. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  731. const domEventDataMock = {
  732. keyCode: direction == 'backward' ? keyCodes.backspace : keyCodes.delete
  733. };
  734. viewDocument.fire( 'keydown', new DomEventData(
  735. viewDocument,
  736. { target: document.createElement( 'div' ), preventDefault() {} },
  737. domEventDataMock
  738. ) );
  739. expect( getModelData( model ) ).to.equal( expected );
  740. scrollStub.restore();
  741. } );
  742. }
  743. // Let's make this integration tests real which will help covering
  744. // cases like https://github.com/ckeditor/ckeditor5/issues/753.
  745. // Originally, this test file used the Delete feature only which was not "integrational" enough.
  746. it( 'tests are executed with the Typing feature', () => {
  747. expect( editor.plugins.get( 'Typing' ) ).to.not.be.undefined;
  748. } );
  749. test(
  750. 'should select widget when backspace is pressed',
  751. '<widget></widget><paragraph>[]foo</paragraph>',
  752. 'backward',
  753. '[<widget></widget>]<paragraph>foo</paragraph>'
  754. );
  755. test(
  756. 'should remove empty element after selecting widget when backspace is pressed',
  757. '<widget></widget><paragraph>[]</paragraph>',
  758. 'backward',
  759. '[<widget></widget>]'
  760. );
  761. test(
  762. 'should select widget when delete is pressed',
  763. '<paragraph>foo[]</paragraph><widget></widget>',
  764. 'forward',
  765. '<paragraph>foo</paragraph>[<widget></widget>]'
  766. );
  767. test(
  768. 'should remove empty element after selecting widget when delete is pressed',
  769. '<paragraph>[]</paragraph><widget></widget>',
  770. 'forward',
  771. '[<widget></widget>]'
  772. );
  773. test(
  774. 'should not select widget on non-collapsed selection',
  775. '<widget></widget><paragraph>[f]oo</paragraph>',
  776. 'backward',
  777. '<widget></widget><paragraph>[]oo</paragraph>'
  778. );
  779. test(
  780. 'should not affect non-object elements',
  781. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  782. 'backward',
  783. '<paragraph>foo[]bar</paragraph>'
  784. );
  785. test(
  786. 'should not modify backward delete default behaviour in single paragraph boundaries',
  787. '<paragraph>[]foo</paragraph>',
  788. 'backward',
  789. '<paragraph>[]foo</paragraph>'
  790. );
  791. test(
  792. 'should not modify forward delete default behaviour in single paragraph boundaries',
  793. '<paragraph>foo[]</paragraph>',
  794. 'forward',
  795. '<paragraph>foo[]</paragraph>'
  796. );
  797. test(
  798. 'should delete selected widget with paragraph before - backward',
  799. '<paragraph>foo</paragraph>[<widget></widget>]',
  800. 'backward',
  801. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  802. );
  803. test(
  804. 'should delete selected widget with paragraph before - forward',
  805. '<paragraph>foo</paragraph>[<widget></widget>]',
  806. 'forward',
  807. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  808. );
  809. test(
  810. 'should delete selected widget with paragraph after - backward',
  811. '[<widget></widget>]<paragraph>foo</paragraph>',
  812. 'backward',
  813. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  814. );
  815. test(
  816. 'should delete selected widget with paragraph after - forward',
  817. '[<widget></widget>]<paragraph>foo</paragraph>',
  818. 'forward',
  819. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  820. );
  821. test(
  822. 'should delete selected widget between paragraphs - backward',
  823. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  824. 'backward',
  825. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  826. );
  827. test(
  828. 'should delete selected widget between paragraphs - forward',
  829. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  830. 'forward',
  831. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  832. );
  833. test(
  834. 'should delete selected widget preceded by another widget - backward',
  835. '<widget></widget>[<widget></widget>]',
  836. 'backward',
  837. '<widget></widget><paragraph>[]</paragraph>'
  838. );
  839. test(
  840. 'should delete selected widget preceded by another widget - forward',
  841. '<widget></widget>[<widget></widget>]',
  842. 'forward',
  843. '<widget></widget><paragraph>[]</paragraph>'
  844. );
  845. test(
  846. 'should delete selected widget before another widget - forward',
  847. '[<widget></widget>]<widget></widget>',
  848. 'forward',
  849. '<paragraph>[]</paragraph><widget></widget>'
  850. );
  851. test(
  852. 'should delete selected widget before another widget - backward',
  853. '[<widget></widget>]<widget></widget>',
  854. 'backward',
  855. '<paragraph>[]</paragraph><widget></widget>'
  856. );
  857. test(
  858. 'should delete selected widget between other widgets - forward',
  859. '<widget></widget>[<widget></widget>]<widget></widget>',
  860. 'forward',
  861. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  862. );
  863. test(
  864. 'should delete selected widget between other widgets - backward',
  865. '<widget></widget>[<widget></widget>]<widget></widget>',
  866. 'backward',
  867. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  868. );
  869. test(
  870. 'should select inline objects - backward',
  871. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  872. 'backward',
  873. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  874. );
  875. test(
  876. 'should select inline objects - forward',
  877. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  878. 'forward',
  879. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  880. );
  881. test(
  882. 'should delete selected inline objects - backward',
  883. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  884. 'backward',
  885. '<paragraph>foo[]bar</paragraph>'
  886. );
  887. test(
  888. 'should delete selected inline objects - forward',
  889. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  890. 'forward',
  891. '<paragraph>foo[]bar</paragraph>'
  892. );
  893. test(
  894. 'should use standard delete behaviour when after first letter - backward',
  895. '<paragraph>a[]</paragraph>',
  896. 'backward',
  897. '<paragraph>[]</paragraph>'
  898. );
  899. test(
  900. 'should use standard delete behaviour when before first letter - forward',
  901. '<paragraph>[]a</paragraph>',
  902. 'forward',
  903. '<paragraph>[]</paragraph>'
  904. );
  905. it( 'should prevent default behaviour and stop event propagation', () => {
  906. setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
  907. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  908. const deleteSpy = sinon.spy();
  909. viewDocument.on( 'delete', deleteSpy );
  910. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  911. viewDocument.fire( 'delete', new DomEventData(
  912. viewDocument,
  913. domEventDataMock,
  914. { direction: 'forward', unit: 'character', sequence: 0 }
  915. ) );
  916. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  917. sinon.assert.notCalled( deleteSpy );
  918. scrollStub.restore();
  919. } );
  920. test(
  921. 'should remove the entire empty element if it is next to a widget',
  922. '<paragraph>foo</paragraph>' +
  923. '<image></image>' +
  924. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  925. '<paragraph>foo</paragraph>',
  926. 'backward',
  927. '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
  928. );
  929. test(
  930. 'should remove the entire empty element (deeper structure) if it is next to a widget',
  931. '<paragraph>foo</paragraph>' +
  932. '<image></image>' +
  933. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  934. '<paragraph>foo</paragraph>',
  935. 'backward',
  936. '<paragraph>foo</paragraph>' +
  937. '[<image></image>]' +
  938. '<paragraph>foo</paragraph>'
  939. );
  940. test(
  941. 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
  942. '<paragraph>foo</paragraph>' +
  943. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  944. '<image></image>' +
  945. '<paragraph>foo</paragraph>',
  946. 'forward',
  947. '<paragraph>foo</paragraph>' +
  948. '[<image></image>]' +
  949. '<paragraph>foo</paragraph>'
  950. );
  951. test(
  952. 'should not remove the entire element which is not empty and the element is next to a widget',
  953. '<paragraph>foo</paragraph>' +
  954. '<image></image>' +
  955. '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
  956. '<paragraph>foo</paragraph>',
  957. 'backward',
  958. '<paragraph>foo</paragraph>' +
  959. '[<image></image>]' +
  960. '<blockQuote><paragraph></paragraph></blockQuote>' +
  961. '<paragraph>foo</paragraph>'
  962. );
  963. test(
  964. 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
  965. '<paragraph>foo</paragraph>' +
  966. '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
  967. '<image></image>' +
  968. '<paragraph>foo</paragraph>',
  969. 'forward',
  970. '<paragraph>foo</paragraph>' +
  971. '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
  972. '[<image></image>]' +
  973. '<paragraph>foo</paragraph>'
  974. );
  975. test(
  976. 'should not remove the entire element (deeper structure) which is not empty and the element is next to a widget',
  977. '<paragraph>foo</paragraph>' +
  978. '<image></image>' +
  979. '<blockQuote>' +
  980. '<div>' +
  981. '<div>' +
  982. '<paragraph>[]</paragraph>' +
  983. '</div>' +
  984. '</div>' +
  985. '<paragraph></paragraph>' +
  986. '</blockQuote>' +
  987. '<paragraph>foo</paragraph>',
  988. 'backward',
  989. '<paragraph>foo</paragraph>' +
  990. '[<image></image>]' +
  991. '<blockQuote>' +
  992. '<paragraph></paragraph>' +
  993. '</blockQuote>' +
  994. '<paragraph>foo</paragraph>'
  995. );
  996. test(
  997. 'should do nothing if the nested element is not empty and the element is next to a widget',
  998. '<paragraph>foo</paragraph>' +
  999. '<image></image>' +
  1000. '<blockQuote>' +
  1001. '<div>' +
  1002. '<div>' +
  1003. '<paragraph>Foo[]</paragraph>' +
  1004. '</div>' +
  1005. '</div>' +
  1006. '</blockQuote>' +
  1007. '<paragraph>foo</paragraph>',
  1008. 'backward',
  1009. '<paragraph>foo</paragraph>' +
  1010. '<image></image>' +
  1011. '<blockQuote>' +
  1012. '<div>' +
  1013. '<div>' +
  1014. '<paragraph>Fo[]</paragraph>' +
  1015. '</div>' +
  1016. '</div>' +
  1017. '</blockQuote>' +
  1018. '<paragraph>foo</paragraph>'
  1019. );
  1020. it( 'does nothing when editor when read only mode is enabled (delete)', () => {
  1021. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1022. setModelData( model,
  1023. '<paragraph>foo</paragraph>' +
  1024. '<image></image>' +
  1025. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1026. '<paragraph>foo</paragraph>'
  1027. );
  1028. editor.isReadOnly = true;
  1029. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1030. viewDocument.fire( 'delete', new DomEventData(
  1031. viewDocument,
  1032. domEventDataMock,
  1033. { direction: 'backward', unit: 'character', sequence: 0 }
  1034. ) );
  1035. expect( getModelData( model ) ).to.equal(
  1036. '<paragraph>foo</paragraph>' +
  1037. '<image></image>' +
  1038. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1039. '<paragraph>foo</paragraph>'
  1040. );
  1041. scrollStub.restore();
  1042. } );
  1043. it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
  1044. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1045. setModelData( model,
  1046. '<paragraph>foo</paragraph>' +
  1047. '<image></image>' +
  1048. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1049. '<paragraph>foo</paragraph>'
  1050. );
  1051. editor.isReadOnly = true;
  1052. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1053. viewDocument.fire( 'delete', new DomEventData(
  1054. viewDocument,
  1055. domEventDataMock,
  1056. { direction: 'forward', unit: 'character', sequence: 0 }
  1057. ) );
  1058. expect( getModelData( model ) ).to.equal(
  1059. '<paragraph>foo</paragraph>' +
  1060. '<image></image>' +
  1061. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1062. '<paragraph>foo</paragraph>'
  1063. );
  1064. scrollStub.restore();
  1065. } );
  1066. } );
  1067. describe( 'selection handle', () => {
  1068. let element, editor;
  1069. beforeEach( () => {
  1070. element = document.createElement( 'div' );
  1071. document.body.appendChild( element );
  1072. return ClassicTestEditor
  1073. .create( element, {
  1074. plugins: [ Paragraph, Widget, Typing ]
  1075. } )
  1076. .then( newEditor => {
  1077. editor = newEditor;
  1078. model = editor.model;
  1079. view = editor.editing.view;
  1080. viewDocument = view.document;
  1081. model.schema.register( 'widget', {
  1082. inheritAllFrom: '$block',
  1083. allowIn: 'widget',
  1084. isObject: true
  1085. } );
  1086. model.schema.register( 'nested', {
  1087. allowIn: 'widget',
  1088. isLimit: true
  1089. } );
  1090. model.schema.extend( '$text', {
  1091. allowIn: 'nested'
  1092. } );
  1093. editor.conversion.for( 'downcast' )
  1094. .elementToElement( { model: 'paragraph', view: 'p' } )
  1095. .elementToElement( {
  1096. model: 'widget',
  1097. view: ( modelItem, viewWriter ) => {
  1098. const widget = viewWriter.createContainerElement( 'div' );
  1099. return toWidget( widget, viewWriter, { hasSelectionHandle: true } );
  1100. }
  1101. } )
  1102. .elementToElement( {
  1103. model: 'nested',
  1104. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  1105. } );
  1106. } );
  1107. } );
  1108. afterEach( () => {
  1109. element.remove();
  1110. return editor.destroy();
  1111. } );
  1112. it( 'should select a widget on mouse click', () => {
  1113. setModelData( model, '<paragraph>bar</paragraph><widget></widget><paragraph>foo[]</paragraph>' );
  1114. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  1115. const domEventDataMock = new DomEventData( view, {
  1116. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1117. preventDefault: sinon.spy()
  1118. } );
  1119. viewDocument.fire( 'mousedown', domEventDataMock );
  1120. expect( getModelData( model ) ).to.equal( '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>' );
  1121. } );
  1122. it( 'should select the most top-outer widget if widgets are nested', () => {
  1123. setModelData( model, '<widget><widget></widget><widget></widget></widget>' );
  1124. // The top-outer widget.
  1125. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1126. const domEventDataMock = new DomEventData( view, {
  1127. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1128. preventDefault: sinon.spy()
  1129. } );
  1130. viewDocument.fire( 'mousedown', domEventDataMock );
  1131. expect( getViewData( view ) ).to.equal(
  1132. '[<div class="' +
  1133. 'ck-widget ' +
  1134. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1135. '>' +
  1136. '<div class="' +
  1137. 'ck-widget ' +
  1138. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1139. '>' +
  1140. '<div class="ck ck-widget__selection-handle"></div>' +
  1141. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1142. '</div>' +
  1143. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1144. '<div class="ck ck-widget__selection-handle"></div>' +
  1145. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1146. '</div>' +
  1147. '<div class="ck ck-widget__selection-handle"></div>' +
  1148. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1149. '</div>]'
  1150. );
  1151. } );
  1152. it( 'should select a proper widget if they are nested and multiplied', () => {
  1153. setModelData( model,
  1154. '<widget></widget>' +
  1155. '<widget>' +
  1156. '<widget></widget>' +
  1157. '<widget></widget>' +
  1158. '</widget>' +
  1159. '<widget></widget>'
  1160. );
  1161. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 );
  1162. const domEventDataMock = new DomEventData( view, {
  1163. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1164. preventDefault: sinon.spy()
  1165. } );
  1166. viewDocument.fire( 'mousedown', domEventDataMock );
  1167. expect( getViewData( view ) ).to.equal(
  1168. '<div class="ck-widget ck-widget_with-selection-handle" ' +
  1169. 'contenteditable="false">' +
  1170. '<div class="ck ck-widget__selection-handle"></div>' +
  1171. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1172. '</div>' +
  1173. '[<div class="' +
  1174. 'ck-widget ' +
  1175. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1176. '>' +
  1177. '<div ' +
  1178. 'class="ck-widget ck-widget_with-selection-handle" ' +
  1179. 'contenteditable="false">' +
  1180. '<div class="ck ck-widget__selection-handle"></div>' +
  1181. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1182. '</div>' +
  1183. '<div class="ck-widget ck-widget_with-selection-handle" ' +
  1184. 'contenteditable="false">' +
  1185. '<div class="ck ck-widget__selection-handle"></div>' +
  1186. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1187. '</div>' +
  1188. '<div class="ck ck-widget__selection-handle"></div>' +
  1189. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1190. '</div>]' +
  1191. '<div ' +
  1192. 'class="ck-widget ck-widget_with-selection-handle" ' +
  1193. 'contenteditable="false">' +
  1194. '<div class="ck ck-widget__selection-handle"></div>' +
  1195. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1196. '</div>'
  1197. );
  1198. } );
  1199. it( 'works fine with a widget that contains more children', () => {
  1200. setModelData( model,
  1201. '<widget>' +
  1202. '<nested>foo bar</nested>' +
  1203. '<widget></widget>' +
  1204. '</widget>'
  1205. );
  1206. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1207. const domEventDataMock = new DomEventData( view, {
  1208. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1209. preventDefault: sinon.spy()
  1210. } );
  1211. viewDocument.fire( 'mousedown', domEventDataMock );
  1212. expect( getViewData( view ) ).to.equal(
  1213. '[<div class="' +
  1214. 'ck-widget ' +
  1215. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1216. '>' +
  1217. '<figcaption contenteditable="true">foo bar</figcaption>' +
  1218. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1219. '<div class="ck ck-widget__selection-handle"></div>' +
  1220. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1221. '</div>' +
  1222. '<div class="ck ck-widget__selection-handle"></div>' +
  1223. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1224. '</div>]'
  1225. );
  1226. } );
  1227. it( 'should select a proper widget for more complex structures', () => {
  1228. setModelData( model,
  1229. '<widget>' +
  1230. '<widget></widget>' +
  1231. '<widget>' +
  1232. '<widget></widget>' +
  1233. '</widget>' +
  1234. '</widget>'
  1235. );
  1236. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 ).getChild( 1 );
  1237. const domEventDataMock = new DomEventData( view, {
  1238. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1239. preventDefault: sinon.spy()
  1240. } );
  1241. viewDocument.fire( 'mousedown', domEventDataMock );
  1242. expect( getViewData( view ) ).to.equal(
  1243. '<div class="' +
  1244. 'ck-widget ' +
  1245. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1246. '>' +
  1247. '<div class="' +
  1248. 'ck-widget ' +
  1249. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1250. '>' +
  1251. '<div class="ck ck-widget__selection-handle"></div>' +
  1252. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1253. '</div>' +
  1254. '[<div class="' +
  1255. 'ck-widget ' +
  1256. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1257. '>' +
  1258. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1259. '<div class="ck ck-widget__selection-handle"></div>' +
  1260. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1261. '</div>' +
  1262. '<div class="ck ck-widget__selection-handle"></div>' +
  1263. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1264. '</div>]' +
  1265. '<div class="ck ck-widget__selection-handle"></div>' +
  1266. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1267. '</div>'
  1268. );
  1269. } );
  1270. it( 'should select widget in editable', () => {
  1271. model.schema.extend( 'widget', { allowIn: 'nested' } );
  1272. setModelData( model, '[]<widget><nested><widget></widget></nested></widget>' );
  1273. const widgetInEditable = viewDocument.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 );
  1274. const domEventDataMock = new DomEventData( view, {
  1275. target: view.domConverter.mapViewToDom( widgetInEditable ),
  1276. preventDefault: sinon.spy()
  1277. } );
  1278. viewDocument.fire( 'mousedown', domEventDataMock );
  1279. expect( getViewData( view ) ).to.equal(
  1280. '<div class="' +
  1281. 'ck-widget ' +
  1282. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1283. '>' +
  1284. '<figcaption contenteditable="true">[' +
  1285. '<div class="' +
  1286. 'ck-widget ' +
  1287. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1288. '>' +
  1289. '<div class="ck ck-widget__selection-handle"></div>' +
  1290. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1291. '</div>]' +
  1292. '</figcaption>' +
  1293. '<div class="ck ck-widget__selection-handle"></div>' +
  1294. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1295. '</div>'
  1296. );
  1297. } );
  1298. } );
  1299. } );