tableediting.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  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 TableEditing from '../src/tableediting';
  10. import { formatModelTable, formattedModelTable, modelTable } from './_utils/utils';
  11. describe( 'TableEditing', () => {
  12. let editor, model;
  13. beforeEach( () => {
  14. return VirtualTestEditor
  15. .create( {
  16. plugins: [ TableEditing, Paragraph ]
  17. } )
  18. .then( newEditor => {
  19. editor = newEditor;
  20. model = editor.model;
  21. } );
  22. } );
  23. afterEach( () => {
  24. editor.destroy();
  25. } );
  26. it( 'should set proper schema rules', () => {
  27. } );
  28. describe( 'conversion in data pipeline', () => {
  29. describe( 'model to view', () => {
  30. it( 'should create tbody section', () => {
  31. setModelData( model, '<table><tableRow><tableCell>foo[]</tableCell></tableRow></table>' );
  32. expect( editor.getData() ).to.equal( '<table><tbody><tr><td>foo</td></tr></tbody></table>' );
  33. } );
  34. it( 'should create thead section', () => {
  35. setModelData( model, '<table headingRows="1"><tableRow><tableCell>foo[]</tableCell></tableRow></table>' );
  36. expect( editor.getData() ).to.equal( '<table><thead><tr><th>foo</th></tr></thead></table>' );
  37. } );
  38. it( 'should create thead and tbody sections in proper order', () => {
  39. setModelData( model, '<table headingRows="1">' +
  40. '<tableRow><tableCell>foo</tableCell></tableRow>' +
  41. '<tableRow><tableCell>bar</tableCell></tableRow>' +
  42. '<tableRow><tableCell>baz[]</tableCell></tableRow>' +
  43. '</table>'
  44. );
  45. expect( editor.getData() ).to.equal( '<table>' +
  46. '<thead><tr><th>foo</th></tr></thead>' +
  47. '<tbody><tr><td>bar</td></tr><tr><td>baz</td></tr></tbody>' +
  48. '</table>'
  49. );
  50. } );
  51. it( 'should convert rowspan on tableCell', () => {
  52. setModelData( model, '<table><tableRow><tableCell rowspan="2">foo[]</tableCell></tableRow></table>' );
  53. expect( editor.getData() ).to.equal( '<table><tbody><tr><td rowspan="2">foo</td></tr></tbody></table>' );
  54. } );
  55. it( 'should convert colspan on tableCell', () => {
  56. setModelData( model, '<table><tableRow><tableCell colspan="2">foo[]</tableCell></tableRow></table>' );
  57. expect( editor.getData() ).to.equal( '<table><tbody><tr><td colspan="2">foo</td></tr></tbody></table>' );
  58. } );
  59. } );
  60. describe( 'view to model', () => {
  61. it( 'should convert table', () => {
  62. editor.setData( '<table><tbody><tr><td>foo</td></tr></tbody></table>' );
  63. expect( getModelData( model, { withoutSelection: true } ) )
  64. .to.equal( '<table><tableRow><tableCell>foo</tableCell></tableRow></table>' );
  65. } );
  66. } );
  67. } );
  68. describe( 'caret movement', () => {
  69. let domEvtDataStub;
  70. beforeEach( () => {
  71. domEvtDataStub = {
  72. keyCode: getCode( 'Tab' ),
  73. preventDefault: sinon.spy(),
  74. stopPropagation: sinon.spy()
  75. };
  76. } );
  77. it( 'should do nothing if not tab pressed', () => {
  78. setModelData( model, modelTable( [
  79. [ '11', '12[]' ]
  80. ] ) );
  81. domEvtDataStub.keyCode = getCode( 'a' );
  82. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  83. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  84. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  85. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  86. [ '11', '12[]' ]
  87. ] ) );
  88. } );
  89. it( 'should do nothing if Ctrl+Tab is pressed', () => {
  90. setModelData( model, modelTable( [
  91. [ '11', '12[]' ]
  92. ] ) );
  93. domEvtDataStub.ctrlKey = true;
  94. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  95. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  96. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  97. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  98. [ '11', '12[]' ]
  99. ] ) );
  100. } );
  101. describe( 'on TAB', () => {
  102. it( 'should do nothing if selection is not in a table', () => {
  103. setModelData( model, '[]' + modelTable( [
  104. [ '11', '12' ]
  105. ] ) );
  106. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  107. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  108. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  109. expect( formatModelTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
  110. [ '11', '12' ]
  111. ] ) );
  112. } );
  113. it( 'should move to next cell', () => {
  114. setModelData( model, modelTable( [
  115. [ '11[]', '12' ]
  116. ] ) );
  117. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  118. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  119. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  120. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  121. [ '11', '[12]' ]
  122. ] ) );
  123. } );
  124. it( 'should create another row and move to first cell in new row', () => {
  125. setModelData( model, modelTable( [
  126. [ '11', '[12]' ]
  127. ] ) );
  128. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  129. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  130. [ '11', '12' ],
  131. [ '[]', '' ]
  132. ] ) );
  133. } );
  134. it( 'should move to the first cell of next row if on end of a row', () => {
  135. setModelData( model, modelTable( [
  136. [ '11', '12[]' ],
  137. [ '21', '22' ]
  138. ] ) );
  139. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  140. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  141. [ '11', '12' ],
  142. [ '[21]', '22' ]
  143. ] ) );
  144. } );
  145. describe( 'on table widget selected', () => {
  146. it( 'should move caret to the first table cell on TAB', () => {
  147. const spy = sinon.spy();
  148. editor.editing.view.document.on( 'keydown', spy );
  149. setModelData( model, '[' + modelTable( [
  150. [ '11', '12' ]
  151. ] ) + ']' );
  152. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  153. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  154. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  155. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  156. [ '[11]', '12' ]
  157. ] ) );
  158. // Should cancel event - so no other tab handler is called.
  159. sinon.assert.notCalled( spy );
  160. } );
  161. it( 'shouldn\' do anything on other blocks', () => {
  162. const spy = sinon.spy();
  163. editor.editing.view.document.on( 'keydown', spy );
  164. setModelData( model, '[<paragraph>foo</paragraph>]' );
  165. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  166. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  167. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  168. expect( formatModelTable( getModelData( model ) ) ).to.equal( '[<paragraph>foo</paragraph>]' );
  169. // Should not cancel event.
  170. sinon.assert.calledOnce( spy );
  171. } );
  172. } );
  173. } );
  174. describe( 'on SHIFT+TAB', () => {
  175. beforeEach( () => {
  176. domEvtDataStub.shiftKey = true;
  177. } );
  178. it( 'should do nothing if selection is not in a table', () => {
  179. setModelData( model, '[]' + modelTable( [
  180. [ '11', '12' ]
  181. ] ) );
  182. domEvtDataStub.keyCode = getCode( 'Tab' );
  183. domEvtDataStub.shiftKey = true;
  184. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  185. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  186. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  187. expect( formatModelTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
  188. [ '11', '12' ]
  189. ] ) );
  190. } );
  191. it( 'should move to previous cell', () => {
  192. setModelData( model, modelTable( [
  193. [ '11', '12[]' ]
  194. ] ) );
  195. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  196. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  197. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  198. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  199. [ '[11]', '12' ]
  200. ] ) );
  201. } );
  202. it( 'should not move if caret is in first table cell', () => {
  203. setModelData( model, '<paragraph>foo</paragraph>' + modelTable( [
  204. [ '[]11', '12' ]
  205. ] ) );
  206. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  207. expect( formatModelTable( getModelData( model ) ) ).to.equal(
  208. '<paragraph>foo</paragraph>' + formattedModelTable( [ [ '[]11', '12' ] ] )
  209. );
  210. } );
  211. it( 'should move to the last cell of previous row if on beginning of a row', () => {
  212. setModelData( model, modelTable( [
  213. [ '11', '12' ],
  214. [ '[]21', '22' ]
  215. ] ) );
  216. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  217. expect( formatModelTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
  218. [ '11', '[12]' ],
  219. [ '21', '22' ]
  220. ] ) );
  221. } );
  222. } );
  223. } );
  224. } );