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

package/dist/tableconfig.d.ts

@@ -1,347 +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/tableconfig
- */
-import type { ToolbarConfigItem } from 'ckeditor5/src/core.js';
-import type { ColorOption, ColorPickerConfig } from 'ckeditor5/src/ui.js';
-/**
- * The configuration of the table feature. Used by the table feature in the `@ckeditor/ckeditor5-table` package.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		table: ... // Table feature options.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface TableConfig {
-    /**
-     * Number of rows and columns to render by default as table heading when inserting new tables.
-     *
-     * You can configure it like this:
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	defaultHeadings: {
-     * 		rows: 1,
-     * 		columns: 1
-     * 	}
-     * };
-     * ```
-     *
-     * Both rows and columns properties are optional defaulting to 0 (no heading).
-     */
-    defaultHeadings?: {
-        rows?: number;
-        columns?: number;
-    };
-    /**
-     * Items to be placed in the table content toolbar.
-     * The {@link module:table/tabletoolbar~TableToolbar} plugin is required to make this toolbar work.
-     *
-     * Assuming that you use the {@link module:table/tableui~TableUI} feature, the following toolbar items will be available
-     * in {@link module:ui/componentfactory~ComponentFactory}:
-     *
-     * * `'tableRow'`,
-     * * `'tableColumn'`,
-     * * `'mergeTableCells'`.
-     *
-     * You can thus configure the toolbar like this:
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	contentToolbar: [ 'tableRow', 'tableColumn', 'mergeTableCells' ]
-     * };
-     * ```
-     *
-     * Of course, the same buttons can also be used in the
-     * {@link module:core/editor/editorconfig~EditorConfig#toolbar main editor toolbar}.
-     *
-     * Read more about configuring the toolbar in {@link module:core/editor/editorconfig~EditorConfig#toolbar}.
-     */
-    contentToolbar?: Array<ToolbarConfigItem>;
-    /**
-     * Items to be placed in the table toolbar.
-     * The {@link module:table/tabletoolbar~TableToolbar} plugin is required to make this toolbar work.
-     *
-     * You can thus configure the toolbar like this:
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	tableToolbar: [ 'blockQuote' ]
-     * };
-     * ```
-     *
-     * Of course, the same buttons can also be used in the
-     * {@link module:core/editor/editorconfig~EditorConfig#toolbar main editor toolbar}.
-     *
-     * Read more about configuring the toolbar in {@link module:core/editor/editorconfig~EditorConfig#toolbar}.
-     */
-    tableToolbar?: Array<ToolbarConfigItem>;
-    /**
-     * The configuration of the table properties user interface (balloon). It allows to define:
-     *
-     * * The color palette for the table border color style field (`tableProperties.borderColors`),
-     * * The color palette for the table background style field (`tableProperties.backgroundColors`).
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	tableProperties: {
-     * 		borderColors: [
-     * 			{
-     * 				color: 'hsl(0, 0%, 90%)',
-     * 				label: 'Light grey'
-     * 			},
-     * 			// ...
-     * 		],
-     * 		backgroundColors: [
-     * 			{
-     * 				color: 'hsl(120, 75%, 60%)',
-     * 				label: 'Green'
-     * 			},
-     * 			// ...
-     * 		]
-     * 	}
-     * };
-     * ```
-     *
-     * * The default styles for tables (`tableProperties.defaultProperties`):
-     *
-     * ```
-     * const tableConfig = {
-     * 	tableProperties: {
-     * 		defaultProperties: {
-     * 			borderStyle: 'dashed',
-     * 			borderColor: 'hsl(0, 0%, 90%)',
-     * 			borderWidth: '3px',
-     * 			alignment: 'left'
-     * 		}
-     * 	}
-     * }
-     * ```
-     *
-     * {@link module:table/tableconfig~TablePropertiesOptions Read more about the supported properties.}
-     *
-     * **Note**: The `borderColors` and `backgroundColors` options do not impact the data loaded into the editor,
-     * i.e. they do not limit or filter the colors in the data. They are used only in the user interface
-     * allowing users to pick colors in a more convenient way. The `defaultProperties` option does impact the data.
-     * Default values will not be kept in the editor model.
-     *
-     * The default color palettes for the table background and the table border are the same
-     * ({@link module:table/utils/ui/table-properties#defaultColors check out their content}).
-     *
-     * Both color palette configurations must follow the
-     * {@link module:table/tableconfig~TableColorConfig table color configuration format}.
-     *
-     * Read more about configuring the table feature in {@link module:table/tableconfig~TableConfig}.
-     */
-    tableProperties?: TablePropertiesConfig;
-    /**
-     * The configuration of the table cell properties user interface (balloon). It allows to define:
-     *
-     * * The color palette for the cell border color style field (`tableCellProperties.borderColors`),
-     * * The color palette for the cell background style field (`tableCellProperties.backgroundColors`).
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	tableCellProperties: {
-     * 		borderColors: [
-     * 			{
-     * 				color: 'hsl(0, 0%, 90%)',
-     * 				label: 'Light grey'
-     * 			},
-     * 			// ...
-     * 		],
-     * 		backgroundColors: [
-     * 			{
-     * 				color: 'hsl(120, 75%, 60%)',
-     * 				label: 'Green'
-     * 			},
-     * 			// ...
-     * 		]
-     * 	}
-     * };
-     * ```
-     *
-     * * The default styles for table cells (`tableCellProperties.defaultProperties`):
-     *
-     * ```ts
-     * const tableConfig = {
-     * 	tableCellProperties: {
-     * 		defaultProperties: {
-     * 			horizontalAlignment: 'right',
-     * 			verticalAlignment: 'bottom',
-     * 			padding: '5px'
-     * 		}
-     * 	}
-     * }
-     * ```
-     *
-     * {@link module:table/tableconfig~TablePropertiesOptions Read more about the supported properties.}
-     *
-     * **Note**: The `borderColors` and `backgroundColors` options do not impact the data loaded into the editor,
-     * i.e. they do not limit or filter the colors in the data. They are used only in the user interface
-     * allowing users to pick colors in a more convenient way. The `defaultProperties` option does impact the data.
-     * Default values will not be kept in the editor model.
-     *
-     * The default color palettes for the cell background and the cell border are the same
-     * ({@link module:table/utils/ui/table-properties#defaultColors check out their content}).
-     *
-     * Both color palette configurations must follow the
-     * {@link module:table/tableconfig~TableColorConfig table color configuration format}.
-     *
-     * Read more about configuring the table feature in {@link module:table/tableconfig~TableConfig}.
-     */
-    tableCellProperties?: TableCellPropertiesConfig;
-}
-/**
- * The configuration of the table properties user interface (balloon).
- */
-export interface TablePropertiesConfig {
-    borderColors?: TableColorConfig;
-    backgroundColors?: TableColorConfig;
-    defaultProperties?: TablePropertiesOptions;
-    /**
-     * Configuration of the color picker in the table properties balloon.
-     *
-     * If set to `false` the picker will not appear.
-     */
-    colorPicker?: false | ColorPickerConfig;
-}
-/**
- * The configuration of the table default properties feature.
- */
-export interface TablePropertiesOptions {
-    /**
-     * The default `width` of the table.
-     */
-    width?: string;
-    /**
-     * The default `height` of the table.
-     */
-    height?: string;
-    /**
-     * The default `background-color` of the table.
-     */
-    backgroundColor?: string;
-    /**
-     * The default `border-color` of the table.
-     */
-    borderColor?: string;
-    /**
-     * The default `border-width` of the table.
-     */
-    borderWidth?: string;
-    /**
-     * The default `border-style` of the table.
-     *
-     * @default 'none'
-     */
-    borderStyle?: string;
-    /**
-     * The default `alignment` of the table.
-     *
-     * @default 'center'
-     */
-    alignment?: string;
-}
-/**
- * The configuration of the table cell properties user interface (balloon).
- */
-export interface TableCellPropertiesConfig {
-    borderColors?: TableColorConfig;
-    backgroundColors?: TableColorConfig;
-    defaultProperties?: TableCellPropertiesOptions;
-    /**
-     * Configuration of the color picker in the table cell properties balloon.
-     *
-     * If set to `false` the picker will not appear.
-     */
-    colorPicker?: false | ColorPickerConfig;
-}
-/**
- * An array of color definitions (either strings or objects).
- *
- * ```ts
- * const colors = [
- * 	{
- * 		color: 'hsl(0, 0%, 60%)',
- * 		label: 'Grey'
- * 	},
- * 	'hsl(0, 0%, 80%)',
- * 	{
- * 		color: 'hsl(0, 0%, 90%)',
- * 		label: 'Light grey'
- * 	},
- * 	{
- * 		color: 'hsl(0, 0%, 100%)',
- * 		label: 'White',
- * 		hasBorder: true
- * 	},
- * 	'#FF0000'
- * ]
- * ```
- *
- * Usually used as a configuration parameter, for instance in
- * {@link module:table/tableconfig~TableConfig#tableProperties `config.table.tableProperties`}
- * or {@link module:table/tableconfig~TableConfig#tableCellProperties `config.table.tableCellProperties`}.
- */
-export type TableColorConfig = Array<ColorOption>;
-/**
- * The configuration of the table cell default properties feature.
- */
-export interface TableCellPropertiesOptions {
-    /**
-     * The default `width` of the table cell.
-     */
-    width?: string;
-    /**
-     * The default `height` of the table cell.
-     */
-    height?: string;
-    /**
-     * The default `padding` of the table cell.
-     */
-    padding?: string;
-    /**
-     * The default `background-color` of the table cell.
-     */
-    backgroundColor?: string;
-    /**
-     * The default `border-color` of the table cell.
-     */
-    borderColor?: string;
-    /**
-     * The default `border-width` of the table cell.
-     */
-    borderWidth?: string;
-    /**
-     * The default `border-style` of the table cell.
-     *
-     * @default 'none'
-     */
-    borderStyle?: string;
-    /**
-     * The default `horizontalAlignment` of the table cell.
-     *
-     * @default 'center'
-     */
-    horizontalAlignment?: string;
-    /**
-     * The default `verticalAlignment` of the table cell.
-     *
-     * @default 'middle'
-     */
-    verticalAlignment?: string;
-}

