@ckeditor/ckeditor5-table 48.8.1-alpha.4 → 49.0.0-alpha.1

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

@@ -1,110 +1,110 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module table/utils/table-properties
- */
-import type { BoxStyleSides } from '@ckeditor/ckeditor5-engine';
+* @module table/utils/table-properties
+*/
+import type { BoxStyleSides } from "@ckeditor/ckeditor5-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' } );
- * ```
- *
- * @internal
- */
+* 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' } );
+* ```
+*
+* @internal
+*/
 export declare function getSingleValue(objectOrString: BoxStyleSides | 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'
- * ```
- *
- * @internal
- * @param defaultUnit A default unit added to a numeric value.
- */
+* 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'
+* ```
+*
+* @internal
+* @param defaultUnit A default unit added to a numeric value.
+*/
 export declare function addDefaultUnitToNumericValue(value: string | number | undefined, defaultUnit: string): string | number | undefined;
 /**
- * Interface representing the normalized default properties for table and cell elements.
- *
- * @internal
- */
+* Interface representing the normalized default properties for table and cell elements.
+*
+* @internal
+*/
 export interface NormalizedDefaultProperties {
-    borderStyle: string;
-    borderWidth: string;
-    borderColor: string;
-    backgroundColor: string;
-    width: string;
-    height: string;
-    alignment?: string;
-    padding?: string;
-    verticalAlignment?: string;
-    horizontalAlignment?: string;
+	borderStyle: string;
+	borderWidth: string;
+	borderColor: string;
+	backgroundColor: string;
+	width: string;
+	height: string;
+	alignment?: string;
+	padding?: string;
+	verticalAlignment?: string;
+	horizontalAlignment?: string;
 }
 /**
- * Options used to determine which properties should be added to the normalized configuration.
- *
- * @internal
- */
+* Options used to determine which properties should be added to the normalized configuration.
+*
+* @internal
+*/
 export type NormalizeTableDefaultPropertiesOptions = {
-    /**
-     * Whether the "alignment" property should be added.
-     */
-    includeAlignmentProperty?: boolean;
-    /**
-     * Whether the "padding" property should be added.
-     */
-    includePaddingProperty?: boolean;
-    /**
-     * Whether the "verticalAlignment" property should be added.
-     */
-    includeVerticalAlignmentProperty?: boolean;
-    /**
-     * Whether the "horizontalAlignment" property should be added.
-     */
-    includeHorizontalAlignmentProperty?: boolean;
-    /**
-     * Whether the content is right-to-left.
-     */
-    isRightToLeftContent?: boolean;
+	/**
+	* Whether the "alignment" property should be added.
+	*/
+	includeAlignmentProperty?: boolean;
+	/**
+	* Whether the "padding" property should be added.
+	*/
+	includePaddingProperty?: boolean;
+	/**
+	* Whether the "verticalAlignment" property should be added.
+	*/
+	includeVerticalAlignmentProperty?: boolean;
+	/**
+	* Whether the "horizontalAlignment" property should be added.
+	*/
+	includeHorizontalAlignmentProperty?: boolean;
+	/**
+	* Whether the content is right-to-left.
+	*/
+	isRightToLeftContent?: boolean;
 };
 /**
- * Returns the normalized configuration.
- *
- * @internal
- * @param config The configuration to normalize.
- * @param options Options used to determine which properties should be added.
- */
+* Returns the normalized configuration.
+*
+* @internal
+* @param config The configuration to normalize.
+* @param options Options used to determine which properties should be added.
+*/
 export declare function getNormalizedDefaultProperties(config?: Partial<NormalizedDefaultProperties>, options?: NormalizeTableDefaultPropertiesOptions): NormalizedDefaultProperties;
 /**
- * Returns the normalized default table properties.
- *
- * @internal
- * @param config The configuration to normalize.
- * @param options Options used to determine which properties should be added.
- */
+* Returns the normalized default table properties.
+*
+* @internal
+* @param config The configuration to normalize.
+* @param options Options used to determine which properties should be added.
+*/
 export declare function getNormalizedDefaultTableProperties(config?: Partial<NormalizedDefaultProperties>, options?: NormalizeTableDefaultPropertiesOptions): NormalizedDefaultProperties;
 /**
- * Returns the normalized default cell properties.
- *
- * @internal
- * @param config The configuration to normalize.
- * @param options Options used to determine which properties should be added.
- */
+* Returns the normalized default cell properties.
+*
+* @internal
+* @param config The configuration to normalize.
+* @param options Options used to determine which properties should be added.
+*/
 export declare function getNormalizedDefaultCellProperties(config?: Partial<NormalizedDefaultProperties>, options?: NormalizeTableDefaultPropertiesOptions): NormalizedDefaultProperties;

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

@@ -1,36 +1,36 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module table/utils/ui/contextualballoon
- */
-import { type DomOptimalPositionOptions } from '@ckeditor/ckeditor5-utils';
-import type { Editor } from '@ckeditor/ckeditor5-core';
+* @module table/utils/ui/contextualballoon
+*/
+import { type DomOptimalPositionOptions } from "@ckeditor/ckeditor5-utils";
+import type { Editor } from "@ckeditor/ckeditor5-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.
- *
- * @internal
- * @param editor The editor instance.
- * @param target Either "cell" or "table". Determines the target the balloon will be attached to.
- */
+* 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.
+*
+* @internal
+* @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.
- */
+* 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<DomOptimalPositionOptions>;
 /**
- * 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.
- * @internal
- */
+* 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.
+* @internal
+*/
 export declare function getBalloonCellPositionData(editor: Editor): Partial<DomOptimalPositionOptions>;

package/dist/utils/ui/table-properties.d.ts

@@ -1,215 +1,153 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module table/utils/ui/table-properties
- */
-import { type ColorOption, type LabeledFieldView, type ListDropdownItemDefinition, type NormalizedColorOption, type ToolbarView, type View, type ColorPickerConfig } from '@ckeditor/ckeditor5-ui';
-import { Collection, type LocaleTranslate } from '@ckeditor/ckeditor5-utils';
-import { type TableCellPropertiesView } from '../../tablecellproperties/ui/tablecellpropertiesview.js';
-import { type TablePropertiesView } from '../../tableproperties/ui/tablepropertiesview.js';
-import { ColorInputView } from '../../ui/colorinputview.js';
+* @module table/utils/ui/table-properties
+*/
+import { type ColorOption, type LabeledFieldView, type ListDropdownItemDefinition, type NormalizedColorOption, type ToolbarView, type View, type ColorPickerConfig } from "@ckeditor/ckeditor5-ui";
+import { Collection, type LocaleTranslate } from "@ckeditor/ckeditor5-utils";
+import { type TableCellPropertiesView } from "../../tablecellproperties/ui/tablecellpropertiesview.js";
+import { type TablePropertiesView } from "../../tableproperties/ui/tablepropertiesview.js";
+import { ColorInputView } from "../../ui/colorinputview.js";
 /**
- * Returns an object containing pairs of CSS border style values and their localized UI
- * labels. Used by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}
- * and {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView}.
- *
- * @internal
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
+* Returns an object containing pairs of CSS border style values and their localized UI
+* labels. Used by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}
+* and {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView}.
+*
+* @internal
+* @param t The "t" function provided by the editor that is used to localize strings.
+*/
 export declare function getBorderStyleLabels(t: LocaleTranslate): Record<string, string>;
 /**
- * Returns a localized error string that can be displayed next to color (background, border)
- * fields that have an invalid value.
- *
- * @internal
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
+* Returns a localized error string that can be displayed next to color (background, border)
+* fields that have an invalid value.
+*
+* @internal
+* @param t The "t" function provided by the editor that is used to localize strings.
+*/
 export declare function getLocalizedColorErrorText(t: LocaleTranslate): string;
 /**
- * Returns a localized error string that can be displayed next to length (padding, border width)
- * fields that have an invalid value.
- *
- * @internal
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
+* Returns a localized error string that can be displayed next to length (padding, border width)
+* fields that have an invalid value.
+*
+* @internal
+* @param t The "t" function provided by the editor that is used to localize strings.
+*/
 export declare function getLocalizedLengthErrorText(t: LocaleTranslate): string;
 /**
- * Returns `true` when the passed value is an empty string or a valid CSS color expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isColorStyleValue}.
- *
- * @internal
- */
+* Returns `true` when the passed value is an empty string or a valid CSS color expression.
+* Otherwise, `false` is returned.
+*
+* See {@link module:engine/view/styles/utils~isColorStyleValue}.
+*
+* @internal
+*/
 export declare function colorFieldValidator(value: string): boolean;
 /**
- * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isLengthStyleValue}.
- * See {@link module:engine/view/styles/utils~isPercentageStyleValue}.
- *
- * @internal
- */
+* Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
+* Otherwise, `false` is returned.
+*
+* See {@link module:engine/view/styles/utils~isLengthStyleValue}.
+* See {@link module:engine/view/styles/utils~isPercentageStyleValue}.
+*
+* @internal
+*/
 export declare function lengthFieldValidator(value: string): boolean;
 /**
- * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isLengthStyleValue}.
- *
- * @internal
- */
+* Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
+* Otherwise, `false` is returned.
+*
+* See {@link module:engine/view/styles/utils~isLengthStyleValue}.
+*
+* @internal
+*/
 export declare function lineWidthFieldValidator(value: string): boolean;
 /**
- * Generates item definitions for a UI dropdown that allows changing the border style of a table or a table cell.
- *
- * @internal
- * @param defaultStyle The default border.
- */
+* Generates item definitions for a UI dropdown that allows changing the border style of a table or a table cell.
+*
+* @internal
+* @param defaultStyle The default border.
+*/
 export declare function getBorderStyleDefinitions(view: TableCellPropertiesView | TablePropertiesView, defaultStyle: string): Collection<ListDropdownItemDefinition>;
 /**
- * A helper that fills a toolbar with buttons that:
- *
- * * have some labels,
- * * have some icons,
- * * set a certain UI view property value upon execution.
- *
- * @internal
- * @param options Configuration options
- * @param options.view The view that has the observable property.
- * @param options.icons Object with button icons.
- * @param options.toolbar The toolbar to fill with buttons.
- * @param options.labels Object with button labels.
- * @param options.propertyName The name of the observable property in the view.
- * @param options.nameToValue A function that maps a button name to a value. By default names are the same as values.
- * @param options.defaultValue Default value for the property.
- */
-export declare function fillToolbar<TView extends View, TPropertyName extends keyof TView>(options: {
-    view: TView;
-    icons: Record<string, string>;
-    toolbar: ToolbarView;
-    labels: Record<number, string>;
-    propertyName: TPropertyName;
-    nameToValue?: (name: string) => string;
-    defaultValue?: string;
+* A helper that fills a toolbar with buttons that:
+*
+* * have some labels,
+* * have some icons,
+* * set a certain UI view property value upon execution.
+*
+* @internal
+* @param options Configuration options
+* @param options.view The view that has the observable property.
+* @param options.icons Object with button icons.
+* @param options.toolbar The toolbar to fill with buttons.
+* @param options.labels Object with button labels.
+* @param options.propertyName The name of the observable property in the view.
+* @param options.nameToValue A function that maps a button name to a value. By default names are the same as values.
+* @param options.defaultValue Default value for the property.
+*/
+export declare function fillToolbar<
+	TView extends View,
+	TPropertyName extends keyof TView
+>(options: {
+	view: TView;
+	icons: Record<string, string>;
+	toolbar: ToolbarView;
+	labels: Record<number, string>;
+	propertyName: TPropertyName;
+	nameToValue?: (name: string) => string;
+	defaultValue?: string;
 }): void;
 /**
- * A default color palette used by various user interfaces related to tables, for instance,
- * by {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI} or
- * {@link module:table/tableproperties/tablepropertiesui~TablePropertiesUI}.
- *
- * The color palette follows the {@link module:table/tableconfig~TableColorConfig table color configuration format}
- * and contains the following color definitions:
- *
- * ```ts
- * const defaultColors = [
- *   {
- *     color: 'hsl(0, 0%, 0%)',
- *     label: 'Black'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 30%)',
- *     label: 'Dim grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 60%)',
- *     label: 'Grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 90%)',
- *     label: 'Light grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 100%)',
- *     label: 'White',
- *     hasBorder: true
- *   },
- *   {
- *     color: 'hsl(0, 75%, 60%)',
- *     label: 'Red'
- *   },
- *   {
- *     color: 'hsl(30, 75%, 60%)',
- *     label: 'Orange'
- *   },
- *   {
- *     color: 'hsl(60, 75%, 60%)',
- *     label: 'Yellow'
- *   },
- *   {
- *     color: 'hsl(90, 75%, 60%)',
- *     label: 'Light green'
- *   },
- *   {
- *     color: 'hsl(120, 75%, 60%)',
- *     label: 'Green'
- *   },
- *   {
- *     color: 'hsl(150, 75%, 60%)',
- *     label: 'Aquamarine'
- *   },
- *   {
- *     color: 'hsl(180, 75%, 60%)',
- *     label: 'Turquoise'
- *   },
- *   {
- *     color: 'hsl(210, 75%, 60%)',
- *     label: 'Light blue'
- *   },
- *   {
- *     color: 'hsl(240, 75%, 60%)',
- *     label: 'Blue'
- *   },
- *   {
- *     color: 'hsl(270, 75%, 60%)',
- *     label: 'Purple'
- *   }
- * ];
- * ```
- *
- * @internal
- */
+* A default color palette used by various user interfaces related to tables, for instance,
+* by {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI} or
+* {@link module:table/tableproperties/tablepropertiesui~TablePropertiesUI}.
+*
+* The color palette follows the {@link module:table/tableconfig~TableColorConfig table color configuration format}
+* and is shared with the other features that display a color grid. See
+* {@link module:ui/colorgrid/colors~defaultColors} for its contents.
+*
+* @internal
+*/
 export declare const defaultColors: Array<ColorOption>;
 /**
- * Returns a creator for a color input with a label.
- *
- * For given options, it returns a function that creates an instance of a
- * {@link module:table/ui/colorinputview~ColorInputView color input} logically related to
- * a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled view} in the DOM.
- *
- * The helper does the following:
- *
- * * It sets the color input `id` and `ariaDescribedById` attributes.
- * * It binds the color input `isReadOnly` to the labeled view.
- * * It binds the color input `hasError` to the labeled view.
- * * It enables a logic that cleans up the error when the user starts typing in the color input.
- *
- * Usage:
- *
- * ```ts
- * const colorInputCreator = getLabeledColorInputCreator( {
- *   colorConfig: [ ... ],
- *   columns: 3,
- * } );
- *
- * const labeledInputView = new LabeledFieldView( locale, colorInputCreator );
- * console.log( labeledInputView.view ); // A color input instance.
- * ```
- *
- * @internal
- * @param options Color input options.
- * @param options.colorConfig The configuration of the color palette displayed in the input's dropdown.
- * @param options.columns The configuration of the number of columns the color palette consists of in the input's dropdown.
- * @param options.defaultColorValue If specified, the color input view will replace the "Remove color" button with
- * the "Restore default" button. Instead of clearing the input field, the default color value will be set.
- * @param options.colorPickerConfig The configuration of the color picker. You could disable it or define your output format.
- */
+* Returns a creator for a color input with a label.
+*
+* For given options, it returns a function that creates an instance of a
+* {@link module:table/ui/colorinputview~ColorInputView color input} logically related to
+* a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled view} in the DOM.
+*
+* The helper does the following:
+*
+* * It sets the color input `id` and `ariaDescribedById` attributes.
+* * It binds the color input `isReadOnly` to the labeled view.
+* * It binds the color input `hasError` to the labeled view.
+* * It enables a logic that cleans up the error when the user starts typing in the color input.
+*
+* Usage:
+*
+* ```ts
+* const colorInputCreator = getLabeledColorInputCreator( {
+*   colorConfig: [ ... ],
+*   columns: 3,
+* } );
+*
+* const labeledInputView = new LabeledFieldView( locale, colorInputCreator );
+* console.log( labeledInputView.view ); // A color input instance.
+* ```
+*
+* @internal
+* @param options Color input options.
+* @param options.colorConfig The configuration of the color palette displayed in the input's dropdown.
+* @param options.columns The configuration of the number of columns the color palette consists of in the input's dropdown.
+* @param options.defaultColorValue If specified, the color input view will replace the "Remove color" button with
+* the "Restore default" button. Instead of clearing the input field, the default color value will be set.
+* @param options.colorPickerConfig The configuration of the color picker. You could disable it or define your output format.
+*/
 export declare function getLabeledColorInputCreator(options: {
-    colorConfig: Array<NormalizedColorOption>;
-    columns: number;
-    defaultColorValue?: string;
-    colorPickerConfig: false | ColorPickerConfig;
+	colorConfig: Array<NormalizedColorOption>;
+	columns?: number;
+	defaultColorValue?: string;
+	colorPickerConfig: false | ColorPickerConfig;
 }): (labeledFieldView: LabeledFieldView, viewUid: string, statusUid: string) => ColorInputView;