widget.js 47 KB

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