widget.js 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470
  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( 'Ctrl+A', () => {
  594. test(
  595. 'should select the entire content of the nested editable',
  596. '<widget><nested>foo[]</nested></widget><paragraph>bar</paragraph>',
  597. { keyCode: keyCodes.a, ctrlKey: true },
  598. '<widget><nested>[foo]</nested></widget><paragraph>bar</paragraph>'
  599. );
  600. test(
  601. 'should not change the selection if outside of the nested editable',
  602. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>',
  603. { keyCode: keyCodes.a, ctrlKey: true },
  604. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>'
  605. );
  606. test(
  607. 'should selected whole content when widget is selected',
  608. '<paragraph>foo</paragraph>[<widget></widget>]<paragraph>bar</paragraph>',
  609. { keyCode: keyCodes.a, ctrlKey: true },
  610. '<paragraph>[foo</paragraph><widget></widget><paragraph>bar]</paragraph>',
  611. '<p>{foo</p><div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div><p>bar}</p>'
  612. );
  613. } );
  614. describe( 'enter', () => {
  615. test(
  616. 'should insert a paragraph after the selected widget upon Enter',
  617. '[<widget></widget>]',
  618. keyCodes.enter,
  619. '<widget></widget><paragraph>[]</paragraph>'
  620. );
  621. test(
  622. 'should insert a paragraph before the selected widget upon Shift+Enter',
  623. '[<widget></widget>]',
  624. { keyCode: keyCodes.enter, shiftKey: true },
  625. '<paragraph>[]</paragraph><widget></widget>'
  626. );
  627. test(
  628. 'should insert a paragraph when not a first-child of the root',
  629. '[<widget></widget>]<paragraph>foo</paragraph>',
  630. keyCodes.enter,
  631. '<widget></widget><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  632. );
  633. test(
  634. 'should insert a paragraph when not a last-child of the root',
  635. '<paragraph>foo</paragraph>[<widget></widget>]',
  636. { keyCode: keyCodes.enter, shiftKey: true },
  637. '<paragraph>foo</paragraph><paragraph>[]</paragraph><widget></widget>'
  638. );
  639. test(
  640. 'should insert a paragraph only when an entire widget is selected (#1)',
  641. '<widget><nested>[foo] bar</nested></widget>',
  642. keyCodes.enter,
  643. '<widget><nested>[] bar</nested></widget>'
  644. );
  645. test(
  646. 'should insert a paragraph only when an entire widget is selected (#2)',
  647. '<paragraph>f[oo</paragraph><widget></widget><paragraph>b]ar</paragraph>',
  648. keyCodes.enter,
  649. '<paragraph>f[]ar</paragraph>'
  650. );
  651. // https://github.com/ckeditor/ckeditor5/issues/1529
  652. it( 'should split parent when widget is inside a block element', () => {
  653. model.schema.register( 'allowP', {
  654. inheritAllFrom: '$block'
  655. } );
  656. model.schema.register( 'disallowP', {
  657. inheritAllFrom: '$block',
  658. allowIn: [ 'allowP' ]
  659. } );
  660. model.schema.extend( 'widget', {
  661. allowIn: [ 'allowP', 'disallowP' ]
  662. } );
  663. model.schema.extend( 'paragraph', {
  664. allowIn: [ 'allowP' ]
  665. } );
  666. editor.conversion.for( 'downcast' ).elementToElement( { model: 'parent', view: 'parent' } );
  667. editor.conversion.for( 'downcast' ).elementToElement( { model: 'allowP', view: 'allowP' } );
  668. editor.conversion.for( 'downcast' ).elementToElement( { model: 'disallowP', view: 'disallowP' } );
  669. setModelData( model, '<allowP><disallowP>[<widget></widget>]</disallowP></allowP>' );
  670. viewDocument.fire( 'keydown', new DomEventData(
  671. viewDocument,
  672. { target: document.createElement( 'div' ), preventDefault() {} },
  673. { keyCode: keyCodes.enter }
  674. ) );
  675. expect( getModelData( model ) ).to.equal(
  676. '<allowP><disallowP><widget></widget></disallowP><paragraph>[]</paragraph><disallowP></disallowP></allowP>'
  677. );
  678. } );
  679. test(
  680. 'should do nothing if selected is inline object',
  681. '<paragraph>foo[<inline-widget></inline-widget>]bar</paragraph>',
  682. keyCodes.enter,
  683. '<paragraph>foo[]bar</paragraph>'
  684. );
  685. test(
  686. 'should insert a paragraph after the selected widget inside an element that is not a block upon Enter',
  687. '<blockQuote>[<widget></widget>]</blockQuote>',
  688. keyCodes.enter,
  689. '<blockQuote><widget></widget><paragraph>[]</paragraph></blockQuote>'
  690. );
  691. test(
  692. 'should insert a paragraph before the selected widget inside an element that is not a block upon Shift+Enter',
  693. '<blockQuote>[<widget></widget>]</blockQuote>',
  694. { keyCode: keyCodes.enter, shiftKey: true },
  695. '<blockQuote><paragraph>[]</paragraph><widget></widget></blockQuote>'
  696. );
  697. } );
  698. function test( name, data, keyCodeOrMock, expected, expectedView, contentLanguageDirection = 'ltr' ) {
  699. it( name, () => {
  700. testUtils.sinon.stub( editor.locale, 'contentLanguageDirection' ).value( contentLanguageDirection );
  701. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  702. keyCode: keyCodeOrMock
  703. };
  704. setModelData( model, data );
  705. viewDocument.fire( 'keydown', new DomEventData(
  706. viewDocument,
  707. { target: document.createElement( 'div' ), preventDefault() {} },
  708. domEventDataMock
  709. ) );
  710. expect( getModelData( model ) ).to.equal( expected );
  711. if ( expectedView ) {
  712. expect( getViewData( view ) ).to.equal( expectedView );
  713. }
  714. } );
  715. }
  716. } );
  717. describe( 'delete integration', () => {
  718. function test( name, input, direction, expected ) {
  719. it( name, () => {
  720. setModelData( model, input );
  721. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  722. const domEventDataMock = {
  723. keyCode: direction == 'backward' ? keyCodes.backspace : keyCodes.delete
  724. };
  725. viewDocument.fire( 'keydown', new DomEventData(
  726. viewDocument,
  727. { target: document.createElement( 'div' ), preventDefault() {} },
  728. domEventDataMock
  729. ) );
  730. expect( getModelData( model ) ).to.equal( expected );
  731. scrollStub.restore();
  732. } );
  733. }
  734. // Let's make this integration tests real which will help covering
  735. // cases like https://github.com/ckeditor/ckeditor5/issues/753.
  736. // Originally, this test file used the Delete feature only which was not "integrational" enough.
  737. it( 'tests are executed with the Typing feature', () => {
  738. expect( editor.plugins.get( 'Typing' ) ).to.not.be.undefined;
  739. } );
  740. test(
  741. 'should select widget when backspace is pressed',
  742. '<widget></widget><paragraph>[]foo</paragraph>',
  743. 'backward',
  744. '[<widget></widget>]<paragraph>foo</paragraph>'
  745. );
  746. test(
  747. 'should remove empty element after selecting widget when backspace is pressed',
  748. '<widget></widget><paragraph>[]</paragraph>',
  749. 'backward',
  750. '[<widget></widget>]'
  751. );
  752. test(
  753. 'should select widget when delete is pressed',
  754. '<paragraph>foo[]</paragraph><widget></widget>',
  755. 'forward',
  756. '<paragraph>foo</paragraph>[<widget></widget>]'
  757. );
  758. test(
  759. 'should remove empty element after selecting widget when delete is pressed',
  760. '<paragraph>[]</paragraph><widget></widget>',
  761. 'forward',
  762. '[<widget></widget>]'
  763. );
  764. test(
  765. 'should not select widget on non-collapsed selection',
  766. '<widget></widget><paragraph>[f]oo</paragraph>',
  767. 'backward',
  768. '<widget></widget><paragraph>[]oo</paragraph>'
  769. );
  770. test(
  771. 'should not affect non-object elements',
  772. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  773. 'backward',
  774. '<paragraph>foo[]bar</paragraph>'
  775. );
  776. test(
  777. 'should not modify backward delete default behaviour in single paragraph boundaries',
  778. '<paragraph>[]foo</paragraph>',
  779. 'backward',
  780. '<paragraph>[]foo</paragraph>'
  781. );
  782. test(
  783. 'should not modify forward delete default behaviour in single paragraph boundaries',
  784. '<paragraph>foo[]</paragraph>',
  785. 'forward',
  786. '<paragraph>foo[]</paragraph>'
  787. );
  788. test(
  789. 'should delete selected widget with paragraph before - backward',
  790. '<paragraph>foo</paragraph>[<widget></widget>]',
  791. 'backward',
  792. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  793. );
  794. test(
  795. 'should delete selected widget with paragraph before - forward',
  796. '<paragraph>foo</paragraph>[<widget></widget>]',
  797. 'forward',
  798. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  799. );
  800. test(
  801. 'should delete selected widget with paragraph after - backward',
  802. '[<widget></widget>]<paragraph>foo</paragraph>',
  803. 'backward',
  804. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  805. );
  806. test(
  807. 'should delete selected widget with paragraph after - forward',
  808. '[<widget></widget>]<paragraph>foo</paragraph>',
  809. 'forward',
  810. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  811. );
  812. test(
  813. 'should delete selected widget between paragraphs - backward',
  814. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  815. 'backward',
  816. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  817. );
  818. test(
  819. 'should delete selected widget between paragraphs - forward',
  820. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  821. 'forward',
  822. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  823. );
  824. test(
  825. 'should delete selected widget preceded by another widget - backward',
  826. '<widget></widget>[<widget></widget>]',
  827. 'backward',
  828. '<widget></widget><paragraph>[]</paragraph>'
  829. );
  830. test(
  831. 'should delete selected widget preceded by another widget - forward',
  832. '<widget></widget>[<widget></widget>]',
  833. 'forward',
  834. '<widget></widget><paragraph>[]</paragraph>'
  835. );
  836. test(
  837. 'should delete selected widget before another widget - forward',
  838. '[<widget></widget>]<widget></widget>',
  839. 'forward',
  840. '<paragraph>[]</paragraph><widget></widget>'
  841. );
  842. test(
  843. 'should delete selected widget before another widget - backward',
  844. '[<widget></widget>]<widget></widget>',
  845. 'backward',
  846. '<paragraph>[]</paragraph><widget></widget>'
  847. );
  848. test(
  849. 'should delete selected widget between other widgets - forward',
  850. '<widget></widget>[<widget></widget>]<widget></widget>',
  851. 'forward',
  852. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  853. );
  854. test(
  855. 'should delete selected widget between other widgets - backward',
  856. '<widget></widget>[<widget></widget>]<widget></widget>',
  857. 'backward',
  858. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  859. );
  860. test(
  861. 'should select inline objects - backward',
  862. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  863. 'backward',
  864. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  865. );
  866. test(
  867. 'should select inline objects - forward',
  868. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  869. 'forward',
  870. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  871. );
  872. test(
  873. 'should delete selected inline objects - backward',
  874. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  875. 'backward',
  876. '<paragraph>foo[]bar</paragraph>'
  877. );
  878. test(
  879. 'should delete selected inline objects - forward',
  880. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  881. 'forward',
  882. '<paragraph>foo[]bar</paragraph>'
  883. );
  884. test(
  885. 'should use standard delete behaviour when after first letter - backward',
  886. '<paragraph>a[]</paragraph>',
  887. 'backward',
  888. '<paragraph>[]</paragraph>'
  889. );
  890. test(
  891. 'should use standard delete behaviour when before first letter - forward',
  892. '<paragraph>[]a</paragraph>',
  893. 'forward',
  894. '<paragraph>[]</paragraph>'
  895. );
  896. it( 'should prevent default behaviour and stop event propagation', () => {
  897. setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
  898. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  899. const deleteSpy = sinon.spy();
  900. viewDocument.on( 'delete', deleteSpy );
  901. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  902. viewDocument.fire( 'delete', new DomEventData(
  903. viewDocument,
  904. domEventDataMock,
  905. { direction: 'forward', unit: 'character', sequence: 0 }
  906. ) );
  907. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  908. sinon.assert.notCalled( deleteSpy );
  909. scrollStub.restore();
  910. } );
  911. test(
  912. 'should remove the entire empty element if it is next to a widget',
  913. '<paragraph>foo</paragraph>' +
  914. '<image></image>' +
  915. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  916. '<paragraph>foo</paragraph>',
  917. 'backward',
  918. '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
  919. );
  920. test(
  921. 'should remove the entire empty element (deeper structure) if it is next to a widget',
  922. '<paragraph>foo</paragraph>' +
  923. '<image></image>' +
  924. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  925. '<paragraph>foo</paragraph>',
  926. 'backward',
  927. '<paragraph>foo</paragraph>' +
  928. '[<image></image>]' +
  929. '<paragraph>foo</paragraph>'
  930. );
  931. test(
  932. 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
  933. '<paragraph>foo</paragraph>' +
  934. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  935. '<image></image>' +
  936. '<paragraph>foo</paragraph>',
  937. 'forward',
  938. '<paragraph>foo</paragraph>' +
  939. '[<image></image>]' +
  940. '<paragraph>foo</paragraph>'
  941. );
  942. test(
  943. 'should not remove the entire element which is not empty and the element is next to a widget',
  944. '<paragraph>foo</paragraph>' +
  945. '<image></image>' +
  946. '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
  947. '<paragraph>foo</paragraph>',
  948. 'backward',
  949. '<paragraph>foo</paragraph>' +
  950. '[<image></image>]' +
  951. '<blockQuote><paragraph></paragraph></blockQuote>' +
  952. '<paragraph>foo</paragraph>'
  953. );
  954. test(
  955. 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
  956. '<paragraph>foo</paragraph>' +
  957. '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
  958. '<image></image>' +
  959. '<paragraph>foo</paragraph>',
  960. 'forward',
  961. '<paragraph>foo</paragraph>' +
  962. '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
  963. '[<image></image>]' +
  964. '<paragraph>foo</paragraph>'
  965. );
  966. test(
  967. 'should not remove the entire element (deeper structure) which 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>[]</paragraph>' +
  974. '</div>' +
  975. '</div>' +
  976. '<paragraph></paragraph>' +
  977. '</blockQuote>' +
  978. '<paragraph>foo</paragraph>',
  979. 'backward',
  980. '<paragraph>foo</paragraph>' +
  981. '[<image></image>]' +
  982. '<blockQuote>' +
  983. '<paragraph></paragraph>' +
  984. '</blockQuote>' +
  985. '<paragraph>foo</paragraph>'
  986. );
  987. test(
  988. 'should do nothing if the nested element is not empty and the element is next to a widget',
  989. '<paragraph>foo</paragraph>' +
  990. '<image></image>' +
  991. '<blockQuote>' +
  992. '<div>' +
  993. '<div>' +
  994. '<paragraph>Foo[]</paragraph>' +
  995. '</div>' +
  996. '</div>' +
  997. '</blockQuote>' +
  998. '<paragraph>foo</paragraph>',
  999. 'backward',
  1000. '<paragraph>foo</paragraph>' +
  1001. '<image></image>' +
  1002. '<blockQuote>' +
  1003. '<div>' +
  1004. '<div>' +
  1005. '<paragraph>Fo[]</paragraph>' +
  1006. '</div>' +
  1007. '</div>' +
  1008. '</blockQuote>' +
  1009. '<paragraph>foo</paragraph>'
  1010. );
  1011. it( 'does nothing when editor when read only mode is enabled (delete)', () => {
  1012. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1013. setModelData( model,
  1014. '<paragraph>foo</paragraph>' +
  1015. '<image></image>' +
  1016. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1017. '<paragraph>foo</paragraph>'
  1018. );
  1019. editor.isReadOnly = true;
  1020. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1021. viewDocument.fire( 'delete', new DomEventData(
  1022. viewDocument,
  1023. domEventDataMock,
  1024. { direction: 'backward', unit: 'character', sequence: 0 }
  1025. ) );
  1026. expect( getModelData( model ) ).to.equal(
  1027. '<paragraph>foo</paragraph>' +
  1028. '<image></image>' +
  1029. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1030. '<paragraph>foo</paragraph>'
  1031. );
  1032. scrollStub.restore();
  1033. } );
  1034. it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
  1035. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1036. setModelData( model,
  1037. '<paragraph>foo</paragraph>' +
  1038. '<image></image>' +
  1039. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1040. '<paragraph>foo</paragraph>'
  1041. );
  1042. editor.isReadOnly = true;
  1043. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1044. viewDocument.fire( 'delete', new DomEventData(
  1045. viewDocument,
  1046. domEventDataMock,
  1047. { direction: 'forward', unit: 'character', sequence: 0 }
  1048. ) );
  1049. expect( getModelData( model ) ).to.equal(
  1050. '<paragraph>foo</paragraph>' +
  1051. '<image></image>' +
  1052. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1053. '<paragraph>foo</paragraph>'
  1054. );
  1055. scrollStub.restore();
  1056. } );
  1057. } );
  1058. describe( 'selection handle', () => {
  1059. beforeEach( () => {
  1060. return VirtualTestEditor.create( { plugins: [ Widget, Typing ] } )
  1061. .then( newEditor => {
  1062. editor = newEditor;
  1063. model = editor.model;
  1064. view = editor.editing.view;
  1065. viewDocument = view.document;
  1066. model.schema.register( 'widget', {
  1067. inheritAllFrom: '$block',
  1068. allowIn: 'widget',
  1069. isObject: true
  1070. } );
  1071. model.schema.register( 'paragraph', {
  1072. inheritAllFrom: '$block'
  1073. } );
  1074. model.schema.register( 'nested', {
  1075. allowIn: 'widget',
  1076. isLimit: true
  1077. } );
  1078. model.schema.extend( '$text', {
  1079. allowIn: 'nested'
  1080. } );
  1081. editor.conversion.for( 'downcast' )
  1082. .elementToElement( { model: 'paragraph', view: 'p' } )
  1083. .elementToElement( {
  1084. model: 'widget',
  1085. view: ( modelItem, viewWriter ) => {
  1086. const widget = viewWriter.createContainerElement( 'div' );
  1087. return toWidget( widget, viewWriter, { hasSelectionHandle: true } );
  1088. }
  1089. } )
  1090. .elementToElement( {
  1091. model: 'nested',
  1092. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  1093. } );
  1094. } );
  1095. } );
  1096. it( 'should select a widget on mouse click', () => {
  1097. setModelData( model, '<paragraph>bar</paragraph><widget></widget><paragraph>foo[]</paragraph>' );
  1098. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  1099. const domEventDataMock = {
  1100. target: viewWidgetSelectionHandle,
  1101. preventDefault: sinon.spy()
  1102. };
  1103. viewDocument.fire( 'mousedown', domEventDataMock );
  1104. expect( getModelData( model ) ).to.equal( '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>' );
  1105. } );
  1106. it( 'should select the most top-outer widget if widgets are nested', () => {
  1107. setModelData( model, '<widget><widget></widget><widget></widget></widget>' );
  1108. // The top-outer widget.
  1109. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1110. const domEventDataMock = {
  1111. target: viewWidgetSelectionHandle,
  1112. preventDefault: sinon.spy()
  1113. };
  1114. viewDocument.fire( 'mousedown', domEventDataMock );
  1115. expect( getViewData( view ) ).to.equal(
  1116. '[<div class="ck-widget ck-widget_selected ck-widget_with-selection-handle" contenteditable="false">' +
  1117. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1118. '<div class="ck ck-widget__selection-handle"></div>' +
  1119. '</div>' +
  1120. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1121. '<div class="ck ck-widget__selection-handle"></div>' +
  1122. '</div>' +
  1123. '<div class="ck ck-widget__selection-handle"></div>' +
  1124. '</div>]'
  1125. );
  1126. } );
  1127. it( 'should select a proper widget if they are nested and multiplied', () => {
  1128. setModelData( model,
  1129. '<widget></widget>' +
  1130. '<widget>' +
  1131. '<widget></widget>' +
  1132. '<widget></widget>' +
  1133. '</widget>' +
  1134. '<widget></widget>'
  1135. );
  1136. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 );
  1137. const domEventDataMock = {
  1138. target: viewWidgetSelectionHandle,
  1139. preventDefault: sinon.spy()
  1140. };
  1141. viewDocument.fire( 'mousedown', domEventDataMock );
  1142. expect( getViewData( view ) ).to.equal(
  1143. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1144. '<div class="ck ck-widget__selection-handle"></div>' +
  1145. '</div>' +
  1146. '[<div class="ck-widget ck-widget_selected ck-widget_with-selection-handle" contenteditable="false">' +
  1147. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1148. '<div class="ck ck-widget__selection-handle"></div>' +
  1149. '</div>' +
  1150. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1151. '<div class="ck ck-widget__selection-handle"></div>' +
  1152. '</div>' +
  1153. '<div class="ck ck-widget__selection-handle"></div>' +
  1154. '</div>]' +
  1155. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1156. '<div class="ck ck-widget__selection-handle"></div>' +
  1157. '</div>'
  1158. );
  1159. } );
  1160. it( 'works fine with a widget that contains more children', () => {
  1161. setModelData( model,
  1162. '<widget>' +
  1163. '<nested>foo bar</nested>' +
  1164. '<widget></widget>' +
  1165. '</widget>'
  1166. );
  1167. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1168. const domEventDataMock = {
  1169. target: viewWidgetSelectionHandle,
  1170. preventDefault: sinon.spy()
  1171. };
  1172. viewDocument.fire( 'mousedown', domEventDataMock );
  1173. expect( getViewData( view ) ).to.equal(
  1174. '[<div class="ck-widget ck-widget_selected ck-widget_with-selection-handle" contenteditable="false">' +
  1175. '<figcaption contenteditable="true">foo bar</figcaption>' +
  1176. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1177. '<div class="ck ck-widget__selection-handle"></div>' +
  1178. '</div>' +
  1179. '<div class="ck ck-widget__selection-handle"></div>' +
  1180. '</div>]'
  1181. );
  1182. } );
  1183. it( 'should select a proper widget for more complex structures', () => {
  1184. setModelData( model,
  1185. '<widget>' +
  1186. '<widget></widget>' +
  1187. '<widget>' +
  1188. '<widget></widget>' +
  1189. '</widget>' +
  1190. '</widget>'
  1191. );
  1192. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 ).getChild( 1 );
  1193. const domEventDataMock = {
  1194. target: viewWidgetSelectionHandle,
  1195. preventDefault: sinon.spy()
  1196. };
  1197. viewDocument.fire( 'mousedown', domEventDataMock );
  1198. expect( getViewData( view ) ).to.equal(
  1199. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1200. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1201. '<div class="ck ck-widget__selection-handle"></div>' +
  1202. '</div>' +
  1203. '[<div class="ck-widget ck-widget_selected ck-widget_with-selection-handle" contenteditable="false">' +
  1204. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1205. '<div class="ck ck-widget__selection-handle"></div>' +
  1206. '</div>' +
  1207. '<div class="ck ck-widget__selection-handle"></div>' +
  1208. '</div>]' +
  1209. '<div class="ck ck-widget__selection-handle"></div>' +
  1210. '</div>'
  1211. );
  1212. } );
  1213. it( 'should select widget in editable', () => {
  1214. model.schema.extend( 'widget', { allowIn: 'nested' } );
  1215. setModelData( model, '[]<widget><nested><widget></widget></nested></widget>' );
  1216. const widgetInEditable = viewDocument.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 );
  1217. const domEventDataMock = {
  1218. target: widgetInEditable,
  1219. preventDefault: sinon.spy()
  1220. };
  1221. viewDocument.fire( 'mousedown', domEventDataMock );
  1222. expect( getViewData( view ) ).to.equal(
  1223. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1224. '<figcaption contenteditable="true">' +
  1225. '[<div class="ck-widget ck-widget_selected ck-widget_with-selection-handle" contenteditable="false">' +
  1226. '<div class="ck ck-widget__selection-handle"></div>' +
  1227. '</div>]' +
  1228. '</figcaption>' +
  1229. '<div class="ck ck-widget__selection-handle"></div>' +
  1230. '</div>'
  1231. );
  1232. } );
  1233. } );
  1234. } );