@ckeditor/ckeditor5-table 36.0.0 → 37.0.0-alpha.0

package/src/utils/ui/widget.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module table/utils/ui/widget
+ */
+import type { ViewDocumentSelection, ViewElement } from 'ckeditor5/src/engine';
+/**
+ * Returns a table widget editing view element if one is selected.
+ */
+export declare function getSelectedTableWidget(selection: ViewDocumentSelection): ViewElement | null;
+/**
+ * Returns a table widget editing view element if one is among the selection's ancestors.
+ */
+export declare function getTableWidgetAncestor(selection: ViewDocumentSelection): ViewElement | null;

package/src/utils/ui/widget.js

@@ -2,59 +2,37 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module table/utils/ui/widget
- */
-
 import { isWidget } from 'ckeditor5/src/widget';
-
 /**
  * Returns a table widget editing view element if one is selected.
- *
- * @param {module:engine/view/selection~Selection|module:engine/view/documentselection~DocumentSelection} selection
- * @returns {module:engine/view/element~Element|null}
  */
-export function getSelectedTableWidget( selection ) {
-	const viewElement = selection.getSelectedElement();
-
-	if ( viewElement && isTableWidget( viewElement ) ) {
-		return viewElement;
-	}
-
-	return null;
+export function getSelectedTableWidget(selection) {
+    const viewElement = selection.getSelectedElement();
+    if (viewElement && isTableWidget(viewElement)) {
+        return viewElement;
+    }
+    return null;
 }
-
 /**
  * Returns a table widget editing view element if one is among the selection's ancestors.
- *
- * @param {module:engine/view/selection~Selection|module:engine/view/documentselection~DocumentSelection} selection
- * @returns {module:engine/view/element~Element|null}
  */
-export function getTableWidgetAncestor( selection ) {
-	const selectionPosition = selection.getFirstPosition();
-
-	if ( !selectionPosition ) {
-		return null;
-	}
-
-	let parent = selectionPosition.parent;
-
-	while ( parent ) {
-		if ( parent.is( 'element' ) && isTableWidget( parent ) ) {
-			return parent;
-		}
-
-		parent = parent.parent;
-	}
-
-	return null;
+export function getTableWidgetAncestor(selection) {
+    const selectionPosition = selection.getFirstPosition();
+    if (!selectionPosition) {
+        return null;
+    }
+    let parent = selectionPosition.parent;
+    while (parent) {
+        if (parent.is('element') && isTableWidget(parent)) {
+            return parent;
+        }
+        parent = parent.parent;
+    }
+    return null;
 }
-
-// Checks if a given view element is a table widget.
-//
-// @param {module:engine/view/element~Element} viewElement
-// @returns {Boolean}
-function isTableWidget( viewElement ) {
-	return !!viewElement.getCustomProperty( 'table' ) && isWidget( viewElement );
+/**
+ * Checks if a given view element is a table widget.
+ */
+function isTableWidget(viewElement) {
+    return !!viewElement.getCustomProperty('table') && isWidget(viewElement);
 }

package/src/tablecolumnresize/tablecolumnwidthscommand.js

@@ -1,55 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module table/tablecolumnresize/tablecolumnwidthscommand
- */
-
-import TablePropertyCommand from '../tableproperties/commands/tablepropertycommand';
-
-/**
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
- */
-export default class TableColumnWidthsCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableColumnWidthsCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} defaultValue The default value of the attribute.
-	 */
-	constructor( editor, defaultValue ) {
-		super( editor, 'columnWidths', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		// The command is always enabled as it doesn't care about the actual selection - table can be resized
-		// even if the selection is elsewhere.
-		this.isEnabled = true;
-	}
-
-	/**
-	 * Changes the `columnWidths` attribute value for the given or currently selected table.
-	 *
-	 * @param {Object} options
-	 * @param {String} [options.columnWidths] New value of the `columnWidths` attribute.
-	 * @param {module:engine/model/element~Element} [options.table] The table that is having the columns resized.
-	 */
-	execute( options = {} ) {
-		const model = this.editor.model;
-		const table = options.table || model.document.selection.getSelectedElement();
-		const { columnWidths } = options;
-
-		model.change( writer => {
-			if ( columnWidths ) {
-				writer.setAttribute( this.attributeName, columnWidths, table );
-			} else {
-				writer.removeAttribute( this.attributeName, table );
-			}
-		} );
-	}
-}

package/src/tablecolumnresize/tablewidthresizecommand.js

@@ -1,65 +0,0 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module table/tablecolumnresize/tablewidthresizecommand
- */
-
-import TablePropertyCommand from '../tableproperties/commands/tablepropertycommand';
-
-/**
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
- */
-export default class TableWidthResizeCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableWidthResizeCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} defaultValue The default value of the attribute.
-	 */
-	constructor( editor, defaultValue ) {
-		// We create a custom command instead of using the existing `TableWidthCommand`
-		// as we also need to change the `columnWidths` property and running both commands
-		// separately would make the integration with Track Changes feature more troublesome.
-		super( editor, 'tableWidth', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		// The command is always enabled as it doesn't care about the actual selection - table can be resized
-		// even if the selection is elsewhere.
-		this.isEnabled = true;
-	}
-
-	/**
-	 * Changes the `tableWidth` and `columnWidths` attribute values for the given or currently selected table.
-	 *
-	 * @param {Object} options
-	 * @param {String} [options.tableWidth] The new table width. If skipped, the model attribute will be removed.
-	 * @param {String} [options.columnWidths] The new table column widths. If skipped, the model attribute will be removed.
-	 * @param {module:engine/model/element~Element} [options.table] The table that is affected by the resize.
-	 */
-	execute( options = {} ) {
-		const model = this.editor.model;
-		const table = options.table || model.document.selection.getSelectedElement();
-		const { tableWidth, columnWidths } = options;
-
-		model.change( writer => {
-			if ( tableWidth ) {
-				writer.setAttribute( this.attributeName, tableWidth, table );
-			} else {
-				writer.removeAttribute( this.attributeName, table );
-			}
-
-			if ( columnWidths ) {
-				writer.setAttribute( 'columnWidths', columnWidths, table );
-			} else {
-				writer.removeAttribute( 'columnWidths', table );
-			}
-		} );
-	}
-}