package/dist/tableediting.d.ts

@@ -1,106 +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/tableediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import type { PositionOffset, SlotFilter } from 'ckeditor5/src/engine.js';
-import TableUtils from '../src/tableutils.js';
-import '../theme/tableediting.css';
-/**
- * The table editing feature.
- */
-export default class TableEditing extends Plugin {
-    /**
-     * Handlers for creating additional slots in the table.
-     */
-    private _additionalSlots;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableUtils];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Registers downcast handler for the additional table slot.
-     */
-    registerAdditionalSlot(slotHandler: AdditionalSlot): void;
-}
-/**
- * By default, only the `tableRow` elements from the `table` model are downcast inside the `<table>` and
- * all other elements are pushed outside the table. This handler allows creating additional slots inside
- * the table for other elements.
- *
- * Take this model as an example:
- *
- * ```xml
- * <table>
- *   <tableRow>...</tableRow>
- *   <tableRow>...</tableRow>
- *   <tableColumnGroup>...</tableColumnGroup>
- * </table>
- * ```
- *
- * By default, downcasting result will be:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>...</tr>
- *     <tr>...</tr>
- *   </tbody>
- * </table>
- * <colgroup>...</colgroup>
- * ```
- *
- * To allow the `tableColumnGroup` element at the end of the table, use the following configuration:
- *
- * ```ts
- * const additionalSlot = {
- *   filter: element => element.is( 'element', 'tableColumnGroup' ),
- *   positionOffset: 'end'
- * }
- * ```
- *
- * Now, the downcast result will be:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>...</tr>
- *     <tr>...</tr>
- *   </tbody>
- *   <colgroup>...</colgroup>
- * </table>
- * ```
- */
-export interface AdditionalSlot {
-    /**
-     * Filter for elements that should be placed inside given slot.
-     */
-    filter: SlotFilter;
-    /**
-     * Position of the slot within the table.
-     */
-    positionOffset: PositionOffset;
-}

