8
0

tableediting.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  8. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  9. import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
  10. import TableEditing from '../src/tableediting';
  11. import { formatTable, formattedModelTable, modelTable } from './_utils/utils';
  12. import InsertRowCommand from '../src/commands/insertrowcommand';
  13. import InsertTableCommand from '../src/commands/inserttablecommand';
  14. import InsertColumnCommand from '../src/commands/insertcolumncommand';
  15. import RemoveRowCommand from '../src/commands/removerowcommand';
  16. import RemoveColumnCommand from '../src/commands/removecolumncommand';
  17. import SplitCellCommand from '../src/commands/splitcellcommand';
  18. import MergeCellCommand from '../src/commands/mergecellcommand';
  19. import SetHeaderRowCommand from '../src/commands/setheaderrowcommand';
  20. import SetHeaderColumnCommand from '../src/commands/setheadercolumncommand';
  21. import MediaEmbedEditing from '@ckeditor/ckeditor5-media-embed/src/mediaembedediting';
  22. describe( 'TableEditing', () => {
  23. let editor, model;
  24. beforeEach( () => {
  25. return VirtualTestEditor
  26. .create( {
  27. plugins: [ TableEditing, Paragraph, ImageEditing, MediaEmbedEditing ]
  28. } )
  29. .then( newEditor => {
  30. editor = newEditor;
  31. model = editor.model;
  32. } );
  33. } );
  34. afterEach( () => {
  35. editor.destroy();
  36. } );
  37. it( 'should set proper schema rules', () => {
  38. // Table:
  39. expect( model.schema.isRegistered( 'table' ) ).to.be.true;
  40. expect( model.schema.isObject( 'table' ) ).to.be.true;
  41. expect( model.schema.isBlock( 'table' ) ).to.be.true;
  42. expect( model.schema.isLimit( 'table' ) ).to.be.true;
  43. expect( model.schema.checkChild( [ '$root' ], 'table' ) ).to.be.true;
  44. expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingRows' ) ).to.be.true;
  45. expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingColumns' ) ).to.be.true;
  46. // Table row:
  47. expect( model.schema.isRegistered( 'tableRow' ) ).to.be.true;
  48. expect( model.schema.isLimit( 'tableRow' ) ).to.be.true;
  49. expect( model.schema.checkChild( [ '$root' ], 'tableRow' ) ).to.be.false;
  50. expect( model.schema.checkChild( [ 'table' ], 'tableRow' ) ).to.be.true;
  51. // Table cell:
  52. expect( model.schema.isRegistered( 'tableCell' ) ).to.be.true;
  53. expect( model.schema.isLimit( 'tableCell' ) ).to.be.true;
  54. expect( model.schema.checkChild( [ '$root' ], 'tableCell' ) ).to.be.false;
  55. expect( model.schema.checkChild( [ 'table' ], 'tableCell' ) ).to.be.false;
  56. expect( model.schema.checkChild( [ 'tableRow' ], 'tableCell' ) ).to.be.true;
  57. expect( model.schema.checkChild( [ 'tableCell' ], 'tableCell' ) ).to.be.false;
  58. expect( model.schema.checkAttribute( [ 'tableCell' ], 'colspan' ) ).to.be.true;
  59. expect( model.schema.checkAttribute( [ 'tableCell' ], 'rowspan' ) ).to.be.true;
  60. // Table cell contents:
  61. expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$text' ) ).to.be.false;
  62. expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$block' ) ).to.be.true;
  63. expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'table' ) ).to.be.false;
  64. expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'image' ) ).to.be.false;
  65. } );
  66. it( 'adds insertTable command', () => {
  67. expect( editor.commands.get( 'insertTable' ) ).to.be.instanceOf( InsertTableCommand );
  68. } );
  69. it( 'adds insertRowAbove command', () => {
  70. expect( editor.commands.get( 'insertTableRowAbove' ) ).to.be.instanceOf( InsertRowCommand );
  71. } );
  72. it( 'adds insertRowBelow command', () => {
  73. expect( editor.commands.get( 'insertTableRowBelow' ) ).to.be.instanceOf( InsertRowCommand );
  74. } );
  75. it( 'adds insertColumnLeft command', () => {
  76. expect( editor.commands.get( 'insertTableColumnLeft' ) ).to.be.instanceOf( InsertColumnCommand );
  77. } );
  78. it( 'adds insertColumnRight command', () => {
  79. expect( editor.commands.get( 'insertTableColumnRight' ) ).to.be.instanceOf( InsertColumnCommand );
  80. } );
  81. it( 'adds removeRow command', () => {
  82. expect( editor.commands.get( 'removeTableRow' ) ).to.be.instanceOf( RemoveRowCommand );
  83. } );
  84. it( 'adds removeColumn command', () => {
  85. expect( editor.commands.get( 'removeTableColumn' ) ).to.be.instanceOf( RemoveColumnCommand );
  86. } );
  87. it( 'adds splitCellVertically command', () => {
  88. expect( editor.commands.get( 'splitTableCellVertically' ) ).to.be.instanceOf( SplitCellCommand );
  89. } );
  90. it( 'adds splitCellHorizontally command', () => {
  91. expect( editor.commands.get( 'splitTableCellHorizontally' ) ).to.be.instanceOf( SplitCellCommand );
  92. } );
  93. it( 'adds mergeCellRight command', () => {
  94. expect( editor.commands.get( 'mergeTableCellRight' ) ).to.be.instanceOf( MergeCellCommand );
  95. } );
  96. it( 'adds mergeCellLeft command', () => {
  97. expect( editor.commands.get( 'mergeTableCellLeft' ) ).to.be.instanceOf( MergeCellCommand );
  98. } );
  99. it( 'adds mergeCellDown command', () => {
  100. expect( editor.commands.get( 'mergeTableCellDown' ) ).to.be.instanceOf( MergeCellCommand );
  101. } );
  102. it( 'adds mergeCellUp command', () => {
  103. expect( editor.commands.get( 'mergeTableCellUp' ) ).to.be.instanceOf( MergeCellCommand );
  104. } );
  105. it( 'adds setColumnHeader command', () => {
  106. expect( editor.commands.get( 'setTableColumnHeader' ) ).to.be.instanceOf( SetHeaderColumnCommand );
  107. } );
  108. it( 'adds setRowHeader command', () => {
  109. expect( editor.commands.get( 'setTableRowHeader' ) ).to.be.instanceOf( SetHeaderRowCommand );
  110. } );
  111. describe( 'conversion in data pipeline', () => {
  112. describe( 'model to view', () => {
  113. it( 'should create tbody section', () => {
  114. setModelData( model, '<table><tableRow><tableCell><paragraph>foo[]</paragraph></tableCell></tableRow></table>' );
  115. expect( editor.getData() ).to.equal(
  116. '<figure class="table">' +
  117. '<table>' +
  118. '<tbody>' +
  119. '<tr><td>foo</td></tr>' +
  120. '</tbody>' +
  121. '</table>' +
  122. '</figure>'
  123. );
  124. } );
  125. it( 'should create thead section', () => {
  126. setModelData(
  127. model,
  128. '<table headingRows="1"><tableRow><tableCell><paragraph>foo[]</paragraph></tableCell></tableRow></table>'
  129. );
  130. expect( editor.getData() ).to.equal(
  131. '<figure class="table">' +
  132. '<table>' +
  133. '<thead>' +
  134. '<tr><th>foo</th></tr>' +
  135. '</thead>' +
  136. '</table>' +
  137. '</figure>'
  138. );
  139. } );
  140. } );
  141. describe( 'view to model', () => {
  142. it( 'should convert table', () => {
  143. editor.setData( '<table><tbody><tr><td>foo</td></tr></tbody></table>' );
  144. expect( getModelData( model, { withoutSelection: true } ) )
  145. .to.equal( '<table><tableRow><tableCell><paragraph>foo</paragraph></tableCell></tableRow></table>' );
  146. } );
  147. it( 'should convert table with image', () => {
  148. editor.setData( '<table><tbody><tr><td><img src="sample.png"></td></tr></tbody></table>' );
  149. expect( getModelData( model, { withoutSelection: true } ) )
  150. .to.equal( '<table><tableRow><tableCell><paragraph></paragraph></tableCell></tableRow></table>' );
  151. } );
  152. it( 'should convert table with media', () => {
  153. editor.setData(
  154. '<table><tbody><tr><td><oembed url="https://www.youtube.com/watch?v=H08tGjXNHO4"></oembed></td></tr></tbody></table>'
  155. );
  156. expect( getModelData( model, { withoutSelection: true } ) )
  157. .to.equal( '<table><tableRow><tableCell><paragraph></paragraph></tableCell></tableRow></table>' );
  158. } );
  159. } );
  160. } );
  161. describe( 'caret movement', () => {
  162. let domEvtDataStub;
  163. beforeEach( () => {
  164. domEvtDataStub = {
  165. keyCode: getCode( 'Tab' ),
  166. preventDefault: sinon.spy(),
  167. stopPropagation: sinon.spy()
  168. };
  169. } );
  170. it( 'should do nothing if not tab pressed', () => {
  171. setModelData( model, modelTable( [
  172. [ '11', '12[]' ]
  173. ] ) );
  174. domEvtDataStub.keyCode = getCode( 'a' );
  175. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  176. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  177. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  178. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  179. [ '11', '12[]' ]
  180. ] ) );
  181. } );
  182. it( 'should do nothing if Ctrl+Tab is pressed', () => {
  183. setModelData( model, modelTable( [
  184. [ '11', '12[]' ]
  185. ] ) );
  186. domEvtDataStub.ctrlKey = true;
  187. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  188. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  189. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  190. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  191. [ '11', '12[]' ]
  192. ] ) );
  193. } );
  194. describe( 'on TAB', () => {
  195. it( 'should do nothing if selection is not in a table', () => {
  196. setModelData( model, '[]' + modelTable( [
  197. [ '11', '12' ]
  198. ] ) );
  199. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  200. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  201. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  202. expect( formatTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
  203. [ '11', '12' ]
  204. ] ) );
  205. } );
  206. it( 'should move to next cell', () => {
  207. setModelData( model, modelTable( [
  208. [ '11[]', '12' ]
  209. ] ) );
  210. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  211. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  212. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  213. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  214. [ '11', '[12]' ]
  215. ] ) );
  216. } );
  217. it( 'should create another row and move to first cell in new row', () => {
  218. setModelData( model, modelTable( [
  219. [ '11', '[12]' ]
  220. ] ) );
  221. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  222. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  223. [ '11', '12' ],
  224. [ '[]', '' ]
  225. ] ) );
  226. } );
  227. it( 'should move to the first cell of next row if on end of a row', () => {
  228. setModelData( model, modelTable( [
  229. [ '11', '12[]' ],
  230. [ '21', '22' ]
  231. ] ) );
  232. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  233. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  234. [ '11', '12' ],
  235. [ '[21]', '22' ]
  236. ] ) );
  237. } );
  238. it( 'should move to the next table cell if part of block content is selected', () => {
  239. setModelData( model, modelTable( [
  240. [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ],
  241. ] ) );
  242. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  243. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  244. [
  245. '11',
  246. '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
  247. '[13]'
  248. ],
  249. ] ) );
  250. } );
  251. it( 'should listen with lower priority then its children', () => {
  252. // Cancel TAB event.
  253. editor.keystrokes.set( 'Tab', ( data, cancel ) => cancel() );
  254. setModelData( model, modelTable( [
  255. [ '11[]', '12' ]
  256. ] ) );
  257. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  258. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  259. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  260. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  261. [ '11[]', '12' ]
  262. ] ) );
  263. } );
  264. describe( 'on table widget selected', () => {
  265. beforeEach( () => {
  266. editor.model.schema.register( 'block', {
  267. allowWhere: '$block',
  268. allowContentOf: '$block',
  269. isObject: true
  270. } );
  271. editor.conversion.elementToElement( { model: 'block', view: 'block' } );
  272. } );
  273. it( 'should move caret to the first table cell on TAB', () => {
  274. const spy = sinon.spy();
  275. editor.keystrokes.set( 'Tab', spy, { priority: 'lowest' } );
  276. setModelData( model, '[' + modelTable( [
  277. [ '11', '12' ]
  278. ] ) + ']' );
  279. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  280. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  281. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  282. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  283. [ '[11]', '12' ]
  284. ] ) );
  285. // Should cancel event - so no other tab handler is called.
  286. sinon.assert.notCalled( spy );
  287. } );
  288. it( 'shouldn\'t do anything on other blocks', () => {
  289. const spy = sinon.spy();
  290. editor.editing.view.document.on( 'keydown', spy );
  291. setModelData( model, '[<block>foo</block>]' );
  292. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  293. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  294. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  295. expect( formatTable( getModelData( model ) ) ).to.equal( '[<block>foo</block>]' );
  296. // Should not cancel event.
  297. sinon.assert.calledOnce( spy );
  298. } );
  299. } );
  300. } );
  301. describe( 'on SHIFT+TAB', () => {
  302. beforeEach( () => {
  303. domEvtDataStub.shiftKey = true;
  304. } );
  305. it( 'should do nothing if selection is not in a table', () => {
  306. setModelData( model, '[]' + modelTable( [
  307. [ '11', '12' ]
  308. ] ) );
  309. domEvtDataStub.keyCode = getCode( 'Tab' );
  310. domEvtDataStub.shiftKey = true;
  311. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  312. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  313. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  314. expect( formatTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
  315. [ '11', '12' ]
  316. ] ) );
  317. } );
  318. it( 'should move to previous cell', () => {
  319. setModelData( model, modelTable( [
  320. [ '11', '12[]' ]
  321. ] ) );
  322. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  323. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  324. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  325. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  326. [ '[11]', '12' ]
  327. ] ) );
  328. } );
  329. it( 'should not move if caret is in first table cell', () => {
  330. setModelData( model, '<paragraph>foo</paragraph>' + modelTable( [
  331. [ '[]11', '12' ]
  332. ] ) );
  333. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  334. expect( formatTable( getModelData( model ) ) ).to.equal(
  335. '<paragraph>foo</paragraph>' + formattedModelTable( [ [ '[]11', '12' ] ] )
  336. );
  337. } );
  338. it( 'should move to the last cell of previous row if on beginning of a row', () => {
  339. setModelData( model, modelTable( [
  340. [ '11', '12' ],
  341. [ '[]21', '22' ]
  342. ] ) );
  343. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  344. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  345. [ '11', '[12]' ],
  346. [ '21', '22' ]
  347. ] ) );
  348. } );
  349. it( 'should move to the previous table cell if part of block content is selected', () => {
  350. setModelData( model, modelTable( [
  351. [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ],
  352. ] ) );
  353. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  354. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  355. [
  356. '[11]',
  357. '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
  358. '13'
  359. ],
  360. ] ) );
  361. } );
  362. } );
  363. } );
  364. describe( 'enter key', () => {
  365. let evtDataStub, viewDocument;
  366. beforeEach( () => {
  367. evtDataStub = {
  368. preventDefault: sinon.spy(),
  369. stopPropagation: sinon.spy(),
  370. isSoft: false
  371. };
  372. return VirtualTestEditor
  373. .create( {
  374. plugins: [ TableEditing, Paragraph ]
  375. } )
  376. .then( newEditor => {
  377. editor = newEditor;
  378. sinon.stub( editor, 'execute' );
  379. viewDocument = editor.editing.view.document;
  380. model = editor.model;
  381. } );
  382. } );
  383. it( 'should do nothing if not in table cell', () => {
  384. setModelData( model, '<paragraph>[]foo</paragraph>' );
  385. viewDocument.fire( 'enter', evtDataStub );
  386. sinon.assert.notCalled( editor.execute );
  387. expect( formatTable( getModelData( model ) ) ).to.equal( '<paragraph>[]foo</paragraph>' );
  388. } );
  389. it( 'should do nothing if table cell has already a block content', () => {
  390. setModelData( model, modelTable( [
  391. [ '<paragraph>[]11</paragraph>' ]
  392. ] ) );
  393. viewDocument.fire( 'enter', evtDataStub );
  394. sinon.assert.notCalled( editor.execute );
  395. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  396. [ '<paragraph>[]11</paragraph>' ]
  397. ] ) );
  398. } );
  399. it( 'should do nothing if table cell with a block content is selected as a whole', () => {
  400. setModelData( model, modelTable( [
  401. [ '<paragraph>[1</paragraph><paragraph>1]</paragraph>' ]
  402. ] ) );
  403. viewDocument.fire( 'enter', evtDataStub );
  404. sinon.assert.notCalled( editor.execute );
  405. setModelData( model, modelTable( [
  406. [ '<paragraph>[1</paragraph><paragraph>1]</paragraph>' ]
  407. ] ) );
  408. } );
  409. it( 'should allow default behavior of Shift+Enter pressed', () => {
  410. setModelData( model, modelTable( [
  411. [ '[]11' ]
  412. ] ) );
  413. evtDataStub.isSoft = true;
  414. viewDocument.fire( 'enter', evtDataStub );
  415. sinon.assert.notCalled( editor.execute );
  416. expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  417. [ '[]11' ]
  418. ] ) );
  419. } );
  420. } );
  421. } );