@ckeditor/ckeditor5-table 44.1.0 → 44.2.0-alpha.1

package/dist/tablecellproperties/commands/tablecellpaddingcommand.d.ts

@@ -1,55 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/commands/tablecellpaddingcommand
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import type { Element } from 'ckeditor5/src/engine.js';
-import TableCellPropertyCommand from './tablecellpropertycommand.js';
-/**
- * The table cell padding command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellPadding'` editor command.
- *
- * To change the padding of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellPadding', {
- *   value: '5px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableCellPadding', {
- *   value: '5'
- * } );
- * ```
- *
- * will set the `padding` attribute to `'5px'` in the model.
- */
-export default class TableCellPaddingCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellPaddingCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value of the attribute.
-     */
-    constructor(editor: Editor, defaultValue: string);
-    /**
-     * @inheritDoc
-     */
-    protected _getAttribute(tableCell: Element): unknown;
-    /**
-     * @inheritDoc
-     */
-    protected _getValueToSet(value: string | number | undefined): unknown;
-}

package/dist/tablecellproperties/commands/tablecellpropertycommand.d.ts

@@ -1,66 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/commands/tablecellpropertycommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import type { Element, Batch } from 'ckeditor5/src/engine.js';
-/**
- * The table cell attribute command.
- *
- * The command is a base command for other table cell property commands.
- */
-export default class TableCellPropertyCommand extends Command {
-    /**
-     * The attribute that will be set by the command.
-     */
-    readonly attributeName: string;
-    /**
-     * The default value for the attribute.
-     */
-    protected readonly _defaultValue: string;
-    /**
-     * Creates a new `TableCellPropertyCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param attributeName Table cell attribute name.
-     * @param defaultValue The default value of the attribute.
-     */
-    constructor(editor: Editor, attributeName: string, defaultValue: string);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.value If set, the command will set the attribute on selected table cells.
-     * If it is not set, the command will remove the attribute from the selected table cells.
-     * @param options.batch Pass the model batch instance to the command to aggregate changes,
-     * for example to allow a single undo step for multiple executions.
-     */
-    execute(options?: {
-        value?: string | number;
-        batch?: Batch;
-    }): void;
-    /**
-     * Returns the attribute value for a table cell.
-     */
-    protected _getAttribute(tableCell: Element | undefined): unknown;
-    /**
-     * Returns the proper model value. It can be used to add a default unit to numeric values.
-     */
-    protected _getValueToSet(value: string | number | undefined): unknown;
-    /**
-     * Returns a single value for all selected table cells. If the value is the same for all cells,
-     * it will be returned (`undefined` otherwise).
-     */
-    private _getSingleValue;
-}

package/dist/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts

@@ -1,44 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/commands/tablecellverticalalignmentcommand
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import TableCellPropertyCommand from './tablecellpropertycommand.js';
-/**
- * The table cell vertical alignment command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellVerticalAlignment'` editor command.
- *
- * To change the vertical text alignment of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellVerticalAlignment', {
- *   value: 'top'
- * } );
- * ```
- *
- * The following values, corresponding to the
- * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
- *
- * * `'top'`
- * * `'bottom'`
- *
- * The `'middle'` value is the default one so there is no need to set it.
- */
-export default class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellVerticalAlignmentCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value for the "alignment" attribute.
-     */
-    constructor(editor: Editor, defaultValue: string);
-}

package/dist/tablecellproperties/tablecellpropertiesediting.d.ts

@@ -1,51 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/tablecellpropertiesediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TableEditing from './../tableediting.js';
-import TableCellWidthEditing from '../tablecellwidth/tablecellwidthediting.js';
-/**
- * The table cell properties editing feature.
- *
- * Introduces table cell model attributes and their conversion:
- *
- * - border: `tableCellBorderStyle`, `tableCellBorderColor` and `tableCellBorderWidth`
- * - background color: `tableCellBackgroundColor`
- * - cell padding: `tableCellPadding`
- * - horizontal and vertical alignment: `tableCellHorizontalAlignment`, `tableCellVerticalAlignment`
- * - cell width and height: `tableCellWidth`, `tableCellHeight`
- *
- * It also registers commands used to manipulate the above attributes:
- *
- * - border: the `'tableCellBorderStyle'`, `'tableCellBorderColor'` and `'tableCellBorderWidth'` commands
- * - background color: the `'tableCellBackgroundColor'` command
- * - cell padding: the `'tableCellPadding'` command
- * - horizontal and vertical alignment: the `'tableCellHorizontalAlignment'` and `'tableCellVerticalAlignment'` commands
- * - width and height: the `'tableCellWidth'` and `'tableCellHeight'` commands
- */
-export default class TableCellPropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableCellPropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableEditing, typeof TableCellWidthEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/tablecellproperties/tablecellpropertiesui.d.ts

