@ckeditor/ckeditor5-table 39.0.2 → 40.0.0

package/src/utils/table-properties.d.ts

@@ -1,67 +1,67 @@
-/**
- * @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/table-properties
- */
-import type { BoxSides } from 'ckeditor5/src/engine';
-/**
- * Returns a string if all four values of box sides are equal.
- *
- * If a string is passed, it is treated as a single value (pass-through).
- *
- * ```ts
- * // Returns 'foo':
- * getSingleValue( { top: 'foo', right: 'foo', bottom: 'foo', left: 'foo' } );
- * getSingleValue( 'foo' );
- *
- * // Returns undefined:
- * getSingleValue( { top: 'foo', right: 'foo', bottom: 'bar', left: 'foo' } );
- * getSingleValue( { top: 'foo', right: 'foo' } );
- * ```
- */
-export declare function getSingleValue(objectOrString: BoxSides | string | undefined): string | undefined;
-/**
- * Adds a unit to a value if the value is a number or a string representing a number.
- *
- * **Note**: It does nothing to non-numeric values.
- *
- * ```ts
- * getSingleValue( 25, 'px' ); // '25px'
- * getSingleValue( 25, 'em' ); // '25em'
- * getSingleValue( '25em', 'px' ); // '25em'
- * getSingleValue( 'foo', 'px' ); // 'foo'
- * ```
- *
- * @param defaultUnit A default unit added to a numeric value.
- */
-export declare function addDefaultUnitToNumericValue(value: string | number | undefined, defaultUnit: string): string | number | undefined;
-export interface NormalizedDefaultProperties {
-    borderStyle: string;
-    borderWidth: string;
-    borderColor: string;
-    backgroundColor: string;
-    width: string;
-    height: string;
-    alignment?: string;
-    padding?: string;
-    verticalAlignment?: string;
-    horizontalAlignment?: string;
-}
-/**
- * Returns the normalized configuration.
- *
- * @param options.includeAlignmentProperty Whether the "alignment" property should be added.
- * @param options.includePaddingProperty Whether the "padding" property should be added.
- * @param options.includeVerticalAlignmentProperty Whether the "verticalAlignment" property should be added.
- * @param options.includeHorizontalAlignmentProperty Whether the "horizontalAlignment" property should be added.
- * @param options.isRightToLeftContent Whether the content is right-to-left.
- */
-export declare function getNormalizedDefaultProperties(config: Partial<NormalizedDefaultProperties> | undefined, options?: {
-    includeAlignmentProperty?: boolean;
-    includePaddingProperty?: boolean;
-    includeVerticalAlignmentProperty?: boolean;
-    includeHorizontalAlignmentProperty?: boolean;
-    isRightToLeftContent?: boolean;
-}): NormalizedDefaultProperties;
+/**
+ * @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/table-properties
+ */
+import type { BoxSides } from 'ckeditor5/src/engine';
+/**
+ * Returns a string if all four values of box sides are equal.
+ *
+ * If a string is passed, it is treated as a single value (pass-through).
+ *
+ * ```ts
+ * // Returns 'foo':
+ * getSingleValue( { top: 'foo', right: 'foo', bottom: 'foo', left: 'foo' } );
+ * getSingleValue( 'foo' );
+ *
+ * // Returns undefined:
+ * getSingleValue( { top: 'foo', right: 'foo', bottom: 'bar', left: 'foo' } );
+ * getSingleValue( { top: 'foo', right: 'foo' } );
+ * ```
+ */
+export declare function getSingleValue(objectOrString: BoxSides | string | undefined): string | undefined;
+/**
+ * Adds a unit to a value if the value is a number or a string representing a number.
+ *
+ * **Note**: It does nothing to non-numeric values.
+ *
+ * ```ts
+ * getSingleValue( 25, 'px' ); // '25px'
+ * getSingleValue( 25, 'em' ); // '25em'
+ * getSingleValue( '25em', 'px' ); // '25em'
+ * getSingleValue( 'foo', 'px' ); // 'foo'
+ * ```
+ *
+ * @param defaultUnit A default unit added to a numeric value.
+ */
+export declare function addDefaultUnitToNumericValue(value: string | number | undefined, defaultUnit: string): string | number | undefined;
+export interface NormalizedDefaultProperties {
+    borderStyle: string;
+    borderWidth: string;
+    borderColor: string;
+    backgroundColor: string;
+    width: string;
+    height: string;
+    alignment?: string;
+    padding?: string;
+    verticalAlignment?: string;
+    horizontalAlignment?: string;
+}
+/**
+ * Returns the normalized configuration.
+ *
+ * @param options.includeAlignmentProperty Whether the "alignment" property should be added.
+ * @param options.includePaddingProperty Whether the "padding" property should be added.
+ * @param options.includeVerticalAlignmentProperty Whether the "verticalAlignment" property should be added.
+ * @param options.includeHorizontalAlignmentProperty Whether the "horizontalAlignment" property should be added.
+ * @param options.isRightToLeftContent Whether the content is right-to-left.
+ */
+export declare function getNormalizedDefaultProperties(config: Partial<NormalizedDefaultProperties> | undefined, options?: {
+    includeAlignmentProperty?: boolean;
+    includePaddingProperty?: boolean;
+    includeVerticalAlignmentProperty?: boolean;
+    includeHorizontalAlignmentProperty?: boolean;
+    isRightToLeftContent?: boolean;
+}): NormalizedDefaultProperties;

