@ckeditor/ckeditor5-heading 38.0.1 → 38.1.1

package/src/headingconfig.d.ts

@@ -1,110 +1,110 @@
-/**
- * @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/headingconfig
- */
-import type { ViewElementDefinition } from 'ckeditor5/src/engine';
-/**
- * The configuration of the heading feature.
- * The option is used by the {@link module:heading/headingediting~HeadingEditing} feature.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     heading: ... // Heading feature config.
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface HeadingConfig {
-    /**
-     * The available heading options.
-     *
-     * The default value is:
-     * ```ts
-     * const headingConfig = {
-     *   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' }
-     *   ]
-     * };
-     * ```
-     *
-     * It defines 3 levels of headings. In the editor model they will use `heading1`, `heading2`, and `heading3` elements.
-     * Their respective view elements (so the elements output by the editor) will be: `h2`, `h3`, and `h4`. This means that
-     * if you choose "Heading 1" in the headings dropdown the editor will turn the current block to `<heading1>` in the model
-     * which will result in rendering (and outputting to data) the `<h2>` element.
-     *
-     * The `title` and `class` properties will be used by the `headings` dropdown to render available options.
-     * Usually, the first option in the headings dropdown is the "Paragraph" option, hence it's also defined on the list.
-     * However, you don't need to define its view representation because it's handled by
-     * the {@link module:paragraph/paragraph~Paragraph} feature (which is required by
-     * the {@link module:heading/headingediting~HeadingEditing} feature).
-     *
-     * You can **read more** about configuring heading levels and **see more examples** in
-     * the {@glink features/headings Headings} guide.
-     *
-     * Note: In the model you should always start from `heading1`, regardless of how the headings are represented in the view.
-     * That's assumption is used by features like {@link module:autoformat/autoformat~Autoformat} to know which element
-     * they should use when applying the first level heading.
-     *
-     * The defined headings are also available as values passed to the `'heading'` command under their model names.
-     * For example, the below code will apply `<heading1>` to the current selection:
-     *
-     * ```ts
-     * editor.execute( 'heading', { value: 'heading1' } );
-     * ```
-     */
-    options?: Array<HeadingOption>;
-}
-/**
- * Heading option descriptor.
- */
-export type HeadingOption = HeadingElementOption | HeadingParagraphOption;
-export interface HeadingElementOption {
-    /**
-     * Name of the model element to convert.
-     */
-    model: 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6';
-    /**
-     * Definition of a view element to convert from/to.
-     */
-    view: ViewElementDefinition;
-    /**
-     * The user-readable title of the option.
-     */
-    title: string;
-    /**
-     * The class which will be added to the dropdown item representing this option.
-     */
-    class: string;
-    /**
-     * Icon used by {@link module:heading/headingbuttonsui~HeadingButtonsUI}. It can be omitted when using the default configuration.
-     */
-    icon?: string;
-}
-export interface HeadingParagraphOption {
-    /**
-     * Name of the model element to convert.
-     */
-    model: 'paragraph';
-    /**
-     * The user-readable title of the option.
-     */
-    title: string;
-    /**
-     * The class which will be added to the dropdown item representing this option.
-     * */
-    class: string;
-    /**
-     * Icon used by {@link module:heading/headingbuttonsui~HeadingButtonsUI}. It can be omitted when using the default configuration.
-     */
-    icon?: string;
-}
+/**
+ * @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/headingconfig
+ */
+import type { ViewElementDefinition } from 'ckeditor5/src/engine';
+/**
+ * The configuration of the heading feature.
+ * The option is used by the {@link module:heading/headingediting~HeadingEditing} feature.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     heading: ... // Heading feature config.
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface HeadingConfig {
+    /**
+     * The available heading options.
+     *
+     * The default value is:
+     * ```ts
+     * const headingConfig = {
+     *   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' }
+     *   ]
+     * };
+     * ```
+     *
+     * It defines 3 levels of headings. In the editor model they will use `heading1`, `heading2`, and `heading3` elements.
+     * Their respective view elements (so the elements output by the editor) will be: `h2`, `h3`, and `h4`. This means that
+     * if you choose "Heading 1" in the headings dropdown the editor will turn the current block to `<heading1>` in the model
+     * which will result in rendering (and outputting to data) the `<h2>` element.
+     *
+     * The `title` and `class` properties will be used by the `headings` dropdown to render available options.
+     * Usually, the first option in the headings dropdown is the "Paragraph" option, hence it's also defined on the list.
+     * However, you don't need to define its view representation because it's handled by
+     * the {@link module:paragraph/paragraph~Paragraph} feature (which is required by
+     * the {@link module:heading/headingediting~HeadingEditing} feature).
+     *
+     * You can **read more** about configuring heading levels and **see more examples** in
+     * the {@glink features/headings Headings} guide.
+     *
+     * Note: In the model you should always start from `heading1`, regardless of how the headings are represented in the view.
+     * That's assumption is used by features like {@link module:autoformat/autoformat~Autoformat} to know which element
+     * they should use when applying the first level heading.
+     *
+     * The defined headings are also available as values passed to the `'heading'` command under their model names.
+     * For example, the below code will apply `<heading1>` to the current selection:
+     *
+     * ```ts
+     * editor.execute( 'heading', { value: 'heading1' } );
+     * ```
+     */
+    options?: Array<HeadingOption>;
+}
+/**
+ * Heading option descriptor.
+ */
+export type HeadingOption = HeadingElementOption | HeadingParagraphOption;
+export interface HeadingElementOption {
+    /**
+     * Name of the model element to convert.
+     */
+    model: 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6';
+    /**
+     * Definition of a view element to convert from/to.
+     */
+    view: ViewElementDefinition;
+    /**
+     * The user-readable title of the option.
+     */
+    title: string;
+    /**
+     * The class which will be added to the dropdown item representing this option.
+     */
+    class: string;
+    /**
+     * Icon used by {@link module:heading/headingbuttonsui~HeadingButtonsUI}. It can be omitted when using the default configuration.
+     */
+    icon?: string;
+}
+export interface HeadingParagraphOption {
+    /**
+     * Name of the model element to convert.
+     */
+    model: 'paragraph';
+    /**
+     * The user-readable title of the option.
+     */
+    title: string;
+    /**
+     * The class which will be added to the dropdown item representing this option.
+     * */
+    class: string;
+    /**
+     * Icon used by {@link module:heading/headingbuttonsui~HeadingButtonsUI}. It can be omitted when using the default configuration.
+     */
+    icon?: string;
+}

