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

package/dist/tableproperties/commands/tablebackgroundcolorcommand.d.ts

@@ -1,36 +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/tableproperties/commands/tablebackgroundcolorcommand
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import TablePropertyCommand from './tablepropertycommand.js';
-/**
- * The table background color command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableBackgroundColor'` editor command.
- *
- * To change the background color of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableBackgroundColor', {
- *   value: '#f00'
- * } );
- * ```
- */
-export default class TableBackgroundColorCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableBackgroundColorCommand` 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);
-}

package/dist/tableproperties/commands/tablebordercolorcommand.d.ts

@@ -1,41 +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/tableproperties/commands/tablebordercolorcommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-import TablePropertyCommand from './tablepropertycommand.js';
-/**
- * The table border color command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableBorderColor'` editor command.
- *
- * To change the border color of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableBorderColor', {
- *   value: '#f00'
- * } );
- * ```
- */
-export default class TableBorderColorCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableBorderColorCommand` 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 _getValue(table: Element): unknown;
-}

package/dist/tableproperties/commands/tableborderstylecommand.d.ts

@@ -1,41 +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/tableproperties/commands/tableborderstylecommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import TablePropertyCommand from './tablepropertycommand.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * The table style border command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableBorderStyle'` editor command.
- *
- * To change the border style of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableBorderStyle', {
- *   value: 'dashed'
- * } );
- * ```
- */
-export default class TableBorderStyleCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableBorderStyleCommand` 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 _getValue(table: Element): unknown;
-}

package/dist/tableproperties/commands/tableborderwidthcommand.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/tableproperties/commands/tableborderwidthcommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-import TablePropertyCommand from './tablepropertycommand.js';
-/**
- * The table width border command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableBorderWidth'` editor command.
- *
- * To change the border width of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableBorderWidth', {
- *   value: '5px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableBorderWidth', {
- *   value: '5'
- * } );
- * ```
- *
- * will set the `borderWidth` attribute to `'5px'` in the model.
- */
-export default class TableBorderWidthCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableBorderWidthCommand` 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 _getValue(table: Element): string | undefined;
-    /**
-     * @inheritDoc
-     */
-    protected _getValueToSet(value: string | number | undefined): unknown;
-}

package/dist/tableproperties/commands/tableheightcommand.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/tableproperties/commands/tableheightcommand
- */
-import TablePropertyCommand from './tablepropertycommand.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * The table height command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableHeight'` editor command.
- *
- * To change the height of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableHeight', {
- *   value: '500px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableHeight', {
- *   value: '50'
- * } );
- * ```
- *
- * will set the `height` attribute to `'50px'` in the model.
- */
-export default class TableHeightCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableHeightCommand` 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 _getValueToSet(value: string | number | undefined): unknown;
-}

package/dist/tableproperties/commands/tablepropertycommand.d.ts

@@ -1,65 +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/tableproperties/commands/tablepropertycommand
- */
-import type { Batch, Element } from 'ckeditor5/src/engine.js';
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-export interface TablePropertyCommandExecuteOptions {
-    batch?: Batch;
-    columnWidths?: string;
-    table?: Element;
-    tableWidth?: string;
-    value?: string;
-}
-/**
- * The table cell attribute command.
- *
- * This command is a base command for other table property commands.
- */
-export default class TablePropertyCommand extends Command {
-    /**
-     * The attribute that will be set by the command.
-     */
-    readonly attributeName: string;
-    /**
-     * The default value for the attribute.
-     */
-    protected readonly _defaultValue: string | undefined;
-    /**
-     * Creates a new `TablePropertyCommand` 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 the selected table.
-     * If not set, the command will remove the attribute from the selected table.
-     * @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?: TablePropertyCommandExecuteOptions): void;
-    /**
-     * Returns the attribute value for a table.
-     */
-    protected _getValue(table: Element): 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;
-}

package/dist/tableproperties/commands/tablewidthcommand.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/tableproperties/commands/tablewidthcommand
- */
-import TablePropertyCommand from './tablepropertycommand.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * The table width command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableWidth'` editor command.
- *
- * To change the width of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '400px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '50'
- * } );
- * ```
- *
- * will set the `width` attribute to `'50px'` in the model.
- */
-export default class TableWidthCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableWidthCommand` 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;
-}

package/dist/tableproperties/tablepropertiesediting.d.ts

@@ -1,48 +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/tableproperties/tablepropertiesediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TableEditing from '../tableediting.js';
-/**
- * The table properties editing feature.
- *
- * Introduces table's model attributes and their conversion:
- *
- * - border: `tableBorderStyle`, `tableBorderColor` and `tableBorderWidth`
- * - background color: `tableBackgroundColor`
- * - horizontal alignment: `tableAlignment`
- * - width & height: `tableWidth` & `tableHeight`
- *
- * It also registers commands used to manipulate the above attributes:
- *
- * - border: `'tableBorderStyle'`, `'tableBorderColor'` and `'tableBorderWidth'` commands
- * - background color: `'tableBackgroundColor'`
- * - horizontal alignment: `'tableAlignment'`
- * - width & height: `'tableWidth'` & `'tableHeight'`
- */
-export default class TablePropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TablePropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/tableproperties/tablepropertiesui.d.ts

@@ -1,122 +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/tableproperties/tablepropertiesui
- */
-import { type Editor, Plugin } from 'ckeditor5/src/core.js';
-import { ContextualBalloon } from 'ckeditor5/src/ui.js';
-import TablePropertiesView from './ui/tablepropertiesview.js';
-/**
- * The table properties UI plugin. It introduces the `'tableProperties'` button
- * that opens a form allowing to specify visual styling of an entire table.
- *
- * It uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
- */
-export default class TablePropertiesUI extends Plugin {
-    /**
-     * The default table properties.
-     */
-    private _defaultTableProperties;
-    /**
-     * The contextual balloon plugin instance.
-     */
-    private _balloon;
-    /**
-     * The properties form view displayed inside the balloon.
-     */
-    view: TablePropertiesView | 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(): "TablePropertiesUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates the {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView} instance.
-     *
-     * @returns The table properties form view instance.
-     */
-    private _createPropertiesView;
-    /**
-     * In this method the "editor data -> UI" binding is happening.
-     *
-     * When executed, this method obtains selected table 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, the new {@link #_undoStepBatch} is created that 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 is no longer selected.
-     */
-    protected _updateView(): void;
-    /**
-     * Returns `true` when the {@link #view} is the 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 {@link #view view's} property change
-     * executes a related editor command with the new property value.
-     *
-     * If new value will be set to the default value, the command will not be executed.
-     *
-     * @param commandName The command that will be executed.
-     */
-    private _getPropertyChangeCallback;
-    /**
-     * Creates a callback that when executed upon {@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;
-}