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

package/src/tabletoolbar.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @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/tabletoolbar
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import './tableconfig';
+/**
+ * The table toolbar class. It creates toolbars for the table feature and its content (for now only for the table cell content).
+ *
+ * The table toolbar shows up when a table widget is selected. Its components (e.g. buttons) are created based on the
+ * {@link module:table/tableconfig~TableConfig#tableToolbar `table.tableToolbar` configuration option}.
+ *
+ * Table content toolbar shows up when the selection is inside the content of a table. It creates its component based on the
+ * {@link module:table/tableconfig~TableConfig#contentToolbar `table.contentToolbar` configuration option}.
+ */
+export default class TableToolbar extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableToolbar';
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableToolbar.pluginName]: TableToolbar;
+    }
+}

package/src/tabletoolbar.js

@@ -2,110 +2,57 @@
  * @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/tabletoolbar
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { WidgetToolbarRepository } from 'ckeditor5/src/widget';
 import { getSelectedTableWidget, getTableWidgetAncestor } from './utils/ui/widget';
-
+import './tableconfig';
 /**
  * The table toolbar class. It creates toolbars for the table feature and its content (for now only for the table cell content).
  *
  * The table toolbar shows up when a table widget is selected. Its components (e.g. buttons) are created based on the
- * {@link module:table/table~TableConfig#tableToolbar `table.tableToolbar` configuration option}.
+ * {@link module:table/tableconfig~TableConfig#tableToolbar `table.tableToolbar` configuration option}.
  *
  * Table content toolbar shows up when the selection is inside the content of a table. It creates its component based on the
- * {@link module:table/table~TableConfig#contentToolbar `table.contentToolbar` configuration option}.
- *
- * @extends module:core/plugin~Plugin
+ * {@link module:table/tableconfig~TableConfig#contentToolbar `table.contentToolbar` configuration option}.
  */
 export default class TableToolbar extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ WidgetToolbarRepository ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'TableToolbar';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	afterInit() {
-		const editor = this.editor;
-		const t = editor.t;
-		const widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
-
-		const tableContentToolbarItems = editor.config.get( 'table.contentToolbar' );
-
-		const tableToolbarItems = editor.config.get( 'table.tableToolbar' );
-
-		if ( tableContentToolbarItems ) {
-			widgetToolbarRepository.register( 'tableContent', {
-				ariaLabel: t( 'Table toolbar' ),
-				items: tableContentToolbarItems,
-				getRelatedElement: getTableWidgetAncestor
-			} );
-		}
-
-		if ( tableToolbarItems ) {
-			widgetToolbarRepository.register( 'table', {
-				ariaLabel: t( 'Table toolbar' ),
-				items: tableToolbarItems,
-				getRelatedElement: getSelectedTableWidget
-			} );
-		}
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [WidgetToolbarRepository];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableToolbar';
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const editor = this.editor;
+        const t = editor.t;
+        const widgetToolbarRepository = editor.plugins.get(WidgetToolbarRepository);
+        const tableContentToolbarItems = editor.config.get('table.contentToolbar');
+        const tableToolbarItems = editor.config.get('table.tableToolbar');
+        if (tableContentToolbarItems) {
+            widgetToolbarRepository.register('tableContent', {
+                ariaLabel: t('Table toolbar'),
+                items: tableContentToolbarItems,
+                getRelatedElement: getTableWidgetAncestor
+            });
+        }
+        if (tableToolbarItems) {
+            widgetToolbarRepository.register('table', {
+                ariaLabel: t('Table toolbar'),
+                items: tableToolbarItems,
+                getRelatedElement: getSelectedTableWidget
+            });
+        }
+    }
 }
-
-/**
- * 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:
- *
- *		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}.
- *
- * @member {Array.<String>} module:table/table~TableConfig#contentToolbar
- */
-
-/**
- * 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:
- *
- *		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}.
- *
- * @member {Array.<String>} module:table/table~TableConfig#tableToolbar
- */

package/src/tableui.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @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/tableui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The table UI plugin. It introduces:
+ *
+ * * The `'insertTable'` dropdown,
+ * * The `'tableColumn'` dropdown,
+ * * The `'tableRow'` dropdown,
+ * * The `'mergeTableCells'` split button.
+ *
+ * The `'tableColumn'`, `'tableRow'` and `'mergeTableCells'` dropdowns work best with {@link module:table/tabletoolbar~TableToolbar}.
+ */
+export default class TableUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableUI';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a dropdown view from a set of options.
+     *
+     * @param label The dropdown button label.
+     * @param icon An icon for the dropdown button.
+     * @param options The list of options for the dropdown.
+     */
+    private _prepareDropdown;
+    /**
+     * Creates a dropdown view with a {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} for
+     * merge (and split)–related commands.
+     *
+     * @param label The dropdown button label.
+     * @param icon An icon for the dropdown button.
+     * @param options The list of options for the dropdown.
+     */
+    private _prepareMergeSplitButtonDropdown;
+    /**
+     * Injects a {@link module:ui/list/listview~ListView} into the passed dropdown with buttons
+     * which execute editor commands as configured in passed options.
+     *
+     * @param options The list of options for the dropdown.
+     * @returns Commands the list options are interacting with.
+     */
+    private _fillDropdownWithListOptions;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableUI.pluginName]: TableUI;
+    }
+}