@ckeditor/ckeditor5-heading 38.1.1 → 38.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-heading",
-  "version": "38.1.1",
+  "version": "38.2.0-alpha.1",
   "description": "Headings feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,8 +11,9 @@
     "ckeditor5-dll"
   ],
   "main": "src/index.js",
+  "type": "module",
   "dependencies": {
-    "ckeditor5": "38.1.1"
+    "ckeditor5": "38.2.0-alpha.1"
   },
   "engines": {
     "node": ">=16.0.0",

package/src/augmentation.d.ts

@@ -1,30 +1,30 @@
-/**
- * @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
- */
-import type { Heading, HeadingCommand, HeadingConfig, HeadingEditing, HeadingUI, Title, TitleConfig } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the heading feature. Introduced by the {@link module:heading/headingediting~HeadingEditing} feature.
-         *
-         * Read more in {@link module:heading/headingconfig~HeadingConfig}.
-         */
-        heading?: HeadingConfig;
-        /**
-         * The configuration of the {@link module:heading/title~Title title feature}.
-         *
-         * Read more in {@link module:heading/title~TitleConfig}.
-         */
-        title?: TitleConfig;
-    }
-    interface PluginsMap {
-        [Heading.pluginName]: Heading;
-        [HeadingEditing.pluginName]: HeadingEditing;
-        [HeadingUI.pluginName]: HeadingUI;
-        [Title.pluginName]: Title;
-    }
-    interface CommandsMap {
-        heading: HeadingCommand;
-    }
-}
+/**
+ * @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
+ */
+import type { Heading, HeadingCommand, HeadingConfig, HeadingEditing, HeadingUI, Title, TitleConfig } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the heading feature. Introduced by the {@link module:heading/headingediting~HeadingEditing} feature.
+         *
+         * Read more in {@link module:heading/headingconfig~HeadingConfig}.
+         */
+        heading?: HeadingConfig;
+        /**
+         * The configuration of the {@link module:heading/title~Title title feature}.
+         *
+         * Read more in {@link module:heading/title~TitleConfig}.
+         */
+        title?: TitleConfig;
+    }
+    interface PluginsMap {
+        [Heading.pluginName]: Heading;
+        [HeadingEditing.pluginName]: HeadingEditing;
+        [HeadingUI.pluginName]: HeadingUI;
+        [Title.pluginName]: Title;
+    }
+    interface CommandsMap {
+        heading: HeadingCommand;
+    }
+}

package/src/augmentation.js

@@ -1,5 +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 {};
+/**
+ * @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/heading.d.ts

@@ -1,32 +1,32 @@
-/**
- * @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 heading/heading
- */
-import { Plugin } from 'ckeditor5/src/core';
-import HeadingEditing from './headingediting';
-import HeadingUI from './headingui';
-import '../theme/heading.css';
-/**
- * The headings feature.
- *
- * For a detailed overview, check the {@glink features/headings Headings feature} guide
- * and the {@glink api/heading package page}.
- *
- * This is a "glue" plugin which loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
- * and {@link module:heading/headingui~HeadingUI heading UI feature}.
- *
- * @extends module:core/plugin~Plugin
- */
-export default class Heading extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof HeadingEditing, typeof HeadingUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Heading";
-}
+/**
+ * @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 heading/heading
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import HeadingEditing from './headingediting.js';
+import HeadingUI from './headingui.js';
+import '../theme/heading.css';
+/**
+ * The headings feature.
+ *
+ * For a detailed overview, check the {@glink features/headings Headings feature} guide
+ * and the {@glink api/heading package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
+ * and {@link module:heading/headingui~HeadingUI heading UI feature}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class Heading extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof HeadingEditing, typeof HeadingUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Heading";
+}

package/src/heading.js

@@ -1,36 +1,36 @@
-/**
- * @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 heading/heading
- */
-import { Plugin } from 'ckeditor5/src/core';
-import HeadingEditing from './headingediting';
-import HeadingUI from './headingui';
-import '../theme/heading.css';
-/**
- * The headings feature.
- *
- * For a detailed overview, check the {@glink features/headings Headings feature} guide
- * and the {@glink api/heading package page}.
- *
- * This is a "glue" plugin which loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
- * and {@link module:heading/headingui~HeadingUI heading UI feature}.
- *
- * @extends module:core/plugin~Plugin
- */
-export default class Heading extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [HeadingEditing, HeadingUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Heading';
-    }
-}
+/**
+ * @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 heading/heading
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import HeadingEditing from './headingediting.js';
+import HeadingUI from './headingui.js';
+import '../theme/heading.css';
+/**
+ * The headings feature.
+ *
+ * For a detailed overview, check the {@glink features/headings Headings feature} guide
+ * and the {@glink api/heading package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
+ * and {@link module:heading/headingui~HeadingUI heading UI feature}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class Heading extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [HeadingEditing, HeadingUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Heading';
+    }
+}

package/src/headingbuttonsui.d.ts

@@ -1,51 +1,51 @@
-/**
- * @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 heading/headingbuttonsui
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The `HeadingButtonsUI` plugin defines a set of UI buttons that can be used instead of the
- * standard drop down component.
- *
- * This feature is not enabled by default by the {@link module:heading/heading~Heading} plugin and needs to be
- * installed manually to the editor configuration.
- *
- * Plugin introduces button UI elements, which names are same as `model` property from {@link module:heading/headingconfig~HeadingOption}.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
- *     heading: {
- *       options: [
- *         { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
- *         { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
- *         { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
- *         { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
- *       ]
- *      },
- *      toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * NOTE: The `'paragraph'` button is defined in by the {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin
- * which needs to be loaded manually as well.
- *
- * It is possible to use custom icons by providing `icon` config option in {@link module:heading/headingconfig~HeadingOption}.
- * For the default configuration standard icons are used.
- */
-export default class HeadingButtonsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates single button view from provided configuration option.
-     */
-    private _createButton;
-}
+/**
+ * @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 heading/headingbuttonsui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The `HeadingButtonsUI` plugin defines a set of UI buttons that can be used instead of the
+ * standard drop down component.
+ *
+ * This feature is not enabled by default by the {@link module:heading/heading~Heading} plugin and needs to be
+ * installed manually to the editor configuration.
+ *
+ * Plugin introduces button UI elements, which names are same as `model` property from {@link module:heading/headingconfig~HeadingOption}.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
+ *     heading: {
+ *       options: [
+ *         { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
+ *         { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
+ *         { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
+ *         { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
+ *       ]
+ *      },
+ *      toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * NOTE: The `'paragraph'` button is defined in by the {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin
+ * which needs to be loaded manually as well.
+ *
+ * It is possible to use custom icons by providing `icon` config option in {@link module:heading/headingconfig~HeadingOption}.
+ * For the default configuration standard icons are used.
+ */
+export default class HeadingButtonsUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates single button view from provided configuration option.
+     */
+    private _createButton;
+}

