@ckeditor/ckeditor5-table 32.0.0 → 33.0.0

package/src/plaintableoutput.js

@@ -0,0 +1,151 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module table/plaintableoutput
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import Table from './table';
+
+/**
+ * The plain table output feature.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class PlainTableOutput extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'PlainTableOutput';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ Table ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const editor = this.editor;
+
+		// Override default table data downcast converter.
+		editor.conversion.for( 'dataDowncast' ).elementToStructure( {
+			model: 'table',
+			view: downcastTableElement,
+			converterPriority: 'high'
+		} );
+
+		// Make sure table <caption> is downcasted into <caption> in the data pipeline when necessary.
+		if ( editor.plugins.has( 'TableCaption' ) ) {
+			editor.conversion.for( 'dataDowncast' ).elementToElement( {
+				model: 'caption',
+				view: ( modelElement, { writer } ) => {
+					if ( modelElement.parent.name === 'table' ) {
+						return writer.createContainerElement( 'caption' );
+					}
+				},
+				converterPriority: 'high'
+			} );
+		}
+
+		// Handle border-style, border-color, border-width and background-color table attributes.
+		if ( editor.plugins.has( 'TableProperties' ) ) {
+			downcastTableBorderAndBackgroundAttributes( editor );
+		}
+	}
+}
+
+// The plain table downcast converter callback.
+//
+// @private
+// @param {module:engine/model/element~Element} Table model element.
+// @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi The conversion API object.
+// @returns {module:engine/view/containerelement~ContainerElement} Created element.
+function downcastTableElement( table, { writer } ) {
+	const headingRows = table.getAttribute( 'headingRows' ) || 0;
+
+	// Table head rows slot.
+	const headRowsSlot = writer.createSlot( element =>
+		element.is( 'element', 'tableRow' ) && element.index < headingRows
+	);
+
+	// Table body rows slot.
+	const bodyRowsSlot = writer.createSlot( element =>
+		element.is( 'element', 'tableRow' ) && element.index >= headingRows
+	);
+
+	// Table children slot.
+	const childrenSlot = writer.createSlot( element => !element.is( 'element', 'tableRow' ) );
+
+	// Table <thead> element with all the heading rows.
+	const theadElement = writer.createContainerElement( 'thead', null, headRowsSlot );
+
+	// Table <tbody> element with all the body rows.
+	const tbodyElement = writer.createContainerElement( 'tbody', null, bodyRowsSlot );
+
+	// Table contents element containing <thead> and <tbody> when necessary.
+	const tableContentElements = [];
+
+	if ( headingRows ) {
+		tableContentElements.push( theadElement );
+	}
+
+	if ( headingRows < table.childCount ) {
+		tableContentElements.push( tbodyElement );
+	}
+
+	// Create table structure.
+	//
+	// <table>
+	//    {children-slot-like-caption}
+	//    <thead>
+	//        {table-head-rows-slot}
+	//    </thead>
+	//    <tbody>
+	//        {table-body-rows-slot}
+	//    </tbody>
+	// </table>
+	return writer.createContainerElement( 'table', null, [ childrenSlot, ...tableContentElements ] );
+}
+
+// Register table border and background attributes converters.
+//
+// @private
+// @param {module:core/editor/editor~Editor} editor
+function downcastTableBorderAndBackgroundAttributes( editor ) {
+	const modelAttributes = {
+		'border-width': 'tableBorderWidth',
+		'border-color': 'tableBorderColor',
+		'border-style': 'tableBorderStyle',
+		'background-color': 'tableBackgroundColor'
+	};
+
+	for ( const [ styleName, modelAttribute ] of Object.entries( modelAttributes ) ) {
+		editor.conversion.for( 'dataDowncast' ).add( dispatcher => {
+			return dispatcher.on( `attribute:${ modelAttribute }:table`, ( evt, data, conversionApi ) => {
+				const { item, attributeNewValue } = data;
+				const { mapper, writer } = conversionApi;
+
+				if ( !conversionApi.consumable.consume( item, evt.name ) ) {
+					return;
+				}
+
+				const table = mapper.toViewElement( item );
+
+				if ( attributeNewValue ) {
+					writer.setStyle( styleName, attributeNewValue, table );
+				} else {
+					writer.removeStyle( styleName, table );
+				}
+			}, { priority: 'high' } );
+		} );
+	}
+}

package/src/tablecellproperties/commands/tablecellpropertycommand.js

@@ -8,7 +8,6 @@
  */
 
 import { Command } from 'ckeditor5/src/core';