package/src/utils/table-properties.js

@@ -1,86 +1,86 @@
-/**
- * @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
- */
-import { isObject } from 'lodash-es';
-/**
- * Returns a string if all four values of box sides are equal.
- *
- * If a string is passed, it is treated as a single value (pass-through).
- *
- * ```ts
- * // Returns 'foo':
- * getSingleValue( { top: 'foo', right: 'foo', bottom: 'foo', left: 'foo' } );
- * getSingleValue( 'foo' );
- *
- * // Returns undefined:
- * getSingleValue( { top: 'foo', right: 'foo', bottom: 'bar', left: 'foo' } );
- * getSingleValue( { top: 'foo', right: 'foo' } );
- * ```
- */
-export function getSingleValue(objectOrString) {
-    if (!objectOrString || !isObject(objectOrString)) {
-        return objectOrString;
-    }
-    const { top, right, bottom, left } = objectOrString;
-    if (top == right && right == bottom && bottom == left) {
-        return top;
-    }
-}
-/**
- * Adds a unit to a value if the value is a number or a string representing a number.
- *
- * **Note**: It does nothing to non-numeric values.
- *
- * ```ts
- * getSingleValue( 25, 'px' ); // '25px'
- * getSingleValue( 25, 'em' ); // '25em'
- * getSingleValue( '25em', 'px' ); // '25em'
- * getSingleValue( 'foo', 'px' ); // 'foo'
- * ```
- *
- * @param defaultUnit A default unit added to a numeric value.
- */
-export function addDefaultUnitToNumericValue(value, defaultUnit) {
-    const numericValue = parseFloat(value);
-    if (Number.isNaN(numericValue)) {
-        return value;
-    }
-    if (String(numericValue) !== String(value)) {
-        return value;
-    }
-    return `${numericValue}${defaultUnit}`;
-}
-/**
- * Returns the normalized configuration.
- *
- * @param options.includeAlignmentProperty Whether the "alignment" property should be added.
- * @param options.includePaddingProperty Whether the "padding" property should be added.
- * @param options.includeVerticalAlignmentProperty Whether the "verticalAlignment" property should be added.
- * @param options.includeHorizontalAlignmentProperty Whether the "horizontalAlignment" property should be added.
- * @param options.isRightToLeftContent Whether the content is right-to-left.
- */
-export function getNormalizedDefaultProperties(config, options = {}) {
-    const normalizedConfig = {
-        borderStyle: 'none',
-        borderWidth: '',
-        borderColor: '',
-        backgroundColor: '',
-        width: '',
-        height: '',
-        ...config
-    };
-    if (options.includeAlignmentProperty && !normalizedConfig.alignment) {
-        normalizedConfig.alignment = 'center';
-    }
-    if (options.includePaddingProperty && !normalizedConfig.padding) {
-        normalizedConfig.padding = '';
-    }
-    if (options.includeVerticalAlignmentProperty && !normalizedConfig.verticalAlignment) {
-        normalizedConfig.verticalAlignment = 'middle';
-    }
-    if (options.includeHorizontalAlignmentProperty && !normalizedConfig.horizontalAlignment) {
-        normalizedConfig.horizontalAlignment = options.isRightToLeftContent ? 'right' : 'left';
-    }
-    return normalizedConfig;
-}
+/**
+ * @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
+ */
+import { isObject } from 'lodash-es';
+/**
+ * Returns a string if all four values of box sides are equal.
+ *
+ * If a string is passed, it is treated as a single value (pass-through).
+ *
+ * ```ts
+ * // Returns 'foo':
+ * getSingleValue( { top: 'foo', right: 'foo', bottom: 'foo', left: 'foo' } );
+ * getSingleValue( 'foo' );
+ *
+ * // Returns undefined:
+ * getSingleValue( { top: 'foo', right: 'foo', bottom: 'bar', left: 'foo' } );
+ * getSingleValue( { top: 'foo', right: 'foo' } );
+ * ```
+ */
+export function getSingleValue(objectOrString) {
+    if (!objectOrString || !isObject(objectOrString)) {
+        return objectOrString;
+    }
+    const { top, right, bottom, left } = objectOrString;
+    if (top == right && right == bottom && bottom == left) {
+        return top;
+    }
+}
+/**
+ * Adds a unit to a value if the value is a number or a string representing a number.
+ *
+ * **Note**: It does nothing to non-numeric values.
+ *
+ * ```ts
+ * getSingleValue( 25, 'px' ); // '25px'
+ * getSingleValue( 25, 'em' ); // '25em'
+ * getSingleValue( '25em', 'px' ); // '25em'
+ * getSingleValue( 'foo', 'px' ); // 'foo'
+ * ```
+ *
+ * @param defaultUnit A default unit added to a numeric value.
+ */
+export function addDefaultUnitToNumericValue(value, defaultUnit) {
+    const numericValue = parseFloat(value);
+    if (Number.isNaN(numericValue)) {
+        return value;
+    }
+    if (String(numericValue) !== String(value)) {
+        return value;
+    }
+    return `${numericValue}${defaultUnit}`;
+}
+/**
+ * Returns the normalized configuration.
+ *
+ * @param options.includeAlignmentProperty Whether the "alignment" property should be added.
+ * @param options.includePaddingProperty Whether the "padding" property should be added.
+ * @param options.includeVerticalAlignmentProperty Whether the "verticalAlignment" property should be added.
+ * @param options.includeHorizontalAlignmentProperty Whether the "horizontalAlignment" property should be added.
+ * @param options.isRightToLeftContent Whether the content is right-to-left.
+ */
+export function getNormalizedDefaultProperties(config, options = {}) {
+    const normalizedConfig = {
+        borderStyle: 'none',
+        borderWidth: '',
+        borderColor: '',
+        backgroundColor: '',
+        width: '',
+        height: '',
+        ...config
+    };
+    if (options.includeAlignmentProperty && !normalizedConfig.alignment) {
+        normalizedConfig.alignment = 'center';
+    }
+    if (options.includePaddingProperty && !normalizedConfig.padding) {
+        normalizedConfig.padding = '';
+    }
+    if (options.includeVerticalAlignmentProperty && !normalizedConfig.verticalAlignment) {
+        normalizedConfig.verticalAlignment = 'middle';
+    }
+    if (options.includeHorizontalAlignmentProperty && !normalizedConfig.horizontalAlignment) {
+        normalizedConfig.horizontalAlignment = options.isRightToLeftContent ? 'right' : 'left';
+    }
+    return normalizedConfig;
+}

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

