widget.js 44 KB

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