widget.js 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547
  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 Widget from '../src/widget';
  8. import WidgetTypeAround from '../src/widgettypearound/widgettypearound';
  9. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  10. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  11. import { toWidget } from '../src/utils';
  12. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  13. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  14. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  15. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. describe( 'Widget', () => {
  18. let element, editor, model, view, viewDocument;
  19. testUtils.createSinonSandbox();
  20. beforeEach( () => {
  21. element = document.createElement( 'div' );
  22. document.body.appendChild( element );
  23. return ClassicTestEditor
  24. .create( element, {
  25. plugins: [ Widget, Typing ]
  26. } )
  27. .then( newEditor => {
  28. editor = newEditor;
  29. model = editor.model;
  30. view = editor.editing.view;
  31. viewDocument = view.document;
  32. model.schema.register( 'widget', {
  33. inheritAllFrom: '$block',
  34. isObject: true
  35. } );
  36. model.schema.extend( 'paragraph', {
  37. allowIn: 'div'
  38. } );
  39. model.schema.register( 'inline', {
  40. allowWhere: '$text',
  41. isObject: true
  42. } );
  43. model.schema.register( 'nested', {
  44. allowIn: 'widget',
  45. isLimit: true
  46. } );
  47. model.schema.extend( '$text', {
  48. allowIn: [ 'nested', 'editable' ]
  49. } );
  50. model.schema.register( 'editable', {
  51. allowIn: [ 'widget', '$root' ]
  52. } );
  53. model.schema.register( 'inline-widget', {
  54. allowWhere: '$text',
  55. isObject: true,
  56. isInline: true
  57. } );
  58. // Image feature.
  59. model.schema.register( 'image', {
  60. allowIn: '$root',
  61. isObject: true,
  62. isBlock: true
  63. } );
  64. // Block-quote feature.
  65. model.schema.register( 'blockQuote', {
  66. allowIn: '$root'
  67. } );
  68. model.schema.extend( '$block', { allowIn: 'blockQuote' } );
  69. // Div element which helps nesting elements.
  70. model.schema.register( 'div', {
  71. allowIn: [ 'blockQuote', 'div' ]
  72. } );
  73. editor.conversion.for( 'downcast' )
  74. .elementToElement( { model: 'inline', view: 'figure' } )
  75. .elementToElement( { model: 'image', view: 'img' } )
  76. .elementToElement( { model: 'blockQuote', view: 'blockquote' } )
  77. .elementToElement( { model: 'div', view: 'div' } )
  78. .elementToElement( {
  79. model: 'widget',
  80. view: ( modelItem, viewWriter ) => {
  81. const b = viewWriter.createAttributeElement( 'b' );
  82. const div = viewWriter.createContainerElement( 'div' );
  83. viewWriter.insert( viewWriter.createPositionAt( div, 0 ), b );
  84. return toWidget( div, viewWriter, { label: 'element label' } );
  85. }
  86. } )
  87. .elementToElement( {
  88. model: 'inline-widget',
  89. view: ( modelItem, viewWriter ) => {
  90. const span = viewWriter.createContainerElement( 'span' );
  91. return toWidget( span, viewWriter );
  92. }
  93. } )
  94. .elementToElement( {
  95. model: 'nested',
  96. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  97. } )
  98. .elementToElement( {
  99. model: 'editable',
  100. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  101. } );
  102. } );
  103. } );
  104. afterEach( () => {
  105. element.remove();
  106. return editor.destroy();
  107. } );
  108. it( 'should be loaded', () => {
  109. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  110. } );
  111. it( 'should add MouseObserver', () => {
  112. expect( view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  113. } );
  114. it( 'should require the WidgetTypeAround plugin', () => {
  115. expect( Widget.requires ).to.have.members( [ WidgetTypeAround ] );
  116. } );
  117. it( 'should create selection over clicked widget', () => {
  118. setModelData( model, '[]<widget></widget>' );
  119. const viewDiv = viewDocument.getRoot().getChild( 0 );
  120. const domEventDataMock = new DomEventData( view, {
  121. target: view.domConverter.mapViewToDom( viewDiv ),
  122. preventDefault: sinon.spy()
  123. } );
  124. viewDocument.fire( 'mousedown', domEventDataMock );
  125. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  126. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  127. } );
  128. it( 'should create selection when clicked in nested element', () => {
  129. setModelData( model, '[]<widget></widget>' );
  130. const viewDiv = viewDocument.getRoot().getChild( 0 );
  131. const viewB = viewDiv.getChild( 0 );
  132. const domEventDataMock = new DomEventData( view, {
  133. target: view.domConverter.mapViewToDom( viewB ),
  134. preventDefault: sinon.spy()
  135. } );
  136. viewDocument.fire( 'mousedown', domEventDataMock );
  137. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  138. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  139. } );
  140. it( 'should do nothing if clicked in non-widget element', () => {
  141. setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  142. const viewP = viewDocument.getRoot().getChild( 0 );
  143. const domEventDataMock = new DomEventData( view, {
  144. target: view.domConverter.mapViewToDom( viewP ),
  145. preventDefault: sinon.spy()
  146. } );
  147. view.focus();
  148. viewDocument.fire( 'mousedown', domEventDataMock );
  149. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  150. sinon.assert.notCalled( domEventDataMock.domEvent.preventDefault );
  151. } );
  152. it( 'should not focus editable if already is focused', () => {
  153. setModelData( model, '<widget></widget>' );
  154. const widget = viewDocument.getRoot().getChild( 0 );
  155. const domEventDataMock = new DomEventData( view, {
  156. target: view.domConverter.mapViewToDom( widget ),
  157. preventDefault: sinon.spy()
  158. } );
  159. const focusSpy = sinon.spy( view, 'focus' );
  160. viewDocument.isFocused = true;
  161. viewDocument.fire( 'mousedown', domEventDataMock );
  162. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  163. sinon.assert.notCalled( focusSpy );
  164. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  165. } );
  166. it( 'should apply fake view selection if model selection is on widget element', () => {
  167. setModelData( model, '[<widget>foo bar</widget>]' );
  168. expect( getViewData( view ) ).to.equal(
  169. '[<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_selected" ' +
  170. 'contenteditable="false">' +
  171. 'foo bar' +
  172. '<b></b>' +
  173. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  174. '</div>]'
  175. );
  176. expect( viewDocument.selection.isFake ).to.be.true;
  177. } );
  178. it( 'should use element\'s label to set fake selection if one is provided', () => {
  179. setModelData( model, '[<widget>foo bar</widget>]' );
  180. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
  181. } );
  182. it( 'should add selected class when other content is selected with widget', () => {
  183. setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
  184. expect( viewDocument.selection.isFake ).to.be.false;
  185. expect( getViewData( view ) ).to.equal(
  186. '<p>{foo</p>' +
  187. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_selected" contenteditable="false">' +
  188. '<b></b>' +
  189. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  190. '</div>' +
  191. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_selected" ' +
  192. 'contenteditable="false">' +
  193. '<b></b>' +
  194. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  195. '</div>]'
  196. );
  197. } );
  198. it( 'fake selection should be empty if widget is not selected', () => {
  199. setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
  200. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
  201. } );
  202. it( 'should toggle selected class', () => {
  203. setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
  204. expect( getViewData( view ) ).to.equal(
  205. '<p>foo</p>' +
  206. '[<div class="ck-widget ck-widget_can-type-around_after ck-widget_selected" contenteditable="false">' +
  207. 'foo' +
  208. '<b></b>' +
  209. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  210. '</div>]'
  211. );
  212. model.change( writer => {
  213. writer.setSelection( null );
  214. } );
  215. expect( getViewData( view ) ).to.equal(
  216. '<p>{}foo</p>' +
  217. '<div class="ck-widget ck-widget_can-type-around_after" contenteditable="false">' +
  218. 'foo' +
  219. '<b></b>' +
  220. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  221. '</div>'
  222. );
  223. } );
  224. it( 'should do nothing when selection is placed in other editable', () => {
  225. setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
  226. expect( getViewData( view ) ).to.equal(
  227. '<div class="ck-widget ck-widget_can-type-around_before" contenteditable="false">' +
  228. '<figcaption contenteditable="true">foo bar</figcaption>' +
  229. '<b></b>' +
  230. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  231. '</div>' +
  232. '<figcaption contenteditable="true">{baz}</figcaption>'
  233. );
  234. } );
  235. describe( 'keys handling', () => {
  236. describe( 'arrows', () => {
  237. test(
  238. 'should move selection forward from selected object - right arrow',
  239. '[<widget></widget>]<paragraph>foo</paragraph>',
  240. keyCodes.arrowright,
  241. '<widget></widget><paragraph>[]foo</paragraph>'
  242. );
  243. test(
  244. 'should move selection forward from selected object - down arrow',
  245. '[<widget></widget>]<paragraph>foo</paragraph>',
  246. keyCodes.arrowdown,
  247. '<widget></widget><paragraph>[]foo</paragraph>'
  248. );
  249. test(
  250. 'should move selection backward from selected object - left arrow',
  251. '<paragraph>foo</paragraph>[<widget></widget>]',
  252. keyCodes.arrowleft,
  253. '<paragraph>foo[]</paragraph><widget></widget>'
  254. );
  255. test(
  256. 'should move selection backward from selected object - up arrow',
  257. '<paragraph>foo</paragraph>[<widget></widget>]',
  258. keyCodes.arrowup,
  259. '<paragraph>foo[]</paragraph><widget></widget>'
  260. );
  261. test(
  262. 'should move selection to next widget - right arrow',
  263. '[<widget></widget>]<widget></widget>',
  264. keyCodes.arrowright,
  265. '<widget></widget>[<widget></widget>]'
  266. );
  267. test(
  268. 'should move selection to next widget - down arrow',
  269. '[<widget></widget>]<widget></widget>',
  270. keyCodes.arrowdown,
  271. '<widget></widget>[<widget></widget>]'
  272. );
  273. test(
  274. 'should move selection to previous widget - left arrow',
  275. '<widget></widget>[<widget></widget>]',
  276. keyCodes.arrowleft,
  277. '[<widget></widget>]<widget></widget>'
  278. );
  279. test(
  280. 'should move selection to previous widget - up arrow',
  281. '<widget></widget>[<widget></widget>]',
  282. keyCodes.arrowup,
  283. '[<widget></widget>]<widget></widget>'
  284. );
  285. test(
  286. 'should do nothing on non-collapsed selection next to object - right arrow',
  287. '<paragraph>ba[r]</paragraph><widget></widget>',
  288. keyCodes.arrowright,
  289. '<paragraph>ba[r]</paragraph><widget></widget>'
  290. );
  291. test(
  292. 'should do nothing on non-collapsed selection next to object - down arrow',
  293. '<paragraph>ba[r]</paragraph><widget></widget>',
  294. keyCodes.arrowdown,
  295. '<paragraph>ba[r]</paragraph><widget></widget>'
  296. );
  297. test(
  298. 'should do nothing on non-collapsed selection next to object - left arrow',
  299. '<widget></widget><paragraph>[b]ar</paragraph>',
  300. keyCodes.arrowleft,
  301. '<widget></widget><paragraph>[b]ar</paragraph>'
  302. );
  303. test(
  304. 'should do nothing on non-collapsed selection next to object - up arrow',
  305. '<widget></widget><paragraph>[b]ar</paragraph>',
  306. keyCodes.arrowup,
  307. '<widget></widget><paragraph>[b]ar</paragraph>'
  308. );
  309. test(
  310. 'should not move selection if there is no correct location - right arrow',
  311. '<paragraph>foo</paragraph>[<widget></widget>]',
  312. keyCodes.arrowright,
  313. '<paragraph>foo</paragraph>[<widget></widget>]'
  314. );
  315. test(
  316. 'should not move selection if there is no correct location - down arrow',
  317. '<paragraph>foo</paragraph>[<widget></widget>]',
  318. keyCodes.arrowdown,
  319. '<paragraph>foo</paragraph>[<widget></widget>]'
  320. );
  321. test(
  322. 'should not move selection if there is no correct location - left arrow',
  323. '[<widget></widget>]<paragraph>foo</paragraph>',
  324. keyCodes.arrowleft,
  325. '[<widget></widget>]<paragraph>foo</paragraph>'
  326. );
  327. test(
  328. 'should not move selection if there is no correct location - up arrow',
  329. '[<widget></widget>]<paragraph>foo</paragraph>',
  330. keyCodes.arrowup,
  331. '[<widget></widget>]<paragraph>foo</paragraph>'
  332. );
  333. test(
  334. 'should do nothing if other key is pressed',
  335. '[<widget></widget>]<paragraph>foo</paragraph>',
  336. // Use a safe key (alt) to not trigger the Input features "unsafe keys" handler.
  337. 18,
  338. '[<widget></widget>]<paragraph>foo</paragraph>'
  339. );
  340. it( 'should prevent default behaviour when there is no correct location - document end', () => {
  341. const keydownHandler = sinon.spy();
  342. const domEventDataMock = {
  343. keyCode: keyCodes.arrowright,
  344. preventDefault: sinon.spy()
  345. };
  346. setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
  347. viewDocument.on( 'keydown', keydownHandler );
  348. viewDocument.fire( 'keydown', domEventDataMock );
  349. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  350. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  351. sinon.assert.notCalled( keydownHandler );
  352. } );
  353. it( 'should prevent default behaviour when there is no correct location - document start', () => {
  354. const keydownHandler = sinon.spy();
  355. const domEventDataMock = {
  356. keyCode: keyCodes.arrowleft,
  357. preventDefault: sinon.spy()
  358. };
  359. setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
  360. viewDocument.on( 'keydown', keydownHandler );
  361. viewDocument.fire( 'keydown', domEventDataMock );
  362. expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
  363. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  364. sinon.assert.notCalled( keydownHandler );
  365. } );
  366. test(
  367. 'should move selection to object element - right arrow',
  368. '<paragraph>foo[]</paragraph><widget></widget>',
  369. keyCodes.arrowright,
  370. '<paragraph>foo</paragraph>[<widget></widget>]'
  371. );
  372. test(
  373. 'should move selection to object element - down arrow',
  374. '<paragraph>foo[]</paragraph><widget></widget>',
  375. keyCodes.arrowdown,
  376. '<paragraph>foo</paragraph>[<widget></widget>]'
  377. );
  378. test(
  379. 'should move selection to object element - left arrow',
  380. '<widget></widget><paragraph>[]foo</paragraph>',
  381. keyCodes.arrowleft,
  382. '[<widget></widget>]<paragraph>foo</paragraph>'
  383. );
  384. test(
  385. 'should move selection to object element - up arrow',
  386. '<widget></widget><paragraph>[]foo</paragraph>',
  387. keyCodes.arrowup,
  388. '[<widget></widget>]<paragraph>foo</paragraph>'
  389. );
  390. test(
  391. 'do nothing on non objects - right arrow',
  392. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  393. keyCodes.arrowright,
  394. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  395. );
  396. test(
  397. 'do nothing on non objects - down arrow',
  398. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  399. keyCodes.arrowdown,
  400. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  401. );
  402. test(
  403. 'do nothing on non objects - left arrow',
  404. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  405. keyCodes.arrowleft,
  406. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  407. );
  408. test(
  409. 'do nothing on non objects - up arrow',
  410. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  411. keyCodes.arrowup,
  412. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  413. );
  414. test(
  415. 'should work correctly with modifier key: right arrow + ctrl',
  416. '[<widget></widget>]<paragraph>foo</paragraph>',
  417. { keyCode: keyCodes.arrowright, ctrlKey: true },
  418. '<widget></widget><paragraph>[]foo</paragraph>'
  419. );
  420. test(
  421. 'should work correctly with modifier key: right arrow + alt',
  422. '[<widget></widget>]<paragraph>foo</paragraph>',
  423. { keyCode: keyCodes.arrowright, altKey: true },
  424. '<widget></widget><paragraph>[]foo</paragraph>'
  425. );
  426. test(
  427. 'should work correctly with modifier key: right arrow + shift',
  428. '[<widget></widget>]<paragraph>foo</paragraph>',
  429. { keyCode: keyCodes.arrowright, shiftKey: true },
  430. '<widget></widget><paragraph>[]foo</paragraph>'
  431. );
  432. test(
  433. 'should work correctly with modifier key: down arrow + ctrl',
  434. '[<widget></widget>]<paragraph>foo</paragraph>',
  435. { keyCode: keyCodes.arrowdown, ctrlKey: true },
  436. '<widget></widget><paragraph>[]foo</paragraph>'
  437. );
  438. test(
  439. 'should work correctly with modifier key: down arrow + alt',
  440. '[<widget></widget>]<paragraph>foo</paragraph>',
  441. { keyCode: keyCodes.arrowdown, altKey: true },
  442. '<widget></widget><paragraph>[]foo</paragraph>'
  443. );
  444. test(
  445. 'should work correctly with modifier key: down arrow + shift',
  446. '[<widget></widget>]<paragraph>foo</paragraph>',
  447. { keyCode: keyCodes.arrowdown, shiftKey: true },
  448. '<widget></widget><paragraph>[]foo</paragraph>'
  449. );
  450. test(
  451. 'should work correctly with modifier key: left arrow + ctrl',
  452. '<paragraph>foo</paragraph>[<widget></widget>]',
  453. { keyCode: keyCodes.arrowleft, ctrlKey: true },
  454. '<paragraph>foo[]</paragraph><widget></widget>'
  455. );
  456. test(
  457. 'should work correctly with modifier key: left arrow + alt',
  458. '<paragraph>foo</paragraph>[<widget></widget>]',
  459. { keyCode: keyCodes.arrowleft, altKey: true },
  460. '<paragraph>foo[]</paragraph><widget></widget>'
  461. );
  462. test(
  463. 'should work correctly with modifier key: left arrow + shift',
  464. '<paragraph>foo</paragraph>[<widget></widget>]',
  465. { keyCode: keyCodes.arrowleft, shiftKey: true },
  466. '<paragraph>foo[]</paragraph><widget></widget>'
  467. );
  468. test(
  469. 'should work correctly with modifier key: up arrow + ctrl',
  470. '<paragraph>foo</paragraph>[<widget></widget>]',
  471. { keyCode: keyCodes.arrowup, ctrlKey: true },
  472. '<paragraph>foo[]</paragraph><widget></widget>'
  473. );
  474. test(
  475. 'should work correctly with modifier key: up arrow + alt',
  476. '<paragraph>foo</paragraph>[<widget></widget>]',
  477. { keyCode: keyCodes.arrowup, altKey: true },
  478. '<paragraph>foo[]</paragraph><widget></widget>'
  479. );
  480. test(
  481. 'should work correctly with modifier key: up arrow + shift',
  482. '<paragraph>foo</paragraph>[<widget></widget>]',
  483. { keyCode: keyCodes.arrowup, shiftKey: true },
  484. '<paragraph>foo[]</paragraph><widget></widget>'
  485. );
  486. test(
  487. 'should do nothing if there is more than one selection in model',
  488. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
  489. keyCodes.arrowright,
  490. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
  491. );
  492. test(
  493. 'should work if selection is in nested element (left arrow)',
  494. '<paragraph>foo</paragraph>' +
  495. '<image></image>' +
  496. '<blockQuote>' +
  497. '<div>' +
  498. '<div>' +
  499. '<paragraph>[]</paragraph>' +
  500. '</div>' +
  501. '</div>' +
  502. '</blockQuote>' +
  503. '<paragraph>foo</paragraph>',
  504. keyCodes.arrowleft,
  505. '<paragraph>foo</paragraph>' +
  506. '[<image></image>]' +
  507. '<blockQuote>' +
  508. '<div>' +
  509. '<div>' +
  510. '<paragraph></paragraph>' +
  511. '</div>' +
  512. '</div>' +
  513. '</blockQuote>' +
  514. '<paragraph>foo</paragraph>'
  515. );
  516. test(
  517. 'should work if selection is in nested element (up arrow)',
  518. '<paragraph>foo</paragraph>' +
  519. '<image></image>' +
  520. '<blockQuote>' +
  521. '<div>' +
  522. '<div>' +
  523. '<paragraph>[]</paragraph>' +
  524. '</div>' +
  525. '</div>' +
  526. '</blockQuote>' +
  527. '<paragraph>foo</paragraph>',
  528. keyCodes.arrowup,
  529. '<paragraph>foo</paragraph>' +
  530. '[<image></image>]' +
  531. '<blockQuote>' +
  532. '<div>' +
  533. '<div>' +
  534. '<paragraph></paragraph>' +
  535. '</div>' +
  536. '</div>' +
  537. '</blockQuote>' +
  538. '<paragraph>foo</paragraph>'
  539. );
  540. test(
  541. 'should work if selection is in nested element (right arrow)',
  542. '<paragraph>foo</paragraph>' +
  543. '<blockQuote>' +
  544. '<div>' +
  545. '<div>' +
  546. '<paragraph>[]</paragraph>' +
  547. '</div>' +
  548. '</div>' +
  549. '</blockQuote>' +
  550. '<image></image>' +
  551. '<paragraph>foo</paragraph>',
  552. keyCodes.arrowright,
  553. '<paragraph>foo</paragraph>' +
  554. '<blockQuote>' +
  555. '<div>' +
  556. '<div>' +
  557. '<paragraph></paragraph>' +
  558. '</div>' +
  559. '</div>' +
  560. '</blockQuote>' +
  561. '[<image></image>]' +
  562. '<paragraph>foo</paragraph>'
  563. );
  564. test(
  565. 'should work if selection is in nested element (down arrow)',
  566. '<paragraph>foo</paragraph>' +
  567. '<blockQuote>' +
  568. '<div>' +
  569. '<div>' +
  570. '<paragraph>[]</paragraph>' +
  571. '</div>' +
  572. '</div>' +
  573. '</blockQuote>' +
  574. '<image></image>' +
  575. '<paragraph>foo</paragraph>',
  576. keyCodes.arrowdown,
  577. '<paragraph>foo</paragraph>' +
  578. '<blockQuote>' +
  579. '<div>' +
  580. '<div>' +
  581. '<paragraph></paragraph>' +
  582. '</div>' +
  583. '</div>' +
  584. '</blockQuote>' +
  585. '[<image></image>]' +
  586. '<paragraph>foo</paragraph>'
  587. );
  588. describe( 'RTL (right-to-left) content', () => {
  589. test(
  590. 'should move selection forward from selected object - left arrow',
  591. '[<widget></widget>]<paragraph>foo</paragraph>',
  592. keyCodes.arrowleft,
  593. '<widget></widget><paragraph>[]foo</paragraph>',
  594. null,
  595. 'rtl'
  596. );
  597. test(
  598. 'should move selection backward from selected object - right arrow',
  599. '<paragraph>foo</paragraph>[<widget></widget>]',
  600. keyCodes.arrowright,
  601. '<paragraph>foo[]</paragraph><widget></widget>',
  602. null,
  603. 'rtl'
  604. );
  605. test(
  606. 'should move selection to next widget - left arrow',
  607. '[<widget></widget>]<widget></widget>',
  608. keyCodes.arrowleft,
  609. '<widget></widget>[<widget></widget>]',
  610. null,
  611. 'rtl'
  612. );
  613. test(
  614. 'should move selection to previous widget - right arrow',
  615. '<widget></widget>[<widget></widget>]',
  616. keyCodes.arrowright,
  617. '[<widget></widget>]<widget></widget>',
  618. null,
  619. 'rtl'
  620. );
  621. } );
  622. } );
  623. describe( 'enter', () => {
  624. test(
  625. 'should insert a paragraph after the selected widget upon Enter',
  626. '[<widget></widget>]',
  627. keyCodes.enter,
  628. '<widget></widget><paragraph>[]</paragraph>'
  629. );
  630. test(
  631. 'should insert a paragraph before the selected widget upon Shift+Enter',
  632. '[<widget></widget>]',
  633. { keyCode: keyCodes.enter, shiftKey: true },
  634. '<paragraph>[]</paragraph><widget></widget>'
  635. );
  636. test(
  637. 'should insert a paragraph when not a first-child of the root',
  638. '[<widget></widget>]<paragraph>foo</paragraph>',
  639. keyCodes.enter,
  640. '<widget></widget><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  641. );
  642. test(
  643. 'should insert a paragraph when not a last-child of the root',
  644. '<paragraph>foo</paragraph>[<widget></widget>]',
  645. { keyCode: keyCodes.enter, shiftKey: true },
  646. '<paragraph>foo</paragraph><paragraph>[]</paragraph><widget></widget>'
  647. );
  648. test(
  649. 'should insert a paragraph only when an entire widget is selected (#1)',
  650. '<widget><nested>[foo] bar</nested></widget>',
  651. keyCodes.enter,
  652. '<widget><nested>[] bar</nested></widget>'
  653. );
  654. test(
  655. 'should insert a paragraph only when an entire widget is selected (#2)',
  656. '<paragraph>f[oo</paragraph><widget></widget><paragraph>b]ar</paragraph>',
  657. keyCodes.enter,
  658. '<paragraph>f[]ar</paragraph>'
  659. );
  660. // https://github.com/ckeditor/ckeditor5/issues/1529
  661. it( 'should split parent when widget is inside a block element', () => {
  662. model.schema.register( 'allowP', {
  663. inheritAllFrom: '$block'
  664. } );
  665. model.schema.register( 'disallowP', {
  666. inheritAllFrom: '$block',
  667. allowIn: [ 'allowP' ]
  668. } );
  669. model.schema.extend( 'widget', {
  670. allowIn: [ 'allowP', 'disallowP' ]
  671. } );
  672. model.schema.extend( 'paragraph', {
  673. allowIn: [ 'allowP' ]
  674. } );
  675. editor.conversion.for( 'downcast' ).elementToElement( { model: 'parent', view: 'parent' } );
  676. editor.conversion.for( 'downcast' ).elementToElement( { model: 'allowP', view: 'allowP' } );
  677. editor.conversion.for( 'downcast' ).elementToElement( { model: 'disallowP', view: 'disallowP' } );
  678. setModelData( model, '<allowP><disallowP>[<widget></widget>]</disallowP></allowP>' );
  679. viewDocument.fire( 'keydown', new DomEventData(
  680. viewDocument,
  681. { target: document.createElement( 'div' ), preventDefault() {} },
  682. { keyCode: keyCodes.enter }
  683. ) );
  684. expect( getModelData( model ) ).to.equal(
  685. '<allowP><disallowP><widget></widget></disallowP><paragraph>[]</paragraph><disallowP></disallowP></allowP>'
  686. );
  687. } );
  688. test(
  689. 'should do nothing if selected is inline object',
  690. '<paragraph>foo[<inline-widget></inline-widget>]bar</paragraph>',
  691. keyCodes.enter,
  692. '<paragraph>foo[]bar</paragraph>'
  693. );
  694. test(
  695. 'should insert a paragraph after the selected widget inside an element that is not a block upon Enter',
  696. '<blockQuote>[<widget></widget>]</blockQuote>',
  697. keyCodes.enter,
  698. '<blockQuote><widget></widget><paragraph>[]</paragraph></blockQuote>'
  699. );
  700. test(
  701. 'should insert a paragraph before the selected widget inside an element that is not a block upon Shift+Enter',
  702. '<blockQuote>[<widget></widget>]</blockQuote>',
  703. { keyCode: keyCodes.enter, shiftKey: true },
  704. '<blockQuote><paragraph>[]</paragraph><widget></widget></blockQuote>'
  705. );
  706. } );
  707. function test( name, data, keyCodeOrMock, expected, expectedView, contentLanguageDirection = 'ltr' ) {
  708. it( name, () => {
  709. testUtils.sinon.stub( editor.locale, 'contentLanguageDirection' ).value( contentLanguageDirection );
  710. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  711. keyCode: keyCodeOrMock
  712. };
  713. setModelData( model, data );
  714. viewDocument.fire( 'keydown', new DomEventData(
  715. viewDocument,
  716. { target: document.createElement( 'div' ), preventDefault() {} },
  717. domEventDataMock
  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: [ 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_can-type-around_after ck-widget_can-type-around_before ' +
  1135. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1136. '>' +
  1137. '<div class="' +
  1138. 'ck-widget ' +
  1139. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1140. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1141. '>' +
  1142. '<div class="ck ck-widget__selection-handle"></div>' +
  1143. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1144. '</div>' +
  1145. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" contenteditable="false">' +
  1146. '<div class="ck ck-widget__selection-handle"></div>' +
  1147. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1148. '</div>' +
  1149. '<div class="ck ck-widget__selection-handle"></div>' +
  1150. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1151. '</div>]'
  1152. );
  1153. } );
  1154. it( 'should select a proper widget if they are nested and multiplied', () => {
  1155. setModelData( model,
  1156. '<widget></widget>' +
  1157. '<widget>' +
  1158. '<widget></widget>' +
  1159. '<widget></widget>' +
  1160. '</widget>' +
  1161. '<widget></widget>'
  1162. );
  1163. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 );
  1164. const domEventDataMock = new DomEventData( view, {
  1165. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1166. preventDefault: sinon.spy()
  1167. } );
  1168. viewDocument.fire( 'mousedown', domEventDataMock );
  1169. expect( getViewData( view ) ).to.equal(
  1170. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1171. 'contenteditable="false">' +
  1172. '<div class="ck ck-widget__selection-handle"></div>' +
  1173. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1174. '</div>' +
  1175. '[<div class="' +
  1176. 'ck-widget ' +
  1177. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1178. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1179. '>' +
  1180. '<div ' +
  1181. 'class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1182. 'contenteditable="false">' +
  1183. '<div class="ck ck-widget__selection-handle"></div>' +
  1184. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1185. '</div>' +
  1186. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1187. 'contenteditable="false">' +
  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 class="ck ck-widget__selection-handle"></div>' +
  1192. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1193. '</div>]' +
  1194. '<div ' +
  1195. 'class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1196. 'contenteditable="false">' +
  1197. '<div class="ck ck-widget__selection-handle"></div>' +
  1198. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1199. '</div>'
  1200. );
  1201. } );
  1202. it( 'works fine with a widget that contains more children', () => {
  1203. setModelData( model,
  1204. '<widget>' +
  1205. '<nested>foo bar</nested>' +
  1206. '<widget></widget>' +
  1207. '</widget>'
  1208. );
  1209. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1210. const domEventDataMock = new DomEventData( view, {
  1211. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1212. preventDefault: sinon.spy()
  1213. } );
  1214. viewDocument.fire( 'mousedown', domEventDataMock );
  1215. expect( getViewData( view ) ).to.equal(
  1216. '[<div class="' +
  1217. 'ck-widget ' +
  1218. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1219. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1220. '>' +
  1221. '<figcaption contenteditable="true">foo bar</figcaption>' +
  1222. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1223. '<div class="ck ck-widget__selection-handle"></div>' +
  1224. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1225. '</div>' +
  1226. '<div class="ck ck-widget__selection-handle"></div>' +
  1227. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1228. '</div>]'
  1229. );
  1230. } );
  1231. it( 'should select a proper widget for more complex structures', () => {
  1232. setModelData( model,
  1233. '<widget>' +
  1234. '<widget></widget>' +
  1235. '<widget>' +
  1236. '<widget></widget>' +
  1237. '</widget>' +
  1238. '</widget>'
  1239. );
  1240. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 ).getChild( 1 );
  1241. const domEventDataMock = new DomEventData( view, {
  1242. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1243. preventDefault: sinon.spy()
  1244. } );
  1245. viewDocument.fire( 'mousedown', domEventDataMock );
  1246. expect( getViewData( view ) ).to.equal(
  1247. '<div class="' +
  1248. 'ck-widget ' +
  1249. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1250. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1251. '>' +
  1252. '<div class="' +
  1253. 'ck-widget ' +
  1254. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1255. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1256. '>' +
  1257. '<div class="ck ck-widget__selection-handle"></div>' +
  1258. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1259. '</div>' +
  1260. '[<div class="' +
  1261. 'ck-widget ' +
  1262. 'ck-widget_can-type-around_before ' +
  1263. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1264. '>' +
  1265. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" contenteditable="false">' +
  1266. '<div class="ck ck-widget__selection-handle"></div>' +
  1267. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1268. '</div>' +
  1269. '<div class="ck ck-widget__selection-handle"></div>' +
  1270. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1271. '</div>]' +
  1272. '<div class="ck ck-widget__selection-handle"></div>' +
  1273. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1274. '</div>'
  1275. );
  1276. } );
  1277. it( 'should select widget in editable', () => {
  1278. model.schema.extend( 'widget', { allowIn: 'nested' } );
  1279. setModelData( model, '[]<widget><nested><widget></widget></nested></widget>' );
  1280. const widgetInEditable = viewDocument.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 );
  1281. const domEventDataMock = new DomEventData( view, {
  1282. target: view.domConverter.mapViewToDom( widgetInEditable ),
  1283. preventDefault: sinon.spy()
  1284. } );
  1285. viewDocument.fire( 'mousedown', domEventDataMock );
  1286. expect( getViewData( view ) ).to.equal(
  1287. '<div class="' +
  1288. 'ck-widget ' +
  1289. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1290. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1291. '>' +
  1292. '<figcaption contenteditable="true">[' +
  1293. '<div class="' +
  1294. 'ck-widget ' +
  1295. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1296. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1297. '>' +
  1298. '<div class="ck ck-widget__selection-handle"></div>' +
  1299. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1300. '</div>]' +
  1301. '</figcaption>' +
  1302. '<div class="ck ck-widget__selection-handle"></div>' +
  1303. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1304. '</div>'
  1305. );
  1306. } );
  1307. } );
  1308. } );