@@ -1,34 +1,34 @@
-/**
- * @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/contextualballoon
- */
-import { type PositionOptions } from 'ckeditor5/src/utils';
-import type { Editor } from 'ckeditor5/src/core';
-/**
- * A helper utility that positions the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
- * with respect to the table in the editor content, if one is selected.
- *
- * @param editor The editor instance.
- * @param target Either "cell" or "table". Determines the target the balloon will be attached to.
- */
-export declare function repositionContextualBalloon(editor: Editor, target: string): void;
-/**
- * Returns the positioning options that control the geometry of the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
- * to the selected table in the editor content.
- *
- * @param editor The editor instance.
- */
-export declare function getBalloonTablePositionData(editor: Editor): Partial<PositionOptions>;
-/**
- * Returns the positioning options that control the geometry of the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
- * to the selected table cell in the editor content.
- *
- * @param editor The editor instance.
- */
-export declare function getBalloonCellPositionData(editor: Editor): Partial<PositionOptions>;
+/**
+ * @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/contextualballoon
+ */
+import { type PositionOptions } from 'ckeditor5/src/utils';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * A helper utility that positions the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
+ * with respect to the table in the editor content, if one is selected.
+ *
+ * @param editor The editor instance.
+ * @param target Either "cell" or "table". Determines the target the balloon will be attached to.
+ */
+export declare function repositionContextualBalloon(editor: Editor, target: string): void;
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected table in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export declare function getBalloonTablePositionData(editor: Editor): Partial<PositionOptions>;
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected table cell in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export declare function getBalloonCellPositionData(editor: Editor): Partial<PositionOptions>;

