@ckeditor/ckeditor5-table 38.1.1 → 38.2.0-alpha.1

package/src/commands/insertrowcommand.js

@@ -1,66 +1,66 @@
-/**
- * @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/commands/insertrowcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The insert row command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTableRowBelow'` and
- * `'insertTableRowAbove'` editor commands.
- *
- * To insert a row below the selected cell, execute the following command:
- *
- * ```ts
- * editor.execute( 'insertTableRowBelow' );
- * ```
- *
- * To insert a row above the selected cell, execute the following command:
- *
- * ```ts
- * editor.execute( 'insertTableRowAbove' );
- * ```
- */
-export default class InsertRowCommand extends Command {
-    /**
-     * Creates a new `InsertRowCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param options.order The order of insertion relative to the row in which the caret is located.
-     * Possible values: `"above"` and `"below"`. Default value is "below"
-     */
-    constructor(editor, options = {}) {
-        super(editor);
-        this.order = options.order || 'below';
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const selection = this.editor.model.document.selection;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const isAnyCellSelected = !!tableUtils.getSelectionAffectedTableCells(selection).length;
-        this.isEnabled = isAnyCellSelected;
-    }
-    /**
-     * Executes the command.
-     *
-     * Depending on the command's {@link #order} value, it inserts a row `'below'` or `'above'` the row in which selection is set.
-     *
-     * @fires execute
-     */
-    execute() {
-        const editor = this.editor;
-        const selection = editor.model.document.selection;
-        const tableUtils = editor.plugins.get('TableUtils');
-        const insertAbove = this.order === 'above';
-        const affectedTableCells = tableUtils.getSelectionAffectedTableCells(selection);
-        const rowIndexes = tableUtils.getRowIndexes(affectedTableCells);
-        const row = insertAbove ? rowIndexes.first : rowIndexes.last;
-        const table = affectedTableCells[0].findAncestor('table');
-        tableUtils.insertRows(table, { at: insertAbove ? row : row + 1, copyStructureFromAbove: !insertAbove });
-    }
-}
+/**
+ * @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/commands/insertrowcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The insert row command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTableRowBelow'` and
+ * `'insertTableRowAbove'` editor commands.
+ *
+ * To insert a row below the selected cell, execute the following command:
+ *
+ * ```ts
+ * editor.execute( 'insertTableRowBelow' );
+ * ```
+ *
+ * To insert a row above the selected cell, execute the following command:
+ *
+ * ```ts
+ * editor.execute( 'insertTableRowAbove' );
+ * ```
+ */
+export default class InsertRowCommand extends Command {
+    /**
+     * Creates a new `InsertRowCommand` instance.
+     *
+     * @param editor The editor on which this command will be used.
+     * @param options.order The order of insertion relative to the row in which the caret is located.
+     * Possible values: `"above"` and `"below"`. Default value is "below"
+     */
+    constructor(editor, options = {}) {
+        super(editor);
+        this.order = options.order || 'below';
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const selection = this.editor.model.document.selection;
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const isAnyCellSelected = !!tableUtils.getSelectionAffectedTableCells(selection).length;
+        this.isEnabled = isAnyCellSelected;
+    }
+    /**
+     * Executes the command.
+     *
+     * Depending on the command's {@link #order} value, it inserts a row `'below'` or `'above'` the row in which selection is set.
+     *
+     * @fires execute
+     */
+    execute() {
+        const editor = this.editor;
+        const selection = editor.model.document.selection;
+        const tableUtils = editor.plugins.get('TableUtils');
+        const insertAbove = this.order === 'above';
+        const affectedTableCells = tableUtils.getSelectionAffectedTableCells(selection);
+        const rowIndexes = tableUtils.getRowIndexes(affectedTableCells);
+        const row = insertAbove ? rowIndexes.first : rowIndexes.last;
+        const table = affectedTableCells[0].findAncestor('table');
+        tableUtils.insertRows(table, { at: insertAbove ? row : row + 1, copyStructureFromAbove: !insertAbove });
+    }
+}

package/src/commands/inserttablecommand.d.ts