package/dist/tablekeyboard.d.ts

@@ -1,76 +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/tablekeyboard
- */
-import TableSelection from './tableselection.js';
-import TableUtils from './tableutils.js';
-import { Plugin } from 'ckeditor5/src/core.js';
-import { type ArrowKeyCodeDirection } from 'ckeditor5/src/utils.js';
-import type { Element } from 'ckeditor5/src/engine.js';
-/**
- * This plugin enables keyboard navigation for tables.
- * It is loaded automatically by the {@link module:table/table~Table} plugin.
- */
-export default class TableKeyboard extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableKeyboard";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableSelection, typeof TableUtils];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Handles {@link module:engine/view/document~Document#event:tab tab} events for the <kbd>Tab</kbd> key executed
-     * when the table widget is selected.
-     */
-    private _handleTabOnSelectedTable;
-    /**
-     * Handles {@link module:engine/view/document~Document#event:tab tab} events for the <kbd>Tab</kbd> key executed
-     * inside table cells.
-     */
-    private _handleTab;
-    /**
-     * Handles {@link module:engine/view/document~Document#event:keydown keydown} events.
-     */
-    private _onArrowKey;
-    /**
-     * Handles arrow keys to move the selection around the table.
-     *
-     * @param direction The direction of the arrow key.
-     * @param expandSelection If the current selection should be expanded.
-     * @returns Returns `true` if key was handled.
-     */
-    private _handleArrowKeys;
-    /**
-     * Returns `true` if the selection is at the boundary of a table cell according to the navigation direction.
-     *
-     * @param selection The current selection.
-     * @param tableCell The current table cell element.
-     * @param isForward The expected navigation direction.
-     */
-    private _isSelectionAtCellEdge;
-    /**
-     * Moves the selection from the given table cell in the specified direction.
-     *
-     * @param focusCell The table cell that is current multi-cell selection focus.
-     * @param direction Direction in which selection should move.
-     * @param expandSelection If the current selection should be expanded. Default value is false.
-     */
-    protected _navigateFromCellInDirection(focusCell: Element, direction: ArrowKeyCodeDirection, expandSelection?: boolean): void;
-}

