widget.js 47 KB

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