package/src/headingconfig.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/headingediting.d.ts

@@ -1,42 +1,42 @@
-/**
- * @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/headingediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import { Paragraph } from 'ckeditor5/src/paragraph';
-/**
- * The headings engine feature. It handles switching between block formats – headings and paragraph.
- * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
- * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
- */
-export default class HeadingEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): 'HeadingEditing';
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Paragraph];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Adds default conversion for `h1` -> `heading1` with a low priority.
-     *
-     * @param editor Editor instance on which to add the `h1` conversion.
-     */
-    private _addDefaultH1Conversion;
-}
+/**
+ * @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/headingediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import { Paragraph } from 'ckeditor5/src/paragraph';
+/**
+ * The headings engine feature. It handles switching between block formats – headings and paragraph.
+ * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
+ * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
+ */
+export default class HeadingEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Paragraph];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Adds default conversion for `h1` -> `heading1` with a low priority.
+     *
+     * @param editor Editor instance on which to add the `h1` conversion.
+     */
+    private _addDefaultH1Conversion;
+}

package/src/headingediting.js

@@ -1,101 +1,101 @@
-/**
- * @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/headingediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Paragraph } from 'ckeditor5/src/paragraph';
-import { priorities } from 'ckeditor5/src/utils';
-import HeadingCommand from './headingcommand';
-const defaultModelElement = 'paragraph';
-/**
- * The headings engine feature. It handles switching between block formats – headings and paragraph.
- * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
- * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
- */
-export default class HeadingEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HeadingEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('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' }
-            ]
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Paragraph];
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const options = editor.config.get('heading.options');
-        const modelElements = [];
-        for (const option of options) {
-            // Skip paragraph - it is defined in required Paragraph feature.
-            if (option.model === 'paragraph') {
-                continue;
-            }
-            // Schema.
-            editor.model.schema.register(option.model, {
-                inheritAllFrom: '$block'
-            });
-            editor.conversion.elementToElement(option);
-            modelElements.push(option.model);
-        }
-        this._addDefaultH1Conversion(editor);
-        // Register the heading command for this option.
-        editor.commands.add('heading', new HeadingCommand(editor, modelElements));
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        // If the enter command is added to the editor, alter its behavior.
-        // Enter at the end of a heading element should create a paragraph.
-        const editor = this.editor;
-        const enterCommand = editor.commands.get('enter');
-        const options = editor.config.get('heading.options');
-        if (enterCommand) {
-            this.listenTo(enterCommand, 'afterExecute', (evt, data) => {
-                const positionParent = editor.model.document.selection.getFirstPosition().parent;
-                const isHeading = options.some(option => positionParent.is('element', option.model));
-                if (isHeading && !positionParent.is('element', defaultModelElement) && positionParent.childCount === 0) {
-                    data.writer.rename(positionParent, defaultModelElement);
-                }
-            });
-        }
-    }
-    /**
-     * Adds default conversion for `h1` -> `heading1` with a low priority.
-     *
-     * @param editor Editor instance on which to add the `h1` conversion.
-     */
-    _addDefaultH1Conversion(editor) {
-        editor.conversion.for('upcast').elementToElement({
-            model: 'heading1',
-            view: 'h1',
-            // With a `low` priority, `paragraph` plugin autoparagraphing mechanism is executed. Make sure
-            // this listener is called before it. If not, `h1` will be transformed into a paragraph.
-            converterPriority: priorities.get('low') + 1
-        });
-    }
-}
+/**
+ * @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/headingediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Paragraph } from 'ckeditor5/src/paragraph';
+import { priorities } from 'ckeditor5/src/utils';
+import HeadingCommand from './headingcommand';
+const defaultModelElement = 'paragraph';
+/**
+ * The headings engine feature. It handles switching between block formats – headings and paragraph.
+ * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
+ * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
+ */
+export default class HeadingEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HeadingEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('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' }
+            ]
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Paragraph];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const options = editor.config.get('heading.options');
+        const modelElements = [];
+        for (const option of options) {
+            // Skip paragraph - it is defined in required Paragraph feature.
+            if (option.model === 'paragraph') {
+                continue;
+            }
+            // Schema.
+            editor.model.schema.register(option.model, {
+                inheritAllFrom: '$block'
+            });
+            editor.conversion.elementToElement(option);
+            modelElements.push(option.model);
+        }
+        this._addDefaultH1Conversion(editor);
+        // Register the heading command for this option.
+        editor.commands.add('heading', new HeadingCommand(editor, modelElements));
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        // If the enter command is added to the editor, alter its behavior.
+        // Enter at the end of a heading element should create a paragraph.
+        const editor = this.editor;
+        const enterCommand = editor.commands.get('enter');
+        const options = editor.config.get('heading.options');
+        if (enterCommand) {
+            this.listenTo(enterCommand, 'afterExecute', (evt, data) => {
+                const positionParent = editor.model.document.selection.getFirstPosition().parent;
+                const isHeading = options.some(option => positionParent.is('element', option.model));
+                if (isHeading && !positionParent.is('element', defaultModelElement) && positionParent.childCount === 0) {
+                    data.writer.rename(positionParent, defaultModelElement);
+                }
+            });
+        }
+    }
+    /**
+     * Adds default conversion for `h1` -> `heading1` with a low priority.
+     *
+     * @param editor Editor instance on which to add the `h1` conversion.
+     */
+    _addDefaultH1Conversion(editor) {
+        editor.conversion.for('upcast').elementToElement({
+            model: 'heading1',
+            view: 'h1',
+            // With a `low` priority, `paragraph` plugin autoparagraphing mechanism is executed. Make sure
+            // this listener is called before it. If not, `h1` will be transformed into a paragraph.
+            converterPriority: priorities.low + 1
+        });
+    }
+}

package/src/headingui.d.ts

@@ -1,22 +1,22 @@
-/**
- * @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/headingui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import '../theme/heading.css';
-/**
- * The headings UI feature. It introduces the `headings` dropdown.
- */
-export default class HeadingUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): 'HeadingUI';
-    /**
-     * @inheritDoc
-     */
-    init(): 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/headingui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import '../theme/heading.css';
+/**
+ * The headings UI feature. It introduces the `headings` dropdown.
+ */
+export default class HeadingUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}