package/dist/tablemouse/mouseeventsobserver.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/tablemouse/mouseeventsobserver
- */
-import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine.js';
-/**
- * The mouse selection event observer.
- *
- * It registers listeners for the following DOM events:
- *
- * - `'mousemove'`
- * - `'mouseleave'`
- *
- * Note that this observer is disabled by default. To enable this observer, it needs to be added to
- * {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
- *
- * The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
- */
-export default class MouseEventsObserver extends DomEventObserver<'mousemove' | 'mouseleave'> {
-    readonly domEventType: readonly ["mousemove", "mouseleave"];
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: MouseEvent): void;
-}
-/**
- * Fired when the mouse is moved over one of the editables.
- *
- * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
- * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
- * @eventName module:engine/view/document~Document#mousemove
- * @param data Event data.
- */
-export type ViewDocumentMouseMoveEvent = {
-    name: 'mousemove';
-    args: [data: DomEventData<MouseEvent>];
-};
-/**
- * Fired when the mouse is moved out of one of the editables.
- *
- * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
- * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
- *
- * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
- * @eventName module:engine/view/document~Document#mouseleave
- * @param data Event data.
- */
-export type ViewDocumentMouseLeaveEvent = {
-    name: 'mouseleave';
-    args: [data: DomEventData<MouseEvent>];
-};

package/dist/tablemouse.d.ts

@@ -1,56 +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/tablemouse
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TableSelection from './tableselection.js';
-import TableUtils from './tableutils.js';
-/**
- * This plugin enables a table cells' selection with the mouse.
- * It is loaded automatically by the {@link module:table/table~Table} plugin.
- */
-export default class TableMouse extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableMouse";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableSelection, typeof TableUtils];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Enables making cells selection by <kbd>Shift</kbd>+click. Creates a selection from the cell which previously held
-     * the selection to the cell which was clicked. It can be the same cell, in which case it selects a single cell.
-     */
-    private _enableShiftClickSelection;
-    /**
-     * Enables making cells selection by dragging.
-     *
-     * The selection is made only on mousemove. Mouse tracking is started on mousedown.
-     * However, the cells selection is enabled only after the mouse cursor left the anchor cell.
-     * Thanks to that normal text selection within one cell works just fine. However, you can still select
-     * just one cell by leaving the anchor cell and moving back to it.
-     */
-    private _enableMouseDragSelection;
-    /**
-     * Returns the model table cell element based on the target element of the passed DOM event.
-     *
-     * @returns Returns the table cell or `undefined`.
-     */
-    private _getModelTableCellFromDomEvent;
-}

package/dist/tableproperties/commands/tablealignmentcommand.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/tablealignmentcommand
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import TablePropertyCommand from './tablepropertycommand.js';
-/**
- * The table alignment command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableAlignment'` editor command.
- *
- * To change the alignment of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableAlignment', {
- *   value: 'right'
- * } );
- * ```
- */
-export default class TableAlignmentCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableAlignmentCommand` 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);
-}