@ckeditor/ckeditor5-table 36.0.0 → 37.0.0-alpha.0

package/src/tableconfig.d.ts

@@ -0,0 +1,341 @@
+/**
+ * @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/tableconfig
+ */
+import type { ToolbarConfigItem } from 'ckeditor5/src/core';
+import type { ColorOption } from 'ckeditor5/src/ui';
+/**
+ * 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;
+}
+/**
+ * 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;
+}
+/**
+ * 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;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:table/table~Table} feature.
+         *
+         * Read more in {@link module:table/tableconfig~TableConfig}.
+         */
+        table?: TableConfig;
+    }
+}

package/src/tableconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/tableediting.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @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/tableediting
+ */
+import { Plugin, type Editor, type PluginDependencies } from 'ckeditor5/src/core';
+import type { PositionOffset, SlotFilter } from 'ckeditor5/src/engine';
+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 requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Registers downcast handler for the additional table slot.
+     */
+    registerAdditionalSlot(slotHandler: AdditionalSlot): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableEditing.pluginName]: TableEditing;
+    }
+}
+/**
+ * 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;
+}