-import { getSelectionAffectedTableCells } from '../../utils/selection';
 
 /**
  * The table cell attribute command.
@@ -51,7 +50,8 @@ export default class TableCellPropertyCommand extends Command {
 	 */
 	refresh() {
 		const editor = this.editor;
-		const selectedTableCells = getSelectionAffectedTableCells( editor.model.document.selection );
+		const tableUtils = this.editor.plugins.get( 'TableUtils' );
+		const selectedTableCells = tableUtils.getSelectionAffectedTableCells( editor.model.document.selection );
 
 		this.isEnabled = !!selectedTableCells.length;
 		this.value = this._getSingleValue( selectedTableCells );
@@ -70,7 +70,8 @@ export default class TableCellPropertyCommand extends Command {
 	execute( options = {} ) {
 		const { value, batch } = options;
 		const model = this.editor.model;
-		const tableCells = getSelectionAffectedTableCells( model.document.selection );
+		const tableUtils = this.editor.plugins.get( 'TableUtils' );
+		const tableCells = tableUtils.getSelectionAffectedTableCells( model.document.selection );
 		const valueToSet = this._getValueToSet( value );
 
 		model.enqueueChange( batch, writer => {

package/src/tableclipboard.js

@@ -12,7 +12,6 @@ import { Plugin } from 'ckeditor5/src/core';
 import TableSelection from './tableselection';
 import TableWalker from './tablewalker';
 import TableUtils from './tableutils';
-import { getColumnIndexes, getRowIndexes, getSelectionAffectedTableCells, isSelectionRectangular, sortRanges } from './utils/selection';
 import {
 	cropTableToDimensions,
 	getHorizontallyOverlappingCells,
@@ -122,7 +121,7 @@ export default class TableClipboard extends Plugin {
 			return;
 		}
 
-		const selectedTableCells = getSelectionAffectedTableCells( model.document.selection );
+		const selectedTableCells = tableUtils.getSelectionAffectedTableCells( model.document.selection );
 
 		if ( !selectedTableCells.length ) {
 			removeEmptyRowsColumns( pastedTable, tableUtils );
@@ -171,7 +170,7 @@ export default class TableClipboard extends Plugin {
 			if ( this.editor.plugins.get( 'TableSelection' ).isEnabled ) {
 				// Selection ranges must be sorted because the first and last selection ranges are considered
 				// as anchor/focus cell ranges for multi-cell selection.
-				const selectionRanges = sortRanges( cellsToSelect.map( cell => writer.createRangeOn( cell ) ) );
+				const selectionRanges = tableUtils.sortRanges( cellsToSelect.map( cell => writer.createRangeOn( cell ) ) );
 
 				writer.setSelection( selectionRanges );
 			} else {
@@ -311,17 +310,21 @@ export default class TableClipboard extends Plugin {
 
 		return cellToInsert;
 	}
+
+	/**
+	 * Extracts the table for pasting into a table.
+	 *
+	 * @protected
+	 * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert.
+	 * @param {module:engine/model/model~Model} model The editor model.
+	 * @returns {module:engine/model/element~Element|null}
+	 */
+	getTableIfOnlyTableInContent( content, model ) {
+		return getTableIfOnlyTableInContent( content, model );
+	}
 }
 
-/**
- * Extract table for pasting into table.
- *
- * @private
- * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert.
- * @param {module:engine/model/model~Model} model The editor model.
- * @returns {module:engine/model/element~Element|null}
- */
-export function getTableIfOnlyTableInContent( content, model ) {
+function getTableIfOnlyTableInContent( content, model ) {
 	if ( !content.is( 'documentFragment' ) && !content.is( 'element' ) ) {
 		return null;
 	}
@@ -381,8 +384,8 @@ export function getTableIfOnlyTableInContent( content, model ) {
 function prepareTableForPasting( selectedTableCells, pastedDimensions, writer, tableUtils ) {
 	const selectedTable = selectedTableCells[ 0 ].findAncestor( 'table' );
 
-	const columnIndexes = getColumnIndexes( selectedTableCells );
-	const rowIndexes = getRowIndexes( selectedTableCells );
+	const columnIndexes = tableUtils.getColumnIndexes( selectedTableCells );
+	const rowIndexes = tableUtils.getRowIndexes( selectedTableCells );
 
 	const selection = {
 		firstColumn: columnIndexes.first,
@@ -403,7 +406,7 @@ function prepareTableForPasting( selectedTableCells, pastedDimensions, writer, t
 
 	// In case of expanding selection we do not reset the selection so in this case we will always try to fix selection
 	// like in the case of a non-rectangular area. This might be fixed by re-setting selected cells array but this shortcut is safe.
-	if ( shouldExpandSelection || !isSelectionRectangular( selectedTableCells, tableUtils ) ) {
+	if ( shouldExpandSelection || !tableUtils.isSelectionRectangular( selectedTableCells ) ) {
 		// For a non-rectangular selection (ie in which some cells sticks out from a virtual selection rectangle) we need to create
 		// a table layout that has a rectangular selection. This will split cells so the selection become rectangular.
 		// Beyond this point we will operate on fixed content table.

package/src/tableediting.js

@@ -10,14 +10,7 @@
 import { Plugin } from 'ckeditor5/src/core';
 
 import upcastTable, { ensureParagraphInTableCell, skipEmptyTableRow, upcastTableFigure } from './converters/upcasttable';
-import {
-	convertParagraphInTableCell,
-	downcastInsertCell,
-	downcastInsertRow,
-	downcastInsertTable,
-	downcastRemoveRow,
-	downcastTableHeadingColumnsChange
-} from './converters/downcast';
+import { convertParagraphInTableCell, downcastCell, downcastRow, downcastTable } from './converters/downcast';
 
 import InsertTableCommand from './commands/inserttablecommand';
 import InsertRowCommand from './commands/insertrowcommand';
@@ -35,8 +28,9 @@ import TableUtils from '../src/tableutils';
 
 import injectTableLayoutPostFixer from './converters/table-layout-post-fixer';
 import injectTableCellParagraphPostFixer from './converters/table-cell-paragraph-post-fixer';
-import injectTableCellRefreshPostFixer from './converters/table-cell-refresh-post-fixer';
-import injectTableHeadingRowsRefreshPostFixer from './converters/table-heading-rows-refresh-post-fixer';
+
+import tableHeadingsRefreshHandler from './converters/table-headings-refresh-handler';
+import tableCellRefreshHandler from './converters/table-cell-refresh-handler';
 
 import '../theme/tableediting.css';
 
@@ -53,6 +47,13 @@ export default class TableEditing extends Plugin {
 		return 'TableEditing';
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ TableUtils ];
+	}
+
 	/**
 	 * @inheritDoc
 	 */
@@ -61,6 +62,7 @@ export default class TableEditing extends Plugin {
 		const model = editor.model;
 		const schema = model.schema;
 		const conversion = editor.conversion;
+		const tableUtils = editor.plugins.get( TableUtils );
 
 		schema.register( 'table', {
 			allowWhere: '$block',
@@ -88,15 +90,29 @@ export default class TableEditing extends Plugin {
 		// Table conversion.
 		conversion.for( 'upcast' ).add( upcastTable() );
 
-		conversion.for( 'editingDowncast' ).add( downcastInsertTable( { asWidget: true } ) );
-		conversion.for( 'dataDowncast' ).add( downcastInsertTable() );
+		conversion.for( 'editingDowncast' ).elementToStructure( {
+			model: {
+				name: 'table',
+				attributes: [ 'headingRows' ]
+			},
+			view: downcastTable( tableUtils, { asWidget: true } )
+		} );
+		conversion.for( 'dataDowncast' ).elementToStructure( {
+			model: {
+				name: 'table',
+				attributes: [ 'headingRows' ]
+			},
+			view: downcastTable( tableUtils )
+		} );
 
 		// Table row conversion.
 		conversion.for( 'upcast' ).elementToElement( { model: 'tableRow', view: 'tr' } );
 		conversion.for( 'upcast' ).add( skipEmptyTableRow() );
 
-		conversion.for( 'editingDowncast' ).add( downcastInsertRow() );
-		conversion.for( 'editingDowncast' ).add( downcastRemoveRow() );
+		conversion.for( 'downcast' ).elementToElement( {
+			model: 'tableRow',
+			view: downcastRow()
+		} );
 
 		// Table cell conversion.
 		conversion.for( 'upcast' ).elementToElement( { model: 'tableCell', view: 'td' } );
@@ -104,12 +120,24 @@ export default class TableEditing extends Plugin {
 		conversion.for( 'upcast' ).add( ensureParagraphInTableCell( 'td' ) );
 		conversion.for( 'upcast' ).add( ensureParagraphInTableCell( 'th' ) );
 
-		conversion.for( 'editingDowncast' ).add( downcastInsertCell() );
+		conversion.for( 'editingDowncast' ).elementToElement( {
+			model: 'tableCell',
+			view: downcastCell( { asWidget: true } )
+		} );
+		conversion.for( 'dataDowncast' ).elementToElement( {
+			model: 'tableCell',
+			view: downcastCell()
+		} );
 
 		// Duplicates code - needed to properly refresh paragraph inside a table cell.
 		conversion.for( 'editingDowncast' ).elementToElement( {
 			model: 'paragraph',
-			view: convertParagraphInTableCell,
+			view: convertParagraphInTableCell( { asWidget: true } ),
+			converterPriority: 'high'
+		} );
+		conversion.for( 'dataDowncast' ).elementToElement( {
+			model: 'paragraph',
+			view: convertParagraphInTableCell(),
 			converterPriority: 'high'
 		} );
 
@@ -126,9 +154,6 @@ export default class TableEditing extends Plugin {
 			view: 'rowspan'
 		} );
 
-		// Table heading columns conversion (a change of heading rows requires a reconversion of the whole table).
-		conversion.for( 'editingDowncast' ).add( downcastTableHeadingColumnsChange() );
-
 		// Manually adjust model position mappings in a special case, when a table cell contains a paragraph, which is bound
 		// to its parent (to the table cell). This custom model-to-view position mapping is necessary in data pipeline only,
 		// because only during this conversion a paragraph can be bound to its parent.
@@ -164,17 +189,13 @@ export default class TableEditing extends Plugin {
 		editor.commands.add( 'selectTableRow', new SelectRowCommand( editor ) );
 		editor.commands.add( 'selectTableColumn', new SelectColumnCommand( editor ) );
 
-		injectTableHeadingRowsRefreshPostFixer( model );
 		injectTableLayoutPostFixer( model );
-		injectTableCellRefreshPostFixer( model, editor.editing.mapper );
 		injectTableCellParagraphPostFixer( model );
-	}
 
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ TableUtils ];
+		this.listenTo( model.document, 'change:data', () => {
+			tableHeadingsRefreshHandler( model, editor.editing );
+			tableCellRefreshHandler( model, editor.editing );
+		} );
 	}
 }
 

package/src/tablekeyboard.js

@@ -9,10 +9,10 @@
 
 import TableSelection from './tableselection';
 import TableWalker from './tablewalker';
+import TableUtils from './tableutils';
 
 import { Plugin } from 'ckeditor5/src/core';
 import { getLocalizedArrowKeyCodeDirection } from 'ckeditor5/src/utils';
-import { getSelectedTableCells, getTableCellsContainingSelection } from './utils/selection';
 
 /**
  * This plugin enables keyboard navigation for tables.
@@ -32,7 +32,7 @@ export default class TableKeyboard extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ TableSelection ];
+		return [ TableSelection, TableUtils ];
 	}
 
 	/**
@@ -83,10 +83,11 @@ export default class TableKeyboard extends Plugin {
 	 */
 	_getTabHandler( isForward ) {
 		const editor = this.editor;
+		const tableUtils = this.editor.plugins.get( TableUtils );
 
 		return ( domEventData, cancel ) => {
 			const selection = editor.model.document.selection;
-			let tableCell = getTableCellsContainingSelection( selection )[ 0 ];
+			let tableCell = tableUtils.getTableCellsContainingSelection( selection )[ 0 ];
 
 			if ( !tableCell ) {
 				tableCell = this.editor.plugins.get( 'TableSelection' ).getFocusCell();
@@ -115,7 +116,6 @@ export default class TableKeyboard extends Plugin {
 				return;
 			}
 
-			const tableUtils = this.editor.plugins.get( 'TableUtils' );
 			const isLastCellInRow = currentCellIndex === tableRow.childCount - 1;
 			const isLastRow = currentRowIndex === tableUtils.getRows( table ) - 1;
 
@@ -188,13 +188,14 @@ export default class TableKeyboard extends Plugin {
 	 * @returns {Boolean} Returns `true` if key was handled.
 	 */
 	_handleArrowKeys( direction, expandSelection ) {
+		const tableUtils = this.editor.plugins.get( TableUtils );
 		const model = this.editor.model;
 		const selection = model.document.selection;
 		const isForward = [ 'right', 'down' ].includes( direction );
 
 		// In case one or more table cells are selected (from outside),
 		// move the selection to a cell adjacent to the selected table fragment.
-		const selectedCells = getSelectedTableCells( selection );
+		const selectedCells = tableUtils.getSelectedTableCells( selection );
 
 		if ( selectedCells.length ) {
 			let focusCell;

package/src/tablemouse.js

@@ -11,8 +11,7 @@ import { Plugin } from 'ckeditor5/src/core';
 
 import TableSelection from './tableselection';
 import MouseEventsObserver from './tablemouse/mouseeventsobserver';
-
-import { getTableCellsContainingSelection } from './utils/selection';
+import TableUtils from './tableutils';
 
 /**
  * This plugin enables a table cells' selection with the mouse.
@@ -32,7 +31,7 @@ export default class TableMouse extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ TableSelection ];
+		return [ TableSelection, TableUtils ];
 	}
 
 	/**
@@ -57,11 +56,14 @@ export default class TableMouse extends Plugin {
 	 */
 	_enableShiftClickSelection() {
 		const editor = this.editor;
+		const tableUtils = editor.plugins.get( TableUtils );
 		let blockSelectionChange = false;
 
 		const tableSelection = editor.plugins.get( TableSelection );
 
 		this.listenTo( editor.editing.view.document, 'mousedown', ( evt, domEventData ) => {
+			const selection = editor.model.document.selection;
+
 			if ( !this.isEnabled || !tableSelection.isEnabled ) {
 				return;
 			}
@@ -70,7 +72,7 @@ export default class TableMouse extends Plugin {
 				return;
 			}
 
-			const anchorCell = tableSelection.getAnchorCell() || getTableCellsContainingSelection( editor.model.document.selection )[ 0 ];
+			const anchorCell = tableSelection.getAnchorCell() || tableUtils.getTableCellsContainingSelection( selection )[ 0 ];
 
 			if ( !anchorCell ) {
 				return;

package/src/tableselection.js

@@ -14,7 +14,6 @@ import TableWalker from './tablewalker';
 import TableUtils from './tableutils';
 
 import { cropTableToDimensions, adjustLastRowIndex, adjustLastColumnIndex } from './utils/structure';
-import { getColumnIndexes, getRowIndexes, getSelectedTableCells, isSelectionRectangular } from './utils/selection';
 
 import '../theme/tableselection.css';
 
@@ -36,7 +35,7 @@ export default class TableSelection extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ TableUtils ];
+		return [ TableUtils, TableUtils ];
 	}
 
 	/**
@@ -58,9 +57,10 @@ export default class TableSelection extends Plugin {
 	 * @returns {Array.<module:engine/model/element~Element>|null}
 	 */
 	getSelectedTableCells() {
+		const tableUtils = this.editor.plugins.get( TableUtils );
 		const selection = this.editor.model.document.selection;
 
-		const selectedCells = getSelectedTableCells( selection );
+		const selectedCells = tableUtils.getSelectedTableCells( selection );
 
 		if ( selectedCells.length == 0 ) {
 			return null;
@@ -81,6 +81,7 @@ export default class TableSelection extends Plugin {
 	 * @returns {module:engine/model/documentfragment~DocumentFragment|null}
 	 */
 	getSelectionAsFragment() {
+		const tableUtils = this.editor.plugins.get( TableUtils );
 		const selectedCells = this.getSelectedTableCells();
 
 		if ( !selectedCells ) {
@@ -89,10 +90,9 @@ export default class TableSelection extends Plugin {
 
 		return this.editor.model.change( writer => {
 			const documentFragment = writer.createDocumentFragment();
-			const tableUtils = this.editor.plugins.get( 'TableUtils' );
 
-			const { first: firstColumn, last: lastColumn } = getColumnIndexes( selectedCells );
-			const { first: firstRow, last: lastRow } = getRowIndexes( selectedCells );
+			const { first: firstColumn, last: lastColumn } = tableUtils.getColumnIndexes( selectedCells );
+			const { first: firstRow, last: lastRow } = tableUtils.getRowIndexes( selectedCells );
 
 			const sourceTable = selectedCells[ 0 ].findAncestor( 'table' );
 
@@ -101,7 +101,7 @@ export default class TableSelection extends Plugin {
 
 			// If the selection is rectangular there could be a case of all cells in the last row/column spanned over
 			// next row/column so the real lastRow/lastColumn should be updated.
-			if ( isSelectionRectangular( selectedCells, tableUtils ) ) {
+			if ( tableUtils.isSelectionRectangular( selectedCells ) ) {
 				const dimensions = {
 					firstColumn,
 					lastColumn,
@@ -269,10 +269,11 @@ export default class TableSelection extends Plugin {
 	 * @param {Array.<*>} args Delete content method arguments.
 	 */
 	_handleDeleteContent( event, args ) {
+		const tableUtils = this.editor.plugins.get( TableUtils );
 		const [ selection, options ] = args;
 		const model = this.editor.model;
 		const isBackward = !options || options.direction == 'backward';
-		const selectedTableCells = getSelectedTableCells( selection );
+		const selectedTableCells = tableUtils.getSelectedTableCells( selection );
 
 		if ( !selectedTableCells.length ) {
 			return;