8
0

widget.js 43 KB

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