@@ -1,120 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/tablecellpropertiesui
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { ContextualBalloon } from 'ckeditor5/src/ui.js';
-import TableCellPropertiesView from './ui/tablecellpropertiesview.js';
-/**
- * The table cell properties UI plugin. It introduces the `'tableCellProperties'` button
- * that opens a form allowing to specify the visual styling of a table cell.
- *
- * It uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
- */
-export default class TableCellPropertiesUI extends Plugin {
-    /**
-     * The default table cell properties.
-     */
-    private _defaultTableCellProperties;
-    /**
-     * The contextual balloon plugin instance.
-     */
-    private _balloon?;
-    /**
-     * The cell properties form view displayed inside the balloon.
-     */
-    view?: TableCellPropertiesView | null;
-    /**
-     * The batch used to undo all changes made by the form (which are live, as the user types)
-     * when "Cancel" was pressed. Each time the view is shown, a new batch is created.
-     */
-    private _undoStepBatch?;
-    /**
-     * Flag used to indicate whether view is ready to execute update commands
-     * (it finished loading initial data).
-     */
-    private _isReady?;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ContextualBalloon];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableCellPropertiesUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates the {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView} instance.
-     *
-     * @returns The cell properties form view instance.
-     */
-    private _createPropertiesView;
-    /**
-     * In this method the "editor data -> UI" binding is happening.
-     *
-     * When executed, this method obtains selected cell property values from various table commands
-     * and passes them to the {@link #view}.
-     *
-     * This way, the UI stays up–to–date with the editor data.
-     */
-    private _fillViewFormFromCommandValues;
-    /**
-     * Shows the {@link #view} in the {@link #_balloon}.
-     *
-     * **Note**: Each time a view is shown, a new {@link #_undoStepBatch} is created. It contains
-     * all changes made to the document when the view is visible, allowing a single undo step
-     * for all of them.
-     */
-    protected _showView(): void;
-    /**
-     * Removes the {@link #view} from the {@link #_balloon}.
-     */
-    protected _hideView(): void;
-    /**
-     * Repositions the {@link #_balloon} or hides the {@link #view} if a table cell is no longer selected.
-     */
-    protected _updateView(): void;
-    /**
-     * Returns `true` when the {@link #view} is visible in the {@link #_balloon}.
-     */
-    private get _isViewVisible();
-    /**
-     * Returns `true` when the {@link #view} is in the {@link #_balloon}.
-     */
-    private get _isViewInBalloon();
-    /**
-     * Creates a callback that when executed upon the {@link #view view's} property change
-     * executes a related editor command with the new property value.
-     *
-     * @param defaultValue The default value of the command.
-     */
-    private _getPropertyChangeCallback;
-    /**
-     * Creates a callback that when executed upon the {@link #view view's} property change:
-     * * Executes a related editor command with the new property value if the value is valid,
-     * * Or sets the error text next to the invalid field, if the value did not pass the validation.
-     */
-    private _getValidatedPropertyChangeCallback;
-}

package/dist/tablecellproperties/ui/tablecellpropertiesview.d.ts