package/src/utils/ui/contextualballoon.js

@@ -1,106 +1,106 @@
-/**
- * @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/contextualballoon
- */
-import { Rect } from 'ckeditor5/src/utils';
-import { BalloonPanelView } from 'ckeditor5/src/ui';
-import { getTableWidgetAncestor } from './widget';
-const DEFAULT_BALLOON_POSITIONS = BalloonPanelView.defaultPositions;
-const BALLOON_POSITIONS = [
-    DEFAULT_BALLOON_POSITIONS.northArrowSouth,
-    DEFAULT_BALLOON_POSITIONS.northArrowSouthWest,
-    DEFAULT_BALLOON_POSITIONS.northArrowSouthEast,
-    DEFAULT_BALLOON_POSITIONS.southArrowNorth,
-    DEFAULT_BALLOON_POSITIONS.southArrowNorthWest,
-    DEFAULT_BALLOON_POSITIONS.southArrowNorthEast,
-    DEFAULT_BALLOON_POSITIONS.viewportStickyNorth
-];
-/**
- * A helper utility that positions the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
- * with respect to the table in the editor content, if one is selected.
- *
- * @param editor The editor instance.
- * @param target Either "cell" or "table". Determines the target the balloon will be attached to.
- */
-export function repositionContextualBalloon(editor, target) {
-    const balloon = editor.plugins.get('ContextualBalloon');
-    if (getTableWidgetAncestor(editor.editing.view.document.selection)) {
-        let position;
-        if (target === 'cell') {
-            position = getBalloonCellPositionData(editor);
-        }
-        else {
-            position = getBalloonTablePositionData(editor);
-        }
-        balloon.updatePosition(position);
-    }
-}
-/**
- * Returns the positioning options that control the geometry of the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
- * to the selected table in the editor content.
- *
- * @param editor The editor instance.
- */
-export function getBalloonTablePositionData(editor) {
-    const firstPosition = editor.model.document.selection.getFirstPosition();
-    const modelTable = firstPosition.findAncestor('table');
-    const viewTable = editor.editing.mapper.toViewElement(modelTable);
-    return {
-        target: editor.editing.view.domConverter.mapViewToDom(viewTable),
-        positions: BALLOON_POSITIONS
-    };
-}
-/**
- * Returns the positioning options that control the geometry of the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
- * to the selected table cell in the editor content.
- *
- * @param editor The editor instance.
- */
-export function getBalloonCellPositionData(editor) {
-    const mapper = editor.editing.mapper;
-    const domConverter = editor.editing.view.domConverter;
-    const selection = editor.model.document.selection;
-    if (selection.rangeCount > 1) {
-        return {
-            target: () => createBoundingRect(selection.getRanges(), editor),
-            positions: BALLOON_POSITIONS
-        };
-    }
-    const modelTableCell = getTableCellAtPosition(selection.getFirstPosition());
-    const viewTableCell = mapper.toViewElement(modelTableCell);
-    return {
-        target: domConverter.mapViewToDom(viewTableCell),
-        positions: BALLOON_POSITIONS
-    };
-}
-/**
- * Returns the first selected table cell from a multi-cell or in-cell selection.
- *
- * @param position Document position.
- */
-function getTableCellAtPosition(position) {
-    const isTableCellSelected = position.nodeAfter && position.nodeAfter.is('element', 'tableCell');
-    return isTableCellSelected ? position.nodeAfter : position.findAncestor('tableCell');
-}
-/**
- * Returns bounding rectangle for given model ranges.
- *
- * @param ranges Model ranges that the bounding rect should be returned for.
- * @param editor The editor instance.
- */
-function createBoundingRect(ranges, editor) {
-    const mapper = editor.editing.mapper;
-    const domConverter = editor.editing.view.domConverter;
-    const rects = Array.from(ranges).map(range => {
-        const modelTableCell = getTableCellAtPosition(range.start);
-        const viewTableCell = mapper.toViewElement(modelTableCell);
-        return new Rect(domConverter.mapViewToDom(viewTableCell));
-    });
-    return Rect.getBoundingRect(rects);
-}
+/**
+ * @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/contextualballoon
+ */
+import { Rect } from 'ckeditor5/src/utils';
+import { BalloonPanelView } from 'ckeditor5/src/ui';
+import { getTableWidgetAncestor } from './widget';
+const DEFAULT_BALLOON_POSITIONS = BalloonPanelView.defaultPositions;
+const BALLOON_POSITIONS = [
+    DEFAULT_BALLOON_POSITIONS.northArrowSouth,
+    DEFAULT_BALLOON_POSITIONS.northArrowSouthWest,
+    DEFAULT_BALLOON_POSITIONS.northArrowSouthEast,
+    DEFAULT_BALLOON_POSITIONS.southArrowNorth,
+    DEFAULT_BALLOON_POSITIONS.southArrowNorthWest,
+    DEFAULT_BALLOON_POSITIONS.southArrowNorthEast,
+    DEFAULT_BALLOON_POSITIONS.viewportStickyNorth
+];
+/**
+ * A helper utility that positions the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
+ * with respect to the table in the editor content, if one is selected.
+ *
+ * @param editor The editor instance.
+ * @param target Either "cell" or "table". Determines the target the balloon will be attached to.
+ */
+export function repositionContextualBalloon(editor, target) {
+    const balloon = editor.plugins.get('ContextualBalloon');
+    if (getTableWidgetAncestor(editor.editing.view.document.selection)) {
+        let position;
+        if (target === 'cell') {
+            position = getBalloonCellPositionData(editor);
+        }
+        else {
+            position = getBalloonTablePositionData(editor);
+        }
+        balloon.updatePosition(position);
+    }
+}
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected table in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export function getBalloonTablePositionData(editor) {
+    const firstPosition = editor.model.document.selection.getFirstPosition();
+    const modelTable = firstPosition.findAncestor('table');
+    const viewTable = editor.editing.mapper.toViewElement(modelTable);
+    return {
+        target: editor.editing.view.domConverter.mapViewToDom(viewTable),
+        positions: BALLOON_POSITIONS
+    };
+}
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected table cell in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export function getBalloonCellPositionData(editor) {
+    const mapper = editor.editing.mapper;
+    const domConverter = editor.editing.view.domConverter;
+    const selection = editor.model.document.selection;
+    if (selection.rangeCount > 1) {
+        return {
+            target: () => createBoundingRect(selection.getRanges(), editor),
+            positions: BALLOON_POSITIONS
+        };
+    }
+    const modelTableCell = getTableCellAtPosition(selection.getFirstPosition());
+    const viewTableCell = mapper.toViewElement(modelTableCell);
+    return {
+        target: domConverter.mapViewToDom(viewTableCell),
+        positions: BALLOON_POSITIONS
+    };
+}
+/**
+ * Returns the first selected table cell from a multi-cell or in-cell selection.
+ *
+ * @param position Document position.
+ */
+function getTableCellAtPosition(position) {
+    const isTableCellSelected = position.nodeAfter && position.nodeAfter.is('element', 'tableCell');
+    return isTableCellSelected ? position.nodeAfter : position.findAncestor('tableCell');
+}
+/**
+ * Returns bounding rectangle for given model ranges.
+ *
+ * @param ranges Model ranges that the bounding rect should be returned for.
+ * @param editor The editor instance.
+ */
+function createBoundingRect(ranges, editor) {
+    const mapper = editor.editing.mapper;
+    const domConverter = editor.editing.view.domConverter;
+    const rects = Array.from(ranges).map(range => {
+        const modelTableCell = getTableCellAtPosition(range.start);
+        const viewTableCell = mapper.toViewElement(modelTableCell);
+        return new Rect(domConverter.mapViewToDom(viewTableCell));
+    });
+    return Rect.getBoundingRect(rects);
+}