@@ -1,44 +1,44 @@
-/**
- * @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/commands/inserttablecommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The insert table command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTable'` editor command.
- *
- * To insert a table at the current selection, execute the command and specify the dimensions:
- *
- * ```ts
- * editor.execute( 'insertTable', { rows: 20, columns: 5 } );
- * ```
- */
-export default class InsertTableCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * Inserts a table with the given number of rows and columns into the editor.
-     *
-     * @param options.rows The number of rows to create in the inserted table. Default value is 2.
-     * @param options.columns The number of columns to create in the inserted table. Default value is 2.
-     * @param options.headingRows The number of heading rows. If not provided it will default to
-     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.rows`} table config.
-     * @param options.headingColumns The number of heading columns. If not provided it will default to
-     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.columns`} table config.
-     * @fires execute
-     */
-    execute(options?: {
-        rows?: number;
-        columns?: number;
-        headingRows?: number;
-        headingColumns?: number;
-    }): void;
-}
+/**
+ * @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/commands/inserttablecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The insert table command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTable'` editor command.
+ *
+ * To insert a table at the current selection, execute the command and specify the dimensions:
+ *
+ * ```ts
+ * editor.execute( 'insertTable', { rows: 20, columns: 5 } );
+ * ```
+ */
+export default class InsertTableCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * Inserts a table with the given number of rows and columns into the editor.
+     *
+     * @param options.rows The number of rows to create in the inserted table. Default value is 2.
+     * @param options.columns The number of columns to create in the inserted table. Default value is 2.
+     * @param options.headingRows The number of heading rows. If not provided it will default to
+     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.rows`} table config.
+     * @param options.headingColumns The number of heading columns. If not provided it will default to
+     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.columns`} table config.
+     * @fires execute
+     */
+    execute(options?: {
+        rows?: number;
+        columns?: number;
+        headingRows?: number;
+        headingColumns?: number;
+    }): void;
+}

package/src/commands/inserttablecommand.js

@@ -1,69 +1,69 @@
-/**
- * @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/commands/inserttablecommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The insert table command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTable'` editor command.
- *
- * To insert a table at the current selection, execute the command and specify the dimensions:
- *
- * ```ts
- * editor.execute( 'insertTable', { rows: 20, columns: 5 } );
- * ```
- */
-export default class InsertTableCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const schema = model.schema;
-        this.isEnabled = isAllowedInParent(selection, schema);
-    }
-    /**
-     * Executes the command.
-     *
-     * Inserts a table with the given number of rows and columns into the editor.
-     *
-     * @param options.rows The number of rows to create in the inserted table. Default value is 2.
-     * @param options.columns The number of columns to create in the inserted table. Default value is 2.
-     * @param options.headingRows The number of heading rows. If not provided it will default to
-     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.rows`} table config.
-     * @param options.headingColumns The number of heading columns. If not provided it will default to
-     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.columns`} table config.
-     * @fires execute
-     */
-    execute(options = {}) {
-        const editor = this.editor;
-        const model = editor.model;
-        const tableUtils = editor.plugins.get('TableUtils');
-        const defaultRows = editor.config.get('table.defaultHeadings.rows');
-        const defaultColumns = editor.config.get('table.defaultHeadings.columns');
-        if (options.headingRows === undefined && defaultRows) {
-            options.headingRows = defaultRows;
-        }
-        if (options.headingColumns === undefined && defaultColumns) {
-            options.headingColumns = defaultColumns;
-        }
-        model.change(writer => {
-            const table = tableUtils.createTable(writer, options);
-            model.insertObject(table, null, null, { findOptimalPosition: 'auto' });
-            writer.setSelection(writer.createPositionAt(table.getNodeByPath([0, 0, 0]), 0));
-        });
-    }
-}
-/**
- * Checks if the table is allowed in the parent.
- */
-function isAllowedInParent(selection, schema) {
-    const positionParent = selection.getFirstPosition().parent;
-    const validParent = positionParent === positionParent.root ? positionParent : positionParent.parent;
-    return schema.checkChild(validParent, 'table');
-}
+/**
+ * @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/commands/inserttablecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The insert table command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'insertTable'` editor command.
+ *
+ * To insert a table at the current selection, execute the command and specify the dimensions:
+ *
+ * ```ts
+ * editor.execute( 'insertTable', { rows: 20, columns: 5 } );
+ * ```
+ */
+export default class InsertTableCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        const selection = model.document.selection;
+        const schema = model.schema;
+        this.isEnabled = isAllowedInParent(selection, schema);
+    }
+    /**
+     * Executes the command.
+     *
+     * Inserts a table with the given number of rows and columns into the editor.
+     *
+     * @param options.rows The number of rows to create in the inserted table. Default value is 2.
+     * @param options.columns The number of columns to create in the inserted table. Default value is 2.
+     * @param options.headingRows The number of heading rows. If not provided it will default to
+     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.rows`} table config.
+     * @param options.headingColumns The number of heading columns. If not provided it will default to
+     * {@link module:table/tableconfig~TableConfig#defaultHeadings `config.table.defaultHeadings.columns`} table config.
+     * @fires execute
+     */
+    execute(options = {}) {
+        const editor = this.editor;
+        const model = editor.model;
+        const tableUtils = editor.plugins.get('TableUtils');
+        const defaultRows = editor.config.get('table.defaultHeadings.rows');
+        const defaultColumns = editor.config.get('table.defaultHeadings.columns');
+        if (options.headingRows === undefined && defaultRows) {
+            options.headingRows = defaultRows;
+        }
+        if (options.headingColumns === undefined && defaultColumns) {
+            options.headingColumns = defaultColumns;
+        }
+        model.change(writer => {
+            const table = tableUtils.createTable(writer, options);
+            model.insertObject(table, null, null, { findOptimalPosition: 'auto' });
+            writer.setSelection(writer.createPositionAt(table.getNodeByPath([0, 0, 0]), 0));
+        });
+    }
+}
+/**
+ * Checks if the table is allowed in the parent.
+ */
+function isAllowedInParent(selection, schema) {
+    const positionParent = selection.getFirstPosition().parent;
+    const validParent = positionParent === positionParent.root ? positionParent : positionParent.parent;
+    return schema.checkChild(validParent, 'table');
+}