@@ -1,232 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/ui/tablecellpropertiesview
- */
-import { ButtonView, FocusCycler, LabeledFieldView, ToolbarView, View, ViewCollection, type FocusableView, type NormalizedColorOption, type ColorPickerConfig } from 'ckeditor5/src/ui.js';
-import { KeystrokeHandler, FocusTracker, type Locale } from 'ckeditor5/src/utils.js';
-import type ColorInputView from '../../ui/colorinputview.js';
-import type { TableCellPropertiesOptions } from '../../tableconfig.js';
-import '../../../theme/form.css';
-import '../../../theme/tableform.css';
-import '../../../theme/tablecellproperties.css';
-export interface TableCellPropertiesViewOptions {
-    borderColors: Array<NormalizedColorOption>;
-    backgroundColors: Array<NormalizedColorOption>;
-    defaultTableCellProperties: TableCellPropertiesOptions;
-    colorPickerConfig: false | ColorPickerConfig;
-}
-/**
- * The class representing a table cell properties form, allowing users to customize
- * certain style aspects of a table cell, for instance, border, padding, text alignment, etc..
- */
-export default class TableCellPropertiesView extends View {
-    /**
-     * The value of the cell border style.
-     *
-     * @observable
-     * @default ''
-     */
-    borderStyle: string;
-    /**
-     * The value of the cell border width style.
-     *
-     * @observable
-     * @default ''
-     */
-    borderWidth: string;
-    /**
-     * The value of the cell border color style.
-     *
-     * @observable
-     * @default ''
-     */
-    borderColor: string;
-    /**
-     * The value of the cell padding style.
-     *
-     * @observable
-     * @default ''
-     */
-    padding: string;
-    /**
-     * The value of the cell background color style.
-     *
-     * @observable
-     * @default ''
-     */
-    backgroundColor: string;
-    /**
-     * The value of the table cell width style.
-     *
-     * @observable
-     * @default ''
-     */
-    width: string;
-    /**
-     * The value of the table cell height style.
-     *
-     * @observable
-     * @default ''
-     */
-    height: string;
-    /**
-     * The value of the horizontal text alignment style.
-     *
-     * @observable
-     * @default ''
-     */
-    horizontalAlignment: string;
-    /**
-     * The value of the vertical text alignment style.
-     *
-     * @observable
-     * @default ''
-     */
-    verticalAlignment: string;
-    /**
-     * Options passed to the view. See {@link #constructor} to learn more.
-     */
-    readonly options: TableCellPropertiesViewOptions;
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * A collection of child views in the form.
-     */
-    readonly children: ViewCollection;
-    /**
-     * A dropdown that allows selecting the style of the table cell border.
-     */
-    readonly borderStyleDropdown: LabeledFieldView<FocusableView>;
-    /**
-     * An input that allows specifying the width of the table cell border.
-     */
-    readonly borderWidthInput: LabeledFieldView<FocusableView>;
-    /**
-     * An input that allows specifying the color of the table cell border.
-     */
-    readonly borderColorInput: LabeledFieldView<ColorInputView>;
-    /**
-     * An input that allows specifying the table cell background color.
-     */
-    readonly backgroundInput: LabeledFieldView<ColorInputView>;
-    /**
-     * An input that allows specifying the table cell padding.
-     */
-    readonly paddingInput: LabeledFieldView;
-    /**
-     * An input that allows specifying the table cell width.
-     */
-    readonly widthInput: LabeledFieldView<FocusableView>;
-    /**
-     * An input that allows specifying the table cell height.
-     */
-    readonly heightInput: LabeledFieldView<FocusableView>;
-    /**
-     * A toolbar with buttons that allow changing the horizontal text alignment in a table cell.
-     */
-    readonly horizontalAlignmentToolbar: ToolbarView;
-    /**
-     * A toolbar with buttons that allow changing the vertical text alignment in a table cell.
-     */
-    readonly verticalAlignmentToolbar: ToolbarView;
-    /**
-     * The "Save" button view.
-     */
-    saveButtonView: ButtonView;
-    /**
-     * The "Cancel" button view.
-     */
-    cancelButtonView: ButtonView;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    protected readonly _focusables: ViewCollection<FocusableView>;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    protected readonly _focusCycler: FocusCycler;
-    /**
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param options Additional configuration of the view.
-     * @param options.borderColors A configuration of the border color palette used by the
-     * {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView#borderColorInput}.
-     * @param options.backgroundColors A configuration of the background color palette used by the
-     * {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView#backgroundInput}.
-     * @param options.defaultTableCellProperties The default table cell properties.
-     */
-    constructor(locale: Locale, options: TableCellPropertiesViewOptions);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the fist focusable field in the form.
-     */
-    focus(): void;
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #borderStyleDropdown},
-     * * {@link #borderWidthInput},
-     * * {@link #borderColorInput}.
-     */
-    private _createBorderFields;
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #backgroundInput}.
-     */
-    private _createBackgroundFields;
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #widthInput}.
-     * * {@link #heightInput}.
-     */
-    private _createDimensionFields;
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #paddingInput}.
-     */
-    private _createPaddingField;
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #horizontalAlignmentToolbar},
-     * * {@link #verticalAlignmentToolbar}.
-     */
-    private _createAlignmentFields;
-    /**
-     * Creates the following form controls:
-     *
-     * * {@link #saveButtonView},
-     * * {@link #cancelButtonView}.
-     */
-    private _createActionButtons;
-    /**
-     * Provides localized labels for {@link #horizontalAlignmentToolbar} buttons.
-     */
-    private get _horizontalAlignmentLabels();
-    /**
-     * Provides localized labels for {@link #verticalAlignmentToolbar} buttons.
-     */
-    private get _verticalAlignmentLabels();
-}

package/dist/tablecellproperties.d.ts

@@ -1,38 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TableCellPropertiesUI from './tablecellproperties/tablecellpropertiesui.js';
-import TableCellPropertiesEditing from './tablecellproperties/tablecellpropertiesediting.js';
-/**
- * The table cell properties feature. Enables support for setting properties of table cells (size, border, background, etc.).
- *
- * Read more in the {@glink features/tables/tables-styling Table and cell styling tools} section.
- * See also the {@link module:table/tableproperties~TableProperties} plugin.
- *
- * This is a "glue" plugin that loads the
- * {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing table cell properties editing feature} and
- * the {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI table cell properties UI feature}.
- */
-export default class TableCellProperties extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableCellProperties";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableCellPropertiesEditing, typeof TableCellPropertiesUI];
-}

package/dist/tablecellwidth/commands/tablecellwidthcommand.d.ts

@@ -1,50 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellwidth/commands/tablecellwidthcommand
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import TableCellPropertyCommand from '../../tablecellproperties/commands/tablecellpropertycommand.js';
-/**
- * The table cell width command.
- *
- * The command is registered by the {@link module:table/tablecellwidth/tablecellwidthediting~TableCellWidthEditing} as
- * the `'tableCellWidth'` editor command.
- *
- * To change the width of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellWidth', {
- *   value: '50px'
- * } );
- * ```
- *
- * **Note**: This command adds a default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableCellWidth', {
- *   value: '50'
- * } );
- * ```
- *
- * will set the `width` attribute to `'50px'` in the model.
- */
-export default class TableCellWidthCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellWidthCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value of the attribute.
-     */
-    constructor(editor: Editor, defaultValue: string);
-    /**
-     * @inheritDoc
-     */
-    _getValueToSet(value: string | number | undefined): unknown;
-}