@ckeditor/ckeditor5-table 31.1.0 → 34.0.0

package/src/converters/table-headings-refresh-handler.js

@@ -0,0 +1,68 @@
+/**
+ * @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/converters/table-heading-rows-refresh-post-fixer
+ */
+
+import TableWalker from '../tablewalker';
+
+/**
+ * A table headings refresh handler which marks the table cells or rows in the differ to have it re-rendered
+ * if the headings attribute changed.
+ *
+ * Table heading rows and heading columns are represented in the model by a `headingRows` and `headingColumns` attributes.
+ *
+ * When table headings attribute changes, all the cells/rows are marked to re-render to change between `<td>` and `<th>`.
+ *
+ * @param {module:engine/model/model~Model} model
+ * @param {module:engine/controller/editingcontroller~EditingController} editing
+ */
+export default function tableHeadingsRefreshHandler( model, editing ) {
+	const differ = model.document.differ;
+
+	for ( const change of differ.getChanges() ) {
+		let table;
+		let isRowChange = false;
+
+		if ( change.type == 'attribute' ) {
+			const element = change.range.start.nodeAfter;
+
+			if ( !element || !element.is( 'element', 'table' ) ) {
+				continue;
+			}
+
+			if ( change.attributeKey != 'headingRows' && change.attributeKey != 'headingColumns' ) {
+				continue;
+			}
+
+			table = element;
+			isRowChange = change.attributeKey == 'headingRows';
+		} else if ( change.name == 'tableRow' || change.name == 'tableCell' ) {
+			table = change.position.findAncestor( 'table' );
+			isRowChange = change.name == 'tableRow';
+		}
+
+		if ( !table ) {
+			continue;
+		}
+
+		const headingRows = table.getAttribute( 'headingRows' ) || 0;
+		const headingColumns = table.getAttribute( 'headingColumns' ) || 0;
+
+		const tableWalker = new TableWalker( table );
+
+		for ( const tableSlot of tableWalker ) {
+			const isHeading = tableSlot.row < headingRows || tableSlot.column < headingColumns;
+			const expectedElementName = isHeading ? 'th' : 'td';
+
+			const viewElement = editing.mapper.toViewElement( tableSlot.cell );
+
+			if ( viewElement && viewElement.is( 'element' ) && viewElement.name != expectedElementName ) {
+				editing.reconvertItem( isRowChange ? tableSlot.cell.parent : tableSlot.cell );
+			}
+		}
+	}
+}

package/src/converters/table-layout-post-fixer.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/converters/tableproperties.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/converters/upcasttable.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/index.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -7,6 +7,7 @@
  * @module table
  */
 
+export { default as PlainTableOutput } from './plaintableoutput';
 export { default as Table } from './table';
 export { default as TableEditing } from './tableediting';
 export { default as TableUI } from './tableui';

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/table.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecaption/tablecaptionediting.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecaption/tablecaptionui.js

@@ -1,7 +1,7 @@
 /**
-* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
-* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
-*/
+ * @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/tablecaption/tablecaptionui

package/src/tablecaption/toggletablecaptioncommand.js

@@ -1,7 +1,7 @@
 /**
-* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
-* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
-*/
+ * @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/tablecaption/toggletablecaptioncommand

package/src/tablecaption/utils.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecaption.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellbordercolorcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellborderstylecommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellborderwidthcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellheightcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellpaddingcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellpropertycommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -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,10 +70,11 @@ 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 || 'default', writer => {
+		model.enqueueChange( batch, writer => {
 			if ( valueToSet ) {
 				tableCells.forEach( tableCell => writer.setAttribute( this.attributeName, valueToSet, tableCell ) );
 			} else {

package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/commands/tablecellwidthcommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/tablecellpropertiesediting.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/tablecellpropertiesui.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties/ui/tablecellpropertiesview.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tablecellproperties.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 

package/src/tableclipboard.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -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.