8
0

tablenavigation.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  2. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  3. import { modelTable } from './_utils/utils';
  4. import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  7. import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
  8. import MediaEmbedEditing from '@ckeditor/ckeditor5-media-embed/src/mediaembedediting';
  9. import TableNavigation from '../src/tablenavigation';
  10. import TableEditing from '../src/tableediting';
  11. describe( 'TableNavigation', () => {
  12. let editor, model;
  13. beforeEach( () => {
  14. return VirtualTestEditor
  15. .create( {
  16. plugins: [ TableEditing, TableNavigation, Paragraph, ImageEditing, MediaEmbedEditing ]
  17. } )
  18. .then( newEditor => {
  19. editor = newEditor;
  20. model = editor.model;
  21. } );
  22. } );
  23. afterEach( () => {
  24. editor.destroy();
  25. } );
  26. it( 'should have pluginName', () => {
  27. expect( TableNavigation.pluginName ).to.equal( 'TableNavigation' );
  28. } );
  29. describe( 'caret movement', () => {
  30. let domEvtDataStub;
  31. beforeEach( () => {
  32. domEvtDataStub = {
  33. keyCode: getCode( 'Tab' ),
  34. preventDefault: sinon.spy(),
  35. stopPropagation: sinon.spy()
  36. };
  37. } );
  38. it( 'should do nothing if not tab pressed', () => {
  39. setModelData( model, modelTable( [
  40. [ '11', '12[]' ]
  41. ] ) );
  42. domEvtDataStub.keyCode = getCode( 'a' );
  43. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  44. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  45. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  46. assertEqualMarkup( getModelData( model ), modelTable( [
  47. [ '11', '12[]' ]
  48. ] ) );
  49. } );
  50. it( 'should do nothing if Ctrl+Tab is pressed', () => {
  51. setModelData( model, modelTable( [
  52. [ '11', '12[]' ]
  53. ] ) );
  54. domEvtDataStub.ctrlKey = true;
  55. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  56. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  57. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  58. assertEqualMarkup( getModelData( model ), modelTable( [
  59. [ '11', '12[]' ]
  60. ] ) );
  61. } );
  62. describe( 'on TAB', () => {
  63. it( 'should do nothing if selection is not in a table', () => {
  64. setModelData( model, '<paragraph>[]</paragraph>' + modelTable( [ [ '11', '12' ] ] ) );
  65. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  66. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  67. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  68. assertEqualMarkup( getModelData( model ), '<paragraph>[]</paragraph>' + modelTable( [
  69. [ '11', '12' ]
  70. ] ) );
  71. } );
  72. it( 'should move to next cell', () => {
  73. setModelData( model, modelTable( [
  74. [ '11[]', '12' ]
  75. ] ) );
  76. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  77. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  78. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  79. assertEqualMarkup( getModelData( model ), modelTable( [
  80. [ '11', '[12]' ]
  81. ] ) );
  82. } );
  83. it( 'should create another row and move to first cell in new row', () => {
  84. setModelData( model, modelTable( [
  85. [ '11', '[12]' ]
  86. ] ) );
  87. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  88. assertEqualMarkup( getModelData( model ), modelTable( [
  89. [ '11', '12' ],
  90. [ '[]', '' ]
  91. ] ) );
  92. } );
  93. it( 'should not create another row and not move the caret if insertTableRowBelow command is disabled', () => {
  94. setModelData( model, modelTable( [
  95. [ '11', '12[]' ]
  96. ] ) );
  97. const insertTableRowBelowCommand = editor.commands.get( 'insertTableRowBelow' );
  98. insertTableRowBelowCommand.forceDisabled( 'test' );
  99. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  100. assertEqualMarkup( getModelData( model ), modelTable( [
  101. [ '11', '12[]' ]
  102. ] ) );
  103. } );
  104. it( 'should move to the first cell of next row if on end of a row', () => {
  105. setModelData( model, modelTable( [
  106. [ '11', '12[]' ],
  107. [ '21', '22' ]
  108. ] ) );
  109. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  110. assertEqualMarkup( getModelData( model ), modelTable( [
  111. [ '11', '12' ],
  112. [ '[21]', '22' ]
  113. ] ) );
  114. } );
  115. it( 'should move to the next table cell if part of block content is selected', () => {
  116. setModelData( model, modelTable( [
  117. [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ]
  118. ] ) );
  119. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  120. assertEqualMarkup( getModelData( model ), modelTable( [
  121. [
  122. '11',
  123. '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
  124. '[13]'
  125. ]
  126. ] ) );
  127. } );
  128. it( 'should move to next cell with an image', () => {
  129. setModelData( model, modelTable( [
  130. [ '11[]', '<paragraph>foo</paragraph><image></image>' ]
  131. ] ) );
  132. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  133. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  134. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  135. assertEqualMarkup( getModelData( model ), modelTable( [
  136. [ '11', '<paragraph>[foo</paragraph><image></image>]' ]
  137. ] ) );
  138. } );
  139. it( 'should move to next cell with an blockQuote', () => {
  140. model.schema.register( 'blockQuote', {
  141. allowWhere: '$block',
  142. allowContentOf: '$root'
  143. } );
  144. editor.conversion.elementToElement( { model: 'blockQuote', view: 'blockquote' } );
  145. setModelData( model, modelTable( [
  146. [ '11[]', '<blockQuote><paragraph>foo</paragraph></blockQuote>' ]
  147. ] ) );
  148. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  149. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  150. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  151. assertEqualMarkup( getModelData( model ), modelTable( [
  152. [ '11', '<blockQuote><paragraph>[foo]</paragraph></blockQuote>' ]
  153. ] ) );
  154. } );
  155. it( 'should listen with lower priority then its children', () => {
  156. // Cancel TAB event.
  157. editor.keystrokes.set( 'Tab', ( data, cancel ) => cancel() );
  158. setModelData( model, modelTable( [
  159. [ '11[]', '12' ]
  160. ] ) );
  161. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  162. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  163. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  164. assertEqualMarkup( getModelData( model ), modelTable( [
  165. [ '11[]', '12' ]
  166. ] ) );
  167. } );
  168. describe( 'on table widget selected', () => {
  169. beforeEach( () => {
  170. editor.model.schema.register( 'block', {
  171. allowWhere: '$block',
  172. allowContentOf: '$block',
  173. isObject: true
  174. } );
  175. editor.conversion.elementToElement( { model: 'block', view: 'block' } );
  176. } );
  177. it( 'should move caret to the first table cell on TAB', () => {
  178. const spy = sinon.spy();
  179. editor.keystrokes.set( 'Tab', spy, { priority: 'lowest' } );
  180. setModelData( model, '[' + modelTable( [
  181. [ '11', '12' ]
  182. ] ) + ']' );
  183. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  184. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  185. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  186. assertEqualMarkup( getModelData( model ), modelTable( [
  187. [ '[11]', '12' ]
  188. ] ) );
  189. // Should cancel event - so no other tab handler is called.
  190. sinon.assert.notCalled( spy );
  191. } );
  192. it( 'shouldn\'t do anything on other blocks', () => {
  193. const spy = sinon.spy();
  194. editor.editing.view.document.on( 'keydown', spy );
  195. setModelData( model, '[<block>foo</block>]' );
  196. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  197. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  198. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  199. assertEqualMarkup( getModelData( model ), '[<block>foo</block>]' );
  200. // Should not cancel event.
  201. sinon.assert.calledOnce( spy );
  202. } );
  203. } );
  204. } );
  205. describe( 'on SHIFT+TAB', () => {
  206. beforeEach( () => {
  207. domEvtDataStub.shiftKey = true;
  208. } );
  209. it( 'should do nothing if selection is not in a table', () => {
  210. setModelData( model, '<paragraph>[]</paragraph>' + modelTable( [
  211. [ '11', '12' ]
  212. ] ) );
  213. domEvtDataStub.keyCode = getCode( 'Tab' );
  214. domEvtDataStub.shiftKey = true;
  215. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  216. sinon.assert.notCalled( domEvtDataStub.preventDefault );
  217. sinon.assert.notCalled( domEvtDataStub.stopPropagation );
  218. assertEqualMarkup( getModelData( model ), '<paragraph>[]</paragraph>' + modelTable( [
  219. [ '11', '12' ]
  220. ] ) );
  221. } );
  222. it( 'should move to previous cell', () => {
  223. setModelData( model, modelTable( [
  224. [ '11', '12[]' ]
  225. ] ) );
  226. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  227. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  228. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  229. assertEqualMarkup( getModelData( model ), modelTable( [
  230. [ '[11]', '12' ]
  231. ] ) );
  232. } );
  233. it( 'should not move if caret is in first table cell', () => {
  234. setModelData( model, '<paragraph>foo</paragraph>' + modelTable( [
  235. [ '[]11', '12' ]
  236. ] ) );
  237. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  238. assertEqualMarkup( getModelData( model ),
  239. '<paragraph>foo</paragraph>' + modelTable( [ [ '[]11', '12' ] ] )
  240. );
  241. } );
  242. it( 'should move to the last cell of previous row if on beginning of a row', () => {
  243. setModelData( model, modelTable( [
  244. [ '11', '12' ],
  245. [ '[]21', '22' ]
  246. ] ) );
  247. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  248. assertEqualMarkup( getModelData( model ), modelTable( [
  249. [ '11', '[12]' ],
  250. [ '21', '22' ]
  251. ] ) );
  252. } );
  253. it( 'should move to the previous table cell if part of block content is selected', () => {
  254. setModelData( model, modelTable( [
  255. [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ]
  256. ] ) );
  257. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  258. assertEqualMarkup( getModelData( model ), modelTable( [
  259. [
  260. '[11]',
  261. '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
  262. '13'
  263. ]
  264. ] ) );
  265. } );
  266. it( 'should move to previous cell with an image', () => {
  267. setModelData( model, modelTable( [
  268. [ '<paragraph>foo</paragraph><image></image>', 'bar[]' ]
  269. ] ) );
  270. editor.editing.view.document.fire( 'keydown', domEvtDataStub );
  271. sinon.assert.calledOnce( domEvtDataStub.preventDefault );
  272. sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
  273. assertEqualMarkup( getModelData( model ), modelTable( [
  274. [ '<paragraph>[foo</paragraph><image></image>]', 'bar' ]
  275. ] ) );
  276. } );
  277. } );
  278. } );
  279. } );