package/src/headingbuttonsui.js

@@ -1,89 +1,89 @@
-/**
- * @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 heading/headingbuttonsui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { ButtonView } from 'ckeditor5/src/ui';
-import { getLocalizedOptions } from './utils';
-import iconHeading1 from '../theme/icons/heading1.svg';
-import iconHeading2 from '../theme/icons/heading2.svg';
-import iconHeading3 from '../theme/icons/heading3.svg';
-import iconHeading4 from '../theme/icons/heading4.svg';
-import iconHeading5 from '../theme/icons/heading5.svg';
-import iconHeading6 from '../theme/icons/heading6.svg';
-const defaultIcons = {
-    heading1: iconHeading1,
-    heading2: iconHeading2,
-    heading3: iconHeading3,
-    heading4: iconHeading4,
-    heading5: iconHeading5,
-    heading6: iconHeading6
-};
-/**
- * The `HeadingButtonsUI` plugin defines a set of UI buttons that can be used instead of the
- * standard drop down component.
- *
- * This feature is not enabled by default by the {@link module:heading/heading~Heading} plugin and needs to be
- * installed manually to the editor configuration.
- *
- * Plugin introduces button UI elements, which names are same as `model` property from {@link module:heading/headingconfig~HeadingOption}.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
- *     heading: {
- *       options: [
- *         { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
- *         { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
- *         { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
- *         { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
- *       ]
- *      },
- *      toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * NOTE: The `'paragraph'` button is defined in by the {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin
- * which needs to be loaded manually as well.
- *
- * It is possible to use custom icons by providing `icon` config option in {@link module:heading/headingconfig~HeadingOption}.
- * For the default configuration standard icons are used.
- */
-export default class HeadingButtonsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const options = getLocalizedOptions(this.editor);
-        options
-            .filter(item => item.model !== 'paragraph')
-            .map(item => this._createButton(item));
-    }
-    /**
-     * Creates single button view from provided configuration option.
-     */
-    _createButton(option) {
-        const editor = this.editor;
-        editor.ui.componentFactory.add(option.model, locale => {
-            const view = new ButtonView(locale);
-            const command = editor.commands.get('heading');
-            view.label = option.title;
-            view.icon = option.icon || defaultIcons[option.model];
-            view.tooltip = true;
-            view.isToggleable = true;
-            view.bind('isEnabled').to(command);
-            view.bind('isOn').to(command, 'value', value => value == option.model);
-            view.on('execute', () => {
-                editor.execute('heading', { value: option.model });
-                editor.editing.view.focus();
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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 heading/headingbuttonsui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ButtonView } from 'ckeditor5/src/ui.js';
+import { getLocalizedOptions } from './utils.js';
+import iconHeading1 from '../theme/icons/heading1.svg';
+import iconHeading2 from '../theme/icons/heading2.svg';
+import iconHeading3 from '../theme/icons/heading3.svg';
+import iconHeading4 from '../theme/icons/heading4.svg';
+import iconHeading5 from '../theme/icons/heading5.svg';
+import iconHeading6 from '../theme/icons/heading6.svg';
+const defaultIcons = {
+    heading1: iconHeading1,
+    heading2: iconHeading2,
+    heading3: iconHeading3,
+    heading4: iconHeading4,
+    heading5: iconHeading5,
+    heading6: iconHeading6
+};
+/**
+ * The `HeadingButtonsUI` plugin defines a set of UI buttons that can be used instead of the
+ * standard drop down component.
+ *
+ * This feature is not enabled by default by the {@link module:heading/heading~Heading} plugin and needs to be
+ * installed manually to the editor configuration.
+ *
+ * Plugin introduces button UI elements, which names are same as `model` property from {@link module:heading/headingconfig~HeadingOption}.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
+ *     heading: {
+ *       options: [
+ *         { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
+ *         { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
+ *         { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
+ *         { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
+ *       ]
+ *      },
+ *      toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * NOTE: The `'paragraph'` button is defined in by the {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin
+ * which needs to be loaded manually as well.
+ *
+ * It is possible to use custom icons by providing `icon` config option in {@link module:heading/headingconfig~HeadingOption}.
+ * For the default configuration standard icons are used.
+ */
+export default class HeadingButtonsUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const options = getLocalizedOptions(this.editor);
+        options
+            .filter(item => item.model !== 'paragraph')
+            .map(item => this._createButton(item));
+    }
+    /**
+     * Creates single button view from provided configuration option.
+     */
+    _createButton(option) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(option.model, locale => {
+            const view = new ButtonView(locale);
+            const command = editor.commands.get('heading');
+            view.label = option.title;
+            view.icon = option.icon || defaultIcons[option.model];
+            view.tooltip = true;
+            view.isToggleable = true;
+            view.bind('isEnabled').to(command);
+            view.bind('isOn').to(command, 'value', value => value == option.model);
+            view.on('execute', () => {
+                editor.execute('heading', { value: option.model });
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
+}

package/src/headingcommand.d.ts

@@ -1,48 +1,48 @@
-/**
- * @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 heading/headingcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-/**
- * The heading command. It is used by the {@link module:heading/heading~Heading heading feature} to apply headings.
- */
-export default class HeadingCommand extends Command {
-    /**
-     * If the selection starts in a heading (which {@link #modelElements is supported by this command})
-     * the value is set to the name of that heading model element.
-     * It is  set to `false` otherwise.
-     *
-     * @observable
-     * @readonly
-     */
-    value: false | string;
-    /**
-     * Set of defined model's elements names that this command support.
-     * See {@link module:heading/headingconfig~HeadingOption}.
-     */
-    readonly modelElements: Array<string>;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param editor Editor instance.
-     * @param modelElements Names of the element which this command can apply in the model.
-     */
-    constructor(editor: Editor, modelElements: Array<string>);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. Applies the heading to the selected blocks or, if the first selected
-     * block is a heading already, turns selected headings (of this level only) to paragraphs.
-     *
-     * @param options.value Name of the element which this command will apply in the model.
-     * @fires execute
-     */
-    execute(options: {
-        value: string;
-    }): void;
-}
+/**
+ * @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 heading/headingcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The heading command. It is used by the {@link module:heading/heading~Heading heading feature} to apply headings.
+ */
+export default class HeadingCommand extends Command {
+    /**
+     * If the selection starts in a heading (which {@link #modelElements is supported by this command})
+     * the value is set to the name of that heading model element.
+     * It is  set to `false` otherwise.
+     *
+     * @observable
+     * @readonly
+     */
+    value: false | string;
+    /**
+     * Set of defined model's elements names that this command support.
+     * See {@link module:heading/headingconfig~HeadingOption}.
+     */
+    readonly modelElements: Array<string>;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor Editor instance.
+     * @param modelElements Names of the element which this command can apply in the model.
+     */
+    constructor(editor: Editor, modelElements: Array<string>);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. Applies the heading to the selected blocks or, if the first selected
+     * block is a heading already, turns selected headings (of this level only) to paragraphs.
+     *
+     * @param options.value Name of the element which this command will apply in the model.
+     * @fires execute
+     */
+    execute(options: {
+        value: string;
+    }): void;
+}