tableediting.js 17 KB

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