| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
- import TableEditing from '../src/tableediting';
- import { modelTable } from './_utils/utils';
- import InsertRowCommand from '../src/commands/insertrowcommand';
- import InsertTableCommand from '../src/commands/inserttablecommand';
- import InsertColumnCommand from '../src/commands/insertcolumncommand';
- import RemoveRowCommand from '../src/commands/removerowcommand';
- import RemoveColumnCommand from '../src/commands/removecolumncommand';
- import SplitCellCommand from '../src/commands/splitcellcommand';
- import MergeCellCommand from '../src/commands/mergecellcommand';
- import SetHeaderRowCommand from '../src/commands/setheaderrowcommand';
- import SetHeaderColumnCommand from '../src/commands/setheadercolumncommand';
- import MediaEmbedEditing from '@ckeditor/ckeditor5-media-embed/src/mediaembedediting';
- import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- describe( 'TableEditing', () => {
- let editor, model;
- beforeEach( () => {
- return VirtualTestEditor
- .create( {
- plugins: [ TableEditing, Paragraph, ImageEditing, MediaEmbedEditing ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- } );
- } );
- afterEach( () => {
- editor.destroy();
- } );
- it( 'should have pluginName', () => {
- expect( TableEditing.pluginName ).to.equal( 'TableEditing' );
- } );
- it( 'should set proper schema rules', () => {
- // Table:
- expect( model.schema.isRegistered( 'table' ) ).to.be.true;
- expect( model.schema.isObject( 'table' ) ).to.be.true;
- expect( model.schema.isBlock( 'table' ) ).to.be.true;
- expect( model.schema.isLimit( 'table' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root' ], 'table' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingRows' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingColumns' ) ).to.be.true;
- // Table row:
- expect( model.schema.isRegistered( 'tableRow' ) ).to.be.true;
- expect( model.schema.isLimit( 'tableRow' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root' ], 'tableRow' ) ).to.be.false;
- expect( model.schema.checkChild( [ 'table' ], 'tableRow' ) ).to.be.true;
- // Table cell:
- expect( model.schema.isRegistered( 'tableCell' ) ).to.be.true;
- expect( model.schema.isLimit( 'tableCell' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root' ], 'tableCell' ) ).to.be.false;
- expect( model.schema.checkChild( [ 'table' ], 'tableCell' ) ).to.be.false;
- expect( model.schema.checkChild( [ 'tableRow' ], 'tableCell' ) ).to.be.true;
- expect( model.schema.checkChild( [ 'tableCell' ], 'tableCell' ) ).to.be.false;
- expect( model.schema.checkAttribute( [ 'tableCell' ], 'colspan' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ 'tableCell' ], 'rowspan' ) ).to.be.true;
- // Table cell contents:
- expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$text' ) ).to.be.false;
- expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$block' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'table' ) ).to.be.false;
- expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'image' ) ).to.be.true;
- } );
- it( 'adds insertTable command', () => {
- expect( editor.commands.get( 'insertTable' ) ).to.be.instanceOf( InsertTableCommand );
- } );
- it( 'adds insertRowAbove command', () => {
- expect( editor.commands.get( 'insertTableRowAbove' ) ).to.be.instanceOf( InsertRowCommand );
- } );
- it( 'adds insertRowBelow command', () => {
- expect( editor.commands.get( 'insertTableRowBelow' ) ).to.be.instanceOf( InsertRowCommand );
- } );
- it( 'adds insertColumnLeft command', () => {
- expect( editor.commands.get( 'insertTableColumnLeft' ) ).to.be.instanceOf( InsertColumnCommand );
- } );
- it( 'adds insertColumnRight command', () => {
- expect( editor.commands.get( 'insertTableColumnRight' ) ).to.be.instanceOf( InsertColumnCommand );
- } );
- it( 'adds removeRow command', () => {
- expect( editor.commands.get( 'removeTableRow' ) ).to.be.instanceOf( RemoveRowCommand );
- } );
- it( 'adds removeColumn command', () => {
- expect( editor.commands.get( 'removeTableColumn' ) ).to.be.instanceOf( RemoveColumnCommand );
- } );
- it( 'adds splitCellVertically command', () => {
- expect( editor.commands.get( 'splitTableCellVertically' ) ).to.be.instanceOf( SplitCellCommand );
- } );
- it( 'adds splitCellHorizontally command', () => {
- expect( editor.commands.get( 'splitTableCellHorizontally' ) ).to.be.instanceOf( SplitCellCommand );
- } );
- it( 'adds mergeCellRight command', () => {
- expect( editor.commands.get( 'mergeTableCellRight' ) ).to.be.instanceOf( MergeCellCommand );
- } );
- it( 'adds mergeCellLeft command', () => {
- expect( editor.commands.get( 'mergeTableCellLeft' ) ).to.be.instanceOf( MergeCellCommand );
- } );
- it( 'adds mergeCellDown command', () => {
- expect( editor.commands.get( 'mergeTableCellDown' ) ).to.be.instanceOf( MergeCellCommand );
- } );
- it( 'adds mergeCellUp command', () => {
- expect( editor.commands.get( 'mergeTableCellUp' ) ).to.be.instanceOf( MergeCellCommand );
- } );
- it( 'adds setColumnHeader command', () => {
- expect( editor.commands.get( 'setTableColumnHeader' ) ).to.be.instanceOf( SetHeaderColumnCommand );
- } );
- it( 'adds setRowHeader command', () => {
- expect( editor.commands.get( 'setTableRowHeader' ) ).to.be.instanceOf( SetHeaderRowCommand );
- } );
- describe( 'conversion in data pipeline', () => {
- describe( 'model to view', () => {
- it( 'should create tbody section', () => {
- setModelData( model, '<table><tableRow><tableCell><paragraph>foo[]</paragraph></tableCell></tableRow></table>' );
- expect( editor.getData() ).to.equal(
- '<figure class="table">' +
- '<table>' +
- '<tbody>' +
- '<tr><td>foo</td></tr>' +
- '</tbody>' +
- '</table>' +
- '</figure>'
- );
- } );
- it( 'should create thead section', () => {
- setModelData(
- model,
- '<table headingRows="1"><tableRow><tableCell><paragraph>foo[]</paragraph></tableCell></tableRow></table>'
- );
- expect( editor.getData() ).to.equal(
- '<figure class="table">' +
- '<table>' +
- '<thead>' +
- '<tr><th>foo</th></tr>' +
- '</thead>' +
- '</table>' +
- '</figure>'
- );
- } );
- } );
- describe( 'view to model', () => {
- it( 'should convert table', () => {
- editor.setData( '<table><tbody><tr><td>foo</td></tr></tbody></table>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<table><tableRow><tableCell><paragraph>foo</paragraph></tableCell></tableRow></table>' );
- } );
- it( 'should convert table with image', () => {
- editor.setData( '<table><tbody><tr><td><img src="sample.png"></td></tr></tbody></table>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<table><tableRow><tableCell><image src="sample.png"></image></tableCell></tableRow></table>' );
- } );
- it( 'should insert a paragraph when the cell content is unsupported', () => {
- editor.setData(
- '<table><tbody><tr><td><foo></foo></td></tr></tbody></table>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<table><tableRow><tableCell><paragraph></paragraph></tableCell></tableRow></table>' );
- } );
- it( 'should convert a table with media', () => {
- editor.setData(
- '<table><tbody><tr><td><oembed url="https://www.youtube.com/watch?v=H08tGjXNHO4"></oembed></td></tr></tbody></table>'
- );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<table><tableRow><tableCell>' +
- '<media url="https://www.youtube.com/watch?v=H08tGjXNHO4"></media>' +
- '</tableCell></tableRow></table>' );
- } );
- } );
- } );
- describe( 'caret movement', () => {
- let domEvtDataStub;
- beforeEach( () => {
- domEvtDataStub = {
- keyCode: getCode( 'Tab' ),
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- } );
- it( 'should do nothing if not tab pressed', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- domEvtDataStub.keyCode = getCode( 'a' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '12[]' ]
- ] ) );
- } );
- it( 'should do nothing if Ctrl+Tab is pressed', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- domEvtDataStub.ctrlKey = true;
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '12[]' ]
- ] ) );
- } );
- describe( 'on TAB', () => {
- it( 'should do nothing if selection is not in a table', () => {
- setModelData( model, '<paragraph>[]</paragraph>' + modelTable( [ [ '11', '12' ] ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), '<paragraph>[]</paragraph>' + modelTable( [
- [ '11', '12' ]
- ] ) );
- } );
- it( 'should move to next cell', () => {
- setModelData( model, modelTable( [
- [ '11[]', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '[12]' ]
- ] ) );
- } );
- it( 'should create another row and move to first cell in new row', () => {
- setModelData( model, modelTable( [
- [ '11', '[12]' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '12' ],
- [ '[]', '' ]
- ] ) );
- } );
- it( 'should not create another row and not move the caret if insertTableRowBelow command is disabled', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- const insertTableRowBelowCommand = editor.commands.get( 'insertTableRowBelow' );
- insertTableRowBelowCommand.forceDisabled( 'test' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '12[]' ]
- ] ) );
- } );
- it( 'should move to the first cell of next row if on end of a row', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ],
- [ '21', '22' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '12' ],
- [ '[21]', '22' ]
- ] ) );
- } );
- it( 'should move to the next table cell if part of block content is selected', () => {
- setModelData( model, modelTable( [
- [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [
- '11',
- '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
- '[13]'
- ]
- ] ) );
- } );
- it( 'should move to next cell with an image', () => {
- setModelData( model, modelTable( [
- [ '11[]', '<paragraph>foo</paragraph><image></image>' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '<paragraph>[foo</paragraph><image></image>]' ]
- ] ) );
- } );
- it( 'should move to next cell with an blockQuote', () => {
- model.schema.register( 'blockQuote', {
- allowWhere: '$block',
- allowContentOf: '$root'
- } );
- editor.conversion.elementToElement( { model: 'blockQuote', view: 'blockquote' } );
- setModelData( model, modelTable( [
- [ '11[]', '<blockQuote><paragraph>foo</paragraph></blockQuote>' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '<blockQuote><paragraph>[foo]</paragraph></blockQuote>' ]
- ] ) );
- } );
- it( 'should listen with lower priority then its children', () => {
- // Cancel TAB event.
- editor.keystrokes.set( 'Tab', ( data, cancel ) => cancel() );
- setModelData( model, modelTable( [
- [ '11[]', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11[]', '12' ]
- ] ) );
- } );
- describe( 'on table widget selected', () => {
- beforeEach( () => {
- editor.model.schema.register( 'block', {
- allowWhere: '$block',
- allowContentOf: '$block',
- isObject: true
- } );
- editor.conversion.elementToElement( { model: 'block', view: 'block' } );
- } );
- it( 'should move caret to the first table cell on TAB', () => {
- const spy = sinon.spy();
- editor.keystrokes.set( 'Tab', spy, { priority: 'lowest' } );
- setModelData( model, '[' + modelTable( [
- [ '11', '12' ]
- ] ) + ']' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '[11]', '12' ]
- ] ) );
- // Should cancel event - so no other tab handler is called.
- sinon.assert.notCalled( spy );
- } );
- it( 'shouldn\'t do anything on other blocks', () => {
- const spy = sinon.spy();
- editor.editing.view.document.on( 'keydown', spy );
- setModelData( model, '[<block>foo</block>]' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), '[<block>foo</block>]' );
- // Should not cancel event.
- sinon.assert.calledOnce( spy );
- } );
- } );
- } );
- describe( 'on SHIFT+TAB', () => {
- beforeEach( () => {
- domEvtDataStub.shiftKey = true;
- } );
- it( 'should do nothing if selection is not in a table', () => {
- setModelData( model, '<paragraph>[]</paragraph>' + modelTable( [
- [ '11', '12' ]
- ] ) );
- domEvtDataStub.keyCode = getCode( 'Tab' );
- domEvtDataStub.shiftKey = true;
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), '<paragraph>[]</paragraph>' + modelTable( [
- [ '11', '12' ]
- ] ) );
- } );
- it( 'should move to previous cell', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '[11]', '12' ]
- ] ) );
- } );
- it( 'should not move if caret is in first table cell', () => {
- setModelData( model, '<paragraph>foo</paragraph>' + modelTable( [
- [ '[]11', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ),
- '<paragraph>foo</paragraph>' + modelTable( [ [ '[]11', '12' ] ] )
- );
- } );
- it( 'should move to the last cell of previous row if on beginning of a row', () => {
- setModelData( model, modelTable( [
- [ '11', '12' ],
- [ '[]21', '22' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '11', '[12]' ],
- [ '21', '22' ]
- ] ) );
- } );
- it( 'should move to the previous table cell if part of block content is selected', () => {
- setModelData( model, modelTable( [
- [ '11', '<paragraph>12</paragraph><paragraph>[foo]</paragraph><paragraph>bar</paragraph>', '13' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [
- '[11]',
- '<paragraph>12</paragraph><paragraph>foo</paragraph><paragraph>bar</paragraph>',
- '13'
- ]
- ] ) );
- } );
- it( 'should move to previous cell with an image', () => {
- setModelData( model, modelTable( [
- [ '<paragraph>foo</paragraph><image></image>', 'bar[]' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '<paragraph>[foo</paragraph><image></image>]', 'bar' ]
- ] ) );
- } );
- } );
- } );
- describe( 'enter key', () => {
- let evtDataStub, viewDocument;
- beforeEach( () => {
- evtDataStub = {
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy(),
- isSoft: false
- };
- return VirtualTestEditor
- .create( {
- plugins: [ TableEditing, Paragraph ]
- } )
- .then( newEditor => {
- editor = newEditor;
- sinon.stub( editor, 'execute' );
- viewDocument = editor.editing.view.document;
- model = editor.model;
- } );
- } );
- it( 'should do nothing if not in table cell', () => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- viewDocument.fire( 'enter', evtDataStub );
- sinon.assert.notCalled( editor.execute );
- assertEqualMarkup( getModelData( model ), '<paragraph>[]foo</paragraph>' );
- } );
- it( 'should do nothing if table cell has already a block content', () => {
- setModelData( model, modelTable( [
- [ '<paragraph>[]11</paragraph>' ]
- ] ) );
- viewDocument.fire( 'enter', evtDataStub );
- sinon.assert.notCalled( editor.execute );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '<paragraph>[]11</paragraph>' ]
- ] ) );
- } );
- it( 'should do nothing if table cell with a block content is selected as a whole', () => {
- setModelData( model, modelTable( [
- [ '<paragraph>[1</paragraph><paragraph>1]</paragraph>' ]
- ] ) );
- viewDocument.fire( 'enter', evtDataStub );
- sinon.assert.notCalled( editor.execute );
- setModelData( model, modelTable( [
- [ '<paragraph>[1</paragraph><paragraph>1]</paragraph>' ]
- ] ) );
- } );
- it( 'should allow default behavior of Shift+Enter pressed', () => {
- setModelData( model, modelTable( [
- [ '[]11' ]
- ] ) );
- evtDataStub.isSoft = true;
- viewDocument.fire( 'enter', evtDataStub );
- sinon.assert.notCalled( editor.execute );
- assertEqualMarkup( getModelData( model ), modelTable( [
- [ '[]11' ]
- ] ) );
- } );
- } );
- } );
|