package/src/commands/mergecellcommand.d.ts

@@ -1,68 +1,68 @@
-/**
- * @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/commands/mergecellcommand
- */
-import type { Node } from 'ckeditor5/src/engine';
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { ArrowKeyCodeDirection } from 'ckeditor5/src/utils';
-/**
- * The merge cell command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCellRight'`, `'mergeTableCellLeft'`,
- * `'mergeTableCellUp'` and `'mergeTableCellDown'` editor commands.
- *
- * To merge a table cell at the current selection with another cell, execute the command corresponding with the preferred direction.
- *
- * For example, to merge with a cell to the right:
- *
- * ```ts
- * editor.execute( 'mergeTableCellRight' );
- * ```
- *
- * **Note**: If a table cell has a different [`rowspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-rowspan)
- * (for `'mergeTableCellRight'` and `'mergeTableCellLeft'`) or [`colspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-colspan)
- * (for `'mergeTableCellUp'` and `'mergeTableCellDown'`), the command will be disabled.
- */
-export default class MergeCellCommand extends Command {
-    /**
-     * The direction that indicates which cell will be merged with the currently selected one.
-     */
-    readonly direction: ArrowKeyCodeDirection;
-    /**
-     * Whether the merge is horizontal (left/right) or vertical (up/down).
-     */
-    readonly isHorizontal: boolean;
-    /**
-     * @inheritDoc
-     */
-    value: Node | undefined;
-    /**
-     * Creates a new `MergeCellCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param options.direction Indicates which cell to merge with the currently selected one.
-     * Possible values are: `'left'`, `'right'`, `'up'` and `'down'`.
-     */
-    constructor(editor: Editor, options: {
-        direction: ArrowKeyCodeDirection;
-    });
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * Depending on the command's {@link #direction} value, it will merge the cell that is to the `'left'`, `'right'`, `'up'` or `'down'`.
-     *
-     * @fires execute
-     */
-    execute(): void;
-    /**
-     * Returns a cell that can be merged with the current cell depending on the command's direction.
-     */
-    private _getMergeableCell;
-}
+/**
+ * @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/commands/mergecellcommand
+ */
+import type { Node } from 'ckeditor5/src/engine.js';
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { ArrowKeyCodeDirection } from 'ckeditor5/src/utils.js';
+/**
+ * The merge cell command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCellRight'`, `'mergeTableCellLeft'`,
+ * `'mergeTableCellUp'` and `'mergeTableCellDown'` editor commands.
+ *
+ * To merge a table cell at the current selection with another cell, execute the command corresponding with the preferred direction.
+ *
+ * For example, to merge with a cell to the right:
+ *
+ * ```ts
+ * editor.execute( 'mergeTableCellRight' );
+ * ```
+ *
+ * **Note**: If a table cell has a different [`rowspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-rowspan)
+ * (for `'mergeTableCellRight'` and `'mergeTableCellLeft'`) or [`colspan`](https://www.w3.org/TR/html50/tabular-data.html#attr-tdth-colspan)
+ * (for `'mergeTableCellUp'` and `'mergeTableCellDown'`), the command will be disabled.
+ */
+export default class MergeCellCommand extends Command {
+    /**
+     * The direction that indicates which cell will be merged with the currently selected one.
+     */
+    readonly direction: ArrowKeyCodeDirection;
+    /**
+     * Whether the merge is horizontal (left/right) or vertical (up/down).
+     */
+    readonly isHorizontal: boolean;
+    /**
+     * @inheritDoc
+     */
+    value: Node | undefined;
+    /**
+     * Creates a new `MergeCellCommand` instance.
+     *
+     * @param editor The editor on which this command will be used.
+     * @param options.direction Indicates which cell to merge with the currently selected one.
+     * Possible values are: `'left'`, `'right'`, `'up'` and `'down'`.
+     */
+    constructor(editor: Editor, options: {
+        direction: ArrowKeyCodeDirection;
+    });
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * Depending on the command's {@link #direction} value, it will merge the cell that is to the `'left'`, `'right'`, `'up'` or `'down'`.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * Returns a cell that can be merged with the current cell depending on the command's direction.
+     */
+    private _getMergeableCell;
+}